Represents the state of the mouse buttons and modifier keys. More...
Public Types | |
| enum | Flags { shiftModifier = 1, ctrlModifier = 2, altModifier = 4, leftButtonModifier = 16, rightButtonModifier = 32, middleButtonModifier = 64, commandModifier = 8, popupMenuClickModifier = rightButtonModifier | ctrlModifier, allKeyboardModifiers = shiftModifier | ctrlModifier | altModifier | commandModifier, allMouseButtonModifiers = leftButtonModifier | rightButtonModifier | middleButtonModifier } |
Flags that represent the different keys. More... | |
Public Member Functions | |
| ModifierKeys (int flags=0) noexcept | |
| Creates a ModifierKeys object from a raw set of flags. | |
| ModifierKeys (const ModifierKeys &other) noexcept | |
| Creates a copy of another object. | |
| ModifierKeys & | operator= (const ModifierKeys &other) noexcept |
| Copies this object from another one. | |
| bool | isCommandDown () const noexcept |
| Checks whether the 'command' key flag is set (or 'ctrl' on Windows/Linux). | |
| bool | isPopupMenu () const noexcept |
| Checks whether the user is trying to launch a pop-up menu. | |
| bool | isLeftButtonDown () const noexcept |
| Checks whether the flag is set for the left mouse-button. | |
| bool | isRightButtonDown () const noexcept |
| Checks whether the flag is set for the right mouse-button. | |
| bool | isMiddleButtonDown () const noexcept |
| bool | isAnyMouseButtonDown () const noexcept |
| Tests for any of the mouse-button flags. | |
| bool | isAnyModifierKeyDown () const noexcept |
| Tests for any of the modifier key flags. | |
| bool | isShiftDown () const noexcept |
| Checks whether the shift key's flag is set. | |
| bool | isCtrlDown () const noexcept |
| Checks whether the CTRL key's flag is set. | |
| bool | isAltDown () const noexcept |
| Checks whether the shift key's flag is set. | |
| const ModifierKeys | withOnlyMouseButtons () const noexcept |
| Returns a copy of only the mouse-button flags. | |
| const ModifierKeys | withoutMouseButtons () const noexcept |
| Returns a copy of only the non-mouse flags. | |
| bool | operator== (const ModifierKeys &other) const noexcept |
| bool | operator!= (const ModifierKeys &other) const noexcept |
| int | getRawFlags () const noexcept |
| Returns the raw flags for direct testing. | |
| const ModifierKeys | withoutFlags (int rawFlagsToClear) const noexcept |
| const ModifierKeys | withFlags (int rawFlagsToSet) const noexcept |
| bool | testFlags (const int flagsToTest) const noexcept |
| Tests a combination of flags and returns true if any of them are set. | |
| int | getNumMouseButtonsDown () const noexcept |
| Returns the total number of mouse buttons that are down. | |
Static Public Member Functions | |
| static const ModifierKeys | getCurrentModifiers () noexcept |
| Creates a ModifierKeys object to represent the last-known state of the keyboard and mouse buttons. | |
| static const ModifierKeys | getCurrentModifiersRealtime () noexcept |
| Creates a ModifierKeys object to represent the current state of the keyboard and mouse buttons. | |
Represents the state of the mouse buttons and modifier keys.
This is used both by mouse events and by KeyPress objects to describe the state of keys such as shift, control, alt, etc.
| enum ModifierKeys::Flags |
Flags that represent the different keys.
| ModifierKeys::ModifierKeys | ( | int | flags = 0 ) |
Creates a ModifierKeys object from a raw set of flags.
| flags | to represent the keys that are down |
| ModifierKeys::ModifierKeys | ( | const ModifierKeys & | other ) |
Creates a copy of another object.
| ModifierKeys& ModifierKeys::operator= | ( | const ModifierKeys & | other ) |
Copies this object from another one.
| bool ModifierKeys::isCommandDown | ( | ) | const |
Checks whether the 'command' key flag is set (or 'ctrl' on Windows/Linux).
This is a platform-agnostic way of checking for the operating system's preferred command-key modifier - so on the Mac it tests for the Apple key, on Windows/Linux, it's actually checking for the CTRL key.
Referenced by SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers(), LassoComponent< SelectableItemType >::dragLasso(), and TextEditorKeyMapper< CallbackClass >::invokeKeyFunction().
| bool ModifierKeys::isPopupMenu | ( | ) | const |
Checks whether the user is trying to launch a pop-up menu.
This checks for platform-specific modifiers that might indicate that the user is following the operating system's normal method of showing a pop-up menu.
So on Windows/Linux, this method is really testing for a right-click. On the Mac, it tests for either the CTRL key being down, or a right-click.
Referenced by SelectedItemSet< SelectableItemType >::addToSelectionOnMouseDown().
| bool ModifierKeys::isLeftButtonDown | ( | ) | const |
Checks whether the flag is set for the left mouse-button.
| bool ModifierKeys::isRightButtonDown | ( | ) | const |
Checks whether the flag is set for the right mouse-button.
Note that for detecting popup-menu clicks, you should be using isPopupMenu() instead, as this is platform-independent (and makes your code more explanatory too).
| bool ModifierKeys::isMiddleButtonDown | ( | ) | const |
| bool ModifierKeys::isAnyMouseButtonDown | ( | ) | const |
Tests for any of the mouse-button flags.
| bool ModifierKeys::isAnyModifierKeyDown | ( | ) | const |
Tests for any of the modifier key flags.
| bool ModifierKeys::isShiftDown | ( | ) | const |
Checks whether the shift key's flag is set.
Referenced by SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers(), LassoComponent< SelectableItemType >::dragLasso(), and TextEditorKeyMapper< CallbackClass >::invokeKeyFunction().
| bool ModifierKeys::isCtrlDown | ( | ) | const |
Checks whether the CTRL key's flag is set.
Remember that it's better to use the platform-agnostic routines to test for command-key and popup-menu modifiers.
Referenced by TextEditorKeyMapper< CallbackClass >::invokeKeyFunction().
| bool ModifierKeys::isAltDown | ( | ) | const |
Checks whether the shift key's flag is set.
Referenced by LassoComponent< SelectableItemType >::dragLasso(), and TextEditorKeyMapper< CallbackClass >::invokeKeyFunction().
| const ModifierKeys ModifierKeys::withOnlyMouseButtons | ( | ) | const |
Returns a copy of only the mouse-button flags.
| const ModifierKeys ModifierKeys::withoutMouseButtons | ( | ) | const |
Returns a copy of only the non-mouse flags.
| bool ModifierKeys::operator== | ( | const ModifierKeys & | other ) | const |
| bool ModifierKeys::operator!= | ( | const ModifierKeys & | other ) | const |
| int ModifierKeys::getRawFlags | ( | ) | const |
Returns the raw flags for direct testing.
| const ModifierKeys ModifierKeys::withoutFlags | ( | int | rawFlagsToClear ) | const |
| const ModifierKeys ModifierKeys::withFlags | ( | int | rawFlagsToSet ) | const |
| bool ModifierKeys::testFlags | ( | const int | flagsToTest ) | const |
Tests a combination of flags and returns true if any of them are set.
| int ModifierKeys::getNumMouseButtonsDown | ( | ) | const |
Returns the total number of mouse buttons that are down.
| static const ModifierKeys ModifierKeys::getCurrentModifiers | ( | ) | [static] |
Creates a ModifierKeys object to represent the last-known state of the keyboard and mouse buttons.
| static const ModifierKeys ModifierKeys::getCurrentModifiersRealtime | ( | ) | [static] |
Creates a ModifierKeys object to represent the current state of the keyboard and mouse buttons.
This isn't often needed and isn't recommended, but will actively check all the mouse and key states rather than just returning their last-known state like getCurrentModifiers() does.
This is only needed in special circumstances for up-to-date modifier information at times when the app's event loop isn't running normally.
Another reason to avoid this method is that it's not stateless, and calling it may update the value returned by getCurrentModifiers(), which could cause subtle changes in the behaviour of some components.
