<!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: iConsoleInput 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 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>iConsoleInput Struct Reference</h1><!-- doxytag: class="iConsoleInput" --><!-- doxytag: inherits="iBase" -->This is a plugin that can handle keyboard input and display it on an associated console.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="conin_8h-source.html">ivaria/conin.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iConsoleInput:</div>
<div class="dynsection">
<p><center><img src="structiConsoleInput__inherit__graph.png" border="0" usemap="#iConsoleInput__inherit__map" alt="Inheritance graph"></center>
<map name="iConsoleInput__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="32,7,88,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiConsoleInput-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiConsoleInput.html#1f5b8daedccffc7e7575590d49daabc7">Bind</a> (<a class="el" href="structiConsoleOutput.html">iConsoleOutput</a> *console)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bind to an output console. <a href="#1f5b8daedccffc7e7575590d49daabc7"></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="structiConsoleInput.html#5a0e25d466cd2f4c98d631702de6fdb3">Clear</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the history buffer. <a href="#5a0e25d466cd2f4c98d631702de6fdb3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiConsoleInput.html#9a29c96a7f9c5cced82b309874b91acd">GetBufferSize</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the size of the history buffer. <a href="#9a29c96a7f9c5cced82b309874b91acd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiConsoleInput.html#f3d214c434d6eaa30f766a7a93f08e87">GetCurLine</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current input line number. <a href="#f3d214c434d6eaa30f766a7a93f08e87"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiConsoleExecCallback.html">iConsoleExecCallback</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiConsoleInput.html#1a9cf5575d044aaec51dcfdd8c739d98">GetExecuteCallback</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the command execution callback. <a href="#1a9cf5575d044aaec51dcfdd8c739d98"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiConsoleInput.html#e27953cf4fdfacec49f2bc7be71db810">GetText</a> (int line=-1) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a line from the input buffer. <a href="#e27953cf4fdfacec49f2bc7be71db810"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiConsoleInput.html#0968f75aafe3f6cd54db2ef58c5f8738">HandleEvent</a> (<a class="el" href="structiEvent.html">iEvent</a> &)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handle a console-related event. <a href="#0968f75aafe3f6cd54db2ef58c5f8738"></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="structiConsoleInput.html#962536edcdf9b037df484fa8fe90f66f">SetBufferSize</a> (int size)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the size of the history buffer. <a href="#962536edcdf9b037df484fa8fe90f66f"></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="structiConsoleInput.html#23c3024e4c7fa659478175ecf9b46a9e">SetExecuteCallback</a> (<a class="el" href="structiConsoleExecCallback.html">iConsoleExecCallback</a> *callback)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the command execution callback. <a href="#23c3024e4c7fa659478175ecf9b46a9e"></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="structiConsoleInput.html#e6649300f875a19b56a070fe922205c3">SetPrompt</a> (const char *prompt)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the prompt string. <a href="#e6649300f875a19b56a070fe922205c3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is a plugin that can handle keyboard input and display it on an associated console.
<p>
The plugin has a command history and when user presses 'Enter' can call some callback function to execute the entered command.<p>
<b>WARNING</b> Do NOT use the event handler that may (or may not) be implemented by the console and register that to the event queue. This doesn't work properly. Instead register your own event handler and call <a class="el" href="structiConsoleInput.html#0968f75aafe3f6cd54db2ef58c5f8738" title="Handle a console-related event.">HandleEvent()</a> from that.<p>
Main creators of instances implementing this interface:<ul>
<li>Standard input console plugin (crystalspace.console.input.standard)</li></ul>
<p>
Main ways to get pointers to this interface:<ul>
<li><a class="el" href="iutil_2objreg_8h.html#ee5a756951eeb09857882b549a563261" title="Query an interface from the registry.">csQueryRegistry()</a> </li></ul>
<p>Definition at line <a class="el" href="conin_8h-source.html#l00061">61</a> of file <a class="el" href="conin_8h-source.html">conin.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1f5b8daedccffc7e7575590d49daabc7"></a><!-- doxytag: member="iConsoleInput::Bind" ref="1f5b8daedccffc7e7575590d49daabc7" args="(iConsoleOutput *console)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleInput::Bind </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiConsoleOutput.html">iConsoleOutput</a> * </td>
<td class="paramname"> <em>console</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Bind to an output console.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>console</em> </td><td></td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5a0e25d466cd2f4c98d631702de6fdb3"></a><!-- doxytag: member="iConsoleInput::Clear" ref="5a0e25d466cd2f4c98d631702de6fdb3" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleInput::Clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear the history buffer.
<p>
</div>
</div><p>
<a class="anchor" name="9a29c96a7f9c5cced82b309874b91acd"></a><!-- doxytag: member="iConsoleInput::GetBufferSize" ref="9a29c96a7f9c5cced82b309874b91acd" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iConsoleInput::GetBufferSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the size of the history buffer.
<p>
</div>
</div><p>
<a class="anchor" name="f3d214c434d6eaa30f766a7a93f08e87"></a><!-- doxytag: member="iConsoleInput::GetCurLine" ref="f3d214c434d6eaa30f766a7a93f08e87" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iConsoleInput::GetCurLine </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the current input line number.
<p>
</div>
</div><p>
<a class="anchor" name="1a9cf5575d044aaec51dcfdd8c739d98"></a><!-- doxytag: member="iConsoleInput::GetExecuteCallback" ref="1a9cf5575d044aaec51dcfdd8c739d98" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiConsoleExecCallback.html">iConsoleExecCallback</a>* iConsoleInput::GetExecuteCallback </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the command execution callback.
<p>
</div>
</div><p>
<a class="anchor" name="e27953cf4fdfacec49f2bc7be71db810"></a><!-- doxytag: member="iConsoleInput::GetText" ref="e27953cf4fdfacec49f2bc7be71db810" args="(int line=-1) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iConsoleInput::GetText </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>line</em> = <code>-1</code> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a line from the input buffer.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>line</em> </td><td>is the line number to get or -1 (default) for current line. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0968f75aafe3f6cd54db2ef58c5f8738"></a><!-- doxytag: member="iConsoleInput::HandleEvent" ref="0968f75aafe3f6cd54db2ef58c5f8738" args="(iEvent &)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iConsoleInput::HandleEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEvent.html">iEvent</a> & </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Handle a console-related event.
<p>
Do NOT use the event handler that may (or may not) be implemented by the console and register that to the event queue. This doesn't work properly. Instead register your own event handler and call <a class="el" href="structiConsoleInput.html#0968f75aafe3f6cd54db2ef58c5f8738" title="Handle a console-related event.">HandleEvent()</a> from that.
</div>
</div><p>
<a class="anchor" name="962536edcdf9b037df484fa8fe90f66f"></a><!-- doxytag: member="iConsoleInput::SetBufferSize" ref="962536edcdf9b037df484fa8fe90f66f" args="(int size)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleInput::SetBufferSize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the size of the history buffer.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>is the size in lines of the history buffer. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="23c3024e4c7fa659478175ecf9b46a9e"></a><!-- doxytag: member="iConsoleInput::SetExecuteCallback" ref="23c3024e4c7fa659478175ecf9b46a9e" args="(iConsoleExecCallback *callback)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleInput::SetExecuteCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiConsoleExecCallback.html">iConsoleExecCallback</a> * </td>
<td class="paramname"> <em>callback</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the command execution callback.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>callback</em> </td><td>will be called whenever the user presses enter so the application can then perform the command that was entered. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e6649300f875a19b56a070fe922205c3"></a><!-- doxytag: member="iConsoleInput::SetPrompt" ref="e6649300f875a19b56a070fe922205c3" args="(const char *prompt)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleInput::SetPrompt </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>prompt</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the prompt string.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="conin_8h-source.html">conin.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
>
2857
