<!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: iConsoleOutput 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>iConsoleOutput Struct Reference</h1><!-- doxytag: class="iConsoleOutput" --><!-- doxytag: inherits="iBase" -->This is the Crystal Space Console interface.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="conout_8h-source.html">ivaria/conout.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iConsoleOutput:</div>
<div class="dynsection">
<p><center><img src="structiConsoleOutput__inherit__graph.png" border="0" usemap="#iConsoleOutput__inherit__map" alt="Inheritance graph"></center>
<map name="iConsoleOutput__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="37,7,93,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiConsoleOutput-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="structiConsoleOutput.html#1632713c98a0d4096427ca3c58d1392d">AutoUpdate</a> (bool autoUpdate)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable automatic console updates. <a href="#1632713c98a0d4096427ca3c58d1392d"></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="structiConsoleOutput.html#c1be1a129c8e5ed871c1890cef6fd705">Clear</a> (bool wipe=false)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear console. <a href="#c1be1a129c8e5ed871c1890cef6fd705"></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="structiConsoleOutput.html#5f379d5e33fb73741f2d471bdd080ab8">Draw2D</a> (<a class="el" href="classcsRect.html">csRect</a> *oRect=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Display the console and return the dirty rectangle. <a href="#5f379d5e33fb73741f2d471bdd080ab8"></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="structiConsoleOutput.html#44f42b38f0132f2b00096ce3a39da4ac">Draw3D</a> (<a class="el" href="classcsRect.html">csRect</a> *oRect=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the 3D part of the console on the window. <a href="#44f42b38f0132f2b00096ce3a39da4ac"></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="structiConsoleOutput.html#210a09a7ec390582fdacc1c08596759b">GetCursorStyle</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the cursor style. <a href="#210a09a7ec390582fdacc1c08596759b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiFont.html">iFont</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiConsoleOutput.html#3638a872005fb8cb8c1e5638de3b915c">GetFont</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the current font. <a href="#3638a872005fb8cb8c1e5638de3b915c"></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="structiConsoleOutput.html#7b299342fba17ed6bc8edb8ececa7382">GetLine</a> (int line=-1) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a line from the buffer. <a href="#7b299342fba17ed6bc8edb8ececa7382"></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="structiConsoleOutput.html#28c97445fb74e2353af20a0e36828e43">GetMaxLineWidth</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query maximal line width in characters. <a href="#28c97445fb74e2353af20a0e36828e43"></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="structiConsoleOutput.html#b9103719ad671df0641c900e6e9a2285">GetTopLine</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current top line being displayed. <a href="#b9103719ad671df0641c900e6e9a2285"></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="structiConsoleOutput.html#6c7a6d7985561ef359902f72b8170ce8">GetTransparency</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the transparency setting. <a href="#6c7a6d7985561ef359902f72b8170ce8"></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="structiConsoleOutput.html#423d3c30d842d32d6550a35ef371ea79">GetVisible</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Query whether the console is visible or hidden. <a href="#423d3c30d842d32d6550a35ef371ea79"></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="structiConsoleOutput.html#9407328b722a9c5525f92b65d50c7c1c">PerformExtension</a> (const char *command,...)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implement simple extension commands. <a href="#9407328b722a9c5525f92b65d50c7c1c"></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="structiConsoleOutput.html#c902dd0d4410f09040ceb38a92a4f4b4">PerformExtensionV</a> (const char *command, va_list)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Implement simple extension commands. <a href="#c902dd0d4410f09040ceb38a92a4f4b4"></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="structiConsoleOutput.html#9f08d35b1c7bae5d026fba47daa80f37">PutText</a> (const char *text,...)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put some text to the console. <a href="#9f08d35b1c7bae5d026fba47daa80f37"></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="structiConsoleOutput.html#77abf6bbd53d30a6a3167c4144b845f7">PutTextV</a> (const char *text, va_list args)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Var_args version of PutText. <a href="#77abf6bbd53d30a6a3167c4144b845f7"></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="structiConsoleOutput.html#3cc6fc80e581764182e9d69098b0cfc9">RegisterWatcher</a> (<a class="el" href="structiConsoleWatcher.html">iConsoleWatcher</a> *)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell console that this object should be notified when console visibility status changes. <a href="#3cc6fc80e581764182e9d69098b0cfc9"></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="structiConsoleOutput.html#0a6c077f8f5333e97160387aaaaac1c8">ScrollTo</a> (int topLine, bool snap=true)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the current top line, or use of the constants above for scrolling. <a href="#0a6c077f8f5333e97160387aaaaac1c8"></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="structiConsoleOutput.html#ea51c84cd36dcb66db2f15a5d5800777">SetBufferSize</a> (int maxLines)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the buffer size in lines. <a href="#ea51c84cd36dcb66db2f15a5d5800777"></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="structiConsoleOutput.html#c55c7821252f400cfaba649416bcc674">SetCursorPos</a> (int charNo)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set cursor horizontal position (-1 == follow output). <a href="#c55c7821252f400cfaba649416bcc674"></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="structiConsoleOutput.html#aab26286b0487d58e3377c452f029b98">SetCursorStyle</a> (int style)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign the cursor style. <a href="#aab26286b0487d58e3377c452f029b98"></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="structiConsoleOutput.html#64482f142ac27745bf746702c1fa42c1">SetFont</a> (<a class="el" href="structiFont.html">iFont</a> *font)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the font. <a href="#64482f142ac27745bf746702c1fa42c1"></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="structiConsoleOutput.html#aa3a25dc7c42913280742c6b0b41c8df">SetTransparency</a> (bool transp)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set transparency. <a href="#aa3a25dc7c42913280742c6b0b41c8df"></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="structiConsoleOutput.html#439fedb2f76223f5792351608e33fcc1">SetVisible</a> (bool show)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Show/hide the console. <a href="#439fedb2f76223f5792351608e33fcc1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is the Crystal Space Console interface.
<p>
It is an output only system. It can be used in conjunction with the <a class="el" href="structiConsoleInput.html" title="This is a plugin that can handle keyboard input and display it on an associated console...">iConsoleInput</a> interface to form an interactive console.<p>
Main creators of instances implementing this interface:<ul>
<li>Standard output console plugin (crystalspace.console.output.standard)</li><li>Fancy output console plugin (crystalspace.console.output.fancy)</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>
Main users of this interface:<ul>
<li><a class="el" href="structiConsoleInput.html" title="This is a plugin that can handle keyboard input and display it on an associated console...">iConsoleInput</a></li><li><a class="el" href="structiStandardReporterListener.html" title="Interface to control the settings of the reporter listener plugin.">iStandardReporterListener</a> </li></ul>
<p>Definition at line <a class="el" href="conout_8h-source.html#l00079">79</a> of file <a class="el" href="conout_8h-source.html">conout.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1632713c98a0d4096427ca3c58d1392d"></a><!-- doxytag: member="iConsoleOutput::AutoUpdate" ref="1632713c98a0d4096427ca3c58d1392d" args="(bool autoUpdate)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::AutoUpdate </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>autoUpdate</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enable or disable automatic console updates.
<p>
When the console is in console auto-update mode, it automatically calls BeginDraw/Console->Draw methods on every PutText call. Otherwise it is your responsability to call Draw() at appropiate times. Initially this mode is enabled.<p>
Note that some implementations of the output consoles may be thread-safe. But in that case you MUST use AutoUpdate(false) because access to graphics is not thread-safe.
</div>
</div><p>
<a class="anchor" name="c1be1a129c8e5ed871c1890cef6fd705"></a><!-- doxytag: member="iConsoleOutput::Clear" ref="c1be1a129c8e5ed871c1890cef6fd705" args="(bool wipe=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::Clear </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>wipe</em> = <code>false</code> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear 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>wipe</em> </td><td>If true then the buffer is completely cleared. Else (default) the top line is moved to the current line. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5f379d5e33fb73741f2d471bdd080ab8"></a><!-- doxytag: member="iConsoleOutput::Draw2D" ref="5f379d5e33fb73741f2d471bdd080ab8" args="(csRect *oRect=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::Draw2D </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcsRect.html">csRect</a> * </td>
<td class="paramname"> <em>oRect</em> = <code>0</code> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Display the console and return the dirty rectangle.
<p>
The graphics driver should be in 2D draw mode. Only call this function from the same thread that maintains the graphics subsystem! <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oRect</em> </td><td>will be set to the dirty rectangle so you can choose to update only that part of the screen. You can also supply 0 (default) if you are not interested in that. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="44f42b38f0132f2b00096ce3a39da4ac"></a><!-- doxytag: member="iConsoleOutput::Draw3D" ref="44f42b38f0132f2b00096ce3a39da4ac" args="(csRect *oRect=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::Draw3D </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcsRect.html">csRect</a> * </td>
<td class="paramname"> <em>oRect</em> = <code>0</code> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the 3D part of the console on the window.
<p>
The graphics driver should be in 3D draw mode. Only call this function from the same thread that maintains the graphics subsystem! <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>oRect</em> </td><td>will be set to the dirty rectangle so you can choose to update only that part of the screen. You can also supply 0 (default) if you are not interested in that. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="210a09a7ec390582fdacc1c08596759b"></a><!-- doxytag: member="iConsoleOutput::GetCursorStyle" ref="210a09a7ec390582fdacc1c08596759b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iConsoleOutput::GetCursorStyle </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 cursor style.
<p>
</div>
</div><p>
<a class="anchor" name="3638a872005fb8cb8c1e5638de3b915c"></a><!-- doxytag: member="iConsoleOutput::GetFont" ref="3638a872005fb8cb8c1e5638de3b915c" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiFont.html">iFont</a>* iConsoleOutput::GetFont </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>
Gets the current font.
<p>
</div>
</div><p>
<a class="anchor" name="7b299342fba17ed6bc8edb8ececa7382"></a><!-- doxytag: member="iConsoleOutput::GetLine" ref="7b299342fba17ed6bc8edb8ececa7382" args="(int line=-1) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iConsoleOutput::GetLine </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 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 to get or -1 (default) for the current line. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="28c97445fb74e2353af20a0e36828e43"></a><!-- doxytag: member="iConsoleOutput::GetMaxLineWidth" ref="28c97445fb74e2353af20a0e36828e43" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iConsoleOutput::GetMaxLineWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query maximal line width in characters.
<p>
</div>
</div><p>
<a class="anchor" name="b9103719ad671df0641c900e6e9a2285"></a><!-- doxytag: member="iConsoleOutput::GetTopLine" ref="b9103719ad671df0641c900e6e9a2285" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iConsoleOutput::GetTopLine </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>
Get the current top line being displayed.
<p>
</div>
</div><p>
<a class="anchor" name="6c7a6d7985561ef359902f72b8170ce8"></a><!-- doxytag: member="iConsoleOutput::GetTransparency" ref="6c7a6d7985561ef359902f72b8170ce8" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iConsoleOutput::GetTransparency </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 transparency setting.
<p>
</div>
</div><p>
<a class="anchor" name="423d3c30d842d32d6550a35ef371ea79"></a><!-- doxytag: member="iConsoleOutput::GetVisible" ref="423d3c30d842d32d6550a35ef371ea79" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iConsoleOutput::GetVisible </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Query whether the console is visible or hidden.
<p>
</div>
</div><p>
<a class="anchor" name="9407328b722a9c5525f92b65d50c7c1c"></a><!-- doxytag: member="iConsoleOutput::PerformExtension" ref="9407328b722a9c5525f92b65d50c7c1c" args="(const char *command,...)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iConsoleOutput::PerformExtension </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Implement simple extension commands.
<p>
</div>
</div><p>
<a class="anchor" name="c902dd0d4410f09040ceb38a92a4f4b4"></a><!-- doxytag: member="iConsoleOutput::PerformExtensionV" ref="c902dd0d4410f09040ceb38a92a4f4b4" args="(const char *command, va_list)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iConsoleOutput::PerformExtensionV </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Implement simple extension commands.
<p>
</div>
</div><p>
<a class="anchor" name="9f08d35b1c7bae5d026fba47daa80f37"></a><!-- doxytag: member="iConsoleOutput::PutText" ref="9f08d35b1c7bae5d026fba47daa80f37" args="(const char *text,...)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::PutText </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put some text to the console.
<p>
Console acts like a simple TTY and should interpret basical symbols like '\n' and '\b'. The '\r' character has a special meaning: it sets a flag that tells console to clear the current line before next character is output. That is, you can emmit non-persistent messages this way: PutText ("some text@\r"); This message will disappear as soon as any other message will be sent to console.<p>
Remember that if you are not using the printf-style functionality, and the string may include '' signs, you should do PutText("%s", str) instead of PutText(str). <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__util.html">Notes about string formatting in Crystal Space</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="77abf6bbd53d30a6a3167c4144b845f7"></a><!-- doxytag: member="iConsoleOutput::PutTextV" ref="77abf6bbd53d30a6a3167c4144b845f7" args="(const char *text, va_list args)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::PutTextV </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Var_args version of PutText.
<p>
</div>
</div><p>
<a class="anchor" name="3cc6fc80e581764182e9d69098b0cfc9"></a><!-- doxytag: member="iConsoleOutput::RegisterWatcher" ref="3cc6fc80e581764182e9d69098b0cfc9" args="(iConsoleWatcher *)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::RegisterWatcher </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiConsoleWatcher.html">iConsoleWatcher</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tell console that this object should be notified when console visibility status changes.
<p>
</div>
</div><p>
<a class="anchor" name="0a6c077f8f5333e97160387aaaaac1c8"></a><!-- doxytag: member="iConsoleOutput::ScrollTo" ref="0a6c077f8f5333e97160387aaaaac1c8" args="(int topLine, bool snap=true)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::ScrollTo </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>topLine</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>snap</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the current top line, or use of the constants above for scrolling.
<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>topLine</em> </td><td>is the new top line. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>snap</em> </td><td>If true the console returns to the very bottom of the display when a new line is printed. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ea51c84cd36dcb66db2f15a5d5800777"></a><!-- doxytag: member="iConsoleOutput::SetBufferSize" ref="ea51c84cd36dcb66db2f15a5d5800777" args="(int maxLines)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::SetBufferSize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>maxLines</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the buffer size in lines.
<p>
</div>
</div><p>
<a class="anchor" name="c55c7821252f400cfaba649416bcc674"></a><!-- doxytag: member="iConsoleOutput::SetCursorPos" ref="c55c7821252f400cfaba649416bcc674" args="(int charNo)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::SetCursorPos </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>charNo</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set cursor horizontal position (-1 == follow output).
<p>
</div>
</div><p>
<a class="anchor" name="aab26286b0487d58e3377c452f029b98"></a><!-- doxytag: member="iConsoleOutput::SetCursorStyle" ref="aab26286b0487d58e3377c452f029b98" args="(int style)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::SetCursorStyle </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>style</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assign the cursor style.
<p>
</div>
</div><p>
<a class="anchor" name="64482f142ac27745bf746702c1fa42c1"></a><!-- doxytag: member="iConsoleOutput::SetFont" ref="64482f142ac27745bf746702c1fa42c1" args="(iFont *font)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::SetFont </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiFont.html">iFont</a> * </td>
<td class="paramname"> <em>font</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the font.
<p>
</div>
</div><p>
<a class="anchor" name="aa3a25dc7c42913280742c6b0b41c8df"></a><!-- doxytag: member="iConsoleOutput::SetTransparency" ref="aa3a25dc7c42913280742c6b0b41c8df" args="(bool transp)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::SetTransparency </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>transp</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set transparency.
<p>
</div>
</div><p>
<a class="anchor" name="439fedb2f76223f5792351608e33fcc1"></a><!-- doxytag: member="iConsoleOutput::SetVisible" ref="439fedb2f76223f5792351608e33fcc1" args="(bool show)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iConsoleOutput::SetVisible </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>show</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Show/hide the console.
<p>
In 'hidden' state console should not display anything at all (when Draw() is called) or draw some minimal information
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="conout_8h-source.html">conout.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
>
2860
