key.go 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. package desktop
  2. import (
  3. "fyne.io/fyne/v2"
  4. )
  5. const (
  6. // KeyNone represents no key
  7. KeyNone fyne.KeyName = ""
  8. // KeyShiftLeft represents the left shift key
  9. KeyShiftLeft fyne.KeyName = "LeftShift"
  10. // KeyShiftRight represents the right shift key
  11. KeyShiftRight fyne.KeyName = "RightShift"
  12. // KeyControlLeft represents the left control key
  13. KeyControlLeft fyne.KeyName = "LeftControl"
  14. // KeyControlRight represents the right control key
  15. KeyControlRight fyne.KeyName = "RightControl"
  16. // KeyAltLeft represents the left alt key
  17. KeyAltLeft fyne.KeyName = "LeftAlt"
  18. // KeyAltRight represents the right alt key
  19. KeyAltRight fyne.KeyName = "RightAlt"
  20. // KeySuperLeft represents the left "Windows" key (or "Command" key on macOS)
  21. KeySuperLeft fyne.KeyName = "LeftSuper"
  22. // KeySuperRight represents the right "Windows" key (or "Command" key on macOS)
  23. KeySuperRight fyne.KeyName = "RightSuper"
  24. // KeyMenu represents the left or right menu / application key
  25. KeyMenu fyne.KeyName = "Menu"
  26. // KeyPrintScreen represents the key used to cause a screen capture
  27. KeyPrintScreen fyne.KeyName = "PrintScreen"
  28. // KeyCapsLock represents the caps lock key, tapping once is the down event then again is the up
  29. KeyCapsLock fyne.KeyName = "CapsLock"
  30. )
  31. // Modifier captures any key modifiers (shift etc.) pressed during a key event
  32. //
  33. // Deprecated: Use fyne.KeyModifier instead.
  34. type Modifier = fyne.KeyModifier
  35. const (
  36. // ShiftModifier represents a shift key being held
  37. //
  38. // Deprecated: Use fyne.KeyModifierShift instead.
  39. ShiftModifier = fyne.KeyModifierShift
  40. // ControlModifier represents the ctrl key being held
  41. //
  42. // Deprecated: Use fyne.KeyModifierControl instead.
  43. ControlModifier = fyne.KeyModifierControl
  44. // AltModifier represents either alt keys being held
  45. //
  46. // Deprecated: Use fyne.KeyModifierAlt instead.
  47. AltModifier = fyne.KeyModifierAlt
  48. // SuperModifier represents either super keys being held
  49. //
  50. // Deprecated: Use fyne.KeyModifierSuper instead.
  51. SuperModifier = fyne.KeyModifierSuper
  52. )
  53. // Keyable describes any focusable canvas object that can accept desktop key events.
  54. // This is the traditional key down and up event that is not applicable to all devices.
  55. type Keyable interface {
  56. fyne.Focusable
  57. KeyDown(*fyne.KeyEvent)
  58. KeyUp(*fyne.KeyEvent)
  59. }