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