<!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: csKeyComposer Class 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 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 Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csKeyComposer Class Reference</h1><!-- doxytag: class="csKeyComposer" --><!-- doxytag: inherits="scfImplementation1< csKeyComposer, iKeyComposer >" --><div class="dynheader">
Inheritance diagram for csKeyComposer:</div>
<div class="dynsection">
<p><center><img src="classcsKeyComposer__inherit__graph.png" border="0" usemap="#csKeyComposer__inherit__map" alt="Inheritance graph"></center>
<map name="csKeyComposer__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csKeyComposer, iKeyComposer \>" alt="" coords="60,161,449,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csKeyComposer \>" alt="" coords="5,84,283,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="308,7,364,33"><area shape="rect" href="structiKeyComposer.html" title="Keyboard input handler." alt="" coords="307,84,424,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="33,7,255,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsKeyComposer-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="group__event__handling.html#g9d08c1b538e925c0b83f3fa3ce0e88ae">csKeyComposeResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsKeyComposer.html#a1d455fedce2948a7faea75942e1f46d">HandleKey</a> (const <a class="el" href="structcsKeyEventData.html">csKeyEventData</a> &keyEventData, <a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> *buf, size_t bufChars, int *resultChars=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle keyboard input. <a href="#a1d455fedce2948a7faea75942e1f46d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsKeyComposer.html#27925527fed791d8135ccfe9ae5dcf90">ResetState</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the composer's internal state. <a href="#27925527fed791d8135ccfe9ae5dcf90"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="90a4b27441bd1a4b3099a6a75df5c2ba"></a><!-- doxytag: member="csKeyComposer::lastDead" ref="90a4b27441bd1a4b3099a6a75df5c2ba" args="" -->
<a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsKeyComposer.html#90a4b27441bd1a4b3099a6a75df5c2ba">lastDead</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="csutil_2csinput_8h-source.html#l00069">69</a> of file <a class="el" href="csutil_2csinput_8h-source.html">csinput.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1d455fedce2948a7faea75942e1f46d"></a><!-- doxytag: member="csKeyComposer::HandleKey" ref="a1d455fedce2948a7faea75942e1f46d" args="(const csKeyEventData &keyEventData, utf32_char *buf, size_t bufChars, int *resultChars=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__event__handling.html#g9d08c1b538e925c0b83f3fa3ce0e88ae">csKeyComposeResult</a> csKeyComposer::HandleKey </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structcsKeyEventData.html">csKeyEventData</a> & </td>
<td class="paramname"> <em>keyEventData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>bufChars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>resultChars</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Handle keyboard input.
<p>
Converts the input to characters, if possible. If the key passed in is a dead key, it will be stored internally and affect the returned data of the subsequent keypress. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keyEventData</em> </td><td>Information from a keyboard event. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>Buffer to store the output in. Should be at least contain 2 characters (however, the method will work with smaller buffers as well.) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bufChars</em> </td><td>Number of characters the output buffer is actually sized. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>resultChars</em> </td><td>If not 0, returns the number of characters written to the output buffer. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The type of character(s) that has been written to the output buffer. </dd></dl>
<p>Implements <a class="el" href="structiKeyComposer.html#46ae35a0731677b1a8c09ef07f618fe6">iKeyComposer</a>.</p>
</div>
</div><p>
<a class="anchor" name="27925527fed791d8135ccfe9ae5dcf90"></a><!-- doxytag: member="csKeyComposer::ResetState" ref="27925527fed791d8135ccfe9ae5dcf90" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csKeyComposer::ResetState </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the composer's internal state.
<p>
Specifically, it will clear any stored dead key - the next key won't be combined with it.
<p>Implements <a class="el" href="structiKeyComposer.html#8f3dc20ecf693d840e40c4f60413db4c">iKeyComposer</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="csutil_2csinput_8h-source.html">csinput.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
706
