English
Kamil Dudka

GED 2006 (C++)

Detail souboru

Jméno:StáhnoutclassPluginCmd.html [Stáhnout]
Umístění: ged2006 > doc > classes
Velikost:8.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: PluginCmd 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>PluginCmd Class Reference</h1><!-- doxytag: class="PluginCmd" --><!-- doxytag: inherits="SlowUndoCmd" --><code>#include &lt;<a class="el" href="command_8h-source.html">command.h</a>&gt;</code>
<p>
<p>Inheritance diagram for PluginCmd:
<p><center><img src="classPluginCmd.png" usemap="#PluginCmd_map" border="0" alt=""></center>
<map name="PluginCmd_map">
<area href="classSlowUndoCmd.html" alt="SlowUndoCmd" shape="rect" coords="0,56,93,80">
<area href="classCmd.html" alt="Cmd" shape="rect" coords="0,0,93,24">
</map>
<a href="classPluginCmd-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluginCmd.html#0d3c0616ff0e61f5a84b6c27bd12c8f0">PluginCmd</a> (<a class="el" href="classFrameBuffer.html">FrameBuffer</a> *pFB, std::string pluginName, std::string args)</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPluginCmd.html#3642db0d31a13fc1e24c2f9a2d23c723">exec</a> ()</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save current frame buffer as undo information.  <a href="#3642db0d31a13fc1e24c2f9a2d23c723"></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="classPluginCmd.html#e98217cde41a539016104d5abbf2d1d1">name</a> ()</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command identification. This will appear in config file.  <a href="#e98217cde41a539016104d5abbf2d1d1"></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="classPluginCmd.html#f7383a429feff3b9b70c1e6388c916db">args</a> ()</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command export to text string. Needed for macro saving.  <a href="#f7383a429feff3b9b70c1e6388c916db"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Plugin call command 
<p>
 
<p>
Definition at line <a class="el" href="command_8h-source.html#l00101">101</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="0d3c0616ff0e61f5a84b6c27bd12c8f0"></a><!-- doxytag: member="PluginCmd::PluginCmd" ref="0d3c0616ff0e61f5a84b6c27bd12c8f0" args="(FrameBuffer *pFB, std::string pluginName, std::string args)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PluginCmd::PluginCmd           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classFrameBuffer.html">FrameBuffer</a> *&nbsp;</td>
          <td class="paramname"> <em>pFB</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&nbsp;</td>
          <td class="paramname"> <em>pluginName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&nbsp;</td>
          <td class="paramname"> <em>args</em></td><td>&nbsp;</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>
Initialize plugin 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>&nbsp;</td><td>Pointer to frame buffer to work with. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>pluginName</em>&nbsp;</td><td>Plugin name (identification) </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>args</em>&nbsp;</td><td>Plugin arguments passed to plugin. </td></tr>
  </table>
</dl>
 
<p>
Definition at line <a class="el" href="command_8h-source.html#l00109">109</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="3642db0d31a13fc1e24c2f9a2d23c723"></a><!-- doxytag: member="PluginCmd::exec" ref="3642db0d31a13fc1e24c2f9a2d23c723" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void PluginCmd::exec           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Save current frame buffer as undo information. 
<p>
 
<p>
Reimplemented from <a class="el" href="classSlowUndoCmd.html#a0fe0ca6ec2ba209691950d31924fa4e">SlowUndoCmd</a>.
</div>
</div><p>
<a class="anchor" name="e98217cde41a539016104d5abbf2d1d1"></a><!-- doxytag: member="PluginCmd::name" ref="e98217cde41a539016104d5abbf2d1d1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string PluginCmd::name           </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>
Command identification. This will appear in config file. 
<p>
 
<p>
Implements <a class="el" href="classSlowUndoCmd.html#ded003144be4d791e36e763b1580f0bc">SlowUndoCmd</a>.
<p>
Definition at line <a class="el" href="command_8h-source.html#l00115">115</a> of file <a class="el" href="command_8h-source.html">command.h</a>.
</div>
</div><p>
<a class="anchor" name="f7383a429feff3b9b70c1e6388c916db"></a><!-- doxytag: member="PluginCmd::args" ref="f7383a429feff3b9b70c1e6388c916db" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string PluginCmd::args           </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>
Command export to text string. Needed for macro saving. 
<p>
 
<p>
Implements <a class="el" href="classSlowUndoCmd.html#a26ced5fe114d904dfdcd56f5d9d7188">SlowUndoCmd</a>.
<p>
Definition at line <a class="el" href="command_8h-source.html#l00116">116</a> of file <a class="el" href="command_8h-source.html">command.h</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>