Sophie

Sophie

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

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: ivaria/conin.h Source File (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><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>ivaria/conin.h</h1><a href="conin_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2000 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">    Written by Michael Dale Long</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_IVARIA_CONIN_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IVARIA_CONIN_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="scf__interface_8h.html" title="Crystal Space Shared Class Facility (SCF) - interface creation support.">csutil/scf_interface.h</a>"</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="keyword">struct </span><a class="code" href="structiEvent.html" title="This interface describes any system event.">iEvent</a>;
<a name="l00030"></a>00030 <span class="keyword">struct </span><a class="code" href="structiConsoleOutput.html" title="This is the Crystal Space Console interface.">iConsoleOutput</a>;
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 
<a name="l00036"></a><a class="code" href="structiConsoleExecCallback.html">00036</a> <span class="keyword">struct </span><a class="code" href="structiConsoleExecCallback.html" title="Command execution callback.">iConsoleExecCallback</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038   SCF_INTERFACE (<a class="code" href="structiConsoleExecCallback.html" title="Command execution callback.">iConsoleExecCallback</a>, 0, 0, 1);
<a name="l00039"></a>00039 
<a name="l00041"></a>00041   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleExecCallback.html#83fe9f669f45f52811518ddc91052ba5" title="Execute.">Execute</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* cmd) = 0;
<a name="l00042"></a>00042 };
<a name="l00043"></a>00043 
<a name="l00061"></a><a class="code" href="structiConsoleInput.html">00061</a> <span class="keyword">struct </span><a class="code" href="structiConsoleInput.html" title="This is a plugin that can handle keyboard input and display it on an associated console...">iConsoleInput</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063   SCF_INTERFACE (<a class="code" href="structiConsoleInput.html" title="This is a plugin that can handle keyboard input and display it on an associated console...">iConsoleInput</a>, 2, 0, 0);
<a name="l00064"></a>00064 
<a name="l00069"></a>00069   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleInput.html#1f5b8daedccffc7e7575590d49daabc7" title="Bind to an output console.">Bind</a> (<a class="code" href="structiConsoleOutput.html" title="This is the Crystal Space Console interface.">iConsoleOutput</a>* console) = 0;
<a name="l00070"></a>00070 
<a name="l00076"></a>00076   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleInput.html#23c3024e4c7fa659478175ecf9b46a9e" title="Set the command execution callback.">SetExecuteCallback</a> (<a class="code" href="structiConsoleExecCallback.html" title="Command execution callback.">iConsoleExecCallback</a>* callback) = 0;
<a name="l00078"></a>00078   <span class="keyword">virtual</span> <a class="code" href="structiConsoleExecCallback.html" title="Command execution callback.">iConsoleExecCallback</a>* <a class="code" href="structiConsoleInput.html#1a9cf5575d044aaec51dcfdd8c739d98" title="Get the command execution callback.">GetExecuteCallback</a> () = 0;
<a name="l00079"></a>00079 
<a name="l00084"></a>00084   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structiConsoleInput.html#e27953cf4fdfacec49f2bc7be71db810" title="Return a line from the input buffer.">GetText</a> (<span class="keywordtype">int</span> line = -1) <span class="keyword">const</span> = 0;
<a name="l00085"></a>00085 
<a name="l00087"></a>00087   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiConsoleInput.html#f3d214c434d6eaa30f766a7a93f08e87" title="Return the current input line number.">GetCurLine</a> () <span class="keyword">const</span> = 0;
<a name="l00088"></a>00088 
<a name="l00090"></a>00090   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiConsoleInput.html#9a29c96a7f9c5cced82b309874b91acd" title="Retrieve the size of the history buffer.">GetBufferSize</a> () <span class="keyword">const</span> = 0;
<a name="l00091"></a>00091 
<a name="l00096"></a>00096   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleInput.html#962536edcdf9b037df484fa8fe90f66f" title="Set the size of the history buffer.">SetBufferSize</a> (<span class="keywordtype">int</span> size) = 0;
<a name="l00097"></a>00097 
<a name="l00099"></a>00099   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleInput.html#5a0e25d466cd2f4c98d631702de6fdb3" title="Clear the history buffer.">Clear</a> () = 0;
<a name="l00100"></a>00100 
<a name="l00102"></a>00102   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleInput.html#e6649300f875a19b56a070fe922205c3" title="Set the prompt string.">SetPrompt</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *prompt) = 0;
<a name="l00103"></a>00103 
<a name="l00110"></a>00110   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiConsoleInput.html#0968f75aafe3f6cd54db2ef58c5f8738" title="Handle a console-related event.">HandleEvent</a> (<a class="code" href="structiEvent.html" title="This interface describes any system event.">iEvent</a>&amp;) = 0;
<a name="l00111"></a>00111 };
<a name="l00112"></a>00112 
<a name="l00113"></a>00113 <span class="preprocessor">#endif // __CS_IVARIA_CONIN_H__</span>
</pre></div><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>