Service AccessibleTreeListBox

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Properties' Summary

Properties' Details

+ + + + + + + + + + +

:: drafts :: com :: sun :: star :: awt ::

service AccessibleTreeListBox

Description: specifies accessibility support for a treelistbox. + +
See also: drafts::com::sun::star::accessibility::AccessibleContext
+ + +
See also: drafts::com::sun::star::accessibility::XAccessibleComponent
+ +
See also: drafts::com::sun::star::accessibility::XAccessibleSelection
+ +

+ + + + + + + + +

Included Services
::drafts::com::sun::star::accessibility::AccessibleContext	+ Central service of the Accessibility API that gives access to various + facets of an object's content. + +

Exported Interfaces
::drafts::com::sun::star::accessibility::XAccessibleComponent	+ The ::drafts::com::sun::star::accessibility::XAccessibleComponent interface should be supported by + any class that can be rendered on the screen. + +
::drafts::com::sun::star::accessibility::XAccessibleSelection	+ Implement this interface to represent a selection of accessible objects. + +

+
Top of Page

+ + +

+ +

+ Apache "OpenOffice.org" is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. + Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and + decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is + not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has + yet to be fully endorsed by the ASF.

+ Contact Us | + Terms of Use +
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. +
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. +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleTreeListBoxEntry-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleTreeListBoxEntry-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleTreeListBoxEntry-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,108 @@ + + + + + + +Uses of Service AccessibleTreeListBoxEntry-xref + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of service AccessibleTreeListBoxEntry

back to service AccessibleTreeListBoxEntry
+
+ +Services which Include this Service
+ +Singletons which Instantiate this Service
+ +References in Developers Guide
+ +

+ + + + + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleTreeListBoxEntry.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleTreeListBoxEntry.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleTreeListBoxEntry.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,181 @@ + + + + + + +Service AccessibleTreeListBoxEntry + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Properties' Summary

Properties' Details

+ + + + + + + + + + +

:: drafts :: com :: sun :: star :: awt ::

service AccessibleTreeListBoxEntry

Description: specifies accessibility support for a treelistbox entry. + +
See also: drafts::com::sun::star::accessibility::AccessibleContext
+ + +
See also: drafts::com::sun::star::accessibility::XAccessibleAction
+ +
See also: drafts::com::sun::star::accessibility::XAccessibleSelection
+ +
See also: drafts::com::sun::star::accessibility::XAccessibleText
+ +

+ + + + + + + + +

Included Services
::drafts::com::sun::star::accessibility::AccessibleContext	+ Central service of the Accessibility API that gives access to various + facets of an object's content. + +

Exported Interfaces
::drafts::com::sun::star::accessibility::XAccessibleComponent	+ The ::drafts::com::sun::star::accessibility::XAccessibleComponent interface should be supported by + any class that can be rendered on the screen. + +
::drafts::com::sun::star::accessibility::XAccessibleAction	+ Implement this interface to give access to actions that can be executed + for accessible objects. + +
::drafts::com::sun::star::accessibility::XAccessibleSelection	+ Implement this interface to represent a selection of accessible objects. + +
::drafts::com::sun::star::accessibility::XAccessibleText	+ Implement this interface to give read-only access to a text. + +

+
Top of Page

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleWindow-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleWindow-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleWindow-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,108 @@ + + + + + + +Uses of Service AccessibleWindow-xref + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of service AccessibleWindow

back to service AccessibleWindow
+
+ +Services which Include this Service
+ +Singletons which Instantiate this Service
+ +References in Developers Guide
+ +

+ + + + + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleWindow.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleWindow.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/AccessibleWindow.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,157 @@ + + + + + + +Service AccessibleWindow + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Included Services

Exported Interfaces

Properties' Summary

Properties' Details

+ + + + + + + + + + +

:: drafts :: com :: sun :: star :: awt ::

service AccessibleWindow

Description: specifies accessibility support for a window. +

Exported Interfaces
::drafts::com::sun::star::accessibility::XAccessibleContext	+ Implement this interface for exposing various aspects of a class' + content. + +
::drafts::com::sun::star::accessibility::XAccessibleEventBroadcaster	+ makes it possible to register listeners which are called whenever + an accessibility event (see ::drafts::com::sun::star::accessibility::AccessibleEventObject ) occurs. + +
::drafts::com::sun::star::accessibility::XAccessibleComponent	+ The ::drafts::com::sun::star::accessibility::XAccessibleComponent interface should be supported by + any class that can be rendered on the screen. + +
::drafts::com::sun::star::accessibility::XAccessibleExtendedComponent	+ The ::AccessibleExtendedComponent interface contains + additional methods to those of the ::AccessibleComponent + interface. These methods provide more seldom used information. The + division into two interfaces allows classes to support the more + frequently used methods of the ::AccessibleComponent + interface and only support the ::AccessibleExtendedComponent + interface if that makes sense for the class. + +

