Interface XAccessibleImage

+ + + + + + + + + + + + + + + + +

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

+ + + + + + + + + + + + + +

:: drafts :: com :: sun :: star :: accessibility ::

interface XAccessibleImage

Base Hierarchy

::com::sun::star::uno::XInterface
+ |
+ +-XAccessibleImage

Description: Implement this interface to represent images and icons. + +; This interface is used for a representation of images like icons of + buttons. The corresponding interface of the Java Accessibility API is + AccessibleIcon. This interface lets you retrieve an image's size and + description.
+

Methods' Summary
getAccessibleImageDescription	Returns the localized description of the image. + +
getAccessibleImageHeight	Returns the height of the image. + +
getAccessibleImageWidth	Returns the width of the image. + +

+ + + + + + + + + + + + + +

getAccessibleImageDescription + + + + +

getAccessibleImageHeight + + + + +

string
+getAccessibleImageDescription();

Description: Returns the localized description of the image. + +; It depends on the usage of an image whether the description + should express the image's function (e.g. for icons) or the actual + content of the image (e.g. for image maps or non-iconic images + embedded into a document.)
+ +
Returns: + Returns a localized string that describes the images's function + or content. +

getAccessibleImageWidth + + + + +

long
+getAccessibleImageHeight();

Description: Returns the height of the image. + +; The height is returned in units specified by the parents + coordinate system.
+ +
Returns: + Returns the image's height with respect to the parent's + coordinate system. +

long
+getAccessibleImageWidth();

Description: Returns the width of the image. + +; The width is returned in units specified by the parents + coordinate system.
+ +
Returns: + Returns the image's width with respect to the parent's + coordinate system. +

+ + +

+ +

+ Apache "OpenOffice.org" is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. + Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and + decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is + not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has + yet to be fully endorsed by the ASF.

+ Contact Us | + Terms of Use +
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. +
OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. +
Other names appearing on the site may be trademarks of their respective owners. +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleKeyBinding-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleKeyBinding-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleKeyBinding-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,126 @@ + + + + + + +Uses of Interface XAccessibleKeyBinding-xref + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of interface XAccessibleKeyBinding

back to interface XAccessibleKeyBinding
+
+ +Derived Interfaces
+ +Synonym Typedefs
+ +Services which Support this Interface
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

XAccessibleAction::getAccessibleKeyBinding()
+

Uses as Return Type

+ + + + + + + + + + + + +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleKeyBinding.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleKeyBinding.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleKeyBinding.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,244 @@ + + + + + + +Interface XAccessibleKeyBinding + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

+ + + + + + + + + + + + + +

:: drafts :: com :: sun :: star :: accessibility ::

interface XAccessibleKeyBinding

Base Hierarchy

::com::sun::star::uno::XInterface
+ |
+ +-XAccessibleKeyBinding

Description

This interface can be used to represent any number of key bindings which + then can be associated to a certain action. + +

There can be zero, one, or more key bindings. Each key binding consists + of a sequence of ::drafts::com::sun::star::awt::KeyStroke + objects. The association of an action with a key binding is established + by the XAccessibleAction interface returning an + XAccessibleKeyBinding object.

+ +

A key binding describes alternative ways how to invoke an action with + pressing one or more keys after each other. Each individual sequence of + key strokes

Methods' Summary
getAccessibleKeyBindingCount	Return the number of available key bindings. +
getAccessibleKeyBinding	The returned sequence of key strokes describes one method to invoke + the associated action (the one from which you obtained the object at + which you called this method) by pressing keys. The keys specified + by each of the returned key strokes have to be pressed at the same + time (the Control-key and the A-key for example). The keys of + one key stroke have to be released before pressing those of the + next. The order of the key strokes in the sequence define the order + in which to press them. +

+ + + + + + + + + + +

getAccessibleKeyBindingCount + + + + +

getAccessibleKeyBinding + + + + +

long
+getAccessibleKeyBindingCount();

Description: Return the number of available key bindings. +
Returns: + The returned value may be 0 to indicate that there are no key + bindings or the positive number of the available key bindings. +

