offapi/com/sun/star/accessibility/XAccessibleAction.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  interface XAccessibleKeyBinding;
  23
  24 /** Implement this interface to give access to actions that can be executed
  25     for accessible objects.
  26
  27     <p>Every accessible object that can be manipulated beyond its methods
  28     exported over the accessibility API should support this interface to
  29     expose all actions that it can perform.  Each action can be performed or
  30     be queried for a description or associated key bindings.</p>
  31
  32     @since OOo 1.1.2
  33 */
  34 interface XAccessibleAction : ::com::sun::star::uno::XInterface
  35 {
  36     /** Returns the number of accessible actions available in this object.
  37
  38         <p>If there are more than one, the first one is considered the
  39         "default" action of the object.</p>
  40
  41         @return
  42             The returned value of the number of actions is zero if there are
  43             no actions.
  44     */
  45     long getAccessibleActionCount ();
  46
  47     /** Perform the specified Action on the object.
  48
  49         @param nIndex
  50             This index specifies the action to perform.  If it lies outside
  51             the valid range `FALSE` is returned and no action is performed.
  52         @return
  53             Returns `TRUE` if the action was successfully performed.  If
  54             the action could not be performed successfully `FALSE` is
  55             returned.
  56
  57         @throws IndexOutOfBoundsException
  58             If no action with the given index exists then an
  59             ::com::sun::star::lang::IndexOutOfBoundsException
  60             exception is thrown.
  61     */
  62     boolean doAccessibleAction ([in] long nIndex)
  63         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  64
  65     /** Returns a description of the specified action of the object.
  66
  67         @param nIndex
  68             This index specifies the action of which to return a
  69             description.  If it lies outside the valid range an empty string
  70             is returned.
  71
  72         @return
  73             The returned value is a localized string of the specified action.
  74
  75         @throws IndexOutOfBoundsException
  76             If the given index lies not in the valid range then an
  77             ::com::sun::star::lang::IndexOutOfBoundsException
  78             exception is thrown.
  79     */
  80     string getAccessibleActionDescription ([in] long nIndex)
  81         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  82
  83     /** Returns a key binding object, if there is one, associated with the
  84         specified action.  Note that there can be several alternative key
  85         bindings for an action.  See XAccessibleKeyBinding for
  86         more information about how key bindings are represented.
  87
  88         @param nIndex
  89             This index specifies the action of which to return the key
  90             binding.
  91
  92         @return
  93             The returned object describes a set of key bindings associated
  94             with the specified action.
  95
  96         @throws IndexOutOfBoundsException
  97             if the given index is not valid.
  98     */
  99     XAccessibleKeyBinding getAccessibleActionKeyBinding ([in] long nIndex)
 100         raises (::com::sun::star::lang::IndexOutOfBoundsException);
 101 };
 102
 103 }; }; }; };
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */