juce_ModifierKeys.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
   WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_MODIFIERKEYS_H_INCLUDED
#define JUCE_MODIFIERKEYS_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  ModifierKeys
{
public:
    //==============================================================================
    ModifierKeys() noexcept;
 
    ModifierKeys (int flags) noexcept;
 
    ModifierKeys (const ModifierKeys& other) noexcept;
 
    ModifierKeys& operator= (const ModifierKeys other) noexcept;
 
    //==============================================================================
    inline bool isCommandDown() const noexcept          { return testFlags (commandModifier); }
 
    inline bool isPopupMenu() const noexcept            { return testFlags (popupMenuClickModifier); }
 
    inline bool isLeftButtonDown() const noexcept       { return testFlags (leftButtonModifier); }
 
    inline bool isRightButtonDown() const noexcept      { return testFlags (rightButtonModifier); }
 
    inline bool isMiddleButtonDown() const noexcept     { return testFlags (middleButtonModifier); }
 
    inline bool isAnyMouseButtonDown() const noexcept   { return testFlags (allMouseButtonModifiers); }
 
    inline bool isAnyModifierKeyDown() const noexcept   { return testFlags ((shiftModifier | ctrlModifier | altModifier | commandModifier)); }
 
    inline bool isShiftDown() const noexcept            { return testFlags (shiftModifier); }
 
    inline bool isCtrlDown() const noexcept             { return testFlags (ctrlModifier); }
 
    inline bool isAltDown() const noexcept              { return testFlags (altModifier); }
 
    //==============================================================================
    enum Flags
    {
        noModifiers                             = 0,
 
        shiftModifier                           = 1,
 
        ctrlModifier                            = 2,
 
        altModifier                             = 4,
 
        leftButtonModifier                      = 16,
 
        rightButtonModifier                     = 32,
 
        middleButtonModifier                    = 64,
 
       #if JUCE_MAC
 
        commandModifier                         = 8,
 
        popupMenuClickModifier                  = rightButtonModifier | ctrlModifier,
       #else
 
        commandModifier                         = ctrlModifier,
 
        popupMenuClickModifier                  = rightButtonModifier,
       #endif
 
        allKeyboardModifiers                    = shiftModifier | ctrlModifier | altModifier | commandModifier,
 
        allMouseButtonModifiers                 = leftButtonModifier | rightButtonModifier | middleButtonModifier,
 
        ctrlAltCommandModifiers                 = ctrlModifier | altModifier | commandModifier
    };
 
    //==============================================================================
    ModifierKeys withOnlyMouseButtons() const noexcept                  { return ModifierKeys (flags & allMouseButtonModifiers); }
 
    ModifierKeys withoutMouseButtons() const noexcept                   { return ModifierKeys (flags & ~allMouseButtonModifiers); }
 
    bool operator== (const ModifierKeys other) const noexcept           { return flags == other.flags; }
    bool operator!= (const ModifierKeys other) const noexcept           { return flags != other.flags; }
 
    //==============================================================================
    inline int getRawFlags() const noexcept                             { return flags; }
 
    ModifierKeys withoutFlags (int rawFlagsToClear) const noexcept      { return ModifierKeys (flags & ~rawFlagsToClear); }
    ModifierKeys withFlags (int rawFlagsToSet) const noexcept           { return ModifierKeys (flags | rawFlagsToSet); }
 
    bool testFlags (int flagsToTest) const noexcept                     { return (flags & flagsToTest) != 0; }
 
    int getNumMouseButtonsDown() const noexcept;
 
    //==============================================================================
    static ModifierKeys getCurrentModifiers() noexcept;
 
    static ModifierKeys getCurrentModifiersRealtime() noexcept;
 
 
private:
    //==============================================================================
    int flags;
 
    friend class ComponentPeer;
    friend class MouseInputSource;
    friend class MouseInputSourceInternal;
 
    static ModifierKeys currentModifiers;
    static void updateCurrentModifiers() noexcept;
};
 
 
#endif   // JUCE_MODIFIERKEYS_H_INCLUDED