LibreOffice
LibreOffice 6.4 SDK API Reference
Exported Interfaces | List of all members
AccessibleParagraphView Service Reference

The accessible view of a paragraph fragment. More...

import"AccessibleParagraphView.idl";

Inheritance diagram for AccessibleParagraphView:
XAccessibleContext XAccessibleComponent XAccessibleEditableText XAccessibleText XAccessibleSelection XAccessibleEventBroadcaster XAccessibleTextAttributes XInterface XInterface XAccessibleText XInterface XInterface XInterface XInterface

Exported Interfaces

interface ::com::sun::star::accessibility::XAccessibleContext
 This interface gives access to a paragraph fragment that is at least partially visible on the screen. More...
 
interface ::com::sun::star::accessibility::XAccessibleComponent
 This interface describes the graphical representation of a paragraph fragment. More...
 
interface ::com::sun::star::accessibility::XAccessibleEditableText
 This interface gives access to a paragraph fragment's text. More...
 
interface ::com::sun::star::accessibility::XAccessibleText
 This interface is a subset of com::sun::star::accessibility::XAccessibleEditableText and gives access to a paragraph fragment's text in a read-only mode. More...
 
interface ::com::sun::star::accessibility::XAccessibleSelection
 This interface is for selecting the paragraph's children. More...
 
interface ::com::sun::star::accessibility::XAccessibleEventBroadcaster
 This is the interface for listeners. More...
 
interface ::com::sun::star::accessibility::XAccessibleTextAttributes
 This interface gives access to the default attributes of a paragraph and to the run attributes of a certain character in a paragraph. More...
 

Additional Inherited Members

- Public Member Functions inherited from XAccessibleContext
long getAccessibleChildCount ()
 Return the number of children. More...
 
XAccessible getAccessibleChild ([in] long i) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Returns the i-th child of this object. More...
 
XAccessible getAccessibleParent ()
 Returns the parent of this object. More...
 
long getAccessibleIndexInParent ()
 Returns the index of this object in its accessible parent. More...
 
short getAccessibleRole ()
 Returns the role of this object. More...
 
string getAccessibleDescription ()
 Returns the object's description. More...
 
string getAccessibleName ()
 Return the object's localized name. More...
 
XAccessibleRelationSet getAccessibleRelationSet ()
 Returns the set of relations defined for this object. More...
 
XAccessibleStateSet getAccessibleStateSet ()
 Returns the set of states that are currently active for this object. More...
 
::com::sun::star::lang::Locale getLocale () raises (IllegalAccessibleComponentStateException)
 Returns the locale of the component. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XAccessibleComponent
boolean containsPoint ([in] ::com::sun::star::awt::Point Point)
 Tests whether the specified point lies within this object's bounds. More...
 
XAccessible getAccessibleAtPoint ([in] ::com::sun::star::awt::Point Point)
 Returns the Accessible child that is rendered under the given point. More...
 
::com::sun::star::awt::Rectangle getBounds ()
 Returns the bounding box of this object. More...
 
::com::sun::star::awt::Point getLocation ()
 Returns the location of the upper left corner of the object's bounding box relative to the parent. More...
 
::com::sun::star::awt::Point getLocationOnScreen ()
 Returns the location of the upper left corner of the object's bounding box in screen coordinates. More...
 
::com::sun::star::awt::Size getSize ()
 Returns the size of this object's bounding box. More...
 
void grabFocus ()
 Grabs the focus to this object. More...
 
::com::sun::star::util::Color getForeground ()
 Returns the foreground color of this object. More...
 
::com::sun::star::util::Color getBackground ()
 Returns the background color of this object. More...
 
- Public Member Functions inherited from XAccessibleText
long getCaretPosition ()
 Return the position of the caret. More...
 
boolean setCaretPosition ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Set the position of the caret. More...
 
char getCharacter ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Return the character at the specified position. More...
 
sequence<::com::sun::star::beans::PropertyValuegetCharacterAttributes ([in] long nIndex, [in] sequence< string > aRequestedAttributes) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::beans::UnknownPropertyException)
 Get the attribute set for the specified position. More...
 
