LibreOffice: AccessibleEndnoteView Service Reference

LibreOffice LibreOffice 7.5 SDK API Reference

Loading...
Searching...
No Matches
Exported Interfaces | List of all members
AccessibleEndnoteView Service Reference

The accessible view of endnotes. More...

Inheritance diagram for AccessibleEndnoteView:

## Exported Interfaces
interface | ::com::sun::star::accessibility::XAccessibleContext
| This interface gives access to any paragraph fragment and table fragment that is contained in an endnote and is at least partially visible on the screen.
interface | ::com::sun::star::accessibility::XAccessibleComponent
| This interface describes the graphical representation of a endnote.
interface | ::com::sun::star::accessibility::XAccessibleEventBroadcaster
| This is the interface for listeners.

## Additional Inherited Members
Public Member Functions inherited from XAccessibleContext
hyper | getAccessibleChildCount ()
| Return the number of children.
XAccessible | getAccessibleChild ([in] hyper i) raises (::com::sun::star::lang::IndexOutOfBoundsException)
| Returns the i-th child of this object.
XAccessible | getAccessibleParent ()
| Returns the parent of this object.
hyper | getAccessibleIndexInParent ()
| Returns the index of this object in its accessible parent.
short | getAccessibleRole ()
| Returns the role of this object.
string | getAccessibleDescription ()
| Returns the object's description.
string | getAccessibleName ()
| Return the object's localized name.
XAccessibleRelationSet | getAccessibleRelationSet ()
| Returns the set of relations defined for this object.
hyper | getAccessibleStateSet ()
| Returns the set of states that are currently active for this object.
::com::sun::star::lang::Locale | getLocale () raises (IllegalAccessibleComponentStateException)
| Returns the locale of the component.
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object.
void | acquire ()
| increases the reference counter by one.
void | release ()
| decreases the reference counter by one.
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.
XAccessible | getAccessibleAtPoint ([in] ::com::sun::star::awt::Point Point)
| Returns the Accessible child that is rendered under the given point.
::com::sun::star::awt::Rectangle | getBounds ()
| Returns the bounding box of this object.
::com::sun::star::awt::Point | getLocation ()
| Returns the location of the upper left corner of the object's bounding box relative to the parent.
::com::sun::star::awt::Point | getLocationOnScreen ()
| Returns the location of the upper left corner of the object's bounding box in screen coordinates.
::com::sun::star::awt::Size | getSize ()
| Returns the size of this object's bounding box.
void | grabFocus ()
| Grabs the focus to this object.
::com::sun::star::util::Color | getForeground ()
| Returns the foreground color of this object.
::com::sun::star::util::Color | getBackground ()
| Returns the background color of this object.
Public Member Functions inherited from XAccessibleEventBroadcaster
void | addAccessibleEventListener ([in] XAccessibleEventListener xListener)
| registers the given XAccessibleEventListener.
void | removeAccessibleEventListener ([in] XAccessibleEventListener xListener)
| unregisters the given XAccessibleEventListener.

## Detailed Description

The accessible view of endnotes.

Since
  OOo 1.1.2

## Exported Interfaces

## ◆ ::com::sun::star::accessibility::XAccessibleComponent

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

This interface describes the graphical representation of a endnote.

## ◆ ::com::sun::star::accessibility::XAccessibleContext

interface ::com::sun::star::accessibility::XAccessibleContext

This interface gives access to any paragraph fragment and table fragment that is contained in an endnote 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 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 com::sun::star::accessibility::AccessibleRole::END_NOTE
- The name is "endnote" (or the equivalent term in application's language) with a number appended.
- The description is endnote" (or the equivalent term in application's language) with the endnote number or character appended in the format that is specified in the endnote settings.
- There are no relations. TODO: One might specify a relation to the endnote anchor's paragraph.
- 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 endnote 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

interface ::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/AccessibleEndnoteView.idl