The accessible view of headers and footers. More...
import"AccessibleHeaderFooterView.idl";
Inheritance diagram for AccessibleHeaderFooterView:
Exported Interfaces | |
| interface | ::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. More... | |
| interface | ::com::sun::star::accessibility::XAccessibleComponent |
| This interface describes the graphical representation of a header or footer. More... | |
| interface | ::com::sun::star::accessibility::XAccessibleEventBroadcaster |
| This is the interface for listeners. More... | |
Additional Inherited Members | |
 Public Member Functions inherited from XAccessibleContext | |
| hyper | getAccessibleChildCount () |
| Return the number of children. More... | |
| XAccessible | getAccessibleChild ([in] hyper i) raises (::com::sun::star::lang::IndexOutOfBoundsException) |
| Returns the i-th child of this object. More... | |
| XAccessible | getAccessibleParent () |
| Returns the parent of this object. More... | |
| hyper | getAccessibleIndexInParent () |
| Returns the index of this object in its accessible parent. More... | |
| short | getAccessibleRole () |
| Returns the role of this object. More... | |
| string | getAccessibleDescription () |
| Returns the object's description. More... | |
| string | getAccessibleName () |
| Return the object's localized name. More... | |
| XAccessibleRelationSet | getAccessibleRelationSet () |
| Returns the set of relations defined for this object. More... | |
| hyper | getAccessibleStateSet () |
| Returns the set of states that are currently active for this object. More... | |
| ::com::sun::star::lang::Locale | getLocale () raises (IllegalAccessibleComponentStateException) |
| Returns the locale of the component. More... | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
| Public Member Functions inherited from XAccessibleComponent | |
| boolean | containsPoint ([in] ::com::sun::star::awt::Point Point) |
| Tests whether the specified point lies within this object's bounds. More... | |
| XAccessible | getAccessibleAtPoint ([in] ::com::sun::star::awt::Point Point) |
| Returns the Accessible child that is rendered under the given point. More... | |
| ::com::sun::star::awt::Rectangle | getBounds () |
| Returns the bounding box of this object. More... | |
| ::com::sun::star::awt::Point | getLocation () |
| Returns the location of the upper left corner of the object's bounding box relative to the parent. More... | |
| ::com::sun::star::awt::Point | getLocationOnScreen () |
| Returns the location of the upper left corner of the object's bounding box in screen coordinates. More... | |
| ::com::sun::star::awt::Size | getSize () |
| Returns the size of this object's bounding box. More... | |
| void | grabFocus () |
| Grabs the focus to this object. More... | |
| ::com::sun::star::util::Color | getForeground () |
| Returns the foreground color of this object. More... | |
| ::com::sun::star::util::Color | getBackground () |
| Returns the background color of this object. More... | |
| Public Member Functions inherited from XAccessibleEventBroadcaster | |
| void | addAccessibleEventListener ([in] XAccessibleEventListener xListener) |
| registers the given XAccessibleEventListener. More... | |
| void | removeAccessibleEventListener ([in] XAccessibleEventListener xListener) |
| unregisters the given XAccessibleEventListener. More... | |
Detailed Description
The accessible view of headers and footers.
- Since
- OOo 1.1.2
Exported Interfaces
◆ ::com::sun::star::accessibility::XAccessibleComponent
This interface describes the graphical representation of a header or footer.
◆ ::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.
- The parent returned by com::sun::star::accessibility::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 com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() all support the interface XAccessible. Calling com::sun::star::accessibility::XAccessible::getAccessibleContext() for these children returns an object that supports one of the following services.
- com::sun::star::text::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 paragraph (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 com::sun::star::accessibility::AccessibleRole::HEADER or com::sun::star::accessibility::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 com::sun::star::accessibility::XAccessibleContext::getAccessibleStateSet():
- com::sun::star::accessibility::AccessibleStateType::DEFUNC (indicates that the document window has been closed or the header or footer is not existing any longer)
- com::sun::star::accessibility::AccessibleStateType::EDITABLE
- com::sun::star::accessibility::AccessibleStateType::ENABLED (always contained)
- com::sun::star::accessibility::AccessibleStateType::OPAQUE
- com::sun::star::accessibility::AccessibleStateType::SHOWING
- com::sun::star::accessibility::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::XAccessibleEventBroadcaster
This is the interface for listeners.
The documentation for this service was generated from the following file:
- com/sun/star/text/AccessibleHeaderFooterView.idl
