Česky
Kamil Dudka

GED 2006 (C++)

Back Back to main page

File detail

Back Go to directory
Name:DownloadclassGedPlugin_1_1Plugin.html [Download]
Location: ged2006 > doc > classes
Size:7.0 KB
Last modification:2022-09-09 13:06

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: GedPlugin::Plugin 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>
<div class="nav">
<a class="el" href="namespaceGedPlugin.html">GedPlugin</a>::<a class="el" href="classGedPlugin_1_1Plugin.html">Plugin</a></div>
<h1>GedPlugin::Plugin Class Reference</h1><!-- doxytag: class="GedPlugin::Plugin" --><code>#include &lt;<a class="el" href="gedplugin_8h-source.html">gedplugin.h</a>&gt;</code>
<p>
<a href="classGedPlugin_1_1Plugin-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="classGedPlugin_1_1Plugin.html#0c46a58c80bac5a75249d99b0d379293">Plugin</a> (int argc, char *argv[])</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGedPlugin_1_1Plugin.html#aa3ed25ae5268047998f2b3aa93e93c2">~Plugin</a> ()</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGedPlugin_1_1Plugin.html#e6a99110219b37fead11d3e8eee24aa9">set</a> (const <a class="el" href="structGedPlugin_1_1PluginDescription.html">PluginDescription</a> &amp;desc)</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGedPlugin_1_1Plugin.html#d1b8a396af0e9f8729f6e730d5a37f36">exec</a> ()</td></tr>
 
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classGedPlugin_1_1Plugin.html">Plugin</a> abstraction. This is needed for plugin code independency. 
<p>
 
<p>
Definition at line <a class="el" href="gedplugin_8h-source.html#l00050">50</a> of file <a class="el" href="gedplugin_8h-source.html">gedplugin.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="0c46a58c80bac5a75249d99b0d379293"></a><!-- doxytag: member="GedPlugin::Plugin::Plugin" ref="0c46a58c80bac5a75249d99b0d379293" args="(int argc, char *argv[])" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GedPlugin::Plugin::Plugin           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>argv</em>[]</td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Create plugin object. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>argc</em>&nbsp;</td><td>This is an argc argument of plugin's main() function. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>argv</em>&nbsp;</td><td>This is an argv argument of plugin's main() function. </td></tr>
  </table>
</dl>
 
</div>
</div><p>
<a class="anchor" name="aa3ed25ae5268047998f2b3aa93e93c2"></a><!-- doxytag: member="GedPlugin::Plugin::~Plugin" ref="aa3ed25ae5268047998f2b3aa93e93c2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GedPlugin::Plugin::~Plugin           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e6a99110219b37fead11d3e8eee24aa9"></a><!-- doxytag: member="GedPlugin::Plugin::set" ref="e6a99110219b37fead11d3e8eee24aa9" args="(const PluginDescription &amp;desc)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GedPlugin::Plugin::set           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structGedPlugin_1_1PluginDescription.html">PluginDescription</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>desc</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Set plugin properties. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>desc</em>&nbsp;</td><td><a class="el" href="classGedPlugin_1_1Plugin.html">Plugin</a> description. Read <a class="el" href="structGedPlugin_1_1PluginDescription.html">PluginDescription</a> documentation. </td></tr>
  </table>
</dl>
 
</div>
</div><p>
<a class="anchor" name="d1b8a396af0e9f8729f6e730d5a37f36"></a><!-- doxytag: member="GedPlugin::Plugin::exec" ref="d1b8a396af0e9f8729f6e730d5a37f36" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int GedPlugin::Plugin::exec           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
Execute plugin. (if ged wants to do this) <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return plugin's exit-code, 0 means success. This value should be returned from plugin's main() function. </dd></dl>
 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gedplugin_8h-source.html">gedplugin.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>