blob: 30c5c47aa9834d1ac2522e0df7808799c3cf9dcd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XAccessibleAction.idl,v $
* $Revision: 1.9 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_accessibility_XAccessibleAction_idl__
#define __com_sun_star_accessibility_XAccessibleAction_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif
module com { module sun { module star { module accessibility {
published interface XAccessibleKeyBinding;
/** Implement this interface to give access to actions that can be executed
for accessible objects.
<p>Every accessible object that can be manipulated beyond its methods
exported over the accessibility API should support this interface to
expose all actions that it can perform. Each action can be performed or
be queried for a description or associated key bindings.</p>
@since OOo 1.1.2
*/
published interface XAccessibleAction : ::com::sun::star::uno::XInterface
{
/** Returns the number of accessible actions available in this object.
<p>If there are more than one, the first one is considered the
"default" action of the object.</p>
@return
The returned value of the number of actions is zero if there are
no actions.
*/
long getAccessibleActionCount ();
/** Perform the specified Action on the object.
@param nIndex
This index specifies the action to perform. If it lies outside
the valid range <FALSE/> is returned and no action is performed.
@return
Returns <TRUE/> if the action was successfully performed. If
the action could not be performed successfully <FALSE/> is
returned.
@throws IndexOutOfBoundsException
If no action with the given index exists then an
<type scope="::com::sun::star::lang">IndexOutOfBoundsException</type>
exception is thrown.
*/
boolean doAccessibleAction ([in] long nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns a description of the specified action of the object.
@param nIndex
This index specifies the action of which to return a
description. If it lies outside the valid range an empty string
is returned.
@return
The returned value is a localized string of the specified action.
@throws IndexOutOfBoundsException
If the given index lies not in the valid range then an
<type scope="::com::sun::star::lang">IndexOutOfBoundsException</type>
exception is thrown.
*/
string getAccessibleActionDescription ([in] long nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
/** Returns a key binding object, if there is one, associated with the
specified action. Note that there can be several alternative key
bindings for an action. See <type>XAccessibleKeyBinding</type> for
more information about how key bindings are represented.
@param nIndex
This index specifies the action of which to return the key
binding.
@return
The returned object describes a set of key bindings associated
with the specified action.
@throws IndexOutOfBoundsException
if the given index is not valid.
*/
XAccessibleKeyBinding getAccessibleActionKeyBinding ([in] long nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
};
}; }; }; };
#endif
|
