English
Kamil Dudka

GED 2006 (C++)

Detail souboru

Jméno:StáhnoutclassCmd.html [Stáhnout]
Umístění: ged2006 > doc > classes
Velikost:16.2 KB
Poslední změna:2022-09-09 13:06

Zdrojový kód

<!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: Cmd 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&nbsp;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&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>Cmd Class Reference</h1><!-- doxytag: class="Cmd" --><code>#include &lt;<a class="el" href="command_8h-source.html">command.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Cmd:
<p><center><img src="classCmd.png" usemap="#Cmd_map" border="0" alt=""></center>
<map name="Cmd_map">
<area href="classMacroCmd.html" alt="MacroCmd" shape="rect" coords="0,56,128,80">
<area href="classSelectCmd.html" alt="SelectCmd" shape="rect" coords="138,56,266,80">
<area href="classSlowUndoCmd.html" alt="SlowUndoCmd" shape="rect" coords="276,56,404,80">
<area href="classSlowUndoSelectCmd.html" alt="SlowUndoSelectCmd" shape="rect" coords="690,56,818,80">
<area href="classPluginCmd.html" alt="PluginCmd" shape="rect" coords="276,112,404,136">
<area href="classBrushCmd.html" alt="BrushCmd" shape="rect" coords="414,112,542,136">
<area href="classGrayScaleCmd.html" alt="GrayScaleCmd" shape="rect" coords="552,112,680,136">
<area href="classInvertCmd.html" alt="InvertCmd" shape="rect" coords="690,112,818,136">
<area href="classPlacementCmd.html" alt="PlacementCmd" shape="rect" coords="828,112,956,136">
<area href="classTextCmd.html" alt="TextCmd" shape="rect" coords="966,112,1094,136">
<area href="classCircleCmd.html" alt="CircleCmd" shape="rect" coords="621,168,749,192">
<area href="classEllipseCmd.html" alt="EllipseCmd" shape="rect" coords="759,168,887,192">
<area href="classLineCmd.html" alt="LineCmd" shape="rect" coords="897,168,1025,192">
<area href="classRectCmd.html" alt="RectCmd" shape="rect" coords="1035,168,1163,192">
</map>
<a href="classCmd-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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCmd.html#1f036f79ba540557042d21f954e01972">~Cmd</a> ()</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">All <a class="el" href="classCmd.html">Cmd</a> based classes will have virtual destructor.  <a href="#1f036f79ba540557042d21f954e01972"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCmd.html#91ebd2007a41d4943ea2d47f16706d97">exec</a> ()=0</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command execution. This should save undo informations.  <a href="#91ebd2007a41d4943ea2d47f16706d97"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCmd.html#92b768830e3583e88f417da33d9b552b">unExec</a> ()=0</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Revert command execution using undo informations.  <a href="#92b768830e3583e88f417da33d9b552b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCmd.html#12950146932aaa5a72e9f5a4fbb86d1c">name</a> ()=0</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command identification. This will appear in config file.  <a href="#12950146932aaa5a72e9f5a4fbb86d1c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCmd.html#28336769776671d47a997a8f1e43f406">args</a> ()=0</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command export to text string. Needed for macro saving.  <a href="#28336769776671d47a997a8f1e43f406"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCmd.html#61ec883203e3b845694efaf2e2fc756a">Cmd</a> (<a class="el" href="classFrameBuffer.html">FrameBuffer</a> *pFB)</td></tr>
 
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classFrameBuffer.html">FrameBuffer</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCmd.html#2bd3ee2fd804193c81a912e7c64b9767">_fb</a></td></tr>
 
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCmd.html#9f62c1dab9a3ceb2841bd8df3b5a6a71">CmdHistory</a></td></tr>
 
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Virtual class command. This class is base for all drawing commands and operation. This is needed especially for undo/redo support and macros support. For more information see the <a class="el" href="classCmdHistory.html">CmdHistory</a> class. Design pattern command. 
<p>
 
<p>
Definition at line <a class="el" href="command_8h-source.html#l00025">25</a> of file <a class="el" href="command_8h-source.html">command.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="1f036f79ba540557042d21f954e01972"></a><!-- doxytag: member="Cmd::~Cmd" ref="1f036f79ba540557042d21f954e01972" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual Cmd::~Cmd           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
All <a class="el" href="classCmd.html">Cmd</a> based classes will have virtual destructor. 
<p>
 
