juce_AccessibilityTextInterface.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  AccessibilityTextInterface
{
public:
    virtual ~AccessibilityTextInterface() = default;

    virtual bool isDisplayingProtectedText() const = 0;

    virtual bool isReadOnly() const = 0;

    virtual int getTotalNumCharacters() const = 0;

    virtual Range<int> getSelection() const = 0;

    virtual void setSelection (Range<int> newRange) = 0;

    virtual int getTextInsertionOffset() const = 0;

    virtual String getText (Range<int> range) const = 0;

    String getAllText() const { return getText ({ 0, getTotalNumCharacters() }); }

    virtual void setText (const String& newText) = 0;

    virtual RectangleList<int> getTextBounds (Range<int> textRange) const = 0;

    virtual int getOffsetAtPoint (Point<int> point) const = 0;
};
 
} // namespace juce