Represents the state of the mouse buttons and modifier keys. More...

#include <juce_ModifierKeys.h>

Collaboration diagram for ModifierKeys:

Public Types
enum	Flags { noModifiers = 0, 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, ctrlAltCommandModifiers = ctrlModifier \| altModifier \| commandModifier }
	Flags that represent the different keys. More...

Public Member Functions
	ModifierKeys () noexcept
	Creates a ModifierKeys object with no flags set. More...

	ModifierKeys (int flags) noexcept
	Creates a ModifierKeys object from a raw set of flags. More...

	ModifierKeys (const ModifierKeys &other) noexcept
	Creates a copy of another object. More...

int	getNumMouseButtonsDown () const noexcept
	Returns the total number of mouse buttons that are down. More...

int	getRawFlags () const noexcept
	Returns the raw flags for direct testing. More...

bool	isAltDown () const noexcept
	Checks whether the ALT key's flag is set. More...

bool	isAnyModifierKeyDown () const noexcept
	Tests for any of the modifier key flags. More...

bool	isAnyMouseButtonDown () const noexcept
	Tests for any of the mouse-button flags. More...

bool	isCommandDown () const noexcept
	Checks whether the 'command' key flag is set (or 'ctrl' on Windows/Linux). More...

bool	isCtrlDown () const noexcept
	Checks whether the CTRL key's flag is set. More...

bool	isLeftButtonDown () const noexcept
	Checks whether the flag is set for the left mouse-button. More...

bool	isMiddleButtonDown () const noexcept

bool	isPopupMenu () const noexcept
	Checks whether the user is trying to launch a pop-up menu. More...

bool	isRightButtonDown () const noexcept
	Checks whether the flag is set for the right mouse-button. More...

bool	isShiftDown () const noexcept
	Checks whether the shift key's flag is set. More...

bool	operator!= (const ModifierKeys other) const noexcept

ModifierKeys &	operator= (const ModifierKeys other) noexcept
	Copies this object from another one. More...

bool	operator== (const ModifierKeys other) const noexcept

bool	testFlags (int flagsToTest) const noexcept
	Tests a combination of flags and returns true if any of them are set. More...

ModifierKeys	withFlags (int rawFlagsToSet) const noexcept

ModifierKeys	withOnlyMouseButtons () const noexcept
	Returns a copy of only the mouse-button flags. More...

ModifierKeys	withoutFlags (int rawFlagsToClear) const noexcept

ModifierKeys	withoutMouseButtons () const noexcept
	Returns a copy of only the non-mouse flags. More...

Static Public Member Functions
static ModifierKeys	getCurrentModifiers () noexcept
	Creates a ModifierKeys object to represent the last-known state of the keyboard and mouse buttons. More...

static ModifierKeys	getCurrentModifiersRealtime () noexcept
	Creates a ModifierKeys object to represent the current state of the keyboard and mouse buttons. More...

Static Private Member Functions
static void	updateCurrentModifiers () noexcept

Private Attributes
int	flags

Static Private Attributes
static ModifierKeys	currentModifiers

Friends
class	ComponentPeer

class	MouseInputSource

class	MouseInputSourceInternal

Detailed Description

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.

See also: KeyPress, MouseEvent::mods

Member Enumeration Documentation

◆ Flags

enum ModifierKeys::Flags

Flags that represent the different keys.

Enumerator
noModifiers	Indicates no modifier keys.
shiftModifier	Shift key flag.
ctrlModifier	CTRL key flag.
altModifier	ALT key flag.
leftButtonModifier	Left mouse button flag.
rightButtonModifier	Right mouse button flag.
middleButtonModifier	Middle mouse button flag.
commandModifier	Command key flag - on windows this is the same as the CTRL key flag.
popupMenuClickModifier	Popup menu flag - on windows this is the same as rightButtonModifier, on the Mac it's the same as (rightButtonModifier \| ctrlModifier).
allKeyboardModifiers	Represents a combination of all the shift, alt, ctrl and command key modifiers.
allMouseButtonModifiers	Represents a combination of all the mouse buttons at once.
ctrlAltCommandModifiers	Represents a combination of all the alt, ctrl and command key modifiers.

Constructor & Destructor Documentation

◆ ModifierKeys() [1/3]

ModifierKeys::ModifierKeys ( )

noexcept

Creates a ModifierKeys object with no flags set.

◆ ModifierKeys() [2/3]

ModifierKeys::ModifierKeys ( int flags )

noexcept

Creates a ModifierKeys object from a raw set of flags.

Parameters

flags to represent the keys that are down

See also: shiftModifier, ctrlModifier, altModifier, leftButtonModifier, rightButtonModifier, commandModifier, popupMenuClickModifier

◆ ModifierKeys() [3/3]

ModifierKeys::ModifierKeys ( const ModifierKeys & other )

noexcept

Creates a copy of another object.

Member Function Documentation

◆ getCurrentModifiers()

static ModifierKeys ModifierKeys::getCurrentModifiers ( )

staticnoexcept

Creates a ModifierKeys object to represent the last-known state of the keyboard and mouse buttons.

See also: getCurrentModifiersRealtime

Referenced by FakeMouseMoveGenerator::timerCallback().

◆ getCurrentModifiersRealtime()