<p>
Definition at line <a class="el" href="command_8h-source.html#l00027">27</a> of file <a class="el" href="command_8h-source.html">command.h</a>.
</div>
</div><p>
<a class="anchor" name="61ec883203e3b845694efaf2e2fc756a"></a><!-- doxytag: member="Cmd::Cmd" ref="61ec883203e3b845694efaf2e2fc756a" args="(FrameBuffer *pFB)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Cmd::Cmd           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classFrameBuffer.html">FrameBuffer</a> *&nbsp;</td>
          <td class="paramname"> <em>pFB</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, protected]</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>&nbsp;</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#l00038">38</a> of file <a class="el" href="command_8h-source.html">command.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="91ebd2007a41d4943ea2d47f16706d97"></a><!-- doxytag: member="Cmd::exec" ref="91ebd2007a41d4943ea2d47f16706d97" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Cmd::exec           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Command execution. This should save undo informations. 
<p>
 
<p>
Implemented in <a class="el" href="classSlowUndoCmd.html#a0fe0ca6ec2ba209691950d31924fa4e">SlowUndoCmd</a>, <a class="el" href="classSlowUndoSelectCmd.html#302b2114591a5469e70c5b32225cd67e">SlowUndoSelectCmd</a>, <a class="el" href="classPluginCmd.html#3642db0d31a13fc1e24c2f9a2d23c723">PluginCmd</a>, <a class="el" href="classMacroCmd.html#2e780443902b228549c4f2c3f969bb47">MacroCmd</a>, <a class="el" href="classBrushCmd.html#9f8e763d8aad1c1d64e6105a5fbe4956">BrushCmd</a>, <a class="el" href="classLineCmd.html#3c15aede313493b9fff31fe4d8bf985b">LineCmd</a>, <a class="el" href="classRectCmd.html#4a793d0fd3fd35130bd423e2a58f9c5a">RectCmd</a>, <a class="el" href="classCircleCmd.html#7df8426dec09ec729521f77b93c92ef6">CircleCmd</a>, <a class="el" href="classEllipseCmd.html#dcbac39e8637ef45e934f15069cb70dc">EllipseCmd</a>, <a class="el" href="classTextCmd.html#5b21c88907521aa5040b164ef0079fed">TextCmd</a>, <a class="el" href="classSelectCmd.html#41d2b80b92c534dd8e44b0a416a23433">SelectCmd</a>, <a class="el" href="classGrayScaleCmd.html#49a960cc7674d6c86d11c67d7a7941f5">GrayScaleCmd</a>, and <a class="el" href="classInvertCmd.html#1eee2b35bd93906806488191660ff909">InvertCmd</a>.
<p>
Referenced by <a class="el" href="image_8h-source.html#l00062">Image::operator&lt;&lt;()</a>.
</div>
</div><p>
<a class="anchor" name="92b768830e3583e88f417da33d9b552b"></a><!-- doxytag: member="Cmd::unExec" ref="92b768830e3583e88f417da33d9b552b" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Cmd::unExec           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Revert command execution using undo informations. 
<p>
 
<p>
Implemented in <a class="el" href="classSlowUndoCmd.html#56afa2d41608a96670f9d5937bbcfd4c">SlowUndoCmd</a>, <a class="el" href="classSlowUndoSelectCmd.html#0d951b6cf06e450526173ecfe1c327cc">SlowUndoSelectCmd</a>, <a class="el" href="classMacroCmd.html#5243047dbf5feae8aa69f71fbc727120">MacroCmd</a>, and <a class="el" href="classSelectCmd.html#e5be3dc9fd2217f6021222df47eea66c">SelectCmd</a>.
</div>
</div><p>
<a class="anchor" name="12950146932aaa5a72e9f5a4fbb86d1c"></a><!-- doxytag: member="Cmd::name" ref="12950146932aaa5a72e9f5a4fbb86d1c" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string Cmd::name           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Command identification. This will appear in config file. 
<p>
 
