<!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::KeyDefinition 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_1KeyDefinition.html">Accessibility::KeyDefinition</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<h1>Accessibility::KeyDefinition Struct Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Accessibility::KeyDefinition" -->
<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">long </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1KeyDefinition.html#a4ff1279b5f6f10fd781e92d33ce5613a">keycode</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1KeyDefinition.html#a69524f602f668392e8990c2a52db73fd">keysym</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1KeyDefinition.html#a68522fc0475cbeb872a4ba282faf56e9">keystring</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="structAccessibility_1_1KeyDefinition.html#a58689a135740ea61dcdd3b75318e022f">unused</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A structure which defines the identity of a key for which notifications are to be requested. The data in the members of a KeyDefinition are used to determine which keyboard events 'match' the notification request filed by a client.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Ordinarily a <a class="el" href="structAccessibility_1_1KeyDefinition.html">KeyDefinition</a> specifies one and only one of the criteria below; the result of using a <a class="el" href="structAccessibility_1_1KeyDefinition.html">KeyDefinition</a> with multiple members defined as nonzero is undefined.</dd></dl>
<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>if nonzero, the numeric, system-dependent value corresponding to a physical key on the keyboard. Keycode values have no semantic meaning to the end-user, and may depend on the user's hardware and operating environment. They therefore are rarely useful "as-is" to AT clients, unless the client has used operating system services to identify the hardward keycode associated with a particular key symbol. Notifications for key events requested by keycode are less dependent on modifier state than <code>keysym</code> based notifications, but some hardware (notably many laptops) may generate more than one keycode for the same physical key, depending on the state of physical shift/modifier keys. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keysym</em> </td><td>if nonzero, the numeric value corresponding to the X Keysym of the key for which notification is requested. Note that the presence of active modifiers will affect whether notification for key events requested via "keysym" specification takes place, since the keysym depends on the modifier state for most keys. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>keystring</em> </td><td>if non-NULL, the string value of the inserted characters if the corresponding key event has KeyEvent:is_text set to <code>True</code>, or the string representing the 'name' of the key. On X11 systems, the string 'name' of non-printing keysyms corresponds to the values in "keysymdef.h" as provided by Xlib, with the leading "XK_" stripped off. </td></tr>
</table>
</dd>
</dl>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a4ff1279b5f6f10fd781e92d33ce5613a"></a><!-- doxytag: member="Accessibility::KeyDefinition::keycode" ref="a4ff1279b5f6f10fd781e92d33ce5613a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structAccessibility_1_1KeyDefinition.html#a4ff1279b5f6f10fd781e92d33ce5613a">Accessibility::KeyDefinition::keycode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a68522fc0475cbeb872a4ba282faf56e9"></a><!-- doxytag: member="Accessibility::KeyDefinition::keystring" ref="a68522fc0475cbeb872a4ba282faf56e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string <a class="el" href="structAccessibility_1_1KeyDefinition.html#a68522fc0475cbeb872a4ba282faf56e9">Accessibility::KeyDefinition::keystring</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a69524f602f668392e8990c2a52db73fd"></a><!-- doxytag: member="Accessibility::KeyDefinition::keysym" ref="a69524f602f668392e8990c2a52db73fd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structAccessibility_1_1KeyDefinition.html#a69524f602f668392e8990c2a52db73fd">Accessibility::KeyDefinition::keysym</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a58689a135740ea61dcdd3b75318e022f"></a><!-- doxytag: member="Accessibility::KeyDefinition::unused" ref="a58689a135740ea61dcdd3b75318e022f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structAccessibility_1_1KeyDefinition.html#a58689a135740ea61dcdd3b75318e022f">Accessibility::KeyDefinition::unused</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</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>
