offapi/com/sun/star/accessibility/XAccessibleAction.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: XAccessibleAction.idl,v $
  10  * $Revision: 1.9 $
  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_XAccessibleAction_idl__
  32 #define __com_sun_star_accessibility_XAccessibleAction_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_lang_IndexOutOfBoundsException_idl__
  38 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  39 #endif
  40
  41 module com { module sun { module star { module accessibility {
  42
  43  published interface XAccessibleKeyBinding;
  44
  45 /** Implement this interface to give access to actions that can be executed
  46     for accessible objects.
  47
  48     <p>Every accessible object that can be manipulated beyond its methods
  49     exported over the accessibility API should support this interface to
  50     expose all actions that it can perform.  Each action can be performed or
  51     be queried for a description or associated key bindings.</p>
  52
  53     @since OOo 1.1.2
  54 */
  55 published interface XAccessibleAction : ::com::sun::star::uno::XInterface
  56 {
  57     /** Returns the number of accessible actions available in this object.
  58
  59         <p>If there are more than one, the first one is considered the
  60         "default" action of the object.</p>
  61
  62         @return
  63             The returned value of the number of actions is zero if there are
  64             no actions.
  65     */
  66     long getAccessibleActionCount ();
  67
  68     /** Perform the specified Action on the object.
  69
  70         @param nIndex
  71             This index specifies the action to perform.  If it lies outside
  72             the valid range <FALSE/> is returned and no action is performed.
  73         @return
  74             Returns <TRUE/> if the action was successfully performed.  If
  75             the action could not be performed successfully <FALSE/> is
  76             returned.
  77
  78         @throws IndexOutOfBoundsException
  79             If no action with the given index exists then an
  80             <type scope="::com::sun::star::lang">IndexOutOfBoundsException</type>
  81             exception is thrown.
  82     */
  83     boolean     doAccessibleAction ([in] long nIndex)
  84         raises (::com::sun::star::lang::IndexOutOfBoundsException);
  85
  86     /** Returns a description of the specified action of the object.
  87
  88         @param nIndex
  89             This index specifies the action of which to return a
  90             description.  If it lies outside the valid range an empty string
  91             is returned.
  92
  93         @return
  94             The returned value is a localized string of the specified action.
  95
  96         @throws IndexOutOfBoundsException
  97             If the given index lies not in the valid range then an
  98             <type scope="::com::sun::star::lang">IndexOutOfBoundsException</type>
  99             exception is thrown.
 100     */
 101     string getAccessibleActionDescription ([in] long nIndex)
 102         raises (::com::sun::star::lang::IndexOutOfBoundsException);
 103
 104     /** Returns a key binding object, if there is one, associated with the
 105         specified action.  Note that there can be several alternative key
 106         bindings for an action.  See <type>XAccessibleKeyBinding</type> for
 107         more information about how key bindings are represented.
 108
 109         @param nIndex
 110             This index specifies the action of which to return the key
 111             binding.
 112
 113         @return
 114             The returned object describes a set of key bindings associated
 115             with the specified action.
 116
 117         @throws IndexOutOfBoundsException
 118             if the given index is not valid.
 119     */
 120     XAccessibleKeyBinding getAccessibleActionKeyBinding ([in] long nIndex)
 121         raises (::com::sun::star::lang::IndexOutOfBoundsException);
 122 };
 123
 124 }; }; }; };
 125
 126 #endif