<p>
Implemented in <a class="el" href="classSlowUndoCmd.html#ded003144be4d791e36e763b1580f0bc">SlowUndoCmd</a>, <a class="el" href="classSlowUndoSelectCmd.html#ee3bd5a915a80da8d81d1e5934639ad2">SlowUndoSelectCmd</a>, <a class="el" href="classPluginCmd.html#e98217cde41a539016104d5abbf2d1d1">PluginCmd</a>, <a class="el" href="classMacroCmd.html#1597e0e61789b0062fad21100d46a90f">MacroCmd</a>, <a class="el" href="classBrushCmd.html#e801b767d528289d52f8d7aef288834a">BrushCmd</a>, <a class="el" href="classLineCmd.html#639dcb2084f2e43a57de212816c6d043">LineCmd</a>, <a class="el" href="classRectCmd.html#b31c7748e026418c4684c436190e64ae">RectCmd</a>, <a class="el" href="classCircleCmd.html#9fd3d2925d23108bb46426784f21bf3b">CircleCmd</a>, <a class="el" href="classEllipseCmd.html#5201cbdb6719b44fde76a7f936322083">EllipseCmd</a>, <a class="el" href="classTextCmd.html#04f61260709b9a70483188a0410760dc">TextCmd</a>, <a class="el" href="classSelectCmd.html#965b66a4b5179dc81ef1914a428b53ab">SelectCmd</a>, <a class="el" href="classGrayScaleCmd.html#633357803bec57de6f7c7690b4173409">GrayScaleCmd</a>, and <a class="el" href="classInvertCmd.html#a48c2025dccba4c98dacf7baa2fdb4c5">InvertCmd</a>.
</div>
</div><p>
<a class="anchor" name="28336769776671d47a997a8f1e43f406"></a><!-- doxytag: member="Cmd::args" ref="28336769776671d47a997a8f1e43f406" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string Cmd::args           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Command export to text string. Needed for macro saving. 
<p>
 
<p>
Implemented in <a class="el" href="classSlowUndoCmd.html#a26ced5fe114d904dfdcd56f5d9d7188">SlowUndoCmd</a>, <a class="el" href="classSlowUndoSelectCmd.html#af48c2bf9ed3365817682dcf8594a550">SlowUndoSelectCmd</a>, <a class="el" href="classPluginCmd.html#f7383a429feff3b9b70c1e6388c916db">PluginCmd</a>, <a class="el" href="classMacroCmd.html#345a33230b77a93b48a0a36a1288a08a">MacroCmd</a>, <a class="el" href="classBrushCmd.html#4e58ba999d79085b851d46c4a2e6be3d">BrushCmd</a>, <a class="el" href="classPlacementCmd.html#1ad8e926b4843921210412cf247f8e7b">PlacementCmd</a>, <a class="el" href="classTextCmd.html#81a0bf34b3bb2498f86e090a7265a38b">TextCmd</a>, <a class="el" href="classSelectCmd.html#1f237c708acec9dcce6cc58d0e545509">SelectCmd</a>, <a class="el" href="classGrayScaleCmd.html#9290f42b0297da7124159a1bacb11153">GrayScaleCmd</a>, and <a class="el" href="classInvertCmd.html#4c8774c21e5d9ef2a7d1c0e3d78e5a5b">InvertCmd</a>.
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="9f62c1dab9a3ceb2841bd8df3b5a6a71"></a><!-- doxytag: member="Cmd::CmdHistory" ref="9f62c1dab9a3ceb2841bd8df3b5a6a71" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classCmdHistory.html">CmdHistory</a><code> [friend]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Needed to obtain <a class="el" href="classCmd.html#2bd3ee2fd804193c81a912e7c64b9767">Cmd::_fb</a> while creating <a class="el" href="classMacroCmd.html">MacroCmd</a> 
<p>
Definition at line <a class="el" href="command_8h-source.html#l00048">48</a> of file <a class="el" href="command_8h-source.html">command.h</a>.
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="2bd3ee2fd804193c81a912e7c64b9767"></a><!-- doxytag: member="Cmd::_fb" ref="2bd3ee2fd804193c81a912e7c64b9767" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classFrameBuffer.html">FrameBuffer</a>&amp; <a class="el" href="classCmd.html#2bd3ee2fd804193c81a912e7c64b9767">Cmd::_fb</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Frame buffer reference. All derived class should use this reference. 
<p>
Definition at line <a class="el" href="command_8h-source.html#l00043">43</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#l00058">SlowUndoCmd::exec()</a>, and <a class="el" href="command_8h-source.html#l00059">SlowUndoCmd::unExec()</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&nbsp;
<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>