1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright IBM Corporation 2010.
6 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 *
8 * OpenOffice.org - a multi-platform office productivity suite
9 *
10 * This file is part of OpenOffice.org.
11 *
12 * OpenOffice.org is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU Lesser General Public License version 3
14 * only, as published by the Free Software Foundation.
15 *
16 * OpenOffice.org is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU Lesser General Public License version 3 for more details
20 * (a copy is included in the LICENSE file that accompanied this code).
21 *
22 * You should have received a copy of the GNU Lesser General Public License
23 * version 3 along with OpenOffice.org.  If not, see
24 * <http://www.openoffice.org/license.html>
25 * for a copy of the LGPLv3 License.
26 *
27 ************************************************************************/
28
29import "objidl.idl";
30import "oaidl.idl";
31import "oleacc.idl";
32import "AccessibleKeyStroke.idl";
33
34[object, uuid(6B1923AC-3E9A-4336-99E1-A69EA4E946E9)]
35interface IAccessibleKeyBinding : IUnknown
36{
37  ///
38  /// get number of key bindings for this object
39  ///
40  [propget] HRESULT nKeyBindings
41    (
42     [out, retval] long *nKeyBindings
43     );
44
45  ///
46  /// get length of keystroke sequence for specified key binding
47  ///
48  [propget] HRESULT keyStrokeSequenceLength
49    (
50     [in] long keyBindingIndex,
51     [out] long *sequenceLength
52     );
53
54  ///
55  /// The returned sequence of key strokes describes one method
56  /// to invoke the associated action (the one from which you
57  /// obtained the object at which you called this method) by
58  /// pressing keys. The keys specified by each of the returned
59  /// key strokes have to be pressed at the same time (the
60  /// Control-key and the A-key for example). The keys of one key
61  /// stroke have to be released before pressing those of the next.
62  /// The order of the key strokes in the sequence define the order
63  /// in which to press them.
64  ///
65  [propget] HRESULT keyBinding
66    (
67     [in] long keyBindingIndex,
68     [in] long keyStrokeSequenceLength,
69     [out, size_is(,keyStrokeSequenceLength), length_is(,*actualKeyStrokeSequenceLength)]
70       ACCESSIBLE_KEYSTROKE **keyStroke,
71     [out, retval] long *actualKeyStrokeSequenceLength
72     );
73}
74