Sophie

Sophie

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

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/conout.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/conout.h</h1><a href="conout_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_CONOUT_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IVARIA_CONOUT_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">class </span><a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</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 <span class="keyword">struct </span><a class="code" href="structiTextureManager.html" title="This is the standard texture manager interface.">iTextureManager</a>;
<a name="l00032"></a>00032 <span class="keyword">struct </span><a class="code" href="structiFont.html" title="A font object.">iFont</a>;
<a name="l00033"></a>00033 
<a name="l00035"></a>00035 <span class="keyword">enum</span>
<a name="l00036"></a>00036 {
<a name="l00037"></a><a class="code" href="conout_8h.html#70ad55be767ca0a42c9150d24618e4ca7824d2f2d17eee4bd60eaf1e48845730">00037</a>   <a class="code" href="conout_8h.html#70ad55be767ca0a42c9150d24618e4ca7824d2f2d17eee4bd60eaf1e48845730">csConPageUp</a> = -1,
<a name="l00038"></a><a class="code" href="conout_8h.html#70ad55be767ca0a42c9150d24618e4ca5ae7c88ddefb4e442d17fe279787f0c5">00038</a>   <a class="code" href="conout_8h.html#70ad55be767ca0a42c9150d24618e4ca5ae7c88ddefb4e442d17fe279787f0c5">csConPageDown</a> = -2,
<a name="l00039"></a><a class="code" href="conout_8h.html#70ad55be767ca0a42c9150d24618e4ca65b2f433a295ecb7b1ab99900d816640">00039</a>   <a class="code" href="conout_8h.html#70ad55be767ca0a42c9150d24618e4ca65b2f433a295ecb7b1ab99900d816640">csConVeryTop</a> = -3,
<a name="l00040"></a><a class="code" href="conout_8h.html#70ad55be767ca0a42c9150d24618e4ca7ef80423489ab5fd7ea32ae9c582b811">00040</a>   <a class="code" href="conout_8h.html#70ad55be767ca0a42c9150d24618e4ca7ef80423489ab5fd7ea32ae9c582b811">csConVeryBottom</a> = -4
<a name="l00041"></a>00041 };
<a name="l00042"></a>00042 
<a name="l00043"></a>00043 <span class="keyword">enum</span>
<a name="l00044"></a>00044 {
<a name="l00045"></a><a class="code" href="conout_8h.html#4b4213b1f9d54da7c7e36bde32fc7c80febd8e14539803fb930b6c7a50c86cbe">00045</a>   <a class="code" href="conout_8h.html#4b4213b1f9d54da7c7e36bde32fc7c80febd8e14539803fb930b6c7a50c86cbe">csConNoCursor</a> = 0,
<a name="l00046"></a><a class="code" href="conout_8h.html#4b4213b1f9d54da7c7e36bde32fc7c80560c2660b09202837b4fced336bf27da">00046</a>   <a class="code" href="conout_8h.html#4b4213b1f9d54da7c7e36bde32fc7c80560c2660b09202837b4fced336bf27da">csConNormalCursor</a>,
<a name="l00047"></a><a class="code" href="conout_8h.html#4b4213b1f9d54da7c7e36bde32fc7c80e6497d181fe473c9860c9f020baeb137">00047</a>   <a class="code" href="conout_8h.html#4b4213b1f9d54da7c7e36bde32fc7c80e6497d181fe473c9860c9f020baeb137">csConInsertCursor</a>
<a name="l00048"></a>00048 };
<a name="l00049"></a>00049 
<a name="l00054"></a><a class="code" href="structiConsoleWatcher.html">00054</a> <span class="keyword">struct </span><a class="code" href="structiConsoleWatcher.html" title="This interface is implemented by objects interested in knowing when the console&amp;#39;s...">iConsoleWatcher</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="l00055"></a>00055 {
<a name="l00056"></a>00056   SCF_INTERFACE (<a class="code" href="structiConsoleWatcher.html" title="This interface is implemented by objects interested in knowing when the console&amp;#39;s...">iConsoleWatcher</a>, 1, 0, 0);
<a name="l00057"></a>00057 
<a name="l00059"></a>00059   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleWatcher.html#39b717074bdad23074e989eca96d7a37" title="Called when the watched console&amp;#39;s visibility status changes.">ConsoleVisibilityChanged</a>(<a class="code" href="structiConsoleOutput.html" title="This is the Crystal Space Console interface.">iConsoleOutput</a>*, <span class="keywordtype">bool</span> visible) = 0;
<a name="l00060"></a>00060 };
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 
<a name="l00079"></a><a class="code" href="structiConsoleOutput.html">00079</a> <span class="keyword">struct </span><a class="code" href="structiConsoleOutput.html" title="This is the Crystal Space Console interface.">iConsoleOutput</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="l00080"></a>00080 {
<a name="l00081"></a>00081   SCF_INTERFACE (<a class="code" href="structiConsoleOutput.html" title="This is the Crystal Space Console interface.">iConsoleOutput</a>, 3, 0, 0);
<a name="l00082"></a>00082  
<a name="l00097"></a>00097   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#9f08d35b1c7bae5d026fba47daa80f37" title="Put some text to the console.">PutText</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *text, ...) <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a> (2, 3) = 0;
<a name="l00098"></a>00098 
<a name="l00102"></a>00102   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#77abf6bbd53d30a6a3167c4144b845f7" title="Var_args version of PutText.">PutTextV</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *text, va_list args)
<a name="l00103"></a>00103       <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a> (2, 0) = 0;
<a name="l00104"></a>00104 
<a name="l00109"></a>00109   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structiConsoleOutput.html#7b299342fba17ed6bc8edb8ececa7382" title="Return a line from the buffer.">GetLine</a> (<span class="keywordtype">int</span> line = -1) <span class="keyword">const</span> = 0;
<a name="l00110"></a>00110 
<a name="l00120"></a>00120   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#5f379d5e33fb73741f2d471bdd080ab8" title="Display the console and return the dirty rectangle.">Draw2D</a> (<a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> *oRect = 0) = 0;
<a name="l00121"></a>00121 
<a name="l00131"></a>00131   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#44f42b38f0132f2b00096ce3a39da4ac" title="Update the 3D part of the console on the window.">Draw3D</a> (<a class="code" href="classcsRect.html" title="Rectangle class: simple class for manipulating 2D rectangles.">csRect</a> *oRect = 0) = 0;
<a name="l00132"></a>00132 
<a name="l00138"></a>00138   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#c1be1a129c8e5ed871c1890cef6fd705" title="Clear console.">Clear</a> (<span class="keywordtype">bool</span> wipe = <span class="keyword">false</span>) = 0;
<a name="l00139"></a>00139 
<a name="l00141"></a>00141   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#ea51c84cd36dcb66db2f15a5d5800777" title="Set the buffer size in lines.">SetBufferSize</a> (<span class="keywordtype">int</span> maxLines) = 0;
<a name="l00142"></a>00142 
<a name="l00144"></a>00144   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiConsoleOutput.html#6c7a6d7985561ef359902f72b8170ce8" title="Retrieve the transparency setting.">GetTransparency</a> () <span class="keyword">const</span> = 0;
<a name="l00146"></a>00146   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#aa3a25dc7c42913280742c6b0b41c8df" title="Set transparency.">SetTransparency</a> (<span class="keywordtype">bool</span> transp) = 0;
<a name="l00147"></a>00147 
<a name="l00149"></a>00149   <span class="keyword">virtual</span> <a class="code" href="structiFont.html" title="A font object.">iFont</a> *<a class="code" href="structiConsoleOutput.html#3638a872005fb8cb8c1e5638de3b915c" title="Gets the current font.">GetFont</a> () <span class="keyword">const</span> = 0;
<a name="l00151"></a>00151   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#64482f142ac27745bf746702c1fa42c1" title="Sets the font.">SetFont</a> (<a class="code" href="structiFont.html" title="A font object.">iFont</a> *font) = 0;
<a name="l00152"></a>00152 
<a name="l00154"></a>00154   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiConsoleOutput.html#b9103719ad671df0641c900e6e9a2285" title="Get the current top line being displayed.">GetTopLine</a> () <span class="keyword">const</span> = 0;
<a name="l00161"></a>00161   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#0a6c077f8f5333e97160387aaaaac1c8" title="Set the current top line, or use of the constants above for scrolling.">ScrollTo</a> (<span class="keywordtype">int</span> topLine, <span class="keywordtype">bool</span> snap = <span class="keyword">true</span>) = 0;
<a name="l00162"></a>00162 
<a name="l00164"></a>00164   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiConsoleOutput.html#210a09a7ec390582fdacc1c08596759b" title="Retrieve the cursor style.">GetCursorStyle</a> () <span class="keyword">const</span> = 0;
<a name="l00166"></a>00166   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#aab26286b0487d58e3377c452f029b98" title="Assign the cursor style.">SetCursorStyle</a> (<span class="keywordtype">int</span> style) = 0;
<a name="l00167"></a>00167 
<a name="l00172"></a>00172   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#439fedb2f76223f5792351608e33fcc1" title="Show/hide the console.">SetVisible</a> (<span class="keywordtype">bool</span> show) = 0;
<a name="l00176"></a>00176   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiConsoleOutput.html#423d3c30d842d32d6550a35ef371ea79" title="Query whether the console is visible or hidden.">GetVisible</a> () = 0;
<a name="l00177"></a>00177 
<a name="l00189"></a>00189   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#1632713c98a0d4096427ca3c58d1392d" title="Enable or disable automatic console updates.">AutoUpdate</a> (<span class="keywordtype">bool</span> autoUpdate) = 0;
<a name="l00190"></a>00190 
<a name="l00192"></a>00192   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#c55c7821252f400cfaba649416bcc674" title="Set cursor horizontal position (-1 == follow output).">SetCursorPos</a> (<span class="keywordtype">int</span> charNo) = 0;
<a name="l00193"></a>00193 
<a name="l00195"></a>00195   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiConsoleOutput.html#28c97445fb74e2353af20a0e36828e43" title="Query maximal line width in characters.">GetMaxLineWidth</a> () = 0;
<a name="l00196"></a>00196 
<a name="l00201"></a>00201   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiConsoleOutput.html#3cc6fc80e581764182e9d69098b0cfc9" title="Tell console that this object should be notified when console visibility status changes...">RegisterWatcher</a> (<a class="code" href="structiConsoleWatcher.html" title="This interface is implemented by objects interested in knowing when the console&amp;#39;s...">iConsoleWatcher</a>*) = 0;
<a name="l00202"></a>00202 
<a name="l00204"></a>00204   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiConsoleOutput.html#9407328b722a9c5525f92b65d50c7c1c" title="Implement simple extension commands.">PerformExtension</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *command, ...) = 0;
<a name="l00205"></a>00205 
<a name="l00207"></a>00207   <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiConsoleOutput.html#c902dd0d4410f09040ceb38a92a4f4b4" title="Implement simple extension commands.">PerformExtensionV</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *command, va_list) = 0;
<a name="l00208"></a>00208 };
<a name="l00209"></a>00209 
<a name="l00210"></a>00210 <span class="preprocessor">#endif // __CS_IVARIA_CONOUT_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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional