<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>at-spi-idl: Accessibility::DeviceEventController Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath">
<ul>
<li><a class="el" href="namespaceAccessibility.html">Accessibility</a> </li>
<li><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html">Accessibility::DeviceEventController</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Accessibility::DeviceEventController Interface Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::DeviceEventController" -->
<p><code>import "<a class="el" href="Accessibility__Registry_8idl_source.html">Accessibility_Registry.idl</a>";</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html#ae821dc139bf3a8cec84d72833ea33b78">registerKeystrokeListener</a> (in <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> listener, in <a class="el" href="namespaceAccessibility.html#a2d52fa6c7a9e5247eb1923733a1c245e">KeySet</a> keys, in <a class="el" href="namespaceAccessibility.html#aaa4b51bda784a1811b91c664733ce277">ControllerEventMask</a> mask, in <a class="el" href="namespaceAccessibility.html#a9f1ab38440ccd0a54bcdf496c58e7a0d">KeyEventTypeSeq</a> type, in <a class="el" href="structAccessibility_1_1EventListenerMode.html">EventListenerMode</a> mode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html#ac3ebac305acfd268bdc9771813fc4808">deregisterKeystrokeListener</a> (in <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> listener, in <a class="el" href="namespaceAccessibility.html#a2d52fa6c7a9e5247eb1923733a1c245e">KeySet</a> keys, in <a class="el" href="namespaceAccessibility.html#aaa4b51bda784a1811b91c664733ce277">ControllerEventMask</a> mask, in <a class="el" href="namespaceAccessibility.html#a9f1ab38440ccd0a54bcdf496c58e7a0d">KeyEventTypeSeq</a> type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html#a7425f266d3f5d1a5838920e0d64de13f">registerDeviceEventListener</a> (in <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> listener, in <a class="el" href="namespaceAccessibility.html#a1e1be7f7621974616fe7932e1b09acc4">EventTypeSeq</a> typeseq)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html#a7eaac0292990f19e2d98e801801fedc1">deregisterDeviceEventListener</a> (in <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> listener, in <a class="el" href="namespaceAccessibility.html#a1e1be7f7621974616fe7932e1b09acc4">EventTypeSeq</a> typeseq)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html#a3382a20d597a2f3d4d75d3d9cd652002">notifyListenersSync</a> (in <a class="el" href="structAccessibility_1_1DeviceEvent.html">DeviceEvent</a> event)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">oneway void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html#ac0a6f00625afca63fb89d02031f92ca5">notifyListenersAsync</a> (in <a class="el" href="structAccessibility_1_1DeviceEvent.html">DeviceEvent</a> event)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html#a33fa42a58c08a2e5c5f703d16a26d334">generateKeyboardEvent</a> (in long keycode, in string keystring, in <a class="el" href="namespaceAccessibility.html#adb1ac6ee9c33067029052869c4ea5eac">KeySynthType</a> type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceAccessibility_1_1DeviceEventController.html#a785bd6e84d72977120b60b99fd7bd3ec">generateMouseEvent</a> (in long x, in long y, in string eventName)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The interface via which clients request notification of device events, and through which device events may be simulated. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7eaac0292990f19e2d98e801801fedc1"></a><!-- doxytag: member="Accessibility::DeviceEventController::deregisterDeviceEventListener" ref="a7eaac0292990f19e2d98e801801fedc1" args="(in DeviceEventListener listener, in EventTypeSeq typeseq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::DeviceEventController::deregisterDeviceEventListener </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> </td>
<td class="paramname"> <em>listener</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#a1e1be7f7621974616fe7932e1b09acc4">EventTypeSeq</a> </td>
<td class="paramname"> <em>typeseq</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>De-register a previously registered keyboard eventlistener. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>listener,:</em> </td><td>a <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> which will intercept events. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>typeseq,:</em> </td><td>an EventTypeSeq indicating which event types to stop listening for. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac3ebac305acfd268bdc9771813fc4808"></a><!-- doxytag: member="Accessibility::DeviceEventController::deregisterKeystrokeListener" ref="ac3ebac305acfd268bdc9771813fc4808" args="(in DeviceEventListener listener, in KeySet keys, in ControllerEventMask mask, in KeyEventTypeSeq type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::DeviceEventController::deregisterKeystrokeListener </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> </td>
<td class="paramname"> <em>listener</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#a2d52fa6c7a9e5247eb1923733a1c245e">KeySet</a> </td>
<td class="paramname"> <em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#aaa4b51bda784a1811b91c664733ce277">ControllerEventMask</a> </td>
<td class="paramname"> <em>mask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#a9f1ab38440ccd0a54bcdf496c58e7a0d">KeyEventTypeSeq</a> </td>
<td class="paramname"> <em>type</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>De-register a previously registered keyboard eventlistener. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>listener,:</em> </td><td>a <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> which will intercept key events. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keys,:</em> </td><td>a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mask,:</em> </td><td>a ControllerEventMask filtering the intercepted key events. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type,:</em> </td><td>an EventType mask that may created by ORing event types together. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a33fa42a58c08a2e5c5f703d16a26d334"></a><!-- doxytag: member="Accessibility::DeviceEventController::generateKeyboardEvent" ref="a33fa42a58c08a2e5c5f703d16a26d334" args="(in long keycode, in string keystring, in KeySynthType type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::DeviceEventController::generateKeyboardEvent </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>keycode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"> <em>keystring</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#adb1ac6ee9c33067029052869c4ea5eac">KeySynthType</a> </td>
<td class="paramname"> <em>type</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Synthesize a keyboard event. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keycode,:</em> </td><td>a long integer indicating the keycode of the keypress to be synthesized. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keystring,:</em> </td><td>an optional UTF-8 string indicating a complex keyboard input event. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type,:</em> </td><td>a KeySynthType indicating the type of event(s) to be synthesized: a key press, release, press-release pair, or a complex input string (for instance from an internationalized or complex text input method, or a composed character).</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>keycode may be truncated before being processed, as keycode length may be platform-dependent and keycode ranges are generally much smaller than CORBA_long. One or the other of keycode or keystring are generally NULL, (but not both), depending on the value of <code>type</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="a785bd6e84d72977120b60b99fd7bd3ec"></a><!-- doxytag: member="Accessibility::DeviceEventController::generateMouseEvent" ref="a785bd6e84d72977120b60b99fd7bd3ec" args="(in long x, in long y, in string eventName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Accessibility::DeviceEventController::generateMouseEvent </td>
<td>(</td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in long </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"> <em>eventName</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Synthesize a mouse event. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>x,:</em> </td><td>a long integer indicating the screen x coord for the mouse event. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y,:</em> </td><td>a long integer indicating the screen y coord for the mouse event. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>eventName,:</em> </td><td>a string indicating the type of mouse event, e.g. "button1up" </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac0a6f00625afca63fb89d02031f92ca5"></a><!-- doxytag: member="Accessibility::DeviceEventController::notifyListenersAsync" ref="ac0a6f00625afca63fb89d02031f92ca5" args="(in DeviceEvent event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oneway void Accessibility::DeviceEventController::notifyListenersAsync </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structAccessibility_1_1DeviceEvent.html">DeviceEvent</a> </td>
<td class="paramname"> <em>event</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Notify the <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> instance that a device event has taken place in an asynchronous manner. This is the method used by accessibility bridges to forward "toolkit dependent" device events to the <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> from the application's process space. If the event in question is potentially pre-emptible. notifyListenersSync should be used instead.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>AT clients do not normally need to use this method, it is intended for use by toolkit bridges and special-purpose applications. </dd></dl>
</div>
</div>
<a class="anchor" id="a3382a20d597a2f3d4d75d3d9cd652002"></a><!-- doxytag: member="Accessibility::DeviceEventController::notifyListenersSync" ref="a3382a20d597a2f3d4d75d3d9cd652002" args="(in DeviceEvent event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::DeviceEventController::notifyListenersSync </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structAccessibility_1_1DeviceEvent.html">DeviceEvent</a> </td>
<td class="paramname"> <em>event</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Notify the <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> instance that a device event has taken place, and allow pre-emptive listeners the opportunity to 'consume' the event and thus prevent its further issuance/forwarding. This is the method used by accessibility bridges to forward "toolkit dependent" device events to the <a class="el" href="interfaceAccessibility_1_1Registry.html">Registry</a> from the application's process space.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>AT clients do not normally need to use this method, it is intended for use by toolkit bridges and special-purpose applications.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the event was consumed by a (pre-emptive) listener, <code>False</code> if not (in which case the device event will be forwarded as normal to any application which would normally receive it, e.g. the currently active application in the case of mouse or keyboard events). </dd></dl>
</div>
</div>
<a class="anchor" id="a7425f266d3f5d1a5838920e0d64de13f"></a><!-- doxytag: member="Accessibility::DeviceEventController::registerDeviceEventListener" ref="a7425f266d3f5d1a5838920e0d64de13f" args="(in DeviceEventListener listener, in EventTypeSeq typeseq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::DeviceEventController::registerDeviceEventListener </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> </td>
<td class="paramname"> <em>listener</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#a1e1be7f7621974616fe7932e1b09acc4">EventTypeSeq</a> </td>
<td class="paramname"> <em>typeseq</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register to intercept events, and either pass them on or consume them. To listen to keyboard events use registerKeystrokeListener instead. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>listener,:</em> </td><td>a <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> which will intercept events. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>typeseq,:</em> </td><td>an EventTypeSeq indicating which event types to listen for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if successful, <code>False</code> if not </dd></dl>
</div>
</div>
<a class="anchor" id="ae821dc139bf3a8cec84d72833ea33b78"></a><!-- doxytag: member="Accessibility::DeviceEventController::registerKeystrokeListener" ref="ae821dc139bf3a8cec84d72833ea33b78" args="(in DeviceEventListener listener, in KeySet keys, in ControllerEventMask mask, in KeyEventTypeSeq type, in EventListenerMode mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean Accessibility::DeviceEventController::registerKeystrokeListener </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> </td>
<td class="paramname"> <em>listener</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#a2d52fa6c7a9e5247eb1923733a1c245e">KeySet</a> </td>
<td class="paramname"> <em>keys</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#aaa4b51bda784a1811b91c664733ce277">ControllerEventMask</a> </td>
<td class="paramname"> <em>mask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="namespaceAccessibility.html#a9f1ab38440ccd0a54bcdf496c58e7a0d">KeyEventTypeSeq</a> </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structAccessibility_1_1EventListenerMode.html">EventListenerMode</a> </td>
<td class="paramname"> <em>mode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register to intercept keyboard events, and either pass them on or consume them.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>listener,:</em> </td><td>a <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> which will intercept key events. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keys,:</em> </td><td>a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mask,:</em> </td><td>a ControllerEventMask filtering the intercepted key events. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type,:</em> </td><td>a KeyEventTypeSeq that may created by ORing event types together. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode,:</em> </td><td>an <a class="el" href="structAccessibility_1_1EventListenerMode.html">EventListenerMode</a> indicating whether the listener should receive the events synchronously, potentially consuming them, or just be notified asynchronously of those events that have been generated. </td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Some platforms have limited support for global, preemptive <a class="el" href="structAccessibility_1_1EventListenerMode.html">EventListenerMode</a>. Such a registration may fail if another client already has priority for preemptive access to one or more of the members of the KeySet. AT consumers have the option of re-trying the request without the global flag, or without the preemptive flag, or of re-trying with a different KeySet. The best support for pre-emptive global keyboard listeners is provided on platforms whose Xserver implementation provides the XEvIE extension.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>True</code> if the <a class="el" href="interfaceAccessibility_1_1DeviceEventListener.html">DeviceEventListener</a> was successfully registered for the requested KeySet, ControllerEventMask, event types, and <a class="el" href="structAccessibility_1_1EventListenerMode.html">EventListenerMode</a>; otherwise returns <code>False</code>. </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>/home/liyuan/src/at-spi/idl/<a class="el" href="Accessibility__Registry_8idl_source.html">Accessibility_Registry.idl</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Sep 27 2010 16:50:43 for at-spi-idl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