+
Top of Page

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/KeyStroke-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/KeyStroke-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/KeyStroke-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,114 @@ + + + + + + +Uses of Struct KeyStroke-xref + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of struct KeyStroke

back to struct KeyStroke
+
+ +Derived Structs
+ +Synonym Typedefs
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

+ + + + + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/KeyStroke.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/KeyStroke.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/KeyStroke.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,220 @@ + + + + + + +Struct KeyStroke + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Devguide

+ + + + + +

+ + + + + + + + + + + + +

:: drafts :: com :: sun :: star :: awt ::

struct KeyStroke

Description: Describes a key stroke for hotkeys etc. +

Elements' Summary
Modifiers	contains the modifier keys which were pressed while event occurred. + +
KeyCode	contains the integer code representing the key of the event. + +
KeyChar	contains the Unicode character generated by this event or 0. +
KeyFunc	contains the function type of the key event. + +

+ + + + + + + + + + + + + + + + +

Elements' Details

Modifiers + + + + +

short Modifiers;

Description: contains the modifier keys which were pressed while event occurred. + +; Zero or more constants from the group + com::sun::star::awt::KeyModifier .
+

KeyCode + + + + +

short KeyCode;

Description: contains the integer code representing the key of the event. + +; This is a constant from the constant group + com::sun::star::awt::Key .
+

KeyChar + + + + +

char KeyChar;

Description: contains the Unicode character generated by this event or 0. +

KeyFunc + + + + +

short KeyFunc;

Description: contains the function type of the key event. + +; This is a constant from the constant group + com::sun::star::awt::KeyFunction .
+

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XExtendedToolkit-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XExtendedToolkit-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XExtendedToolkit-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,116 @@ + + + + + + +Uses of Interface XExtendedToolkit-xref + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

+ + + + + + + +

uses of interface XExtendedToolkit

back to interface XExtendedToolkit
+
+ +Derived Interfaces
+ +Synonym Typedefs
+ +Services which Support this Interface
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XExtendedToolkit.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XExtendedToolkit.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XExtendedToolkit.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,583 @@ + + + + + + +Interface XExtendedToolkit + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

+ + + + + + + + + + + + + +

:: drafts :: com :: sun :: star :: awt ::

interface XExtendedToolkit

Base Hierarchy

::com::sun::star::uno::XInterface
+ |
+ +-XExtendedToolkit

Description

The XExtendedToolkit is an extension of the ::com::sun::star::awt::XToolkit interface. It basically + provides access to three event broadcasters which are used for instance + in the context of accessibility. It is, however, not restricted to + accessibility. + +

The first event broadcaster lets you keep track of the open top-level + windows (frames). To get the set of currently open top-level window use + the getTopWindowCount and + getTopWindow methods.

+ +

The second event broadcaster informs its listeners of key events. + Its listeners can, unlike with most other broadcasters/listeners, + consume events, so that other listeners will not be called for consumed + events.

+ +

The last event broadcaster sends events on focus changes of all + elements that can have the input focus.

Methods' Summary
getTopWindowCount	This function returns the number of currently existing top-level + windows. +
getTopWindow	Return a reference to the specified top-level window. Note that the + number of top-level windows may change between a call to + getTopWindowCount() and successive calls to this + function. +
getActiveTopWindow	Return the currently active top-level window, i.e. which has + currently the input focus. +
addTopWindowListener	Add a new listener that is called on ::com::sun::star::awt::TopWindowEvent s. After having + obtained the current list of exisiting top-level windows you can + keep this list up-to-date by listening to opened or closed top-level + windows. Wait for activations or deactivations of top-level windows + to keep track of the currently active frame. +
removeTopWindowListener	Remove the specified listener from the list of listeners. +
addKeyHandler	Add a new listener that is called on ::com::sun::star::awt::KeyEvent s. Every listener is + given the opportunity to consume the event, i.e. prevent the not yet + called listeners from being called. +
removeKeyHandler	Remove the specified listener from the list of listeners. +
addFocusListener	Add a new listener that is called on ::com::sun::star::awt::FocusEvent s. Use this focus + broadcaster to keep track of the object that currently has the input + focus. +
removeFocusListener	Remove the specified listener from the list of listeners. +
fireFocusGained	Broadcasts the a focusGained on all registered focus listeners +
fireFocusLost	Broadcasts the a focusGained on all registered focus listeners +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods' Details

getTopWindowCount + + + + +

long
+getTopWindowCount();

Description: This function returns the number of currently existing top-level + windows. +
Returns: + Returns the number of top-level windows. This includes all + top-level windows, regardless of whether they are iconized, + visible, or active. +

getTopWindow + + + + +

