Property Descriptions

bool alt_pressed = false

• void set_alt_pressed ( bool value )
• bool is_alt_pressed ( )

State of the Alt modifier.

bool command_or_control_autoremap = false

• void set_command_or_control_autoremap ( bool value )
• bool is_command_or_control_autoremap ( )

Automatically use Meta (Cmd) on macOS and Ctrl on other platforms. If true, ctrl_pressed and meta_pressed cannot be set.

bool ctrl_pressed = false

• void set_ctrl_pressed ( bool value )
• bool is_ctrl_pressed ( )

State of the Ctrl modifier.

bool meta_pressed = false

• void set_meta_pressed ( bool value )
• bool is_meta_pressed ( )

State of the Meta modifier. On Windows and Linux, this represents the Windows key (sometimes called "meta" or "super" on Linux). On macOS, this represents the Command key.

bool shift_pressed = false

• void set_shift_pressed ( bool value )
• bool is_shift_pressed ( )

State of the Shift modifier.

Method Descriptions

BitField<KeyModifierMask> get_modifiers_mask ( ) const

Returns the keycode combination of modifier keys.

bool is_command_or_control_pressed ( ) const

On macOS, returns true if Meta (Cmd) is pressed.

On other platforms, returns true if Ctrl is pressed.