Input Devices
PBMouseButton
Enumeration/bitset of type uint8_t: A standardized mouse button.
Constants
PBMouseButton_LEFT
PBMouseButton_LEFT = 0
The left mouse button.
PBMouseButton_MIDDLE
PBMouseButton_MIDDLE = 1
The middle mouse button or scroll wheel button.
PBMouseButton_RIGHT
PBMouseButton_RIGHT = 2
The right mouse button.
PBKeyCode
Enumeration/bitset of type uint16_t: A standardized keyboard key.
Constants
PBKey_NONE
PBKey_NONE = 0x0
No key.
PBKey_A
PBKey_A = 0x41
The letter A from the Latin alphabet.
PBKey_B
PBKey_B = 0x42
The letter B from the Latin alphabet.
PBKey_C
PBKey_C = 0x43
The letter C from the Latin alphabet.
PBKey_D
PBKey_D = 0x44
The letter D from the Latin alphabet.
PBKey_E
PBKey_E = 0x45
The letter E from the Latin alphabet.
PBKey_F
PBKey_F = 0x46
The letter F from the Latin alphabet.
PBKey_G
PBKey_G = 0x47
The letter G from the Latin alphabet.
PBKey_H
PBKey_H = 0x48
The letter H from the Latin alphabet.
PBKey_I
PBKey_I = 0x49
The letter I from the Latin alphabet.
PBKey_J
PBKey_J = 0x4A
The letter J from the Latin alphabet.
PBKey_K
PBKey_K = 0x4B
The letter K from the Latin alphabet.
PBKey_L
PBKey_L = 0x4C
The letter L from the Latin alphabet.
PBKey_M
PBKey_M = 0x4D
The letter M from the Latin alphabet.
PBKey_N
PBKey_N = 0x4E
The letter N from the Latin alphabet.
PBKey_O
PBKey_O = 0x4F
The letter O from the Latin alphabet.
PBKey_P
PBKey_P = 0x50
The letter P from the Latin alphabet.
PBKey_Q
PBKey_Q = 0x51
The letter Q from the Latin alphabet.
PBKey_R
PBKey_R = 0x52
The letter R from the Latin alphabet.
PBKey_S
PBKey_S = 0x53
The letter S from the Latin alphabet.
PBKey_T
PBKey_T = 0x54
The letter T from the Latin alphabet.
PBKey_U
PBKey_U = 0x55
The letter U from the Latin alphabet.
PBKey_V
PBKey_V = 0x56
The letter V from the Latin alphabet.
PBKey_W
PBKey_W = 0x57
The letter W from the Latin alphabet.
PBKey_X
PBKey_X = 0x58
The letter X from the Latin alphabet.
PBKey_Y
PBKey_Y = 0x59
The letter Y from the Latin alphabet.
PBKey_Z
PBKey_Z = 0x5A
The letter Z from the Latin alphabet.
PBKey_1
PBKey_1 = 0x31
The digit 1 from the Western Arabic numerals.
PBKey_2
PBKey_2 = 0x32
The digit 2 from the Western Arabic numerals.
PBKey_3
PBKey_3 = 0x33
The digit 3 from the Western Arabic numerals.
PBKey_4
PBKey_4 = 0x34
The digit 4 from the Western Arabic numerals.
PBKey_5
PBKey_5 = 0x35
The digit 5 from the Western Arabic numerals.
PBKey_6
PBKey_6 = 0x36
The digit 6 from the Western Arabic numerals.
PBKey_7
PBKey_7 = 0x37
The digit 7 from the Western Arabic numerals.
PBKey_8
PBKey_8 = 0x38
The digit 8 from the Western Arabic numerals.
PBKey_9
PBKey_9 = 0x39
The digit 9 from the Western Arabic numerals.
PBKey_0
PBKey_0 = 0x30
The digit 0 from the Western Arabic numerals.
PBKey_ENTER
PBKey_ENTER = 0x0D
The enter/return key.
PBKey_ESCAPE
PBKey_ESCAPE = 0x1B
The escape key.
PBKey_BACKSPACE
PBKey_BACKSPACE = 0x08
The backspace/backwards-delete key.
PBKey_TAB
PBKey_TAB = 0x09
The tab key.
PBKey_SPACE
PBKey_SPACE = 0x20
The spacebar.
PBKey_HYPHEN
PBKey_HYPHEN = 0x2D
The hyphen/underscore key.
PBKey_EQUALS
PBKey_EQUALS = 0x2E
The equals/plus key.
PBKey_LEFT_BRACE
PBKey_LEFT_BRACE = 0x2F
The left/opening brace/bracket key.
PBKey_RIGHT_BRACE
PBKey_RIGHT_BRACE = 0x29
The right/closing brace/bracket key.
PBKey_COMMA
PBKey_COMMA = 0x18
The comma/less-than key.
PBKey_PERIOD
PBKey_PERIOD = 0x19
The period/full-stop/greater-than key.
PBKey_SLASH
PBKey_SLASH = 0x1A
The forward-slash/question-mark key.
PBKey_PUNCTUATION_1
PBKey_PUNCTUATION_1 = 0x11
A keyboard layout dependent punctuation key. (On US keyboards, the backwards-slash/pipe key.)
PBKey_PUNCTUATION_2
PBKey_PUNCTUATION_2 = 0x12
A keyboard layout dependent punctuation key
PBKey_PUNCTUATION_3
PBKey_PUNCTUATION_3 = 0x15
A keyboard layout dependent punctuation key. (On US keyboards, the semi-colon/colon key.)
PBKey_PUNCTUATION_4
PBKey_PUNCTUATION_4 = 0x16
A keyboard layout dependent punctuation key. (On US keyboards, the quote-mark/speech-mark key.)
PBKey_PUNCTUATION_5
PBKey_PUNCTUATION_5 = 0x17
A keyboard layout dependent punctuation key. (On US keyboards, the backtick/tilde key.)
PBKey_PUNCTUATION_6
PBKey_PUNCTUATION_6 = 0x1C
A keyboard layout dependent punctuation key
PBKey_F1
PBKey_F1 = 0x70
The F1 key.
PBKey_F2
PBKey_F2 = 0x71
The F2 key.
PBKey_F3
PBKey_F3 = 0x72
The F3 key.
PBKey_F4
PBKey_F4 = 0x73
The F4 key.
PBKey_F5
PBKey_F5 = 0x74
The F5 key.
PBKey_F6
PBKey_F6 = 0x75
The F6 key.
PBKey_F7
PBKey_F7 = 0x76
The F7 key.
PBKey_F8
PBKey_F8 = 0x77
The F8 key.
PBKey_F9
PBKey_F9 = 0x78
The F9 key.
PBKey_F10
PBKey_F10 = 0x79
The F10 key.
PBKey_F11
PBKey_F11 = 0x7A
The F11 key.
PBKey_F12
PBKey_F12 = 0x7B
The F12 key.
PBKey_F13
PBKey_F13 = 0x7C
The F13 key.
PBKey_F14
PBKey_F14 = 0x7D
The F14 key.
PBKey_F15
PBKey_F15 = 0x7E
The F15 key.
PBKey_F16
PBKey_F16 = 0x7F
The F16 key.
PBKey_F17
PBKey_F17 = 0x80
The F17 key.
PBKey_F18
PBKey_F18 = 0x81
The F18 key.
PBKey_F19
PBKey_F19 = 0x82
The F19 key.
PBKey_F20
PBKey_F20 = 0x83
The F20 key.
PBKey_F21
PBKey_F21 = 0x84
The F21 key.
PBKey_F22
PBKey_F22 = 0x85
The F22 key.
PBKey_F23
PBKey_F23 = 0x86
The F23 key.
PBKey_F24
PBKey_F24 = 0x87
The F24 key.
PBKey_CAPS_LOCK
PBKey_CAPS_LOCK = 0x14
The caps-lock key. See also: PBLock_CAPS.
PBKey_PRINT_SCREEN
PBKey_PRINT_SCREEN = 0x2A
The print-screen key.
PBKey_SCROLL_LOCK
PBKey_SCROLL_LOCK = 0x1D
The scroll-lock key. See also: PBLock_SCROLL.
PBKey_PAUSE
PBKey_PAUSE = 0x13
The pause/break key.
PBKey_INSERT
PBKey_INSERT = 0x1E
The insert/overwrite key.
PBKey_HOME
PBKey_HOME = 0x24
The home key.
PBKey_PAGE_UP
PBKey_PAGE_UP = 0x21
The page-up/PgUp key.
PBKey_DELETE
PBKey_DELETE = 0x1F
The delete/forwards-delete key.
PBKey_END
PBKey_END = 0x23
The end key.
PBKey_PAGE_DOWN
PBKey_PAGE_DOWN = 0x22
The page-down/PgDn key.
PBKey_RIGHT_ARROW
PBKey_RIGHT_ARROW = 0x27
The right directional arrow key.
PBKey_LEFT_ARROW
PBKey_LEFT_ARROW = 0x25
The left directional arrow key.
PBKey_DOWN_ARROW
PBKey_DOWN_ARROW = 0x28
The down directional arrow key.
PBKey_UP_ARROW
PBKey_UP_ARROW = 0x26
The up directional arrow key.
PBKey_NUM_LOCK
PBKey_NUM_LOCK = 0x5B
The num-lock key. See also: PBLock_NUM.
PBKey_CONTEXT_MENU
PBKey_CONTEXT_MENU = 0x6D
The open-context-menu key.
PBKey_SYSTEM_REQUEST
PBKey_SYSTEM_REQUEST = 0x9A
The system-request/SysRq key.
PBKey_ACTION_EXECUTE
PBKey_ACTION_EXECUTE = 0xA0
PBKey_ACTION_HELP
PBKey_ACTION_HELP = 0xA1
PBKey_ACTION_MENU
PBKey_ACTION_MENU = 0xA2
PBKey_ACTION_SELECT
PBKey_ACTION_SELECT = 0xA3
PBKey_ACTION_STOP
PBKey_ACTION_STOP = 0xA4
PBKey_ACTION_AGAIN
PBKey_ACTION_AGAIN = 0xA5
PBKey_ACTION_UNDO
PBKey_ACTION_UNDO = 0xA6
PBKey_ACTION_CUT
PBKey_ACTION_CUT = 0xA7
PBKey_ACTION_COPY
PBKey_ACTION_COPY = 0xA8
PBKey_ACTION_PASTE
PBKey_ACTION_PASTE = 0xA9
PBKey_ACTION_FIND
PBKey_ACTION_FIND = 0xAA
PBKey_ACTION_CANCEL
PBKey_ACTION_CANCEL = 0x9B
PBKey_ACTION_CLEAR
PBKey_ACTION_CLEAR = 0x9C
PBKey_ACTION_PRIOR
PBKey_ACTION_PRIOR = 0x9D
PBKey_ACTION_RETURN
PBKey_ACTION_RETURN = 0x9E
PBKey_ACTION_SEPARATOR
PBKey_ACTION_SEPARATOR = 0x9F
PBKey_MM_MUTE
PBKey_MM_MUTE = 0xAB
The mute key from the multimedia extensions.
PBKey_MM_LOUDER
PBKey_MM_LOUDER = 0xAC
The volume-increase key from the multimedia extensions.
PBKey_MM_QUIETER
PBKey_MM_QUIETER = 0xAD
The volume-decrease key from the multimedia extensions.
PBKey_MM_NEXT
PBKey_MM_NEXT = 0x103
The next-track key from the multimedia extensions.
PBKey_MM_PREVIOUS
PBKey_MM_PREVIOUS = 0x104
The previous-track key from the multimedia extensions.
PBKey_MM_STOP
PBKey_MM_STOP = 0x105
The stop-playback key from the multimedia extensions.
PBKey_MM_PAUSE
PBKey_MM_PAUSE = 0x106
The play/pause key from the multimedia extensions.
PBKey_MM_SELECT
PBKey_MM_SELECT = 0x107
The item-select key from the multimedia extensions.
PBKey_MM_EMAIL
PBKey_MM_EMAIL = 0x108
The open-email-client key from the multimedia extensions.
PBKey_MM_CALC
PBKey_MM_CALC = 0x109
The open-calculator key from the multimedia extensions.
PBKey_MM_FILES
PBKey_MM_FILES = 0x10A
The open-file-manager key from the multimedia extensions.
PBKey_INTERNATIONAL_1
PBKey_INTERNATIONAL_1 = 0xAE
PBKey_INTERNATIONAL_2
PBKey_INTERNATIONAL_2 = 0x88
PBKey_INTERNATIONAL_3
PBKey_INTERNATIONAL_3 = 0x89
PBKey_INTERNATIONAL_4
PBKey_INTERNATIONAL_4 = 0x8A
PBKey_INTERNATIONAL_5
PBKey_INTERNATIONAL_5 = 0x8B
PBKey_INTERNATIONAL_6
PBKey_INTERNATIONAL_6 = 0x8C
PBKey_INTERNATIONAL_7
PBKey_INTERNATIONAL_7 = 0x8D
PBKey_INTERNATIONAL_8
PBKey_INTERNATIONAL_8 = 0x8E
PBKey_INTERNATIONAL_9
PBKey_INTERNATIONAL_9 = 0x8F
PBKey_HANGUL_ENGLISH_TOGGLE
PBKey_HANGUL_ENGLISH_TOGGLE = 0x90
PBKey_HANJA_CONVERSION
PBKey_HANJA_CONVERSION = 0x91
PBKey_KATAKANA
PBKey_KATAKANA = 0x92
PBKey_HIRAGANA
PBKey_HIRAGANA = 0x93
PBKey_HANKAKU_ZENKAKU_TOGGLE
PBKey_HANKAKU_ZENKAKU_TOGGLE = 0x94
PBKey_ALTERNATE_ERASE
PBKey_ALTERNATE_ERASE = 0x99
PBKey_THOUSANDS_SEPARATOR
PBKey_THOUSANDS_SEPARATOR = 0xB2
PBKey_DECIMAL_SEPARATOR
PBKey_DECIMAL_SEPARATOR = 0xB3
PBKey_CURRENCY_UNIT
PBKey_CURRENCY_UNIT = 0xB4
PBKey_CURRENCY_SUBUNIT
PBKey_CURRENCY_SUBUNIT = 0xB5
PBKey_NUM_DIVIDE
PBKey_NUM_DIVIDE = 0x5C
The forward slash key on the numpad.
PBKey_NUM_MULTIPLY
PBKey_NUM_MULTIPLY = 0x5D
The asterisk key on the numpad.
PBKey_NUM_SUBTRACT
PBKey_NUM_SUBTRACT = 0x5E
The hyphen key on the numpad.
PBKey_NUM_ADD
PBKey_NUM_ADD = 0x5F
The plus key on the numpad.
PBKey_NUM_ENTER
PBKey_NUM_ENTER = 0x6A
The enter/return key on the numpad.
PBKey_NUM_1
PBKey_NUM_1 = 0x61
The digit 1 on the numpad.
PBKey_NUM_2
PBKey_NUM_2 = 0x62
The digit 2 on the numpad.
PBKey_NUM_3
PBKey_NUM_3 = 0x63
The digit 3 on the numpad.
PBKey_NUM_4
PBKey_NUM_4 = 0x64
The digit 4 on the numpad.
PBKey_NUM_5
PBKey_NUM_5 = 0x65
The digit 5 on the numpad.
PBKey_NUM_6
PBKey_NUM_6 = 0x66
The digit 6 on the numpad.
PBKey_NUM_7
PBKey_NUM_7 = 0x67
The digit 7 on the numpad.
PBKey_NUM_8
PBKey_NUM_8 = 0x68
The digit 8 on the numpad.
PBKey_NUM_9
PBKey_NUM_9 = 0x69
The digit 9 on the numpad.
PBKey_NUM_0
PBKey_NUM_0 = 0x60
The digit 0 on the numpad.
PBKey_NUM_POINT
PBKey_NUM_POINT = 0x6B
The period key on the numpad.
PBKey_NUM_EQUALS
PBKey_NUM_EQUALS = 0x6E
The equals key on the numpad.
PBKey_NUM_COMMA
PBKey_NUM_COMMA = 0x6C
The comma key on the numpad.
PBKey_NUM_00
PBKey_NUM_00 = 0xB0
The double-0 key on the numpad.
PBKey_NUM_000
PBKey_NUM_000 = 0xB1
The triple-0 key on the numpad.
PBKey_NUM_LEFT_PAREN
PBKey_NUM_LEFT_PAREN = 0xB6
PBKey_NUM_RIGHT_PAREN
PBKey_NUM_RIGHT_PAREN = 0xB7
PBKey_NUM_LEFT_BRACE
PBKey_NUM_LEFT_BRACE = 0xB8
PBKey_NUM_RIGHT_BRACE
PBKey_NUM_RIGHT_BRACE = 0xB9
PBKey_NUM_TAB
PBKey_NUM_TAB = 0xBA
PBKey_NUM_BACKSPACE
PBKey_NUM_BACKSPACE = 0xBB
PBKey_NUM_A
PBKey_NUM_A = 0xBC
PBKey_NUM_B
PBKey_NUM_B = 0xBD
PBKey_NUM_C
PBKey_NUM_C = 0xBE
PBKey_NUM_D
PBKey_NUM_D = 0xBF
PBKey_NUM_E
PBKey_NUM_E = 0xC0
PBKey_NUM_F
PBKey_NUM_F = 0xC1
PBKey_NUM_XOR
PBKey_NUM_XOR = 0xC2
PBKey_NUM_CARET
PBKey_NUM_CARET = 0xC3
PBKey_NUM_PERCENT
PBKey_NUM_PERCENT = 0xC4
PBKey_NUM_LESS_THAN
PBKey_NUM_LESS_THAN = 0xC5
PBKey_NUM_GREATER_THAN
PBKey_NUM_GREATER_THAN = 0xC6
PBKey_NUM_AMPERSAND
PBKey_NUM_AMPERSAND = 0xC7
PBKey_NUM_DOUBLE_AMPERSAND
PBKey_NUM_DOUBLE_AMPERSAND = 0xC8
PBKey_NUM_BAR
PBKey_NUM_BAR = 0xC9
PBKey_NUM_DOUBLE_BAR
PBKey_NUM_DOUBLE_BAR = 0xCA
PBKey_NUM_COLON
PBKey_NUM_COLON = 0xCB
PBKey_NUM_HASH
PBKey_NUM_HASH = 0xCC
PBKey_NUM_SPACE
PBKey_NUM_SPACE = 0xCD
PBKey_NUM_AT
PBKey_NUM_AT = 0xCE
PBKey_NUM_EXCLAMATION_MARK
PBKey_NUM_EXCLAMATION_MARK = 0xCF
PBKey_NUM_MEMORY_STORE
PBKey_NUM_MEMORY_STORE = 0xD0
PBKey_NUM_MEMORY_RECALL
PBKey_NUM_MEMORY_RECALL = 0xD1
PBKey_NUM_MEMORY_CLEAR
PBKey_NUM_MEMORY_CLEAR = 0xD2
PBKey_NUM_MEMORY_ADD
PBKey_NUM_MEMORY_ADD = 0xD3
PBKey_NUM_MEMORY_SUBTRACT
PBKey_NUM_MEMORY_SUBTRACT = 0xD4
PBKey_NUM_MEMORY_MULTIPLY
PBKey_NUM_MEMORY_MULTIPLY = 0xD5
PBKey_NUM_MEMORY_DIVIDE
PBKey_NUM_MEMORY_DIVIDE = 0xD6
PBKey_NUM_NEGATE
PBKey_NUM_NEGATE = 0xD7
PBKey_NUM_CLEAR_ALL
PBKey_NUM_CLEAR_ALL = 0xD8
PBKey_NUM_CLEAR
PBKey_NUM_CLEAR = 0xD9
PBKey_NUM_BINARY
PBKey_NUM_BINARY = 0xDA
PBKey_NUM_OCTAL
PBKey_NUM_OCTAL = 0xDB
PBKey_NUM_DECIMAL
PBKey_NUM_DECIMAL = 0xDC
PBKey_NUM_HEXADECIMAL
PBKey_NUM_HEXADECIMAL = 0xDD
PBKey_LEFT_CMD
PBKey_LEFT_CMD = 0xE0
The command modifier key on the left side of the keyboard. See also: PBModifier_CMD.
PBKey_LEFT_SHIFT
PBKey_LEFT_SHIFT = 0xE1
The shift modifier key on the left side of the keyboard. See also: PBModifier_SHIFT.
PBKey_LEFT_ALT
PBKey_LEFT_ALT = 0xE2
The alt/option modifier key on the left side of the keyboard. See also: PBModifier_ALT.
PBKey_LEFT_SYS
PBKey_LEFT_SYS = 0xE3
The flag system key on the left side of the keyboard. See also: PBModifier_SYS.
PBKey_RIGHT_CMD
PBKey_RIGHT_CMD = 0xE4
The command modifier key on the right side of the keyboard. See also: PBModifier_CMD.
PBKey_RIGHT_SHIFT
PBKey_RIGHT_SHIFT = 0xE5
The shift modifier key on the right side of the keyboard. See also: PBModifier_SHIFT.
PBKey_RIGHT_ALT
PBKey_RIGHT_ALT = 0xE6
The alt/option/alt-gr modifier key on the right side of the keyboard. See also: PBModifier_ALT_GR.
PBKey_RIGHT_SYS
PBKey_RIGHT_SYS = 0xE7
The system modifier key on the right side of the keyboard. See also: PBModifier_SYS.
PBKey_ACPI_POWER
PBKey_ACPI_POWER = 0x100
The shutdown key from the ACPI extensions.
PBKey_ACPI_SLEEP
PBKey_ACPI_SLEEP = 0x101
The enter-sleep-mode key from the ACPI extensions.
PBKey_ACPI_WAKE
PBKey_ACPI_WAKE = 0x102
The wake-from-sleep key from the ACPI extensions.
PBKey_WWW_SEARCH
PBKey_WWW_SEARCH = 0x10B
The search-internet key from the WWW extensions.
PBKey_WWW_HOME
PBKey_WWW_HOME = 0x10C
The home-page key from the WWW extensions.
PBKey_WWW_BACK
PBKey_WWW_BACK = 0x10D
The back-page key from the WWW extensions.
PBKey_WWW_FORWARD
PBKey_WWW_FORWARD = 0x10E
The forwards-page key from the WWW extensions.
PBKey_WWW_STOP
PBKey_WWW_STOP = 0x10F
The stop-loading-page key from the WWW extensions.
PBKey_WWW_REFRESH
PBKey_WWW_REFRESH = 0x110
The refresh-page key from the WWW extensions.
PBKey_WWW_STARRED
PBKey_WWW_STARRED = 0x111
The toggle-bookmark key from the WWW extensions.
PBKey_ENTER_OR_ESCAPE
PBKey_ENTER_OR_ESCAPE = 0xF000
A synthetic key value, used in PBAlertConfiguration to represent either the enter or escape key being pressed.
See Also
PBKeyboardInputFlags
Enumeration/bitset of type uint8_t: Bitset of flags for a keyboard event.
Constants
PBKeyboardInput_REPEAT
PBKeyboardInput_REPEAT = 1<<0
The event is repeated because the key is being held. This bit is always clear for key up events.
PBKeyboardInput_IN_MENU_MODE
PBKeyboardInput_IN_MENU_MODE = 1<<5
Set when one or more menus are open in the workspace.
See Also
PBMouseInputFlags
Enumeration/bitset of type uint16_t: Bitset of flags for a mouse event.
Constants
PBMouseInput_NO_POINT
PBMouseInput_NO_POINT = 1<<0
If set, then the x/y/pressedRelativeX/pressedRelativeY fields are all always zero and should be ignored.
PBMouseInput_PASSED_DRAG_MOVEMENT_THRESHOLD
PBMouseInput_PASSED_DRAG_MOVEMENT_THRESHOLD = 1<<1
Set once the mouse has been dragged a distance greater than a certain threshold. You may wish to ignore PBMsg_*_DRAG messages until this bit is set.
PBMouseInput_ACTIVATED_WINDOW
PBMouseInput_ACTIVATED_WINDOW = 1<<2
Set if the press activated a new window, or caused menus to be closed. Only elements with the flag PBElement_ALLOW_FIRST_MOUSE set will receive mouse input messages with this bit set!
PBMouseInput_HAS_PRESSURE
PBMouseInput_HAS_PRESSURE = 1<<3
The pressure field is valid.
PBMouseInput_CANCEL_ACTION
PBMouseInput_CANCEL_ACTION = 1<<4
Set in mouse button up events simulated by e.g. pressing the escape key.
PBMouseInput_IN_MENU_MODE
PBMouseInput_IN_MENU_MODE = 1<<5
Set when one or more menus are open in the workspace.
See Also
PBMouseWheelInputFlags
Enumeration/bitset of type uint16_t: Bitset of flags for a mouse wheel event.
Constants
(none)
See Also
PBModifierKeys
Enumeration/bitset of type uint16_t: Bitset of modifier keys.
Constants
PBModifier_CMD
PBModifier_CMD = 1<<0
The left or right command key is held.
PBModifier_ALT
PBModifier_ALT = 1<<1
The alt key is held.
PBModifier_SHIFT
PBModifier_SHIFT = 1<<2
The left or right shift key is held.
PBModifier_SYS
PBModifier_SYS = 1<<3
The left or right system key is held.
PBModifier_ALT_GR
PBModifier_ALT_GR = 1<<4
The alt-gr key is held.
See Also
PBLockKeys
Enumeration/bitset of type uint8_t: Bitset of lockable keys.
Constants
PBLock_NUM
PBLock_NUM = 1<<0
The num-lock key is locked.
PBLock_CAPS
PBLock_CAPS = 1<<1
The caps-lock key is locked.
PBLock_SCROLL
PBLock_SCROLL = 1<<2
The scroll-lock key is locked.
See Also
PBMessageMouse
Structure: Associated information for a mouse event.
Fields
[in] x (int32_t): The x-coordinate of the mouse cursor at the time of the event, relative to the left side of the element to which it was sent.
[in] y (int32_t): The y-coordinate of the mouse cursor at the time of the event, relative to the top side of the element to which it was sent.
[in] pressedRelativeX (int32_t): The x-coordinate of the mouse cursor at the time of the event, relative to its position when the mouse button was pressed. If the mouse button is not pressed, then this field will be 0.
[in] pressedRelativeY (int32_t): The y-coordinate of the mouse cursor at the time of the event, relative to its position when the mouse button was pressed. If the mouse button is not pressed, then this field will be 0.
[in] pressure (uint16_t): The pressure applied, from 0 to 0xFFFF. This field is only valid if the flag PBMouseInput_HAS_PRESSURE is present in the flags field. If this flag is not set, then no pressure information is available for the input device.
[in] clickChainCount (uint16_t): The number of times this mouse button has been pressed down at this location without the multiple click timer threshold expiring. For example, 2 represents a double-click. This field is 0 for PBMsg_MOUSE_MOVE. PBMsg_DRAG and PBMsgUP messages will have the same count as the corresponding PBMsg*_DOWN message.
[in] flags (PBMouseInputFlags): The flags for the event.
[in] modifiers (PBModifierKeys): The modifier keys held at the time of the event.
PBMessageKeyboard
Structure: Associated information for a keyboard event.
Fields
[in] rawCode (PBKeyCode): The actual key that was pressed or released. May be PBKey_NONE when simulated, in which case only the text field is meaningful.
[in] mappedCode (PBKeyCode): The key code after applying lock keys and numpad mapping. For example, with numlock off, PBKey_NUM_1 is mapped to PBKey_END; with numlock on, it is mapped to PBKey_1.
[in] modifiers (PBModifierKeys): The held modifier keys. If the event is caused by pressing or releasing a modifier key, this field will have already been updated to reflect its new state.
[in] locks (PBLockKeys): The locked keys at the time of the event.
[in] flags (PBKeyboardInputFlags): Flags bitwise OR-ed together giving additional information about the event.
[in] text (referenced string): The text corresponding to the pressed key, or possibly an arbitrary string to insert (with simulated events). Empty for key up.
PBMessageMouseWheel
Structure: Associated information for a mouse wheel event.
Fields
[in] dx (float): The relative horizontal motion in pixels. This may have an absolute value less than 1.
[in] dy (float): The relative vertical motion in pixels. This may have an absolute value less than 1.
[in] flags (PBMouseWheelInputFlags): Flags bitwise OR-ed together giving additional information about the event.
[in] modifiers (PBModifierKeys): The modifier keys held at the time of the event.
[in] mouseX (int32_t): The x-coordinate of the mouse cursor, relative to the left side of the element.
[in] mouseY (int32_t): The y-coordinate of the mouse cursor, relative to the top side of the element.
PBKeyboardGetModifiersSync
Function:
Syntax (C/C++)
PBModifierKeys PBKeyboardGetModifiersSync();
Syntax (Python)
KeyboardGetModifiersSync() -> (modifiers)
Parameters and Return Values
[out] modifiers (PBModifierKeys):
PBMouseGetPositionSync
Function:
Syntax (C/C++)
void PBMouseGetPositionSync(PBWindowRef forWindow,
/* output */ int32_t * _Nullable __restrict x,
/* output */ int32_t * _Nullable __restrict y);
Syntax (Python)
MouseGetPositionSync(forWindow) -> (x, y)
Parameters and Return Values
[in] forWindow (referenced PBWindow):
[optional-out] x (int32_t):
[optional-out] y (int32_t):
PBMouseGetDragDeltaSync
Function:
Syntax (C/C++)
void PBMouseGetDragDeltaSync(PBWindowRef forWindow,
/* output */ int32_t * __restrict x, /* output */ int32_t * __restrict y);
Syntax (Python)
MouseGetDragDeltaSync(forWindow) -> (x, y)
Parameters and Return Values
[in] forWindow (referenced PBWindow):
[out] x (int32_t):
[out] y (int32_t):
PBMouseGetPressedButtonSync
Function:
Syntax (C/C++)
bool PBMouseGetPressedButtonSync(PBWindowRef forWindow,
/* output */ PBMouseButton * _Nullable __restrict pressedButton);
Syntax (Python)
MouseGetPressedButtonSync(forWindow) -> (isPressed, pressedButton)
Parameters and Return Values
[in] forWindow (referenced PBWindow):
[out] isPressed (bool):
[optional-out] pressedButton (PBMouseButton):
PBMouseHideUntilMoved
Function: Hide the mouse cursor until it is moved.
Syntax (C/C++)
void PBMouseHideUntilMoved();
Syntax (Python)
MouseHideUntilMoved()
Discussion
This can be used to hide the mouse cursor while the using is typing into an input field or similar.