1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_accessibility_XAccessibleKeyBinding_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_accessibility_XAccessibleKeyBinding_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_KeyStroke_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/KeyStroke.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 34*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 35*b1cdbd2cSJim Jagielski#endif 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module accessibility { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski/** This interface can be used to represent any number of key bindings which 40*b1cdbd2cSJim Jagielski then can be associated to a certain action. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski <p>There can be zero, one, or more key bindings. Each key binding consists 43*b1cdbd2cSJim Jagielski of a sequence of <type scope="::com::sun::star::awt">KeyStroke</type> 44*b1cdbd2cSJim Jagielski objects. The association of an action with a key binding is established 45*b1cdbd2cSJim Jagielski by the <type>XAccessibleAction</type> interface returning an 46*b1cdbd2cSJim Jagielski <type>XAccessibleKeyBinding</type> object.</p> 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski <p>A key binding describes alternative ways how to invoke an action with 49*b1cdbd2cSJim Jagielski pressing one or more keys after each other. Each individual sequence of 50*b1cdbd2cSJim Jagielski key strokes </p> 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski @since OpenOffice 1.1.2 53*b1cdbd2cSJim Jagielski*/ 54*b1cdbd2cSJim Jagielskipublished interface XAccessibleKeyBinding : ::com::sun::star::uno::XInterface 55*b1cdbd2cSJim Jagielski{ 56*b1cdbd2cSJim Jagielski /** Return the number of available key bindings. 57*b1cdbd2cSJim Jagielski @return 58*b1cdbd2cSJim Jagielski The returned value may be 0 to indicate that there are no key 59*b1cdbd2cSJim Jagielski bindings or the positive number of the available key bindings. 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski long getAccessibleKeyBindingCount (); 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski /** The returned sequence of key strokes describes one method to invoke 64*b1cdbd2cSJim Jagielski the associated action (the one from which you obtained the object at 65*b1cdbd2cSJim Jagielski which you called this method) by pressing keys. The keys specified 66*b1cdbd2cSJim Jagielski by each of the returned key strokes have to be pressed at the same 67*b1cdbd2cSJim Jagielski time (the Control-key and the A-key for example). The keys of 68*b1cdbd2cSJim Jagielski one key stroke have to be released before pressing those of the 69*b1cdbd2cSJim Jagielski next. The order of the key strokes in the sequence define the order 70*b1cdbd2cSJim Jagielski in which to press them. 71*b1cdbd2cSJim Jagielski @param nIndex 72*b1cdbd2cSJim Jagielski The index selects one of alternative key bindings. It has to 73*b1cdbd2cSJim Jagielski non-negative and smaller then the number of key bindings as 74*b1cdbd2cSJim Jagielski returned by the <member>geetAccessibleKeyBindingCount()</member> 75*b1cdbd2cSJim Jagielski method. 76*b1cdbd2cSJim Jagielski @return 77*b1cdbd2cSJim Jagielski The returned sequence of key strokes specifies one way to invoke 78*b1cdbd2cSJim Jagielski the associated action. The sequence may be empty (but should 79*b1cdbd2cSJim Jagielski not be; better not to return such a key binding at all). 80*b1cdbd2cSJim Jagielski @throws ::com::sun::star::lang::IndexOutOfBoundsException 81*b1cdbd2cSJim Jagielski if the index is not valid. 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski sequence<::com::sun::star::awt::KeyStroke> getAccessibleKeyBinding ([in] long nIndex) 84*b1cdbd2cSJim Jagielski raises (::com::sun::star::lang::IndexOutOfBoundsException); 85*b1cdbd2cSJim Jagielski}; 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski}; }; }; }; 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski#endif 90