(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 AccessibleFootnoteView
Description
The accessible view of footnotes.
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 footnote and is at least partially visible on the screen. (details)

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

This interface describes the graphical representation of a footnote.

::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 footnote and is at least partially visible on the screen.
  • The parent returned by XAccessibleContext::getAccessibleParent is either the accessible view of a text document, a page of the accessible page preview of a text document, or the accessible page preview of a spreadsheet document.
  • 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.
    • ::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.

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

  • The role is AccessibleRole::FOOTNOTE
  • The name is "footnote" (or the equivalent term in application's language) with a number appended.
  • The description is footnote" (or the equivalent term in application's language) with the footnote number or character appended in the format that is specified in the footnote settings.
  • There are no relations. TODO: One might specify a relation to the footnote anchor's paragraph.
  • The following states might be contained in the state set returned by XAccessible::getAccessibleStateSet:
    • AccessibleStateType::DEFUNC (indicates that the document window has been closed or the footnote is not existing any longer)
    • AccessibleStateType::EDITABLE
    • AccessibleStateType::ENABLED (always contained)
    • AccessibleStateType::OPAQUE
    • 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 footnote.
::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.