Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2620

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csKeyEventData Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csKeyEventData Struct Reference<br>
<small>
[<a class="el" href="group__event__handling.html">Event handling</a>]</small>
</h1><!-- doxytag: class="csKeyEventData" -->Structure that collects the data a keyboard event carries.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="iutil_2event_8h-source.html">iutil/event.h</a>&gt;</code>
<p>

<p>
<a href="structcsKeyEventData-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsKeyEventData.html#8dade2f09bd3936cbbf04585c011ba0b">autoRepeat</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Auto-repeat flag.  <a href="#8dade2f09bd3936cbbf04585c011ba0b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="evdefs_8h.html#01c809d9f3c8b5c7985bc34b611ecdd4">csKeyCharType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsKeyEventData.html#28dad62f7303af77dc5959df314f67f8">charType</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type of the key, if it is a character key.  <a href="#28dad62f7303af77dc5959df314f67f8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsKeyEventData.html#61de8887b72f63f6d9b55ff99f3b270f">codeCooked</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cooked key code.  <a href="#61de8887b72f63f6d9b55ff99f3b270f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsKeyEventData.html#d978b95ecadef76cf176760b3a8d3baf">codeRaw</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Raw key code.  <a href="#d978b95ecadef76cf176760b3a8d3baf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__event__handling.html#ge77b5898945ed86046a25788a491cb4e">csKeyEventType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsKeyEventData.html#d0c846fb51ab40e8f4e233a20a1a385b">eventType</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Event type.  <a href="#d0c846fb51ab40e8f4e233a20a1a385b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct__csKeyModifiers.html">csKeyModifiers</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsKeyEventData.html#d00b7f700cab859b8b4f6d29691cd850">modifiers</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modifiers at the time the event was generated.  <a href="#d00b7f700cab859b8b4f6d29691cd850"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Structure that collects the data a keyboard event carries. 
<p>
The event it self doesn't transfer the data in this structure; it is merely meant to pass around keyboard event data in a compact way within client code without having to pass around the event itself. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcsKeyEventHelper.html" title="Helper class to conveniently deal with keyboard events.">csKeyEventHelper</a> </dd></dl>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00128">128</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="8dade2f09bd3936cbbf04585c011ba0b"></a><!-- doxytag: member="csKeyEventData::autoRepeat" ref="8dade2f09bd3936cbbf04585c011ba0b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="structcsKeyEventData.html#8dade2f09bd3936cbbf04585c011ba0b">csKeyEventData::autoRepeat</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Auto-repeat flag. 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00139">139</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="28dad62f7303af77dc5959df314f67f8"></a><!-- doxytag: member="csKeyEventData::charType" ref="28dad62f7303af77dc5959df314f67f8" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="evdefs_8h.html#01c809d9f3c8b5c7985bc34b611ecdd4">csKeyCharType</a> <a class="el" href="structcsKeyEventData.html#28dad62f7303af77dc5959df314f67f8">csKeyEventData::charType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Type of the key, if it is a character key. 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00141">141</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="61de8887b72f63f6d9b55ff99f3b270f"></a><!-- doxytag: member="csKeyEventData::codeCooked" ref="61de8887b72f63f6d9b55ff99f3b270f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> <a class="el" href="structcsKeyEventData.html#61de8887b72f63f6d9b55ff99f3b270f">csKeyEventData::codeCooked</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Cooked key code. 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00135">135</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="d978b95ecadef76cf176760b3a8d3baf"></a><!-- doxytag: member="csKeyEventData::codeRaw" ref="d978b95ecadef76cf176760b3a8d3baf" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> <a class="el" href="structcsKeyEventData.html#d978b95ecadef76cf176760b3a8d3baf">csKeyEventData::codeRaw</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Raw key code. 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00133">133</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="d0c846fb51ab40e8f4e233a20a1a385b"></a><!-- doxytag: member="csKeyEventData::eventType" ref="d0c846fb51ab40e8f4e233a20a1a385b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__event__handling.html#ge77b5898945ed86046a25788a491cb4e">csKeyEventType</a> <a class="el" href="structcsKeyEventData.html#d0c846fb51ab40e8f4e233a20a1a385b">csKeyEventData::eventType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Event type. 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00131">131</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="d00b7f700cab859b8b4f6d29691cd850"></a><!-- doxytag: member="csKeyEventData::modifiers" ref="d00b7f700cab859b8b4f6d29691cd850" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct__csKeyModifiers.html">csKeyModifiers</a> <a class="el" href="structcsKeyEventData.html#d00b7f700cab859b8b4f6d29691cd850">csKeyEventData::modifiers</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Modifiers at the time the event was generated. 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00137">137</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iutil/<a class="el" href="iutil_2event_8h-source.html">event.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>