LibreOffice LibreOffice 25.2 SDK API Reference

Exported Interfaces | List of all members
AccessibleSpreadsheetPageView Service Reference

The accessible view of a spreadsheet page preview. More...

`import"AccessibleSpreadsheetPageView.idl";`

Inheritance diagram for AccessibleSpreadsheetPageView:

## Exported Interfaces
interface | ::com::sun::star::accessibility::XAccessibleContext
| This interface gives access to any object that is at least partially visible on the screen in the page preview. More...
interface | ::com::sun::star::accessibility::XAccessibleComponent
| This interface gives access to the visibility of the document. 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 a spreadsheet page preview.

Since
  OOo 1.1.2

## Exported Interfaces

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

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

This interface gives access to the visibility of the document.

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

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

This interface gives access to any object that is at least partially visible on the screen in the page preview.

- The parent returned by com::sun::star::accessibility::XAccessibleContext::getAccessibleParent() is the window which contains the view of these page preview.

- 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::sheet::AccessiblePageHeaderFooterAreasView: A child where calling com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() an object that supports this service is returned for every header and footer that is at least partially visible.
  - com::sun::star::table::AccessibleTableView: A child where calling com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() an object that supports this service 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.
  - com::sun::star::drawing::AccessibleShape: A child where calling com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() an object that supports this service is returned for every shape that is at least partially visible. These objects are children of the AccessibleSpreadsheetPageView regardless whether they are bound to a table or a cell.
  - com::sun::star::text::AccessibleParagraphView: A child where calling com::sun::star::accessibility::XAccessibleContext::getAccessibleChild() an object that supports this service is returned for every note (its paragraphs) and its location (which is represented as a paragraph with the cell name as content).

  The following rules apply to the children order. General it represents the paint order. The object in the background came first and then all over lying objects. The last painted object is also the last child.

  - The logical order of paragraph and table fragments is never changed.
  - Headers appear immediately before the first table fragment of the header's page.
  - Footers appear immediately after the last table fragment.
  - Shapes appear before any other children if they are painted in the background. Their order reflects the z order.
  - Shapes appear behind any other children except controls if they are painted in the foreground. Their order reflects the z order.
  - Controls appear behind any other objects. Their order reflects the z order.
- The description is ???.
- The name is Spreadsheet Document Page Preview.
- The role is com::sun::star::accessibility::AccessibleRole::DOCUMENT_SPREADSHEET
- There are no relations.
- The following states are supported:
  - com::sun::star::accessibility::AccessibleStateType::DEFUNC is always false until the preview is closed.
  - com::sun::star::accessibility::AccessibleStateType::EDITABLE is always false, because the document is not editable in the page preview. So it is left out of the list.
  - com::sun::star::accessibility::AccessibleStateType::ENABLED is always true.
  - com::sun::star::accessibility::AccessibleStateType::MULTI_LINE makes no sense on a document and so it is left out of the list.
  - com::sun::star::accessibility::AccessibleStateType::MULTI_SELECTABLE is always false, because in a page preview a selection is not possible. So it is left out of the list.
  - com::sun::star::accessibility::AccessibleStateType::OPAQUE is always true.
  - com::sun::star::accessibility::AccessibleStateType::RESIZABLE is always false, because you can resize the window of the page preview, but not the page preview itself. So it is left out of the list.
  - com::sun::star::accessibility::AccessibleStateType::SELECTABLE is always false, because in the page preview is no selection possible. So it is left out of the list.
  - com::sun::star::accessibility::AccessibleStateType::SELECTED is always false, because in the page preview is no selection possible. So it is left out of the list.
  - com::sun::star::accessibility::AccessibleStateType::SHOWING is true if the Bounding Box lies in the Bounding Box of the parent. Otherwise it is false.
  - com::sun::star::accessibility::AccessibleStateType::VISIBLE is always true.

## ◆ ::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/sheet/AccessibleSpreadsheetPageView.idl