Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-release > by-pkgid > 554fa56029a60daf7aab25253fdab3d8 > files > 118

clanlib0.6-docs-0.6.5-28mdv2008.1.x86_64.rpm


<html>
<head><title>ClanLib Reference: CL_Key</title></head>
<body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0>
<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr>
<tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table>
<table align=center border=0 cellspacing=10> <tr>
<td><a href="entire_class_index.html">Entire Class Index</a></td>
<td><a href="class_index.html">Main Class Index</a></td>
<td><a href="cross_index.html">Cross Index</a></td>
<td><a href="global_index.html">Global Index</a></td>
</table><h1 align=center>Class CL_Key</h1><p>
<b>  Structure descripting a key event.</b><br>
Contained in: <a href="global_index.html">global</a><br>
Derived from:
<i>none</i>
<br>
Derived by:
<i>none</i>
<br>Group: Display (Input)
<p>
#include &lt;ClanLib/display.h&gt;
<p>
<hr noshade>
<table border=0>
<tr><td colspan=3><h3>public function member index:</h3></td>
<tr valign=top><td align=left><h3>Construction:</h3></td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Key.html#1994"><tt><font color=blue><b>CL_Key</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Key.html#1995"><tt><font color=blue><b>CL_Key</b></font></tt></a></td><td><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>l_id</font></tt>, <tt><font color=navy>State</font></tt> <tt><font color=blue>l_state</font></tt> = NoKey, <tt><font color=purple>int</font></tt> <tt><font color=blue>l_ascii</font></tt> = -1, <tt><font color=purple>float</font></tt> <tt><font color=blue>l_x</font></tt> = -1, <tt><font color=purple>float</font></tt> <tt><font color=blue>l_y</font></tt> = -1)</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
<br>  CL_KEY_BACKSPACE	backspace<br>  CL_KEY_TAB       tab<br>  CL_KEY_ENTER     return<br>  CL_KEY_PAUSE     pause<br>  CL_KEY_ESCAPE    escape<br>  CL_KEY_SPACE     space<br>  CL_KEY_0         0<br>  ...<br>  CL_KEY_9         9<br>  CL_KEY_A         a<br>  ...<br>  CL_KEY_Z         z<br>  CL_KEY_KP_0      keypad 0<br>  ...<br>  CL_KEY_KP_9      keypad 9<br>  CL_KEY_KP_DEV    keypad divide<br>  CL_KEY_KP_MULT   keypad multiply<br>  CL_KEY_KP_MINUS  keypad minus<br>  CL_KEY_KP_PLUS   keypad plus<br>  CL_KEY_KP_DECIMAL	keypad decimal point<br>  CL_KEY_KP_ENTER  keypad enter<br>  CL_KEY_UP        up arrow<br>  CL_KEY_DOWN      down arrow<br>  CL_KEY_RIGHT     right arrow<br>  CL_KEY_LEFT      left arrow<br>  CL_KEY_DELETE    delete<br>  CL_KEY_INSERT    insert<br>  CL_KEY_HOME      home<br>  CL_KEY_END       end<br>  CL_KEY_PAGEUP    page up<br>  CL_KEY_PAGEDOWN  page down<br>  CL_KEY_F1        F1<br>  ...<br>  CL_KEY_F12       F12<br>  CL_KEY_NUMLOCK   numlock<br>  CL_KEY_CAPSLOCK  capslock<br>  CL_KEY_SCRLOCK   scrollock<br>  CL_KEY_RSHIFT    right shift<br>  CL_KEY_LSHIFT    left shift<br>  CL_KEY_RCTRL     right ctrl<br>  CL_KEY_LCTRL     left ctrl<br>  CL_KEY_ALTGR     right alt / alt gr<br>  CL_KEY_ALT       left alt / alt<br>  CL_KEY_PRINT     print-screen<br><br>  CL_MOUSE_LEFTBUTTON		mouse left button<br>  CL_MOUSE_MIDDLEBUTTON	mouse middle button<br>  CL_MOUSE_RIGHTBUTTON		mouse right button<br>  CL_MOUSE_THUMBBUTTON		mouse thumb button<br>  CL_MOUSE_WHEELUP			mouse wheel up<br>  CL_MOUSE_WHEELDOWN		mouse wheel down<br>  CL_MOUSE_WHEELBUTTON		mouse wheel click<br><p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="1994"><font size=+1><b>CL_Key::CL_Key</b></font></a> -   Key Constructor<br><tt></tt> <a href="CL_Key.html#1994"><tt><font color=blue><b>CL_Key</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="1995"><font size=+1><b>CL_Key::CL_Key</b></font></a> -   Key Constructor<br><tt></tt> <a href="CL_Key.html#1995"><tt><font color=blue><b>CL_Key</b></font></tt></a><tt>(<tt><font color=purple>int</font></tt> <tt><font color=blue>l_id</font></tt>, <tt><font color=navy>State</font></tt> <tt><font color=blue>l_state</font></tt> = NoKey, <tt><font color=purple>int</font></tt> <tt><font color=blue>l_ascii</font></tt> = -1, <tt><font color=purple>float</font></tt> <tt><font color=blue>l_x</font></tt> = -1, <tt><font color=purple>float</font></tt> <tt><font color=blue>l_y</font></tt> = -1)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<hr noshade>
<h2>Variable Member Descriptions:</h2>
<a name="1990"><font size=+1><b>CL_Key::ascii</b></font></a> -   Ascii value or -1 if not available.<br>
<tt><tt><font color=purple>int</font></tt> </tt> <tt><a href="CL_Key.html#1990"><tt><font color=blue>ascii</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br>
<a name="1989"><font size=+1><b>CL_Key::id</b></font></a> -   Key ID.<br>
<tt><tt><font color=purple>int</font></tt> </tt> <tt><a href="CL_Key.html#1989"><tt><font color=blue>id</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br>
<a name="1991"><font size=+1><b>CL_Key::state</b></font></a> -   &lt;p&gt;Key state. Was it pressed or released. NoKey is used when there were
  no key available in the input buffer.&lt;/p&gt;<br>
<tt><tt><font color=navy>State</font></tt> </tt> <tt><a href="CL_Key.html#1991"><tt><font color=blue>state</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br>
<a name="1992"><font size=+1><b>CL_Key::x</b></font></a> -   x-coordinate position if a pointing device was the source. -1 if none.<br>
<tt><tt><font color=purple>float</font></tt> </tt> <tt><a href="CL_Key.html#1992"><tt><font color=blue>x</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br>
<a name="1993"><font size=+1><b>CL_Key::y</b></font></a> -   y-coordinate position if a pointing device was the source. -1 if none.<br>
<tt><tt><font color=purple>float</font></tt> </tt> <tt><a href="CL_Key.html#1993"><tt><font color=blue>y</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br>
<hr noshade>
</body>
</html>