::com::sun::star::awt::XTopWindow
+getTopWindow(

+[in] long

raises(

+nIndex )
+::com::sun::star::lang::IndexOutOfBoundsException );

Description: Return a reference to the specified top-level window. Note that the + number of top-level windows may change between a call to + getTopWindowCount() and successive calls to this + function. +
Parameter nIndex: + The index should be in the intervall from 0 up to but not + including the number of top-level windows as returned by + getTopWindowCount() . +
Returns: + The returned value is a valid reference to a top-level window. +
Throws: IndexOutOfBoundsException + when the specified index is outside the valid range. +

getActiveTopWindow + + + + +

::com::sun::star::awt::XTopWindow
+getActiveTopWindow();

Description: Return the currently active top-level window, i.e. which has + currently the input focus. +
Returns: + The returned reference may be empty when no top-level window is + active. +

addTopWindowListener + + + + +

+[in] ::com::sun::star::awt::XTopWindowListener

[oneway] void
+addTopWindowListener(

removeTopWindowListener + + + + +

Description: Add a new listener that is called on ::com::sun::star::awt::TopWindowEvent s. After having + obtained the current list of exisiting top-level windows you can + keep this list up-to-date by listening to opened or closed top-level + windows. Wait for activations or deactivations of top-level windows + to keep track of the currently active frame. +
Parameter xListener: + If this is a valid reference it is inserted into the list of + listeners. It is the task of the caller to not register the + same listener twice (otherwise that listener will be called + twice.) +

+[in] ::com::sun::star::awt::XTopWindowListener

[oneway] void
+removeTopWindowListener(

Description: Remove the specified listener from the list of listeners. +
Parameter xListener: + If the reference is empty then nothing will be changed. If the + listener has been registered twice (or more) then all refrences + will be removed. +

addKeyHandler + + + + +

removeKeyHandler + + + + +

[oneway] void
+addKeyHandler(

+[in] XKeyHandler

+xHandler );

Description: Add a new listener that is called on ::com::sun::star::awt::KeyEvent s. Every listener is + given the opportunity to consume the event, i.e. prevent the not yet + called listeners from being called. +
Parameter xHandler: + If this is a valid reference it is inserted into the list of + handlers. It is the task of the caller to not register the + same handler twice (otherwise that listener will be called + twice.) +

addFocusListener + + + + +

[oneway] void
+removeKeyHandler(

+[in] XKeyHandler

+xHandler );

Description: Remove the specified listener from the list of listeners. +
Parameter xHandler: + If the reference is empty then nothing will be changed. If the + handler has been registered twice (or more) then all refrences + will be removed. +

+[in] ::com::sun::star::awt::XFocusListener

[oneway] void
+addFocusListener(

removeFocusListener + + + + +

Description: Add a new listener that is called on ::com::sun::star::awt::FocusEvent s. Use this focus + broadcaster to keep track of the object that currently has the input + focus. +
Parameter xListener: + If this is a valid reference it is inserted into the list of + listeners. It is the task of the caller to not register the + same listener twice (otherwise that listener will be called + twice.) +

+[in] ::com::sun::star::awt::XFocusListener

[oneway] void
+removeFocusListener(

fireFocusGained + + + + +

Description: Remove the specified listener from the list of listeners. +
Parameter xListener: + If the reference is empty then nothing will be changed. If the + listener has been registered twice (or more) then all refrences + will be removed. +

+[in] ::com::sun::star::uno::XInterface

[oneway] void
+fireFocusGained(

+source );

Description: Broadcasts the a focusGained on all registered focus listeners +
Parameter source: + The object that has gained the input focus. It should implement + com::sun::star::accessibility::XAccessible . +

fireFocusLost + + + + +

+[in] ::com::sun::star::uno::XInterface

[oneway] void
+fireFocusLost(

+source );

Description: Broadcasts the a focusGained on all registered focus listeners +
Parameter source: + The object that has lost the input focus. It should implement + com::sun::star::accessibility::XAccessible . +

+ + +

+ +

+ + + Added: websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XKeyHandler-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XKeyHandler-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XKeyHandler-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,129 @@ + + + + + + +Uses of Interface XKeyHandler-xref + + + + + + + + + +

+ +

+ + + + + + + + + + + + +

Use

Devguide

XUserInputInterception::addKeyHandler()
+XExtendedToolkit::addKeyHandler()
+XUserInputInterception::removeKeyHandler()
+XExtendedToolkit::removeKeyHandler()
+

+ + + + + + + +

uses of interface XKeyHandler

back to interface XKeyHandler
+
+ +Derived Interfaces
+ +Synonym Typedefs
+ +Services which Support this Interface
+ +Uses as Return Type
+ +Uses as Parameter
+ +Uses as Data Type
+ +References in Developers Guide
+ +

+ + + + + + + +

Uses as Parameter