Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: accessibility ::

interface XAccessibleKeyBinding
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
Developers Guide
Accessibility - XAccessibleKeyBinding

Methods' Summary
getAccessibleKeyBindingCount Return the number of available key bindings.  
getAccessibleKeyBinding 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.  
Methods' Details
getAccessibleKeyBindingCount
long
getAccessibleKeyBindingCount();

Description
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.
getAccessibleKeyBinding
sequence< ::com::sun::star::awt::KeyStroke >
getAccessibleKeyBinding( [in] long  nIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
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.
Parameter nIndex
The index selects one of alternative key bindings. It has to non-negative and smaller then the number of key bindings as returned by the geetAccessibleKeyBindingCount() 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).
Throws
::com::sun::star::lang::IndexOutOfBoundsException if the index is not valid.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.