<!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::DeviceEvent Struct 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="structAccessibility_1_1DeviceEvent.html">Accessibility::DeviceEvent</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>Accessibility::DeviceEvent Struct Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::DeviceEvent" -->
<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-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceAccessibility.html#acbb81727d2969eecafa1012b28a4a1ab">EventType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1DeviceEvent.html#a61c876565b61f001938283b34e7927a7">type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1DeviceEvent.html#a6143a11bee90889e5a5b23173b2b2496">id</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1DeviceEvent.html#a408bc340a88fa43d87561a6a7ce4ab9a">hw_code</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1DeviceEvent.html#a85c19109a52541e83ef92e7f9a0be7f4">modifiers</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1DeviceEvent.html#aaed462bfb7b7d55eb2f48ab5c3c48cc6">timestamp</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1DeviceEvent.html#a83a4b973b164f41beb874eaa65239ba2">event_string</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1DeviceEvent.html#aec3dcc0a0240e055ca0bd36ac2f2daa5">is_text</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A structure which encapsulates information about a device event. </p>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a83a4b973b164f41beb874eaa65239ba2"></a><!-- doxytag: member="Accessibility::DeviceEvent::event_string" ref="a83a4b973b164f41beb874eaa65239ba2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="structAccessibility_1_1DeviceEvent.html#a83a4b973b164f41beb874eaa65239ba2">Accessibility::DeviceEvent::event_string</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A string representation of the event. If is_text is <code>True</code>, then this string represents the character or typographic sequence that would be received by a focussed text input field. event_string is in general suitable for exposure to the end-user for purposes of keyboard echo. </p>
</div>
</div>
<a class="anchor" id="a408bc340a88fa43d87561a6a7ce4ab9a"></a><!-- doxytag: member="Accessibility::DeviceEvent::hw_code" ref="a408bc340a88fa43d87561a6a7ce4ab9a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short <a class="el" href="structAccessibility_1_1DeviceEvent.html#a408bc340a88fa43d87561a6a7ce4ab9a">Accessibility::DeviceEvent::hw_code</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>a numeric code which is hardware and system-dependent, identifying the specific hardware button or key on the device for which the event has occurred. On X Window systems, for global key notifications and for most non-global key notifications as well, this code corresponds to the XKeycode. For switch and button events it indicates the switch or button number. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>For technical reasons, this code may differ from the XKeycode when generated by Java applications for consumption by non-global key listeners. This is subject to change in future versions of the <a class="el" href="interfaceAccessibility_1_1DeviceEventController.html">DeviceEventController</a> implementation. </dd></dl>
</div>
</div>
<a class="anchor" id="a6143a11bee90889e5a5b23173b2b2496"></a><!-- doxytag: member="Accessibility::DeviceEvent::id" ref="a6143a11bee90889e5a5b23173b2b2496" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structAccessibility_1_1DeviceEvent.html#a6143a11bee90889e5a5b23173b2b2496">Accessibility::DeviceEvent::id</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>an identifier which identifies this event in the event stream. On X Window systems this corresponds to the XEvent serial number. </p>
</div>
</div>
<a class="anchor" id="aec3dcc0a0240e055ca0bd36ac2f2daa5"></a><!-- doxytag: member="Accessibility::DeviceEvent::is_text" ref="aec3dcc0a0240e055ca0bd36ac2f2daa5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boolean <a class="el" href="structAccessibility_1_1DeviceEvent.html#aec3dcc0a0240e055ca0bd36ac2f2daa5">Accessibility::DeviceEvent::is_text</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><code>True</code> if the event results in the insertion of characters into an input text buffer, or would do so if delivered to a focussed text input field. ¨Typographical¨ key events have this field set to <code>True</code>, whereas ¨control¨ key events generally do not. </p>
</div>
</div>
<a class="anchor" id="a85c19109a52541e83ef92e7f9a0be7f4"></a><!-- doxytag: member="Accessibility::DeviceEvent::modifiers" ref="a85c19109a52541e83ef92e7f9a0be7f4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short <a class="el" href="structAccessibility_1_1DeviceEvent.html#a85c19109a52541e83ef92e7f9a0be7f4">Accessibility::DeviceEvent::modifiers</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>an unsigned short int consisting of zero or more of the following values OR'ed together: </p>
<ul>
<li><code>1<<<a class="el" href="namespaceAccessibility.html#a9193f86283b269f08a575b1f8149ae93a042a9271764fa6dabac87437e44aeca4">MODIFIER_SHIFT</a></code> (=1, corresponds to Xlib's ShiftMask) </li>
<li><code>1<<<a class="el" href="namespaceAccessibility.html#a9193f86283b269f08a575b1f8149ae93aa739f46636da7ed30e493954877be159">MODIFIER_SHIFTLOCK</a></code> (=2, corresponds to Xlib's LockMask) </li>
<li><code>1<<<a class="el" href="namespaceAccessibility.html#a9193f86283b269f08a575b1f8149ae93ad00958396ccd0f805c43a8c17a29056c">MODIFIER_CONTROL</a></code> (=4, corresponds to Xlib's ControlMask) </li>
<li><code>1<<<a class="el" href="namespaceAccessibility.html#a9193f86283b269f08a575b1f8149ae93a38d92cea80da369472b54125bda5e166">MODIFIER_ALT</a></code> (=8, corresponds to Xlib's Mod1Mask) </li>
<li><code>1<<<a class="el" href="namespaceAccessibility.html#a9193f86283b269f08a575b1f8149ae93a1db9c517bf2aa30b4d77e8767d6c5be3">MODIFIER_META</a></code> (=16, corresponds to Xlib's Mod2Mask) </li>
<li><code>1<<<a class="el" href="namespaceAccessibility.html#a9193f86283b269f08a575b1f8149ae93afe860705cbf29de361722247f6c879dd">MODIFIER_META2</a></code> (=32, corresponds to Xlib's Mod3Mask) </li>
<li><code>1<<<a class="el" href="namespaceAccessibility.html#a9193f86283b269f08a575b1f8149ae93ad0243c4245876122477168bea9482003">MODIFIER_META3</a></code> (=64, corresponds to Xlib's Mod4Mask) </li>
</ul>
</div>
</div>
<a class="anchor" id="aaed462bfb7b7d55eb2f48ab5c3c48cc6"></a><!-- doxytag: member="Accessibility::DeviceEvent::timestamp" ref="aaed462bfb7b7d55eb2f48ab5c3c48cc6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long <a class="el" href="structAccessibility_1_1DeviceEvent.html#aaed462bfb7b7d55eb2f48ab5c3c48cc6">Accessibility::DeviceEvent::timestamp</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>an unsigned integer representing the time that the event occurred. On X Window systems this event is a time in milliseconds from some arbitrary starting point; it therefore has a cycle time of approximately 50 days. </p>
</div>
</div>
<a class="anchor" id="a61c876565b61f001938283b34e7927a7"></a><!-- doxytag: member="Accessibility::DeviceEvent::type" ref="a61c876565b61f001938283b34e7927a7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceAccessibility.html#acbb81727d2969eecafa1012b28a4a1ab">EventType</a> <a class="el" href="structAccessibility_1_1DeviceEvent.html#a61c876565b61f001938283b34e7927a7">Accessibility::DeviceEvent::type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Identifies the type of the containing <a class="el" href="structAccessibility_1_1DeviceEvent.html">DeviceEvent</a>. </p>
</div>
</div>
<hr/>The documentation for this struct 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>