::com::sun::star::awt::Rectangle getCharacterBounds ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Return the bounding box of the specified position. More...
 
long getCharacterCount ()
 Return the number of characters in the represented text. More...
 
long getIndexAtPoint ([in] ::com::sun::star::awt::Point aPoint)
 Return the text position for the specified screen position. More...
 
string getSelectedText ()
 Return the selected text. More...
 
long getSelectionStart ()
 Return the position of the start of the selection. More...
 
long getSelectionEnd ()
 Return the position of the end of the selection. More...
 
boolean setSelection ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Set a new selection. More...
 
string getText ()
 Return the whole text. More...
 
string getTextRange ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Return the specified text range. More...
 
TextSegment getTextAtIndex ([in] long nIndex, [in] short nTextType) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException)
 Get a text portion around the given position. More...
 
TextSegment getTextBeforeIndex ([in] long nIndex, [in] short nTextType) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException)
 Get a text portion before the given position. More...
 
TextSegment getTextBehindIndex ([in] long nIndex, [in] short nTextType) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException)
 Get a text portion behind the given position. More...
 
boolean copyText ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Copy the specified text into the clipboard. More...
 
- Public Member Functions inherited from XAccessibleEventBroadcaster
void addAccessibleEventListener ([in] XAccessibleEventListener xListener)
 registers the given XAccessibleEventListener. More...
 
void removeAccessibleEventListener ([in] XAccessibleEventListener xListener)
 unregisters the given XAccessibleEventListener. More...
 
- Protected Member Functions inherited from XAccessibleEditableText
boolean cutText ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Copies the text range into the clipboard. More...
 
boolean pasteText ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Pastes text from the clipboard. More...
 
boolean deleteText ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Deletes a range of text. More...
 
boolean insertText ([in] string sText, [in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Inserts text at the specified position. More...
 
boolean replaceText ([in] long nStartIndex, [in] long nEndIndex, [in] string sReplacement) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Replaces text. More...
 
boolean setAttributes ([in] long nStartIndex, [in] long nEndIndex, [in] sequence<::com::sun::star::beans::PropertyValue > aAttributeSet) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Replaces the attributes of a text range by the given set of attributes. More...
 
boolean setText ([in] string sText)
 Replaces the whole text with the given text. More...
 
- Protected Member Functions inherited from XAccessibleText
long getCaretPosition ()
 Return the position of the caret. More...
 
boolean setCaretPosition ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Set the position of the caret. More...
 
char getCharacter ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Return the character at the specified position. More...
 
sequence<::com::sun::star::beans::PropertyValuegetCharacterAttributes ([in] long nIndex, [in] sequence< string > aRequestedAttributes) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::beans::UnknownPropertyException)
 Get the attribute set for the specified position. More...
 
::com::sun::star::awt::Rectangle getCharacterBounds ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Return the bounding box of the specified position. More...
 
long getCharacterCount ()
 Return the number of characters in the represented text. More...
 
long getIndexAtPoint ([in] ::com::sun::star::awt::Point aPoint)
 Return the text position for the specified screen position. More...
 
string getSelectedText ()
 Return the selected text. More...
 
long getSelectionStart ()
 Return the position of the start of the selection. More...
 
long getSelectionEnd ()
 Return the position of the end of the selection. More...
 
boolean setSelection ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Set a new selection. More...
 
string getText ()
 Return the whole text. More...
 
string getTextRange ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Return the specified text range. More...
 
TextSegment getTextAtIndex ([in] long nIndex, [in] short nTextType) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException)
 Get a text portion around the given position. More...
 
TextSegment getTextBeforeIndex ([in] long nIndex, [in] short nTextType) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException)
 Get a text portion before the given position. More...
 
TextSegment getTextBehindIndex ([in] long nIndex, [in] short nTextType) raises (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException)
 Get a text portion behind the given position. More...
 
