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: LineCmd 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>LineCmd Class Reference</h1><!-- doxytag: class="LineCmd" --><!-- doxytag: inherits="PlacementCmd" --><code>#include <<a class="el" href="draw_8h-source.html">draw.h</a>></code>
<p>
<p>Inheritance diagram for LineCmd:
<p><center><img src="classLineCmd.png" usemap="#LineCmd_map" border="0" alt=""></center>
<map name="LineCmd_map">
<area href="classPlacementCmd.html" alt="PlacementCmd" shape="rect" coords="0,112,128,136">
<area href="classSlowUndoSelectCmd.html" alt="SlowUndoSelectCmd" shape="rect" coords="0,56,128,80">
<area href="classCmd.html" alt="Cmd" shape="rect" coords="0,0,128,24">
</map>
<a href="classLineCmd-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="classLineCmd.html#2e1e18853184d8a4b63cb2f3613355fd">LineCmd</a> (<a class="el" href="classFrameBuffer.html">FrameBuffer</a> *pFB, <a class="el" href="structRect.html">Rect</a> placement, <a class="el" href="structDrawContext.html">DrawContext</a> dc, bool bBack=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineCmd.html#3c15aede313493b9fff31fe4d8bf985b">exec</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command execution. This should save undo informations. <a href="#3c15aede313493b9fff31fe4d8bf985b"></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="classLineCmd.html#639dcb2084f2e43a57de212816c6d043">name</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command identification. This will appear in config file. <a href="#639dcb2084f2e43a57de212816c6d043"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineCmd.html#682d4f5d3e10682bc60fcd736c0b16fd">LineCmd</a> (<a class="el" href="classFrameBuffer.html">FrameBuffer</a> *pFB, const std::string &args)</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 *const </td><td class="memItemRight" valign="bottom"><a class="el" href="classLineCmd.html#31a1ae38639cf773493c767fc0d19b3f">szCmdName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">command id string <a href="#31a1ae38639cf773493c767fc0d19b3f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Line draw command class. Design pattern command.
<p>
<p>
Definition at line <a class="el" href="draw_8h-source.html#l00162">162</a> of file <a class="el" href="draw_8h-source.html">draw.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="2e1e18853184d8a4b63cb2f3613355fd"></a><!-- doxytag: member="LineCmd::LineCmd" ref="2e1e18853184d8a4b63cb2f3613355fd" args="(FrameBuffer *pFB, Rect placement, DrawContext dc, bool bBack=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LineCmd::LineCmd </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"><a class="el" href="structRect.html">Rect</a> </td>
<td class="paramname"> <em>placement</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structDrawContext.html">DrawContext</a> </td>
<td class="paramname"> <em>dc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>bBack</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct line command. <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 framebuffer to work with. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>placement</em> </td><td>Command placement. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dc</em> </td><td>Current draw context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bBack</em> </td><td>Give true to use background brush. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="draw_8h-source.html#l00171">171</a> of file <a class="el" href="draw_8h-source.html">draw.h</a>.
</div>
</div><p>
<a class="anchor" name="682d4f5d3e10682bc60fcd736c0b16fd"></a><!-- doxytag: member="LineCmd::LineCmd" ref="682d4f5d3e10682bc60fcd736c0b16fd" args="(FrameBuffer *pFB, const std::string &args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LineCmd::LineCmd </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">const std::string & </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Import line command. <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>args</em> </td><td>Data to import -- previously returned by <a class="el" href="classPlacementCmd.html#1ad8e926b4843921210412cf247f8e7b" title="Command export to text string. Needed for macro saving.">PlacementCmd::args()</a> method. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="draw_8h-source.html#l00183">183</a> of file <a class="el" href="draw_8h-source.html">draw.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3c15aede313493b9fff31fe4d8bf985b"></a><!-- doxytag: member="LineCmd::exec" ref="3c15aede313493b9fff31fe4d8bf985b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void LineCmd::exec </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Command execution. This should save undo informations.
<p>
<p>
Reimplemented from <a class="el" href="classSlowUndoSelectCmd.html#302b2114591a5469e70c5b32225cd67e">SlowUndoSelectCmd</a>.
</div>
</div><p>
<a class="anchor" name="639dcb2084f2e43a57de212816c6d043"></a><!-- doxytag: member="LineCmd::name" ref="639dcb2084f2e43a57de212816c6d043" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual std::string LineCmd::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="classSlowUndoSelectCmd.html#ee3bd5a915a80da8d81d1e5934639ad2">SlowUndoSelectCmd</a>.
<p>
Definition at line <a class="el" href="draw_8h-source.html#l00175">175</a> of file <a class="el" href="draw_8h-source.html">draw.h</a>.
<p>
References <a class="el" href="draw_8h-source.html#l00176">szCmdName</a>.
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="31a1ae38639cf773493c767fc0d19b3f"></a><!-- doxytag: member="LineCmd::szCmdName" ref="31a1ae38639cf773493c767fc0d19b3f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const <a class="el" href="classLineCmd.html#31a1ae38639cf773493c767fc0d19b3f">LineCmd::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="draw_8h-source.html#l00176">176</a> of file <a class="el" href="draw_8h-source.html">draw.h</a>.
<p>
Referenced by <a class="el" href="draw_8h-source.html#l00175">name()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="draw_8h-source.html">draw.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
classLineCmd.html [Download]