Interface XKeyHandler

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

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

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

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

interface XKeyHandler

Base Hierarchy

::com::sun::star::lang::XEventListener
+ |
+ +-XKeyHandler

Description: This key handler is similar to ::com::sun::star::awt::XKeyListener but allows the + consumotion of key events. If a key event is consumed by one + handler both the following handlers, with respect to the list of key + handlers of the broadcaster, and a following handling by the + broadcaster will not take place. +

Methods' Summary
keyPressed	This function is called by the broadcaster, an XExtendedToolkit for + instance, after a key has been pressed but before it is released. + The return value decides about whether other handlers will be + called and a handling by the broadcaster will take place. + +
keyReleased	This function is called by the broadcaster, an XExtendedToolkit for + instance, after a key has been pressed and released. The return + value decides about whether other handlers will be called and a + handling by the broadcaster will take place. + +

+ + + + + + + + + + +

Methods' Details

keyPressed + + + + +

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

boolean
+keyPressed(

+aEvent );

Description

This function is called by the broadcaster, an XExtendedToolkit for + instance, after a key has been pressed but before it is released. + The return value decides about whether other handlers will be + called and a handling by the broadcaster will take place. + +

Consume the event if the action performed by the implementation + is mutualy exclusive with the default action of the broadcaster or, + when known, with that of other handlers.

+ +

Consuming this event does not prevent the pending key-release + event of beeing broadcasted.

+ +

Parameter aEvent

+ The key event informs about the pressed key. +

Returns

+ When false is returned the other handlers are called and a + following handling of the event by the broadcaster takes place. + Otherwise, when true is returned, no other handler will be + called and the broadcaster will take no further actions + regarding the event. +

keyReleased + + + + +

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

boolean
+keyReleased(

+aEvent );

Description: This function is called by the broadcaster, an XExtendedToolkit for + instance, after a key has been pressed and released. The return + value decides about whether other handlers will be called and a + handling by the broadcaster will take place. + +; Consume the event if the action performed by the implementation + is mutualy exclusive with the default action of the broadcaster or, + when known, with that of other handlers.
+ +
Parameter aEvent: + The key event informs about the pressed key. +
Returns: + When false is returned the other handlers are called and a + following handling of the event by the broadcaster takes place. + Otherwise, when true is returned, no other handler will be + called and the broadcaster will take no further actions + regarding the event. +

+ + +

+ +

+ 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/XMouseClickHandler-xref.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XMouseClickHandler-xref.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XMouseClickHandler-xref.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,127 @@ + + + + + + +Uses of Interface XMouseClickHandler-xref + + + + + + + + + +

+ +

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

Use

Devguide

XUserInputInterception::addMouseClickHandler()
+XUserInputInterception::removeMouseClickHandler()
+

+ + + + + + + +

uses of interface XMouseClickHandler

back to interface XMouseClickHandler
+
+ +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

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

+ + +

+ +

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

+ +

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

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

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

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

interface XMouseClickHandler

Base Hierarchy

::com::sun::star::lang::XEventListener
+ |
+ +-XMouseClickHandler

Description: makes it possible to receive events from the mouse in a certain window. +

Methods' Summary
mousePressed	gets invoked when a mouse button has been pressed on a window. +
mouseReleased	gets invoked when a mouse button has been released on a window. +

+ + + + + + + + + + +

Methods' Details

mousePressed + + + + +

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

boolean
+mousePressed(

+e );

Description: gets invoked when a mouse button has been pressed on a window. +

mouseReleased + + + + +

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

boolean
+mouseReleased(

+e );

Description: gets invoked when a mouse button has been released on a window. +

+ + +

+ +

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

+ +

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

Use

Devguide

+ + + + + + + +

uses of interface XUserInputInterception

back to interface XUserInputInterception
+
+ +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/XUserInputInterception.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XUserInputInterception.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/awt/XUserInputInterception.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,251 @@ + + + + + + +Interface XUserInputInterception + + + + + + + + + +