sequence< ::drafts::com::sun::star::awt::KeyStroke >
+getAccessibleKeyBinding(

+nIndex )
+::com::sun::star::lang::IndexOutOfBoundsException );

raises(

Description: The returned sequence of key strokes describes one method to invoke + the associated action (the one from which you obtained the object at + which you called this method) by pressing keys. The keys specified + by each of the returned key strokes have to be pressed at the same + time (the Control-key and the A-key for example). The keys of + one key stroke have to be released before pressing those of the + next. The order of the key strokes in the sequence define the order + in which to press them. +
Parameter nIndex: + The index selects one of alternative key bindings. It has to + non-negative and smaller then the number of key bindings as + returned by the geetAccessibleKeyBindingCount() + method. +
Returns: + The returned sequence of key strokes specifies one way to invoke + the associated action. The sequence may be empty (but should + not be; better not to return such a key binding at all). +
Throws: ::com::sun::star::lang::IndexOutOfBoundsException + if the index is not valid. +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleRelationSet-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleRelationSet-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleRelationSet-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,126 @@ + + + + + + +Uses of Interface XAccessibleRelationSet-xref + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of interface XAccessibleRelationSet

back to interface XAccessibleRelationSet
+
+ +Derived Interfaces
+ +Synonym Typedefs
+ +Services which Support this Interface
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

XAccessibleContext::getAccessibleRelationSet()
+

Uses as Return Type

+ + + + + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleRelationSet.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleRelationSet.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleRelationSet.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,320 @@ + + + + + + +Interface XAccessibleRelationSet + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

+ + + + + + + + + + + + + +

:: drafts :: com :: sun :: star :: accessibility ::

interface XAccessibleRelationSet

Base Hierarchy

::com::sun::star::uno::XInterface
+ |
+ +-XAccessibleRelationSet

Description: Implement this interface to give access to an object's set of relations. + +; Such relation are modeled with the AccessibleRelation + structure. This interface is used for representing sets of relations + between Accessible objects. Most of the convenience + methods of the corresponding AccessibleRelationSet interface of the Java + Accessibility API have been removed from this interface in order to + clean it up. These methods are add , + addAll , clear , and + remove . The other methods have been renamed to achieve + a geater conformance with the other accessibility interfaces.
+

Methods' Summary
getRelationCount	Returns the number of relations in this relation set. + +
getRelation	Returns the relation of this relation set that is specified by + the given index. + +
containsRelation	Tests whether the relation set contains a relation matching the + specified key. + +
getRelationByType	Retrieve and return the relation with the given relation type. + +

+ + + + + + + + + + + + + + + + +

getRelationCount + + + + +

long
+getRelationCount();

Description: Returns the number of relations in this relation set. + +
Returns: + Returns the number of relations or zero if there are none. +

getRelation + + + + +

AccessibleRelation
+getRelation(

+nIndex )
+::com::sun::star::lang::IndexOutOfBoundsException );

