Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

service AccessibleHeaderFooterView
Description
The accessible view of headers and footers.
Since
OOo 1.1.2

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

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

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

This interface describes the graphical representation of a header or footer.

::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 and table that is contained in the header and footer 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 that is contained in the document body and is at least partially visible. The child always represents a whole paragarph (and not a fragment only), because there are no page breaks within headers and footers.
    • ::com::sun::star::table::AccessibleTableView: A child of this kind is returned for every table that is contained in the document body and is at least partially visible. The child always represents a whole table (and not a fragment only), because there are no page breaks within headers and footers.

    The logical order of paragraphs and tables is never changed.

  • The role is either AccessibleRole::HEADER or AccessibleRole::FOOTER.
  • The name is "header" or "footer" (or the equivalent term in application's language) with a number appended.
  • The description is "header" or "footer" (or the equivalent term in application's language) with the page number appended in the format that is specified in the page's style.
  • There are no relations.
  • 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 header or footer 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 header or footer.
::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.