juce_ModifierKeys.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  ModifierKeys
{
public:
    //==============================================================================
    ModifierKeys() = default;

    ModifierKeys (int flags) noexcept;

    ModifierKeys (const ModifierKeys&) = default;

    ModifierKeys& operator= (const ModifierKeys&) = default;
 
    //==============================================================================
    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 || JUCE_IOS
        commandModifier                         = 8,

        popupMenuClickModifier                  = rightButtonModifier | ctrlModifier,
       #else
        commandModifier                         = ctrlModifier,

        popupMenuClickModifier                  = rightButtonModifier,
       #endif

        allKeyboardModifiers                    = shiftModifier | ctrlModifier | altModifier | commandModifier,

        allMouseButtonModifiers                 = leftButtonModifier | rightButtonModifier | middleButtonModifier,

        ctrlAltCommandModifiers                 = ctrlModifier | altModifier | commandModifier
    };
 
    //==============================================================================
    JUCE_NODISCARD ModifierKeys withOnlyMouseButtons() const noexcept                  { return ModifierKeys (flags & allMouseButtonModifiers); }

    JUCE_NODISCARD 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; }
 
    JUCE_NODISCARD ModifierKeys withoutFlags (int rawFlagsToClear) const noexcept      { return ModifierKeys (flags & ~rawFlagsToClear); }
    JUCE_NODISCARD 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 currentModifiers;

    static ModifierKeys getCurrentModifiers() noexcept                                 { return currentModifiers; }

    static ModifierKeys getCurrentModifiersRealtime() noexcept;
 
private:
    int flags = 0;
};
 
} // namespace juce