boolean copyText ([in] long nStartIndex, [in] long nEndIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Copy the specified text into the clipboard. More...
 
- Protected Member Functions inherited from XAccessibleSelection
void selectAccessibleChild ([in] long nChildIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Selects the specified Accessible child of the object. More...
 
boolean isAccessibleChildSelected ([in] long nChildIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Determines if the specified child of this object is selected. More...
 
void clearAccessibleSelection ()
 Clears the selection, so that no children of the object are selected. More...
 
void selectAllAccessibleChildren ()
 Select all children. More...
 
long getSelectedAccessibleChildCount ()
 Returns the number of Accessible children that are currently selected. More...
 
XAccessible getSelectedAccessibleChild ([in] long nSelectedChildIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Returns the specified selected Accessible child. More...
 
void deselectAccessibleChild ([in] long nChildIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 Removes the specified child from the set of this object's selected children. More...
 
- Protected Member Functions inherited from XAccessibleEventBroadcaster
void addAccessibleEventListener ([in] XAccessibleEventListener xListener)
 registers the given XAccessibleEventListener. More...
 
void removeAccessibleEventListener ([in] XAccessibleEventListener xListener)
 unregisters the given XAccessibleEventListener. More...
 
- Protected Member Functions inherited from XAccessibleTextAttributes
sequence<::com::sun::star::beans::PropertyValuegetDefaultAttributes ([in] sequence< string > RequestedAttributes) raises ( ::com::sun::star::beans::UnknownPropertyException )
 Get the default attribute set for the text. More...
 
sequence<::com::sun::star::beans::PropertyValuegetRunAttributes ([in] long Index, [in] sequence< string > RequestedAttributes) raises (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::IndexOutOfBoundsException)
 Get the run attribute set for the specified position. More...
 

Detailed Description

The accessible view of a paragraph fragment.

Since
OOo 1.1.2

Exported Interfaces

◆ ::com::sun::star::accessibility::XAccessibleComponent

This interface describes the graphical representation of a paragraph fragment.

◆ ::com::sun::star::accessibility::XAccessibleContext

This interface gives access to a paragraph fragment that is at least partially visible on the screen.

A paragraph fragment is the portion of a paragraph that is displayed on a single page or a in a single column.

◆ ::com::sun::star::accessibility::XAccessibleEditableText

This interface gives access to a paragraph fragment's text.

The text contains the paragraph's editable text as well as generated text, like chapter numbers, hyphens or fields. Characters of generated text contribute to the text's character indexing. However, it is not possible to set the caret or start a selection within generated text.

For text frames, graphics, etc. that are bound as character some text is generated that contains the objects description.

The attributes (or properties) returned by com::sun::star::accessibility::XAccessibleText::getCharacterAttributes() are a sub set of the properties described by the service com::sun::star::style::CharacterProperties. For properties that have Asian and complex counterparts, the value that is visible is returned. This can be in fact the western, Asian or complex value. It's not possible to change the value of any property by using com::sun::star::accessibility::XAccessibleEditableText::setAttributes().

TODO: If there is a demand, some attributes might be added that tells whether the character at a certain index is editable or generated.

◆ ::com::sun::star::accessibility::XAccessibleEventBroadcaster

This is the interface for listeners.

◆ ::com::sun::star::accessibility::XAccessibleSelection

This interface is for selecting the paragraph's children.

Multi selection is supported only for children that are multi selectable in the GUI, too.

◆ ::com::sun::star::accessibility::XAccessibleText

This interface is a subset of com::sun::star::accessibility::XAccessibleEditableText and gives access to a paragraph fragment's text in a read-only mode.

The text contains the paragraph's text (changeable as well as generated text, like chapter numbers, hyphens or fields). Characters of generated text contribute to the text's character indexing.

For text frames, graphics, etc. that are bound as character some text is generated that contains the objects description.

The attributes (or properties) returned by com::sun::star::accessibility::XAccessibleText::getCharacterAttributes() are a sub set of the properties described by the service com::sun::star::style::CharacterProperties. For properties that have Asian and complex counterparts, the value that is visible is returned. This can be in fact the western, Asian or complex value.

TODO: If there is a demand, some attributes might be added that tells whether the character at a certain index is changeable or generated.

◆ ::com::sun::star::accessibility::XAccessibleTextAttributes

This interface gives access to the default attributes of a paragraph and to the run attributes of a certain character in a paragraph.

Since
OOo 2.0.4

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