An abstract interface which represents a UI element that supports a text interface. More...
#include <juce_AccessibilityTextInterface.h>
Public Member Functions | |
virtual | ~AccessibilityTextInterface ()=default |
Destructor. More... | |
virtual int | getOffsetAtPoint (Point< int > point) const =0 |
Returns the index of the character at a given position in screen coordinates. More... | |
virtual Range< int > | getSelection () const =0 |
Returns the range of characters that are currently selected, or an empty range if nothing is selected. More... | |
virtual String | getText (Range< int > range) const =0 |
Returns a section of text. More... | |
virtual RectangleList< int > | getTextBounds (Range< int > textRange) const =0 |
Returns the bounding box in screen coordinates for a range of text. More... | |
virtual int | getTextInsertionOffset () const =0 |
Gets the current text insertion position, if supported. More... | |
virtual int | getTotalNumCharacters () const =0 |
Returns the total number of characters in the text element. More... | |
virtual bool | isDisplayingProtectedText () const =0 |
Returns true if the text being displayed is protected and should not be exposed to the user, for example a password entry field. More... | |
virtual bool | isReadOnly () const =0 |
Returns true if the text being displayed is read-only or false if editable. More... | |
virtual void | setSelection (Range< int > newRange)=0 |
Selects a section of the text. More... | |
virtual void | setText (const String &newText)=0 |
Replaces the text with a new string. More... | |
An abstract interface which represents a UI element that supports a text interface.
A UI element can use this interface to provide extended textual information which cannot be conveyed using just the title, description, and help text properties of AccessibilityHandler. This is typically for text that an accessibility client might want to read line-by-line, or provide text selection and input for.
@tags{Accessibility}
|
virtualdefault |
Destructor.
|
pure virtual |
Returns the index of the character at a given position in screen coordinates.
Referenced by juce::UIATextProvider::RangeFromPoint().
Returns the range of characters that are currently selected, or an empty range if nothing is selected.
Referenced by juce::UIATextProvider::GetSelection().
Returns a section of text.
Referenced by juce::UIATextProvider::UIATextRangeProvider::FindText(), juce::AccessibilityTextHelpers::findTextBoundary(), and juce::UIATextProvider::UIATextRangeProvider::GetText().
|
pure virtual |
Returns the bounding box in screen coordinates for a range of text.
As the range may span multiple lines, this method returns a RectangleList.
Referenced by juce::UIATextProvider::UIATextRangeProvider::GetBoundingRectangles().
|
pure virtual |
Gets the current text insertion position, if supported.
Referenced by juce::UIATextProvider::UIATextRangeProvider::GetAttributeValue(), juce::UIATextProvider::GetCaretRange(), and juce::UIATextProvider::GetSelection().
|
pure virtual |
Returns the total number of characters in the text element.
Referenced by juce::AccessibilityTextHelpers::findTextBoundary(), juce::UIATextProvider::get_DocumentRange(), juce::UIATextProvider::UIATextRangeProvider::GetAttributeValue(), juce::UIATextProvider::GetVisibleRanges(), and juce::UIATextProvider::UIATextRangeProvider::MoveEndpointByUnit().
|
pure virtual |
Returns true if the text being displayed is protected and should not be exposed to the user, for example a password entry field.
|
pure virtual |
Returns true if the text being displayed is read-only or false if editable.
Referenced by juce::UIATextProvider::UIATextRangeProvider::GetAttributeValue().
Selects a section of the text.
|
pure virtual |
Replaces the text with a new string.