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 AccessibleTextDocumentView
Description
The accessible view of a text document.
Since
OOo 1.1.2

Exported Interfaces - Summary
::com::sun::star::accessibility::XAccessibleContext

This interface gives access to any text, table, graphic, embedded object and drawing that is at least partially visible on the screen. The tree that arises from the children of this object reflects the structure of the document as it is displayed. (details)

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

This interface describes the graphical representation of a text document view.

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

This interface is for selecting the document's children. Selectable are any children with the exception of headers, footers, footnotes and endnotes, where only the grandchildren might be selectable.

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

This is the interface for listeners

Exported Interfaces - Details
::com::sun::star::accessibility::XAccessibleContext
Description
This interface gives access to any text, table, graphic, embedded object and drawing that is at least partially visible on the screen. The tree that arises from the children of this object reflects the structure of the document as it is displayed.
  • The children returned by XAccessibleContext::getAccessibleChild all support the interface XAccessible. Calling XAccessible::getAccessibleContext for these children returns an object that supports one of the following services.
    • AccessibleHeaderFooterView: A child of this kind is returned for every header and footer that is at least partially visible.
    • AccessibleFootnoteView: A child of this kind is returned for every footnote that is at least partially visible.
    • AccessibleEndnoteView: A child of this kind is returned for every endnote that is at least partially visible.
    • AccessibleParagraphView: A child of this kind is returned for every paragraph fragment that is contained in the document body and is at least partially visible. A paragraph fragment is the part of a paragraph that is displayed on a certain page.
    • ::com::sun::star::table::AccessibleTableView: A child of this kind is returned for every table fragment that is contained in the document body and is at least partially visible. A table fragment is the part of a table that is displayed on a certain page.
    • AccessibleTextFrameView: A child of this kind is returned for every text frame that is at least partially visible. These objects are children of the AccessibleTextDocumentView regardless whether they are bound to a page, a paragarph, a frame, or a character. The only exception are text frames that are bound as character. They are childen of the paragraph they are contained in.
    • AccessibleTextGraphicObject: A child of this kind is returned for every graphic that is at least partially visible. These objects are children of the AccessibleTextDocumentView regardless whether they are bound to a page, paragraph, a frame or a character. The only exception are text frames that are bound as character. They are childen of the paragraph they are contained in.
    • AccessibleTextEmbeddedObject: A child of this kind is returned for every embedded object that is at least partially visible. These objects are children of the AccessibleTextDocumentView regardless whether they are bound to a page, a paragarph, a frame, or a character. They are childen of the paragraph they are contained in.
    • ::com::sun::star::drawing::AccessibleShape: A child of this kind (or a derived interface) is returned for every shape that is at least partially visible. These objects are children of the AccessibleTextDocumentView regardless whether they are bound to a page, a paragraph, a frame or a character.

    The following rules apply to the children order:

    • The logical order of paragraph and table fragments is never changed.
    • Headers appear immediately before the first paragraph or table fragment of the header's page.
    • Footnotes appear immediately after the last paragraph or table fragment of the footnote's page. The logical order of footnotes isn't changed.
    • Endnotes appear immediately after the last footnote of the endnote's page or after the last paragraph or table fragment of this page if there are no footnotes. The logical order of endnotes isn't changed.
    • Footers appear immediately after the last endnote, footnote, paragraph or table fragment of the footer's page.
    • Text frames, graphics, embedded objects and shapes that are painted in the background appear before any other children. Their order reflects the z order.
    • Text frames, graphics, embedded objects and shapes that are painted in the foreground appear behind any other children. Their order reflects the z order, with the exception of controls that appear really last, but also keep the z order.
  • The role is AccessibleRole::DOCUMENT.
  • The name is "document view" (or the equivalent term in application's language).
  • The description also is "document view" (or the equivalent term in application's language).
  • There are no relation sets.
  • The following states might be contained in the state set returned by XAccessibleContext::getAccessibleStateSet:
    • AccessibleStateType::DEFUNC (indicates that the document window has been closed)
    • AccessibleStateType::EDITABLE
    • AccessibleStateType::ENABLED (always contained)
    • AccessibleStateType::MULTI_SELECTABLE (always contained)
    • AccessibleStateType::OPAQUE (always contained)
    • AccessibleStateType::SHOWING
    • AccessibleStateType::VISIBLE
  • Depending of the application's region setting, the locale is the western, asian or complex default language of the document.
::com::sun::star::accessibility::XAccessibleComponent
Description
This interface describes the graphical representation of a text document view.
::com::sun::star::accessibility::XAccessibleSelection
Description
This interface is for selecting the document's children. Selectable are any children with the exception of headers, footers, footnotes and endnotes, where only the grandchildren might be selectable.
::com::sun::star::accessibility::XAccessibleEventBroadcaster
Description
This is the interface for listeners

 
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.