raises(

Description: Returns the relation of this relation set that is specified by + the given index. + +
Parameter nIndex: + This index specifies the relatio to return. + +
Returns: + For a valid index, i.e. inside the range 0 to the number of + relations minus one, the returned value is the requested + relation. If the index is invalid then the returned relation + has the type INVALID. + +

containsRelation + + + + +

getRelationByType + + + + +

boolean
+containsRelation(

+[in] short

+aRelationType );

Description: Tests whether the relation set contains a relation matching the + specified key. + +
Parameter aRelationType: + The type of relation to look for in this set of relations. This + has to be one of the constants of + AccessibleRelationType . + +
Returns: + Returns true if there is a (at least one) relation of the + given type and false if there is no such relation in the set. +

AccessibleRelation
+getRelationByType(

+[in] short

+aRelationType );

Description: Retrieve and return the relation with the given relation type. + +
Parameter aRelationType: + The type of the relation to return. This has to be one of the + constants of AccessibleRelationType . + +
Returns: + If a relation with the given type could be found than (a copy + of) this relation is returned. Otherwise a relation with the + type INVALID is returned. +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleSelection-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleSelection-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleSelection-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,141 @@ + + + + + + +Uses of Interface XAccessibleSelection-xref + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of interface XAccessibleSelection

back to interface XAccessibleSelection
+
+ +Derived Interfaces
+ +Synonym Typedefs
+ +Services which Support this Interface
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

Services which Support this Interface

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleSelection.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleSelection.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleSelection.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,470 @@ + + + + + + +Interface XAccessibleSelection + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

+ + + + + + + + + + + + + +

:: drafts :: com :: sun :: star :: accessibility ::

interface XAccessibleSelection

Base Hierarchy

::com::sun::star::uno::XInterface
+ |
+ +-XAccessibleSelection

Description

Implement this interface to represent a selection of accessible objects. + +

This interface is the standard mechanism to obtain and modify the + currently selected children. Every object that has children that can be + selected should support this interface.

+ +

The XAccessibleSelection interface has to be implemented + in conjunction with the XAccessibleContext interface that + provides the children on which the first operates.

+ +

It depends on the class implementing this interface, whether it + supports single or multi selection.

Methods' Summary
selectAccessibleChild	Selects the specified Accessible child of the + object. + +
isAccessibleChildSelected	Determines if the specified child of this object is selected. + +
clearAccessibleSelection	Clears the selection, so that no children of the + object are selected. +
selectAllAccessible	Select all children. + +
getSelectedAccessibleChildCount	Returns the number of Accessible children that are currently + selected. + +
getSelectedAccessibleChild	Returns the specified selected Accessible child. + +
deselectSelectedAccessibleChild	Removes the specified child from the set of this object's + selected children. Note that not all applications support + deselection: calls to this method may be silently ignored. + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +

selectAccessibleChild + + + + +

void
+selectAccessibleChild(

+nChildIndex )
+::com::sun::star::lang::IndexOutOfBoundsException );

raises(

Description: Selects the specified Accessible child of the + object. + +; Depending on the implementing class the child is added to the + current set a selected children (multi selection) or a previously + selected child is deselected first (single selection).
+ +
Parameter nChildIndex: + Index of the child which is to add to the selection. This index + referes to all the the children of this object. +
Throws: ::com::sun::star::lang::IndexOutOfBoundsException + if the given index does not lie in the valid range of 0 up to + the result of + XAccessibleContext::getAccessibleChildCount() -1. +

isAccessibleChildSelected + + + + +

boolean
+isAccessibleChildSelected(

+nChildIndex )
+::com::sun::star::lang::IndexOutOfBoundsException );

raises(

Description: Determines if the specified child of this object is selected. + +
Parameter nChildIndex: + Index of the child for which to detect whether it is selected. + This index referes to all the children of this object. + +
Returns: + Returns true if the specified child is selected and false + if it is not selected. +
Throws: ::com::sun::star::lang::IndexOutOfBoundsException + if the given index does not lie in the valid range of 0 up to + the result of + XAccessibleContext::getAccessibleChildCount() -1. +

clearAccessibleSelection + + + + +

selectAllAccessible + + + + +

[oneway] void
+clearAccessibleSelection();

Description: Clears the selection, so that no children of the + object are selected. +

getSelectedAccessibleChildCount + + + + +

[oneway] void
+selectAllAccessible();

Description: Select all children. + +; Causes every child of the object to be selected if the object + supports multiple selections. If multiple selection is not + supported then the first child, if it exists, is selected and all + other children are deselected.
+

getSelectedAccessibleChild + + + + +

long
+getSelectedAccessibleChildCount();

Description: Returns the number of Accessible children that are currently + selected. + +; This number specifies the valid interval of indices that can be + used as arguments for the methods + XAccessibleSelection::getSelectedChild and + XAccessibleSelection::deselectSelectedChild .
+ +
Returns: + Returns the number of selected children of this object or 0 if + no child is selected. +

XAccessible
+getSelectedAccessibleChild(

+nSelectedChildIndex )
+::com::sun::star::lang::IndexOutOfBoundsException );

