offapi/com/sun/star/accessibility/XAccessibleKeyBinding.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XAccessibleKeyBinding.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_accessibility_XAccessibleKeyBinding_idl__
  32 #define __com_sun_star_accessibility_XAccessibleKeyBinding_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_awt_KeyStroke_idl__
  38 #include <com/sun/star/awt/KeyStroke.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  41 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  42 #endif
  43
  44 module com { module sun { module star { module accessibility {
  45
  46 /** This interface can be used to represent any number of key bindings which
  47     then can be associated to a certain action.
  48
  49     <p>There can be zero, one, or more key bindings.  Each key binding consists
  50     of a sequence of <type scope="::com::sun::star::awt">KeyStroke</type>
  51     objects.  The association of an action with a key binding is established
  52     by the <type>XAccessibleAction</type> interface returning an
  53     <type>XAccessibleKeyBinding</type> object.</p>
  54
  55     <p>A key binding describes alternative ways how to invoke an action with
  56     pressing one or more keys after each other.  Each individual sequence of
  57     key strokes </p>
  58
  59     @since OOo 1.1.2
  60 */
  61 published interface XAccessibleKeyBinding : ::com::sun::star::uno::XInterface
  62 {
  63     /** Return the number of available key bindings.
  64         @return
  65             The returned value may be 0 to indicate that there are no key
  66             bindings or the positive number of the available key bindings.
  67     */
  68     long getAccessibleKeyBindingCount ();
  69
  70     /** The returned sequence of key strokes describes one method to invoke
  71         the associated action (the one from which you obtained the object at
  72         which you called this method) by pressing keys.  The keys specified
  73         by each of the returned key strokes have to be pressed at the same
  74         time (the Control-key and the A-key for example).  The keys of
  75         one key stroke have to be released before pressing those of the
  76         next.  The order of the key strokes in the sequence define the order
  77         in which to press them.
  78         @param nIndex
  79             The index selects one of alternative key bindings.  It has to
  80             non-negative and smaller then the number of key bindings as
  81             returned by the <member>geetAccessibleKeyBindingCount()</member>
  82             method.
  83         @return
  84            The returned sequence of key strokes specifies one way to invoke
  85            the associated action.  The sequence may be empty (but should
  86            not be; better not to return such a key binding at all).
  87         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  88             if the index is not valid.
  89     */
  90     sequence<::com::sun::star::awt::KeyStroke> getAccessibleKeyBinding ([in] long nIndex)
  91         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  92 };
  93
  94 }; }; }; };
  95
  96 #endif