juce_AccessibilityState.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  AccessibleState
{
public:
    AccessibleState() = default;
 
    //==============================================================================
    JUCE_NODISCARD AccessibleState withCheckable() const noexcept            { return withFlag (Flags::checkable); }

    JUCE_NODISCARD AccessibleState withChecked() const noexcept              { return withFlag (Flags::checked); }

    JUCE_NODISCARD AccessibleState withCollapsed() const noexcept            { return withFlag (Flags::collapsed); }

    JUCE_NODISCARD AccessibleState withExpandable() const noexcept           { return withFlag (Flags::expandable); }

    JUCE_NODISCARD AccessibleState withExpanded() const noexcept             { return withFlag (Flags::expanded); }

    JUCE_NODISCARD AccessibleState withFocusable() const noexcept            { return withFlag (Flags::focusable); }

    JUCE_NODISCARD AccessibleState withFocused() const noexcept              { return withFlag (Flags::focused); }

    JUCE_NODISCARD AccessibleState withIgnored() const noexcept              { return withFlag (Flags::ignored); }

    JUCE_NODISCARD AccessibleState withSelectable() const noexcept           { return withFlag (Flags::selectable); }

    JUCE_NODISCARD AccessibleState withMultiSelectable() const noexcept      { return withFlag (Flags::multiSelectable); }

    JUCE_NODISCARD AccessibleState withSelected() const noexcept             { return withFlag (Flags::selected); }

    JUCE_NODISCARD AccessibleState withAccessibleOffscreen() const noexcept  { return withFlag (Flags::accessibleOffscreen); }
 
    //==============================================================================
    bool isCheckable() const noexcept            { return isFlagSet (Flags::checkable); }

    bool isChecked() const noexcept              { return isFlagSet (Flags::checked); }

    bool isCollapsed() const noexcept            { return isFlagSet (Flags::collapsed); }

    bool isExpandable() const noexcept           { return isFlagSet (Flags::expandable); }

    bool isExpanded() const noexcept             { return isFlagSet (Flags::expanded); }

    bool isFocusable() const noexcept            { return isFlagSet (Flags::focusable); }

    bool isFocused() const noexcept              { return isFlagSet (Flags::focused); }

    bool isIgnored() const noexcept              { return isFlagSet (Flags::ignored); }

    bool isMultiSelectable() const noexcept      { return isFlagSet (Flags::multiSelectable); }

    bool isSelectable() const noexcept           { return isFlagSet (Flags::selectable); }

    bool isSelected() const noexcept             { return isFlagSet (Flags::selected); }

    bool isAccessibleOffscreen() const noexcept  { return isFlagSet (Flags::accessibleOffscreen); }
 
private:
    enum Flags
    {
        checkable           = (1 << 0),
        checked             = (1 << 1),
        collapsed           = (1 << 2),
        expandable          = (1 << 3),
        expanded            = (1 << 4),
        focusable           = (1 << 5),
        focused             = (1 << 6),
        ignored             = (1 << 7),
        multiSelectable     = (1 << 8),
        selectable          = (1 << 9),
        selected            = (1 << 10),
        accessibleOffscreen = (1 << 11)
    };
 
    JUCE_NODISCARD AccessibleState withFlag (int flag) const noexcept
    {
        auto copy = *this;
        copy.flags |= flag;
 
        return copy;
    }
 
    bool isFlagSet (int flag) const noexcept
    {
        return (flags & flag) != 0;
    }
 
    int flags = 0;
};
 
} // namespace juce