LibreOffice: AccessibleOLEShape Service Reference

LibreOffice LibreOffice 7.4 SDK API Reference

Loading...
Searching...
No Matches
Included Services | Exported Interfaces | List of all members
AccessibleOLEShape Service Reference

The AccessibleOLEShape service is implemented by OLE shapes. More...

Inheritance diagram for AccessibleOLEShape:

## Included Services
service | AccessibleShape
| Give access to information of generic shapes.

## Exported Interfaces
interface | ::com::sun::star::accessibility::XAccessibleAction
| The intended purpose of the support of this interface is the activation of the accessible OLE object.
Exported Interfaces inherited from AccessibleShape
interface | ::com::sun::star::accessibility::XAccessible
| Base interface for being accessible.
interface | ::com::sun::star::accessibility::XAccessibleContext
| Give access to the structural information of a shape.
interface | ::com::sun::star::accessibility::XAccessibleComponent
| Give access to the graphical representation of a shape.
interface | ::com::sun::star::accessibility::XAccessibleExtendedComponent
| Give extended access to the graphical representation of a shape.

## Additional Inherited Members
Public Member Functions inherited from XAccessible
XAccessibleContext | getAccessibleContext ()
| Returns the AccessibleContext associated with this object.
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 XAccessibleContext
long | getAccessibleChildCount ()
| Return the number of children.
XAccessible | getAccessibleChild ([in] long i) raises (::com::sun::star::lang::IndexOutOfBoundsException)
| Returns the i-th child of this object.
XAccessible | getAccessibleParent ()
| Returns the parent of this object.
long | 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.
XAccessibleStateSet | 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 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 XAccessibleAction
long | getAccessibleActionCount ()
| Returns the number of accessible actions available in this object.
boolean | doAccessibleAction ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
| Perform the specified Action on the object.
string | getAccessibleActionDescription ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
| Returns a description of the specified action of the object.
XAccessibleKeyBinding | getAccessibleActionKeyBinding ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
| Returns a key binding object, if there is one, associated with the specified action.
Protected Member Functions inherited from XAccessibleExtendedComponent
::com::sun::star::awt::XFont | getFont ()
| Returns the font of this object.
string | getTitledBorderText ()
| Returns the titled border text.
string | getToolTipText ()
| Returns the tool tip text of this object.

## Detailed Description

The AccessibleOLEShape service is implemented by OLE shapes.

This includes generic OLE shapes, frames, plug-ins, and applets.

This service supports the additional com::sun::star::accessibility::XAccessibleAction interface.

OLE objects are handled as place holders. While not activated the accessible OLE shape is the only indicator of the OLE object's existence. When an OLE object has been activated then the accessibility tree representing it (as far as that is available) is included directly under the accessible document view and not under the OLE object. This is due to underlying implementation constraints and may change in the future.

Since
  OOo 1.1.2

## Exported Interfaces

## ◆ AccessibleShape

service AccessibleShape

Give access to information of generic shapes.

See AccessibleShape for basic documentation and support of the com::sun::star::accessibility::XAccessibleContext, and com::sun::star::accessibility::XAccessibleComponent interfaces.

See also
  AccessibleShape

## Exported Interfaces

## ◆ ::com::sun::star::accessibility::XAccessibleAction

interface ::com::sun::star::accessibility::XAccessibleAction

The intended purpose of the support of this interface is the activation of the accessible OLE object.

This, however, is not realized at the moment. It therefore serves solely as indicator of accessible OLE objects.

The documentation for this service was generated from the following file:

- com/sun/star/drawing/AccessibleOLEShape.idl