?? classconsole__c.html
字號(hào):
<!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>console_c class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>console_c Class Reference</h1>A generic text I/O console class, needs to be subclassed to interface with input/rendering code. <a href="#_details">More...</a><p><code>#include <<a class="el" href="console_8h-source.html">console.h</a>></code><p><a href="classconsole__c-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 Methods</h2></td></tr><tr><td nowrap align=right valign=top><a name="a0" doxytag="console_c::console_c"></a> </td><td valign=bottom><a class="el" href="classconsole__c.html#a0">console_c</a> (int outputBufferSizeInKilobytes, int consoleDisplayColumns, int consoleDisplayRows)</td></tr><tr><td> </td><td><font size=-1><em>constructor : console + default display</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a1" doxytag="console_c::console_c"></a> </td><td valign=bottom><a class="el" href="classconsole__c.html#a1">console_c</a> (int outputBufferSizeInKilobytes)</td></tr><tr><td> </td><td><font size=-1><em>constructor : console without display, you must call <a class="el" href="classconsole__c.html#a4">enable_display()</a> later and provide columns and rows of the display</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a2" doxytag="console_c::console_c"></a> </td><td valign=bottom><a class="el" href="classconsole__c.html#a2">console_c</a> ()</td></tr><tr><td> </td><td><font size=-1><em>default constructor: allocate a small buffer size</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a3" doxytag="console_c::~console_c"></a>virtual </td><td valign=bottom><a class="el" href="classconsole__c.html#a3">~console_c</a> ()</td></tr><tr><td> </td><td><font size=-1><em>destructor (frees buffers)</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a4" doxytag="console_c::enable_display"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a4">enable_display</a> (int cols, int rows)</td></tr><tr><td> </td><td><font size=-1><em>makes the console start drawing (again?) when calling <a class="el" href="classconsole__c.html#a17">draw_page()</a></em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a5" doxytag="console_c::disable_display"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a5">disable_display</a> ()</td></tr><tr><td> </td><td><font size=-1><em>disables console rendering (<a class="el" href="classconsole__c.html#b8">draw_line()</a> callback, etc.)</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a6" doxytag="console_c::set_debug_mode"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a6">set_debug_mode</a> (bool devmode)</td></tr><tr><td> </td><td><font size=-1><em>toggle developer mode</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a7" doxytag="console_c::set_xprintf_level"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a7">set_xprintf_level</a> (int level)</td></tr><tr><td> </td><td><font size=-1><em>toggle "xprintf" minimum message level for output</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a8" doxytag="console_c::enable_log"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a8">enable_log</a> (int log_handle)</td></tr><tr><td> </td><td><font size=-1><em>enables logging of console input/output to the given log handle (see <a class="el" href="log_8h.html">log.h</a>)</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a9" doxytag="console_c::disable_log"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a9">disable_log</a> ()</td></tr><tr><td> </td><td><font size=-1><em>disables logging of console input/output (the default)</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a10" doxytag="console_c::write_string"></a>virtual bool </td><td valign=bottom><a class="el" href="classconsole__c.html#a10">write_string</a> (const char *outstr)</td></tr><tr><td> </td><td><font size=-1><em>sends a character string to the console as output, returns false if didn't do the writing for any reason.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a11" doxytag="console_c::printf"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a11">printf</a> (const char *formatstr,...)</td></tr><tr><td> </td><td><font size=-1><em>sends a formatted character string to the console as output</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a12" doxytag="console_c::dprintf"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a12">dprintf</a> (const char *formatstr,...)</td></tr><tr><td> </td><td><font size=-1><em>same as printf but is ignored if set_debug_mode(false)</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a13" doxytag="console_c::xprintf"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a13">xprintf</a> (int level, const char *formatstr,...)</td></tr><tr><td> </td><td><font size=-1><em>same as dprintf but - level = message priority 0=low..N=high, use <a class="el" href="classconsole__c.html#a7">set_xprintf_level()</a></em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a14" doxytag="console_c::read_string"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a14">read_string</a> (const char *instr, bool isScript=false)</td></tr><tr><td> </td><td><font size=-1><em>sends a character string to the console as input (typed by user or a script)</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a15" doxytag="console_c::read_char"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a15">read_char</a> (char inchar, bool isScript=false)</td></tr><tr><td> </td><td><font size=-1><em>sends a single character to the console as input</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a16" doxytag="console_c::clear_text"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a16">clear_text</a> ()</td></tr><tr><td> </td><td><font size=-1><em>clear all text (input & output)</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a17" doxytag="console_c::draw_page"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a17">draw_page</a> (bool force=false)</td></tr><tr><td> </td><td><font size=-1><em>redraws the console if necessary (if input prompt or output have changed), if force == true, then forces the console to redraw even if nothing has changed. this method will call the other virtual methods of this class, namely <a class="el" href="classconsole__c.html#b9">clear()</a>, <a class="el" href="classconsole__c.html#b10">clear_prompt()</a>, and <a class="el" href="classconsole__c.html#b8">draw_line()</a>, to do the actual drawing to a screen, bitmap, or whatever 2D graphical context.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a18" doxytag="console_c::scroll_page_up"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a18">scroll_page_up</a> ()</td></tr><tr><td> </td><td><font size=-1><em>scroll page up</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a19" doxytag="console_c::scroll_page_down"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a19">scroll_page_down</a> ()</td></tr><tr><td> </td><td><font size=-1><em>scroll page down</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a20" doxytag="console_c::scroll_all_down"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a20">scroll_all_down</a> ()</td></tr><tr><td> </td><td><font size=-1><em>scroll to the bottom</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a21" doxytag="console_c::history_back"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a21">history_back</a> ()</td></tr><tr><td> </td><td><font size=-1><em>put the next line in hystory in the prompt</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="a22" doxytag="console_c::history_forward"></a>void </td><td valign=bottom><a class="el" href="classconsole__c.html#a22">history_forward</a> ()</td></tr><tr><td> </td><td><font size=-1><em>put the previous line in hystory in the prompt</em></font><br><br></td></tr><tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr><tr><td nowrap align=right valign=top><a name="d1" doxytag="console_c::GetDefCon"></a>console_c * </td><td valign=bottom><a class="el" href="classconsole__c.html#d1">GetDefCon</a> ()</td></tr><tr><td> </td><td><font size=-1><em>returns the default console</em></font><br><br></td></tr><tr><td colspan=2><br><h2>Protected Methods</h2></td></tr><tr><td nowrap align=right valign=top><a name="b7" doxytag="console_c::interprete_command"></a>virtual void </td><td valign=bottom><a class="el" href="classconsole__c.html#b7">interprete_command</a> (char *cmdstr)</td></tr><tr><td> </td><td><font size=-1><em>ABSTRACT: input comand processing (triggered from <a class="el" href="classconsole__c.html#a14">read_string()</a> and <a class="el" href="classconsole__c.html#a15">read_char()</a> calls) . *** TO BE IMPLEMENTED IN SUBCLASS ***.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="b8" doxytag="console_c::draw_line"></a>virtual void </td><td valign=bottom><a class="el" href="classconsole__c.html#b8">draw_line</a> (int line, char *buf)</td></tr><tr><td> </td><td><font size=-1><em>ABSTRACT: render a console line. line: line offset onscreen. buf: line of text. *** TO BE IMPLEMENTED IN SUBCLASS ***.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="b9" doxytag="console_c::clear"></a>virtual void </td><td valign=bottom><a class="el" href="classconsole__c.html#b9">clear</a> ()</td></tr><tr><td> </td><td><font size=-1><em>ABSTRACT: called when console must be redrawn. *** TO BE IMPLEMENTED IN SUBCLASS ***.</em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a name="b10" doxytag="console_c::clear_prompt"></a>virtual void </td><td valign=bottom><a class="el" href="classconsole__c.html#b10">clear_prompt</a> ()</td></tr><tr><td> </td><td><font size=-1><em>ABSTRACT: called when console input must be redrawn. *** TO BE IMPLEMENTED IN SUBCLASS ***.</em></font><br><br></td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>A generic text I/O console class, needs to be subclassed to interface with input/rendering code.<p><hr>The documentation for this class was generated from the following files:<ul><li><a class="el" href="console_8h-source.html">console.h</a><li>console.cpp</ul><hr><address style="align: right;"><small>Generated on Mon Jan 24 21:14:23 2005 for ZIG by<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.18 </small></address></body></html>?? 快捷鍵說(shuō)明
復(fù)制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號(hào)
Ctrl + =
減小字號(hào)
Ctrl + -