blob: c131d9c19815027ef93b52c89247d742c829f7ec (
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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_XAccessibleKeyBinding_idl__
#define __com_sun_star_accessibility_XAccessibleKeyBinding_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_awt_KeyStroke_idl__
#include <com/sun/star/awt/KeyStroke.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 {
/** This interface can be used to represent any number of key bindings which
then can be associated to a certain action.
<p>There can be zero, one, or more key bindings. Each key binding consists
of a sequence of <type scope="::com::sun::star::awt">KeyStroke</type>
objects. The association of an action with a key binding is established
by the <type>XAccessibleAction</type> interface returning an
<type>XAccessibleKeyBinding</type> object.</p>
<p>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 </p>
@since OOo 1.1.2
*/
published interface XAccessibleKeyBinding : ::com::sun::star::uno::XInterface
{
/** Return the number of available key bindings.
@return
The returned value may be 0 to indicate that there are no key
bindings or the positive number of the available key bindings.
*/
long getAccessibleKeyBindingCount ();
/** 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.
@param 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 <member>geetAccessibleKeyBindingCount()</member>
method.
@return
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.
*/
sequence<::com::sun::star::awt::KeyStroke> getAccessibleKeyBinding ([in] long nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException);
};
}; }; }; };
#endif
|
