Sophie

Sophie

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

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


<html>
<head><title>ClanLib Reference: CL_InputBuffer</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_InputBuffer</h1><p>
<b>  Input buffer interface.</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_InputBuffer.html#1997"><tt><font color=blue><b>CL_InputBuffer</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_InputBuffer.html#1998"><tt><font color=blue><b>CL_InputBuffer</b></font></tt></a></td><td><tt>(<a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* <tt><font color=blue>device</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_InputBuffer.html#1999"><tt><font color=blue><b>CL_InputBuffer</b></font></tt></a></td><td><tt>(<tt><font color=navy>CL_Signal_v4</font></tt><<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* , <a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* , <a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a>, <tt><font color=purple>bool</font></tt>& >& <tt><font color=blue>sig_key_down</font></tt>, <tt><font color=navy>CL_Signal_v3</font></tt><<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* , <a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* , <a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a>>& <tt><font color=blue>sig_key_up</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_InputBuffer.html#2000"><tt><font color=blue><b>~CL_InputBuffer</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=left><h3>Operations:</h3></td>
<tr valign=top><td align=right><tt><a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a></tt> </td><td align=right><a href="CL_InputBuffer.html#2001"><tt><font color=blue><b>peek_key</b></font></tt></a></td><td><tt>() <tt>const</tt></tt>;</td>
<tr valign=top><td align=right><tt><a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a></tt> </td><td align=right><a href="CL_InputBuffer.html#2002"><tt><font color=blue><b>get_key</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>int</font></tt></tt> </td><td align=right><a href="CL_InputBuffer.html#2003"><tt><font color=blue><b>keys_left</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputBuffer.html#2004"><tt><font color=blue><b>clear</b></font></tt></a></td><td><tt>()</tt>;</td>
<tr><td>&nbsp;</td><tr><td colspan=3><h3>private function member index:</h3></td>
<tr valign=top><td align=left><h3>Implementation:</h3></td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputBuffer.html#2009"><tt><font color=blue><b>on_button_press</b></font></tt></a></td><td><tt>(<a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* <tt><font color=blue>device</font></tt>, <tt>const</tt> <a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a>& <tt><font color=blue>key</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputBuffer.html#2010"><tt><font color=blue><b>on_button_release</b></font></tt></a></td><td><tt>(<a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* <tt><font color=blue>device</font></tt>, <tt>const</tt> <a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a>& <tt><font color=blue>key</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputBuffer.html#2011"><tt><font color=blue><b>on_key_down</b></font></tt></a></td><td><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* , <a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* <tt><font color=blue>device</font></tt>, <a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a> <tt><font color=blue>key</font></tt>, <tt><font color=purple>bool</font></tt>& <tt><font color=blue>retval</font></tt>)</tt>;</td>
<tr valign=top><td align=right><tt><tt><font color=purple>void</font></tt></tt> </td><td align=right><a href="CL_InputBuffer.html#2012"><tt><font color=blue><b>on_key_up</b></font></tt></a></td><td><tt>(<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* , <a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* <tt><font color=blue>device</font></tt>, <a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a> <tt><font color=blue>key</font></tt>)</tt>;</td>
<tr><td>&nbsp;</td></table>
<hr noshade>
<h2>Description:</h2>
  Use this class to read buffered keys from the keyboard (or any other device).<br><p>
<hr noshade>
<h2>Function Member Descriptions:</h2>
<a name="1997"><font size=+1><b>CL_InputBuffer::CL_InputBuffer</b></font></a> -   Constructs an input buffer that attaches itself to the first keyboard.<br><tt></tt> <a href="CL_InputBuffer.html#1997"><tt><font color=blue><b>CL_InputBuffer</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="1998"><font size=+1><b>CL_InputBuffer::CL_InputBuffer</b></font></a> -   Constructs an input buffer that attaches itself to the specified device.<br><tt></tt> <a href="CL_InputBuffer.html#1998"><tt><font color=blue><b>CL_InputBuffer</b></font></tt></a><tt>(<a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* <tt><font color=blue>device</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="1999"><font size=+1><b>CL_InputBuffer::CL_InputBuffer</b></font></a> -   Constructs an input buffer that attaches itself to the specified signals.<br>  Use it to buffer input from a GUI component.<br><tt></tt> <a href="CL_InputBuffer.html#1999"><tt><font color=blue><b>CL_InputBuffer</b></font></tt></a><tt>(<tt><font color=navy>CL_Signal_v4</font></tt><<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* , <a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* , <a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a>, <tt><font color=purple>bool</font></tt>& >& <tt><font color=blue>sig_key_down</font></tt>, <tt><font color=navy>CL_Signal_v3</font></tt><<a href="CL_Component.html"><tt><font color=navy><b>CL_Component</b></font></tt></a>* , <a href="CL_InputDevice.html"><tt><font color=navy><b>CL_InputDevice</b></font></tt></a>* , <a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a>>& <tt><font color=blue>sig_key_up</font></tt>)</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2004"><font size=+1><b>CL_InputBuffer::clear</b></font></a> -   Clears the buffer. After this, the buffer will not contain any keys.<br><tt><tt><font color=purple>void</font></tt></tt> <a href="CL_InputBuffer.html#2004"><tt><font color=blue><b>clear</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2002"><font size=+1><b>CL_InputBuffer::get_key</b></font></a> -   Pops the next key in the buffer and returns it.<br><tt><a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a></tt> <a href="CL_InputBuffer.html#2002"><tt><font color=blue><b>get_key</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2003"><font size=+1><b>CL_InputBuffer::keys_left</b></font></a> -   Returns number of keys still available in the buffer.<br><tt><tt><font color=purple>int</font></tt></tt> <a href="CL_InputBuffer.html#2003"><tt><font color=blue><b>keys_left</b></font></tt></a><tt>()</tt>;<br><blockquote>  Returns - Number of key values lefts in buffer.</blockquote>
<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2001"><font size=+1><b>CL_InputBuffer::peek_key</b></font></a> -   Returns the next key in the buffer, but unlike get_key() it does not<br>  pop it from the input buffer.<br><tt><a href="CL_Key.html"><tt><font color=navy><b>CL_Key</b></font></tt></a></tt> <a href="CL_InputBuffer.html#2001"><tt><font color=blue><b>peek_key</b></font></tt></a><tt>() <tt>const</tt></tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<a name="2000"><font size=+1><b>CL_InputBuffer::~CL_InputBuffer</b></font></a> -   Input Buffer Destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_InputBuffer.html#2000"><tt><font color=blue><b>~CL_InputBuffer</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br>
<hr noshade>
<h2>Variable Member Descriptions:</h2>
<hr noshade>
</body>
</html>