static ModifierKeys ModifierKeys::getCurrentModifiersRealtime ( )

staticnoexcept

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.

◆ getNumMouseButtonsDown()

int ModifierKeys::getNumMouseButtonsDown ( ) const

noexcept

Returns the total number of mouse buttons that are down.

◆ getRawFlags()

int ModifierKeys::getRawFlags ( ) const

inlinenoexcept

Returns the raw flags for direct testing.

◆ isAltDown()

bool ModifierKeys::isAltDown ( ) const

inlinenoexcept

Checks whether the ALT key's flag is set.

Referenced by LassoComponent< SelectableItemType >::dragLasso(), and TextEditorKeyMapper< CallbackClass >::invokeKeyFunction().

◆ isAnyModifierKeyDown()

bool ModifierKeys::isAnyModifierKeyDown ( ) const

inlinenoexcept

Tests for any of the modifier key flags.

◆ isAnyMouseButtonDown()

bool ModifierKeys::isAnyMouseButtonDown ( ) const

inlinenoexcept

Tests for any of the mouse-button flags.

Referenced by FakeMouseMoveGenerator::timerCallback().

◆ isCommandDown()

bool ModifierKeys::isCommandDown ( ) const

inlinenoexcept

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().

◆ isCtrlDown()

bool ModifierKeys::isCtrlDown ( ) const

inlinenoexcept

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.

See also: isCommandDown, isPopupMenu

Referenced by TextEditorKeyMapper< CallbackClass >::invokeKeyFunction().

◆ isLeftButtonDown()

bool ModifierKeys::isLeftButtonDown ( ) const

inlinenoexcept

Checks whether the flag is set for the left mouse-button.

◆ isMiddleButtonDown()

bool ModifierKeys::isMiddleButtonDown ( ) const

inlinenoexcept

◆ isPopupMenu()

bool ModifierKeys::isPopupMenu ( ) const

inlinenoexcept

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().

◆ isRightButtonDown()

bool ModifierKeys::isRightButtonDown ( ) const

inlinenoexcept

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).

◆ isShiftDown()

bool ModifierKeys::isShiftDown ( ) const

inlinenoexcept

Checks whether the shift key's flag is set.

Referenced by SelectedItemSet< SelectableItemType >::addToSelectionBasedOnModifiers(), LassoComponent< SelectableItemType >::dragLasso(), and TextEditorKeyMapper< CallbackClass >::invokeKeyFunction().

◆ operator!=()

bool ModifierKeys::operator!= ( const ModifierKeys other ) const

inlinenoexcept

References flags.

◆ operator=()

ModifierKeys& ModifierKeys::operator= ( const ModifierKeys other )

noexcept

Copies this object from another one.

◆ operator==()

bool ModifierKeys::operator== ( const ModifierKeys other ) const

inlinenoexcept

References flags.

◆ testFlags()

bool ModifierKeys::testFlags ( int flagsToTest ) const

inlinenoexcept

Tests a combination of flags and returns true if any of them are set.

◆ updateCurrentModifiers()

static void ModifierKeys::updateCurrentModifiers ( )

staticprivatenoexcept

◆ withFlags()

ModifierKeys ModifierKeys::withFlags ( int rawFlagsToSet ) const

inlinenoexcept

◆ withOnlyMouseButtons()

ModifierKeys ModifierKeys::withOnlyMouseButtons ( ) const

inlinenoexcept

Returns a copy of only the mouse-button flags.

◆ withoutFlags()

ModifierKeys ModifierKeys::withoutFlags ( int rawFlagsToClear ) const

inlinenoexcept

◆ withoutMouseButtons()

ModifierKeys ModifierKeys::withoutMouseButtons ( ) const

inlinenoexcept

Returns a copy of only the non-mouse flags.

Friends And Related Function Documentation

◆ ComponentPeer

friend class ComponentPeer

friend

◆ MouseInputSource

friend class MouseInputSource

friend

◆ MouseInputSourceInternal

friend class MouseInputSourceInternal

friend

Member Data Documentation

◆ currentModifiers

ModifierKeys ModifierKeys::currentModifiers

staticprivate

◆ flags

int ModifierKeys::flags

private

Referenced by operator!=(), and operator==().

The documentation for this class was generated from the following file:

juce_ModifierKeys.h

Public Types

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ ModifierKeys() [1/3]

◆ ModifierKeys() [2/3]

◆ ModifierKeys() [3/3]

Member Function Documentation

◆ getCurrentModifiers()

◆ getCurrentModifiersRealtime()

◆ getNumMouseButtonsDown()

◆ getRawFlags()

◆ isAltDown()

◆ isAnyModifierKeyDown()

◆ isAnyMouseButtonDown()

◆ isCommandDown()

◆ isCtrlDown()

◆ isLeftButtonDown()

◆ isMiddleButtonDown()

◆ isPopupMenu()

◆ isRightButtonDown()

◆ isShiftDown()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ testFlags()

◆ updateCurrentModifiers()

◆ withFlags()

◆ withOnlyMouseButtons()

◆ withoutFlags()

◆ withoutMouseButtons()

Friends And Related Function Documentation

◆ ComponentPeer

◆ MouseInputSource

◆ MouseInputSourceInternal

Member Data Documentation

◆ currentModifiers

◆ flags