raises(

Description: Returns the specified selected Accessible child. + +
Parameter nSelectedChildIndex: + This index refers only to the selected children, not to all the + children of this object. Even if all children are selected, the + indices enumerating the selected children need not be the same + as those enumerating all children. If only single selection is + supported the only valid value is 0. + +
Returns: + If the index is valid, i.e. not negative and lower than the + number of selected children, then a valid reference to the + corresponding XAccessible child is returned. + Otherwise an exception is thrown. +
Throws: ::com::sun::star::lang::IndexOutOfBoundsException + if the given index does not lie in the valid range of 0 up to + the result of + XAccessibleRelationSet::getAccessibleChildCount() -1. +

deselectSelectedAccessibleChild + + + + +

void
+deselectSelectedAccessibleChild(

+nSelectedChildIndex )
+::com::sun::star::lang::IndexOutOfBoundsException );

raises(

Description: Removes the specified child from the set of this object's + selected children. Note that not all applications support + deselection: calls to this method may be silently ignored. + +
Parameter nSelectedChildIndex: + This index refers to all children not just the selected ones. + If the specified child is not selected or it can not be + deselected for any reason then the method call is silently + ignored. +
Throws: ::com::sun::star::lang::IndexOutOfBoundsException + if the given index does not lie in the valid range of 0 up to, + but not including, the result of + getAccessibleChildCount() . +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleStateSet-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleStateSet-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleStateSet-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,126 @@ + + + + + + +Uses of Interface XAccessibleStateSet-xref + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of interface XAccessibleStateSet

back to interface XAccessibleStateSet
+
+ +Derived Interfaces
+ +Synonym Typedefs
+ +Services which Support this Interface
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

XAccessibleContext::getAccessibleStateSet()
+

Uses as Return Type

+ + + + + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleStateSet.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleStateSet.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/accessibility/XAccessibleStateSet.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,315 @@ + + + + + + +Interface XAccessibleStateSet + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

+ + + + + + + + + + + + + +

:: drafts :: com :: sun :: star :: accessibility ::

interface XAccessibleStateSet

Base Hierarchy

::com::sun::star::uno::XInterface
+ |
+ +-XAccessibleStateSet

Description: Implement this interface to represent a set of states. + +; The interface XAccessibleStateSet represents a set of + states of an accessible object. It can hold any combination of states + defined by the constants collection + AccessibleStateType .
+

Methods' Summary
isEmpty	Checks whether the current state set is empty. + +
contains	Checks if the given state is a member of the state set of the called + object. + +
containsAll	Checks if all of the given states are in the state set of the called + object. + +
getStates	Get all currently set states as a sequence of state ids. + +

+ + + + + + + + + + + + + + + + +

isEmpty + + + + +

boolean
+isEmpty();

Description: Checks whether the current state set is empty. + +
Returns: + Returns true if there is no state in this state set and + false if there is at least one set state in it. +

contains + + + + +

boolean
+contains(

+[in] short

+aState );

Description: Checks if the given state is a member of the state set of the called + object. + +
Parameter aState: + The state for which to check membership. This has to be one of + the constants of AccessibleStateType . + +
Returns: + Returns true if the given state is a memeber of this object's + state set and false otherwise. +

containsAll + + + + +

boolean
+containsAll(

+[in] sequence< short >

+aStateSet );

Description: Checks if all of the given states are in the state set of the called + object. + +
Parameter aStateSet: + This sequence of states is interpreted as set and every of its + members, duplicates are ignored, is checked for membership in + this object's state set. Each state has to be one of the + constants of AccessibleStateType . + +
Returns: + Returns true if all states of the given state set are members + of this object's state set. false is returned if at least + one of the states in the given state is not a member of this + object's state set. +

getStates + + + + +

sequence< short >
+getStates();

Description: Get all currently set states as a sequence of state ids. + +; The purpose of this function is to reduce the communication + between accessibility objects and AT. Without this function an + AT-Tool had to call contains() for every state + type. Now a single call is sufficient.
+ +
Returns: + The returned sequence contains one entry for every currently set + state. This entry is the id of that state. The order of the + states in the sequence is undefined. +