juce::AccessibilityTextInterface Class Reference

#include <juce_AccessibilityTextInterface.h>

Inheritance diagram for juce::AccessibilityTextInterface:

Public Member Functions
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
virtual void	setText (const String &newText)=0
virtual RectangleList< int >	getTextBounds (Range< int > textRange) const =0
virtual int	getOffsetAtPoint (Point< int > point) const =0

Detailed Description

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}

Constructor & Destructor Documentation

~AccessibilityTextInterface()

virtual juce::AccessibilityTextInterface::~AccessibilityTextInterface ( )

virtualdefault

Destructor.

Member Function Documentation

getAllText()

String juce::AccessibilityTextInterface::getAllText ( ) const

inline

Returns the full text.

getOffsetAtPoint()

virtual int juce::AccessibilityTextInterface::getOffsetAtPoint ( Point< int > point ) const

pure virtual

Returns the index of the character at a given position in screen coordinates.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

getSelection()

virtual Range< int > juce::AccessibilityTextInterface::getSelection ( ) const

pure virtual

Returns the range of characters that are currently selected, or an empty range if nothing is selected.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

getText()

virtual String juce::AccessibilityTextInterface::getText ( Range< int > range ) const

pure virtual

Returns a section of text.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

getTextBounds()

virtual RectangleList< int > juce::AccessibilityTextInterface::getTextBounds ( Range< int > textRange ) const

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.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

getTextInsertionOffset()

virtual int juce::AccessibilityTextInterface::getTextInsertionOffset ( ) const

pure virtual

Gets the current text insertion position, if supported.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

getTotalNumCharacters()

virtual int juce::AccessibilityTextInterface::getTotalNumCharacters ( ) const

pure virtual

Returns the total number of characters in the text element.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

isDisplayingProtectedText()

virtual bool juce::AccessibilityTextInterface::isDisplayingProtectedText ( ) const

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.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

isReadOnly()

virtual bool juce::AccessibilityTextInterface::isReadOnly ( ) const

pure virtual

Returns true if the text being displayed is read-only or false if editable.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

setSelection()

virtual void juce::AccessibilityTextInterface::setSelection ( Range< int > newRange )

pure virtual

Selects a section of the text.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

setText()

virtual void juce::AccessibilityTextInterface::setText ( const String & newText )

pure virtual

Replaces the text with a new string.

Implemented in juce::CodeEditorComponent::CodeEditorAccessibilityHandler::CodeEditorComponentTextInterface, and juce::TextEditor::EditorAccessibilityHandler::TextEditorTextInterface.

---

The documentation for this class was generated from the following file:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/accessibility/interfaces/juce_AccessibilityTextInterface.h