+ +

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

Devguide

+ + + + + + + +

Attributes' Summary

Attributes' Details

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

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

interface XUserInputInterception

Base Hierarchy

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

Methods' Summary
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. +
addMouseClickHandler
removeMouseClickHandler

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

Methods' Details

addKeyHandler + + + + +

[oneway] void
+addKeyHandler(

+[in] XKeyHandler

removeKeyHandler + + + + +

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.) +

[oneway] void
+removeKeyHandler(

+[in] XKeyHandler

addMouseClickHandler + + + + +

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. +

[oneway] void
+addMouseClickHandler(

+[in] XMouseClickHandler

removeMouseClickHandler + + + + +

[oneway] void
+removeMouseClickHandler(

+[in] XMouseClickHandler

+ + +

+ +

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

+ +

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

Module

Use

Devguide

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

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

Nested Modules

Services

Singletons

Interfaces

Structs

Exceptions

Enums

Typedefs

Constant Groups

+ + + + + + + + + +

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

module awt

Services
AccessibleButton	specifies accessibility support for a button. +
AccessibleCheckBox	specifies accessibility support for a check box. +
AccessibleComboBox	specifies accessibility support for a combo box. + +
AccessibleDropDownComboBox	specifies accessibility support for a dropdown combo box. + +
AccessibleDropDownListBox	specifies accessibility support for a dropdown list box. + +
AccessibleEdit	specifies accessibility support for an edit. +
AccessibleFixedText	specifies accessibility support for a fixed text. +
AccessibleIconChoiceControl	specifies accessibility support for a iconchoicecontrol. + +
AccessibleIconChoiceControlEntry	specifies accessibility support for a iconchoicecontrol entry. + +
AccessibleList	Accessible lists are used by combo boxes as container for + the list items. The drafts::com::sun::star::accessibility::XAccessibleSelection interface is not + supported at the moment due to implementation problems. Selection of + items is handled by the items and the edit field of the combo box. + +
AccessibleListBox	specifies accessibility support for a list box. + +
AccessibleListBoxList	Accessible list box lists are used by list boxes as container for + the list items. In addtion of the simple container functionality of the + AccessibleList service the + drafts::com::sun::star::accessibility::XAccessibleSelection interface is supported. +
AccessibleListItem	specifies accessibility support for a list item. + +
AccessibleMenu	specifies accessibility support for a menu. +
AccessibleMenuBar	specifies accessibility support for a menu bar. +
AccessibleMenuItem	specifies accessibility support for a menu item. +
AccessibleMenuSeparator	specifies accessibility support for a menu separator. +
AccessiblePopupMenu	specifies accessibility support for a popup menu. +
AccessibleRadioButton	specifies accessibility support for a radio button. +
AccessibleScrollBar	specifies accessibility support for a scroll bar. +
AccessibleStatusBar	specifies accessibility support for a status bar. +
AccessibleStatusBarItem	specifies accessibility support for a status bar item. +
AccessibleTabBar	specifies accessibility support for a tabbar. +
AccessibleTabBarPage	specifies accessibility support for a tabbar page. +
AccessibleTabBarPageList	specifies accessibility support for a tabbar page list. +
AccessibleTabControl	specifies accessibility support for a tab control. +
AccessibleTabPage	specifies accessibility support for a tab page. +
AccessibleTextField	Text fields are like edit fields as described by the + AccessibleEdit service but with the ability to edit the + text. +
AccessibleToolBox	specifies accessibility support for a tool box. + +
AccessibleToolBoxItem	specifies accessibility support for a tool box item. + +
AccessibleTreeListBox	specifies accessibility support for a treelistbox. + +
AccessibleTreeListBoxEntry	specifies accessibility support for a treelistbox entry. + +
AccessibleWindow	specifies accessibility support for a window. +

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

Interfaces
XExtendedToolkit	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. + +
XKeyHandler	This key handler is similar to ::com::sun::star::awt::XKeyListener but allows the + consumotion of key events. If a key event is consumed by one + handler both the following handlers, with respect to the list of key + handlers of the broadcaster, and a following handling by the + broadcaster will not take place. +
XMouseClickHandler	makes it possible to receive events from the mouse in a certain window. +
XUserInputInterception

+ + + + + + + + +

Structs
KeyStroke	Describes a key stroke for hotkeys etc. +

+ + +

+ +

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

+ +

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

Use

Devguide

+ + + + + + + +

uses of service AccessibleChartDocumentView

back to service AccessibleChartDocumentView
+
+ +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/chart/AccessibleChartDocumentView.html ============================================================================== --- websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/chart/AccessibleChartDocumentView.html (added) +++ websites/staging/ooo-site/trunk/content/ui/accessibility/apiref/drafts/com/sun/star/chart/AccessibleChartDocumentView.html Mon Nov 28 00:45:46 2011 @@ -0,0 +1,231 @@ + + + + + + +Service AccessibleChartDocumentView + + + + + + + + + +

+ +

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

Devguide

+ + + + + + + +

Included Services

Exported Interfaces

Properties' Summary

Properties' Details

+ + + + + + + + + + +

:: drafts :: com :: sun :: star :: chart ::

service AccessibleChartDocumentView

Description: The AccessibleChartDocumentView service is supported + by a Component that represents the view of a Chart document to + provide an entry point to the document tree for accessibility. + +; An object that implements the AccessibleChartDocumentView + service provides information about itself and about the chart + subcomponents contained in the chart document displayed in a + window. This service gives a simplified view on the underlying + implementation. It tries both to keep the structure of the + accessibility representation tree as simple as possible and + provide as much relevant information as possible.
+

Exported Interfaces
::drafts::com::sun::star::accessibility::XAccessible	+ Description + Base interface for being accessible. It gives access to the + ::XAccessibleContext interface. + + +
::drafts::com::sun::star::accessibility::XAccessibleContext	+ Description + Provide access to a Chart document's view. + + + You can access the following information: + + Role + The object's role is + AccessibleRole::DOCUMENT . + Name + Its name is the document's name or the base name of the filename if + no document name has been set explicitly. + Description + The description is the document's description or the + full filename if no description has been set + explicitly. + Children + The subcomponents of a chart. This includes all kinds of + titles, a legend and the diagram. The diagram and the legend are + the only children that themselves contain children. The Chart + subcomponents support the service + AccessibleChartElement . Additionally, there may be + shapes a user added via the clipboard. For details see the + drafts::com::sun::star::drawing::AccessibleShape . + + Parent + The parent will usually be the window that contains the + Chart document view. It has to be set via implementation dependent + ways. + Relations + At the moment relations are not supported. The method + drafts::com::sun::star::accessibility::XAccessibleContext::getAccessibleRelationSet + will always return an empty set. + States + The following states are supported: + + AccessibleStateType::DEFUNC + is set if a document view becomes obsolete like when + the window, which displays the view, is closed. + AccessibleStateType::ENABLED + is always set unless the + AccessibleStateType::DEFUNC + state is set. + AccessibleStateType::OPAQUE + is always set. + AccessibleStateType::SHOWING + is always set unless the + AccessibleStateType::DEFUNC + state is set. + AccessibleStateType::VISIBLE + is always set unless the + AccessibleStateType::DEFUNC + state is set. + + + Locale + Is the locale set at the document. + Property change listeners + They are supported to inform the + listeners about changes in this object. + + + +
::drafts::com::sun::star::accessibility::XAccessibleComponent	+ Description + Provide access to a Chart document's graphical representation. + + + The main purpose of this interface is to provide a bounding + box of the currently visible area and to let the user find the + subcomponents of a chart that cover a given test point. + + The accessible Chart subcomponents all support the service + AccessibleChartElement + + + See also + AccessibleChartElement + + + +

+
Top of Page

+ + +

+ +

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

+ +

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

Use

Devguide

+ + + + + + + +

uses of service AccessibleChartElement

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