LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
AccessibleShape Service Reference

The AccessibleShape service is implemented by UNO shapes to provide accessibility information that describe the shape's features. More...

import"AccessibleShape.idl";

Inheritance diagram for AccessibleShape:
XAccessible XAccessibleContext XAccessibleComponent XAccessibleExtendedComponent XInterface XInterface XInterface XAccessibleComponent XInterface AccessibleGraphicShape AccessibleOLEShape

Exported Interfaces

interface ::com::sun::star::accessibility::XAccessible
 Base interface for being accessible. More...
 
interface ::com::sun::star::accessibility::XAccessibleContext
 Give access to the structural information of a shape. More...
 
interface ::com::sun::star::accessibility::XAccessibleComponent
 Give access to the graphical representation of a shape. More...
 
interface ::com::sun::star::accessibility::XAccessibleExtendedComponent
 Give extended access to the graphical representation of a shape. More...
 

Additional Inherited Members

- Public Member Functions inherited from XAccessible
XAccessibleContext getAccessibleContext ()
 Returns the AccessibleContext associated with this object. 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 XAccessibleContext
long getAccessibleChildCount ()
 Return the number of children. More...
 
XAccessible getAccessibleChild ([in] long 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...
 
long 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...
 
XAccessibleStateSet 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 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...
 
- Protected Member Functions inherited from XAccessibleExtendedComponent
::com::sun::star::awt::XFont getFont ()
 Returns the font of this object. More...
 
string getTitledBorderText ()
 Returns the titled border text. More...
 
string getToolTipText ()
 Returns the tool tip text of this object. More...
 

Detailed Description

The AccessibleShape service is implemented by UNO shapes to provide accessibility information that describe the shape's features.

A UNO shape is any object that implements the com::sun::star::drawing::XShape interface.

The content of a draw page is modelled as tree of accessible shapes and accessible text paragraphs. The root of this (sub-)tree is the accessible draw document view. An accessible shape implements either this service or one of the "derived" services AccessibleGraphicShape or AccessibleOLEShape. See the section Children in the description of the com::sun::star::accessibility::XAccessibleContext interface support for more details.

There are two services that extend this one: the AccessibleGraphicShape and the AccessibleOLEShape services provide additional interfaces. See there for details.

A shape object is either fully or partially visible on the screen or has set the com::sun::star::accessibility::AccessibleStateType::DEFUNC state to indicate that it is no longer actively supported by its parent.

Each shape object that has not set the DEFUNC state has a valid parent. That is either the containing draw page or a group shape or a 3D scene object.

Since
OOo 1.1.2

Exported Interfaces

Base interface for being accessible.

It gives access to the com::sun::star::accessibility::XAccessibleContext interface.

Give access to the graphical representation of a shape.

The bounding box returned by the com::sun::star::accessibility::XAccessibleComponent::getBounds() function returns the shape's bounding box clipped at its parent's bounding box

An accessible shape tries as best as it can to return proper values for calls to the com::sun::star::accessibility::XAccessibleExtendedComponent::getForeground() and com::sun::star::accessibility::XAccessibleExtendedComponent::getBackground() functions. If the shape is painted with a uniform and non-transparent color then the returned colors may differ from the ones visible on the screen.

Key bindings are not supported at the moment

Give access to the structural information of a shape.

You can access the following information for the shape being made accessible:

Give extended access to the graphical representation of a shape.

The functions com::sun::star::accessibility::XAccessibleExtendedComponent::getFont(), com::sun::star::accessibility::XAccessibleExtendedComponent::getTitledBorderText(), and com::sun::star::accessibility::XAccessibleExtendedComponent::getToolTipText() are not supported and return empty references respectively empty strings.

The support of this interface is optional to reduce overhead in case that no text is displayed and color information can not be determined with an acceptable cost.


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