Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.3 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: text ::

service AccessibleParagraphView
Description
The accessible view of a paragraph fragment.
Since
OOo 1.1.2

Exported Interfaces - Summary
::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. (details)

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

This interface describes the graphical representation of a paragraph fragment.

::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. (details)

::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. (details)

::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. (details)

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

This is the interface for listeners.

::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 (details)

Exported Interfaces - Details
::com::sun::star::accessibility::XAccessibleContext
Description
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.
  • The parent returned by XAccessibleContext::getAccessibleParent is the accessible view of a text document (in this case the paragraph is contained in a page body) or the accessible view of a header, footer, footnote, endnote, table cell, text frame, page or shape.
  • The children returned by XAccessibleContext::getAccessibleChild are the graphics, text boxes and OLE objects that are bound as character within the paragraph. Graphics, text boxes and OLE objects that are bound to the paragraph or to a character within the paragraph are not children of the paragraph fragment but of the document view itself.
  • The role is either AccessibleRole::PARAGRAPH or AccessibleRole::HEADING. The later one is returned if the paragraph's style is contained in the chapter numbering of a text document.
  • The name is "paragraph" or "heading" (or the equivalent term in application's language) with a number appended.
  • The description contains the term "paragraph" (or the equivalent term in application's language) and the first sentence of the paragraph.
  • There are no relations.
  • The following states are supported by the ::com::sun::star::accessibility::XAccessibleStateSet returned by XAccessibleContext::getAccessibleStateSet.
    • AccessibleStateType::DEFUNC (indicates that the document window has been closed or the paragraph fragment is not existing any longer).
    • AccessibleStateType::EDITABLE
    • AccessibleStateType::ENABLED (always contained)
    • AccessibleStateType::MULTILINE (always contained)
    • AccessibleStateType::MULTISELECTABLE (always contained)
    • AccessibleStateType::OPAQUE
    • AccessibleStateType::SHOWING
    • AccessibleStateType::VISIBLE
    • AccessibleStateType::FOCUSED
  • Depending of the application's region setting, the locale is the western, asian or complex language of the paragraph.
::com::sun::star::accessibility::XAccessibleComponent
Description
This interface describes the graphical representation of a paragraph fragment.
::com::sun::star::accessibility::XAccessibleEditableText
Usage Restrictions
optional
Description
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 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. Its not possible to change the value of any property by using 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::XAccessibleText
Description
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 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::XAccessibleSelection
Usage Restrictions
optional
Description
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::XAccessibleEventBroadcaster
Description
This is the interface for listeners.
::com::sun::star::accessibility::XAccessibleTextAttributes
Usage Restrictions
optional
Description
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

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.