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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module accessibility {
  21
  22 /** This interface can be used to represent any number of key bindings which
  23     then can be associated to a certain action.
  24
  25     <p>There can be zero, one, or more key bindings.  Each key binding consists
  26     of a sequence of ::com::sun::star::awt::KeyStroke
  27     objects.  The association of an action with a key binding is established
  28     by the XAccessibleAction interface returning an
  29     XAccessibleKeyBinding object.</p>
  30
  31     <p>A key binding describes alternative ways how to invoke an action with
  32     pressing one or more keys after each other.  Each individual sequence of
  33     key strokes </p>
  34
  35     @since OOo 1.1.2
  36 */
  37 interface XAccessibleKeyBinding : ::com::sun::star::uno::XInterface
  38 {
  39     /** Return the number of available key bindings.
  40         @return
  41             The returned value may be 0 to indicate that there are no key
  42             bindings or the positive number of the available key bindings.
  43     */
  44     long getAccessibleKeyBindingCount ();
  45
  46     /** The returned sequence of key strokes describes one method to invoke
  47         the associated action (the one from which you obtained the object at
  48         which you called this method) by pressing keys.  The keys specified
  49         by each of the returned key strokes have to be pressed at the same
  50         time (the Control-key and the A-key for example).  The keys of
  51         one key stroke have to be released before pressing those of the
  52         next.  The order of the key strokes in the sequence define the order
  53         in which to press them.
  54         @param nIndex
  55             The index selects one of alternative key bindings.  It has to
  56             non-negative and smaller then the number of key bindings as
  57             returned by the getAccessibleKeyBindingCount()
  58             method.
  59         @return
  60            The returned sequence of key strokes specifies one way to invoke
  61            the associated action.  The sequence may be empty (but should
  62            not be; better not to return such a key binding at all).
  63         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  64             if the index is not valid.
  65     */
  66     sequence<::com::sun::star::awt::KeyStroke> getAccessibleKeyBinding ([in] long nIndex)
  67         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  68 };
  69
  70 }; }; }; };
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */