GED 2006 (C++)
File detail
Source code
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>GED 2006: MacroCmd Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</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>
</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>MacroCmd Class Reference</h1><!-- doxytag: class="MacroCmd" --><!-- doxytag: inherits="Cmd" --><code>#include <<a class="el" href="command_8h-source.html">command.h</a>></code>
<p>
<p>Inheritance diagram for MacroCmd:
<p><center><img src="classMacroCmd.png" usemap="#MacroCmd_map" border="0" alt=""></center>
<map name="MacroCmd_map">
<area href="classCmd.html" alt="Cmd" shape="rect" coords="0,0,74,24">
</map>
<a href="classMacroCmd-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#dac5d6a2dab9c1d95f90e3b2574ba347">MacroCmd</a> (<a class="el" href="classFrameBuffer.html">FrameBuffer</a> *pFB)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#0ecb95fc8fa72854c5530e33b7b0fbe0">MacroCmd</a> (<a class="el" href="classFrameBuffer.html">FrameBuffer</a> *pFB, std::string macName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classMacroCmd.html">MacroCmd</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#c91d5f35080377de63b6bd1fb24b4a9e">operator<<</a> (<a class="el" href="classCmd.html">Cmd</a> *pCmd)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#2e780443902b228549c4f2c3f969bb47">exec</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#5243047dbf5feae8aa69f71fbc727120">unExec</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#1597e0e61789b0062fad21100d46a90f">name</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command identification. This will appear in config file. <a href="#1597e0e61789b0062fad21100d46a90f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#345a33230b77a93b48a0a36a1288a08a">args</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command export to text string. Needed for macro saving. <a href="#345a33230b77a93b48a0a36a1288a08a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#1f04523b1386aaa6d53af74f14328fd7">name</a> (std::string name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#9284eeabaa4d212251351f5bec189bd2">save</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMacroCmd.html#3bb038007713095dc69a011072809a68">szCmdName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command id string. <a href="#3bb038007713095dc69a011072809a68"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Macro command abstraction. Design patterns: command, composite
<p>
<p>
Definition at line <a class="el" href="command_8h-source.html#l00126">126</a> of file <a class="el" href="command_8h-source.html">command.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="dac5d6a2dab9c1d95f90e3b2574ba347"></a><!-- doxytag: member="MacroCmd::MacroCmd" ref="dac5d6a2dab9c1d95f90e3b2574ba347" args="(FrameBuffer *pFB)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MacroCmd::MacroCmd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFrameBuffer.html">FrameBuffer</a> * </td>
<td class="paramname"> <em>pFB</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize base. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pFB</em> </td><td>Pointer to frame buffer to work with. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="command_8h-source.html#l00132">132</a> of file <a class="el" href="command_8h-source.html">command.h</a>.
</div>
</div><p>
<a class="anchor" name="0ecb95fc8fa72854c5530e33b7b0fbe0"></a><!-- doxytag: member="MacroCmd::MacroCmd" ref="0ecb95fc8fa72854c5530e33b7b0fbe0" args="(FrameBuffer *pFB, std::string macName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MacroCmd::MacroCmd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFrameBuffer.html">FrameBuffer</a> * </td>
<td class="paramname"> <em>pFB</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>macName</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read macro from configuration file. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pFB</em> </td><td>Pointer to frame buffer to work with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>macName</em> </td><td>Macro name. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c91d5f35080377de63b6bd1fb24b4a9e"></a><!-- doxytag: member="MacroCmd::operator<<" ref="c91d5f35080377de63b6bd1fb24b4a9e" args="(Cmd *pCmd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classMacroCmd.html">MacroCmd</a>& MacroCmd::operator<< </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCmd.html">Cmd</a> * </td>
<td class="paramname"> <em>pCmd</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put command to <a class="el" href="classMacroCmd.html">MacroCmd</a>. *pCmd object must exist all the time since <a class="el" href="classMacroCmd.html">MacroCmd</a> object is destroyed. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pCmd</em> </td><td>pointer to command. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to this. Needed for << operator concatenation. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2e780443902b228549c4f2c3f969bb47"></a><!-- doxytag: member="MacroCmd::exec" ref="2e780443902b228549c4f2c3f969bb47" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MacroCmd::exec </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Execute macro command. This means all elementary commands are executed.
<p>
Implements <a class="el" href="classCmd.html#91ebd2007a41d4943ea2d47f16706d97">Cmd</a>.
</div>
</div><p>
<a class="anchor" name="5243047dbf5feae8aa69f71fbc727120"></a><!-- doxytag: member="MacroCmd::unExec" ref="5243047dbf5feae8aa69f71fbc727120" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MacroCmd::unExec </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Undo macro command. This means all elementary commands are unexecuted in reverse order.
<p>
Implements <a class="el" href="classCmd.html#92b768830e3583e88f417da33d9b552b">Cmd</a>.
</div>
</div><p>
<a class="anchor" name="1597e0e61789b0062fad21100d46a90f"></a><!-- doxytag: member="MacroCmd::name" ref="1597e0e61789b0062fad21100d46a90f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string MacroCmd::name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Command identification. This will appear in config file.
<p>
<p>
Implements <a class="el" href="classCmd.html#12950146932aaa5a72e9f5a4fbb86d1c">Cmd</a>.
<p>
Definition at line <a class="el" href="command_8h-source.html#l00160">160</a> of file <a class="el" href="command_8h-source.html">command.h</a>.
<p>
References <a class="el" href="command_8h-source.html#l00174">szCmdName</a>.
</div>
</div><p>
<a class="anchor" name="345a33230b77a93b48a0a36a1288a08a"></a><!-- doxytag: member="MacroCmd::args" ref="345a33230b77a93b48a0a36a1288a08a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string MacroCmd::args </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Command export to text string. Needed for macro saving.
<p>
<p>
Implements <a class="el" href="classCmd.html#28336769776671d47a997a8f1e43f406">Cmd</a>.
<p>
Definition at line <a class="el" href="command_8h-source.html#l00161">161</a> of file <a class="el" href="command_8h-source.html">command.h</a>.
</div>
</div><p>
<a class="anchor" name="1f04523b1386aaa6d53af74f14328fd7"></a><!-- doxytag: member="MacroCmd::name" ref="1f04523b1386aaa6d53af74f14328fd7" args="(std::string name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MacroCmd::name </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set macro name. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>New macro name. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="command_8h-source.html#l00167">167</a> of file <a class="el" href="command_8h-source.html">command.h</a>.
</div>
</div><p>
<a class="anchor" name="9284eeabaa4d212251351f5bec189bd2"></a><!-- doxytag: member="MacroCmd::save" ref="9284eeabaa4d212251351f5bec189bd2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MacroCmd::save </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save macro to configuration file.
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="3bb038007713095dc69a011072809a68"></a><!-- doxytag: member="MacroCmd::szCmdName" ref="3bb038007713095dc69a011072809a68" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="classMacroCmd.html#3bb038007713095dc69a011072809a68">MacroCmd::szCmdName</a><code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Command id string.
<p>
<p>
Definition at line <a class="el" href="command_8h-source.html#l00174">174</a> of file <a class="el" href="command_8h-source.html">command.h</a>.
<p>
Referenced by <a class="el" href="command_8h-source.html#l00160">name()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="command_8h-source.html">command.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 29 00:01:04 2007 for GED 2006 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
Back to main page
classMacroCmd.html [Download]