(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.

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

service AccessibleTextFrameView
Description
The accessible view of text frames.
Since
OOo 1.1.2

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

This interface gives access to any paragraph fragment and table fragment that is contained in a text frame and at least partially visible on the screen. (details)

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

This interface describes the graphical representation of a text frame.

::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 paragraph fragment and table fragment that is contained in a text frame and at least partially visible on the screen.
  • The parent returned by XAccessibleContext::getAccessibleParent is the accessible view of a paragraph if the text frame is bound as character, and the accessible view (or of a page in the page preview) of the document in any other case.
  • 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.
    • 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 or a certain column.
    • ::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 or a certain column.

    The logical order of paragraph and table fragments is never changed.

  • The role is AccessibleRole::TEXT_FRAME
  • The name is the one assigned to the text frame in the text document. This means that it is not internationalized.
  • The description is the one assigned to the text frame in the text document. This means that it is not internationalized. If no description has been set, the description equals the name.
  • There are no relations.
  • The following states might be contained in the state set returned by XAccessibleContext::getAccessibleStateSet:
    • AccessibleStateType::DEFUNC (indicates that the document window has been closed or the graphic is not existing any longer)
    • AccessibleStateType::EDITABLE
    • AccessibleStateType::ENABLED (always contained)
    • AccessibleStateType::OPAQUE
    • AccessibleStateType::SELECTABLE
    • AccessibleStateType::SELECTED
    • AccessibleStateType::FOCUSABLE
    • AccessibleStateType::FOCUSED
    • AccessibleStateType::SHOWING
    • AccessibleStateType::VISIBLE
  • The locale is the one the text document itself.
  • There are the two relations CONTENT_FLOWS_FROM and CONTENT_FLOWS_TO supported.
::com::sun::star::accessibility::XAccessibleComponent
Description
This interface describes the graphical representation of a text frame.
::com::sun::star::accessibility::XAccessibleEventBroadcaster
Description
This is the interface for listeners

 
Top of Page

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.