KeyModifiers

Scaleform::KeyModifiers

Declaration

class KeyModifiers;

Description

KeyModifiers describes the state of modifier keys (such as Shift,Ctrl, Caps lock) when used in keyboard handling.

Data Members

Data Member	Description
States	The state of the modifier keys.

Methods

Method	Description
IsAltPressed	Determines whether the (Alt) key is pressed or not.
IsCapsToggled	Determines whether the Caps Lock key is turned on or off.
IsCtrlPressed	Determines whether the (Ctrl) key is pressed or not.
IsExtendedKey	Determines whether the right shift, alt or ctrl key is pressed.
IsInitialized	Initializes the state of the modifier keys.
IsNumToggled	Determines whether the Num Lock key is turned on or off.
IsScrollToggled	Determines whether the Scroll Lock key is turned on or off.
IsShiftPressed	Determines whether the (Shift) key is pressed or not.
IsSpecialKeyPressed	Determines if the special key is pressed.
KeyModifiers	KeyModifiers constructor.
Reset	Resets the state of the modifier keys as zero.
SetAltPressed	Sets the state of the Alt key (pressed/unpressed).
SetCapsToggled	Sets the state of Caps lock key.
SetCtrlPressed	Sets the state of Ctrl key (pressed/unpressed).
SetExtendedKey	Sets the state of the Extended key (pressed/unpressed).
SetNumToggled	Sets the state of Num Lock key.
SetScrollToggled	Sets the state of Scroll key.
SetShiftPressed	Sets the state of Shift key (pressed/unpressed).

File

SF_KeyCodes.h