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

#include "juce_ModifierKeys.h"

Public Types
enum	Flags { noModifiers , shiftModifier , ctrlModifier , altModifier , leftButtonModifier , rightButtonModifier , middleButtonModifier , commandModifier , popupMenuClickModifier , allKeyboardModifiers , allMouseButtonModifiers , ctrlAltCommandModifiers }
	Flags that represent the different keys. More...

Public Member Functions
	ModifierKeys ()=default
	Creates a ModifierKeys object with no flags set.

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

	ModifierKeys (const ModifierKeys &)=default
	Creates a copy of another object.

ModifierKeys &	operator= (const ModifierKeys &)=default
	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 ALT key's flag is set.

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

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.

ModifierKeys	withoutFlags (int rawFlagsToClear) const noexcept

ModifierKeys	withFlags (int rawFlagsToSet) const noexcept

bool	testFlags (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 ModifierKeys	getCurrentModifiers () noexcept
	Creates a ModifierKeys object to represent the last-known state of the keyboard and mouse buttons.

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

Static Public Attributes
static ModifierKeys	currentModifiers
	This object represents the last-known state of the keyboard and mouse buttons.

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

@tags{GUI}

Definition at line 40 of file juce_ModifierKeys.h.

Member Enumeration Documentation

◆ Flags

enum juce::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.

Definition at line 115 of file juce_ModifierKeys.h.

Constructor & Destructor Documentation

◆ ModifierKeys()

juce::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

Definition at line 31 of file juce_ModifierKeys.cpp.

Member Function Documentation

◆ getCurrentModifiers()

static ModifierKeys juce::ModifierKeys::getCurrentModifiers ( )

staticnoexcept

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

This method is here for backwards compatibility and there's no need to call it anymore, you should use the public currentModifiers member directly.

Definition at line 197 of file juce_ModifierKeys.h.

◆ getCurrentModifiersRealtime()

ModifierKeys juce::ModifierKeys::getCurrentModifiersRealtime ( )

staticnoexcept

Creates a ModifierKeys object to represent the current state of the keyboard and mouse buttons.

This method is here for backwards compatibility and you should call ComponentPeer::getCurrentModifiersRealtime() instead (which is what this method now does).

Definition at line 44 of file juce_ModifierKeys.cpp.

◆ getNumMouseButtonsDown()

int juce::ModifierKeys::getNumMouseButtonsDown ( ) const

noexcept

Returns the total number of mouse buttons that are down.

Definition at line 33 of file juce_ModifierKeys.cpp.

◆ getRawFlags()

int juce::ModifierKeys::getRawFlags ( ) const

noexcept

Returns the raw flags for direct testing.

Definition at line 176 of file juce_ModifierKeys.h.

◆ isAltDown()

bool juce::ModifierKeys::isAltDown ( ) const

noexcept

Checks whether the ALT key's flag is set.

Definition at line 111 of file juce_ModifierKeys.h.

◆ isAnyModifierKeyDown()

bool juce::ModifierKeys::isAnyModifierKeyDown ( ) const

noexcept

Tests for any of the modifier key flags.

Definition at line 96 of file juce_ModifierKeys.h.

◆ isAnyMouseButtonDown()

bool juce::ModifierKeys::isAnyMouseButtonDown ( ) const

noexcept

Tests for any of the mouse-button flags.

Definition at line 93 of file juce_ModifierKeys.h.

◆ isCommandDown()

bool juce::ModifierKeys::isCommandDown ( ) const

noexcept

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 cmd key, on Windows/Linux, it's actually checking for the CTRL key.

Definition at line 68 of file juce_ModifierKeys.h.

◆ isCtrlDown()

bool juce::ModifierKeys::isCtrlDown ( ) const

noexcept

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

Definition at line 108 of file juce_ModifierKeys.h.

◆ isLeftButtonDown()

bool juce::ModifierKeys::isLeftButtonDown ( ) const

noexcept

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

Definition at line 81 of file juce_ModifierKeys.h.

◆ isMiddleButtonDown()

bool juce::ModifierKeys::isMiddleButtonDown ( ) const

noexcept

Definition at line 90 of file juce_ModifierKeys.h.

◆ isPopupMenu()

bool juce::ModifierKeys::isPopupMenu ( ) const

noexcept

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.

Definition at line 78 of file juce_ModifierKeys.h.

◆ isRightButtonDown()

bool juce::ModifierKeys::isRightButtonDown ( ) const

noexcept

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

Definition at line 88 of file juce_ModifierKeys.h.

◆ isShiftDown()

bool juce::ModifierKeys::isShiftDown ( ) const

noexcept

Checks whether the shift key's flag is set.

Definition at line 99 of file juce_ModifierKeys.h.

◆ operator!=()

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

noexcept

Definition at line 172 of file juce_ModifierKeys.h.

◆ operator==()

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

noexcept

Definition at line 171 of file juce_ModifierKeys.h.

◆ testFlags()

bool juce::ModifierKeys::testFlags ( int flagsToTest ) const

noexcept

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

Definition at line 182 of file juce_ModifierKeys.h.

◆ withFlags()

ModifierKeys juce::ModifierKeys::withFlags ( int rawFlagsToSet ) const

noexcept

Definition at line 179 of file juce_ModifierKeys.h.

◆ withOnlyMouseButtons()

ModifierKeys juce::ModifierKeys::withOnlyMouseButtons ( ) const

noexcept

Returns a copy of only the mouse-button flags.

Definition at line 166 of file juce_ModifierKeys.h.

◆ withoutFlags()

ModifierKeys juce::ModifierKeys::withoutFlags ( int rawFlagsToClear ) const

noexcept

Definition at line 178 of file juce_ModifierKeys.h.

◆ withoutMouseButtons()

ModifierKeys juce::ModifierKeys::withoutMouseButtons ( ) const

noexcept

Returns a copy of only the non-mouse flags.

Definition at line 169 of file juce_ModifierKeys.h.

Member Data Documentation

◆ currentModifiers

ModifierKeys juce::ModifierKeys::currentModifiers

static

This object represents the last-known state of the keyboard and mouse buttons.

Definition at line 189 of file juce_ModifierKeys.h.

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

juce_gui_basics/keyboard/juce_ModifierKeys.h
juce_gui_basics/keyboard/juce_ModifierKeys.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ ModifierKeys()

Member Function Documentation

◆ getCurrentModifiers()

◆ getCurrentModifiersRealtime()

◆ getNumMouseButtonsDown()

◆ getRawFlags()

◆ isAltDown()

◆ isAnyModifierKeyDown()

◆ isAnyMouseButtonDown()

◆ isCommandDown()

◆ isCtrlDown()

◆ isLeftButtonDown()

◆ isMiddleButtonDown()

◆ isPopupMenu()

◆ isRightButtonDown()

◆ isShiftDown()

◆ operator!=()

◆ operator==()

◆ testFlags()

◆ withFlags()

◆ withOnlyMouseButtons()

◆ withoutFlags()

◆ withoutMouseButtons()

Member Data Documentation

◆ currentModifiers