LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XAccessibleKeyBinding Interface Reference

This interface can be used to represent any number of key bindings which then can be associated to a certain action. More...

import"XAccessibleKeyBinding.idl";

Inheritance diagram for XAccessibleKeyBinding:
XInterface

Public Member Functions

long getAccessibleKeyBindingCount ()
 Return the number of available key bindings. More...
 
sequence<::com::sun::star::awt::KeyStrokegetAccessibleKeyBinding ([in] long nIndex) raises (::com::sun::star::lang::IndexOutOfBoundsException)
 The returned sequence of key strokes describes one method to invoke the associated action (the one from which you obtained the object at which you called this method) by pressing keys. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

This interface can be used to represent any number of key bindings which then can be associated to a certain action.

There can be zero, one, or more key bindings. Each key binding consists of a sequence of com::sun::star::awt::KeyStroke objects. The association of an action with a key binding is established by the XAccessibleAction interface returning an XAccessibleKeyBinding object.

A key binding describes alternative ways how to invoke an action with pressing one or more keys after each other. Each individual sequence of key strokes

Since
OOo 1.1.2

Member Function Documentation

sequence<::com::sun::star::awt::KeyStroke> getAccessibleKeyBinding ( [in] long  nIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException
)

The returned sequence of key strokes describes one method to invoke the associated action (the one from which you obtained the object at which you called this method) by pressing keys.

The keys specified by each of the returned key strokes have to be pressed at the same time (the Control-key and the A-key for example). The keys of one key stroke have to be released before pressing those of the next. The order of the key strokes in the sequence define the order in which to press them.

Parameters
nIndexThe index selects one of alternative key bindings. It has to non-negative and smaller then the number of key bindings as returned by the getAccessibleKeyBindingCount() method.
Returns
The returned sequence of key strokes specifies one way to invoke the associated action. The sequence may be empty (but should not be; better not to return such a key binding at all).
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif the index is not valid.
long getAccessibleKeyBindingCount ( )

Return the number of available key bindings.

Returns
The returned value may be 0 to indicate that there are no key bindings or the positive number of the available key bindings.

The documentation for this interface was generated from the following file: