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: GedConf 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>GedConf Class Reference</h1><!-- doxytag: class="GedConf" --><code>#include <<a class="el" href="gedconf_8h-source.html">gedconf.h</a>></code>
<p>
<a href="classGedConf-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="classGedConf.html#a977f222aba54fb48e52765d2d276e98">~GedConf</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#036a02956f96597b5465df24f6f67aad">readConfig</a> (const char *pathToFile)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#1bf13404c943789c10336189c31be235">saveConfig</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="gedconf_8h.html#6e460c7e29e2723443bf404463544804">PluginDirsList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#6082f9c00c2ce43a75b3edfc7ea586b5">getPluginDirs</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#bd07f5872d6a237250b5b1bb2a537287">setPluginDir</a> (const char *pathToDir)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#90e681c34a408c78e0c1c8eb7d34e19b">removePluginDir</a> (const char *pathToDir)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="gedconf_8h.html#6e8e7e2c6bc24610c07a629511b31e71">MacroList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#71c0ec018af399f13fe117f375d097aa">getMacroList</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="gedconf_8h.html#25f0021c29607fd2364999be3a07dcae">CommandVector</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#0db5c1f36055af0c890fb31a40ceae12">getCommands</a> (const std::string macroName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#7a33e55897fb3f292eaf7a0571a0c52b">removeMacro</a> (const std::string macroName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#a9cead25b68dc760b6aed8203d4cc881">addMacro</a> (const char *macroName, const char *commandName, const char *commandParams)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#08e1d61dfcc51a7d4e5b1846880bb4c5">getHelpDir</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#0321ecc1f611b2409177b5eb80406566">getImageDir</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#424a719d4edb0378ac4524422f23c8d9">getFont</a> (std::string &fileName, std::string &dpi, std::string &size)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGedConf.html">GedConf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#64a8e0a4b170662b293a15d53a77a54c">ptr</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#8ab92f4b04ac5f2f50e41be90f6374e3">destroy</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGedConf.html#445e648cf15e91db368f48c57defc020">GedConf</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<p>
Definition at line <a class="el" href="gedconf_8h-source.html#l00096">96</a> of file <a class="el" href="gedconf_8h-source.html">gedconf.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a977f222aba54fb48e52765d2d276e98"></a><!-- doxytag: member="GedConf::~GedConf" ref="a977f222aba54fb48e52765d2d276e98" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GedConf::~GedConf </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="445e648cf15e91db368f48c57defc020"></a><!-- doxytag: member="GedConf::GedConf" ref="445e648cf15e91db368f48c57defc020" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GedConf::GedConf </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Singleton can't be allocated static. use <a class="el" href="classGedConf.html#64a8e0a4b170662b293a15d53a77a54c">GedConf::ptr()</a> method to obtain singleton address.
<p>
Definition at line <a class="el" href="gedconf_8h-source.html#l00194">194</a> of file <a class="el" href="gedconf_8h-source.html">gedconf.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="64a8e0a4b170662b293a15d53a77a54c"></a><!-- doxytag: member="GedConf::ptr" ref="64a8e0a4b170662b293a15d53a77a54c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGedConf.html">GedConf</a>* GedConf::ptr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Access point to singleton. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return pointer to singleton. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8ab92f4b04ac5f2f50e41be90f6374e3"></a><!-- doxytag: member="GedConf::destroy" ref="8ab92f4b04ac5f2f50e41be90f6374e3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void GedConf::destroy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy singleton object. It has no effect, if object is not allocated.
</div>
</div><p>
<a class="anchor" name="036a02956f96597b5465df24f6f67aad"></a><!-- doxytag: member="GedConf::readConfig" ref="036a02956f96597b5465df24f6f67aad" args="(const char *pathToFile)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GedConf::readConfig </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pathToFile</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read configuration file incrementally. New nodes replace existing if redefined. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pathToFile</em> </td><td>Path to config file to read. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1bf13404c943789c10336189c31be235"></a><!-- doxytag: member="GedConf::saveConfig" ref="1bf13404c943789c10336189c31be235" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GedConf::saveConfig </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save configuration to config file that was opened last. Existing file is replaced.
</div>
</div><p>
<a class="anchor" name="6082f9c00c2ce43a75b3edfc7ea586b5"></a><!-- doxytag: member="GedConf::getPluginDirs" ref="6082f9c00c2ce43a75b3edfc7ea586b5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gedconf_8h.html#6e460c7e29e2723443bf404463544804">PluginDirsList</a> GedConf::getPluginDirs </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the list of directories containing plugins. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return map of plugins, empty map if no directory was found. The key contains directory name. </dd></dl>
</div>
</div><p>
<a class="anchor" name="bd07f5872d6a237250b5b1bb2a537287"></a><!-- doxytag: member="GedConf::setPluginDir" ref="bd07f5872d6a237250b5b1bb2a537287" args="(const char *pathToDir)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GedConf::setPluginDir </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pathToDir</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add plugin directory to configuration file opened as last. If there wasn't any opened configuration file, 'ged.conf' is used. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pathToDir</em> </td><td>Path to directory with plugins. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="90e681c34a408c78e0c1c8eb7d34e19b"></a><!-- doxytag: member="GedConf::removePluginDir" ref="90e681c34a408c78e0c1c8eb7d34e19b" args="(const char *pathToDir)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GedConf::removePluginDir </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>pathToDir</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove plugin directory from last opend 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>pathToDir</em> </td><td>Directory to remove. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="71c0ec018af399f13fe117f375d097aa"></a><!-- doxytag: member="GedConf::getMacroList" ref="71c0ec018af399f13fe117f375d097aa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gedconf_8h.html#6e8e7e2c6bc24610c07a629511b31e71">MacroList</a> GedConf::getMacroList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return macro list, empty map if no macro was found. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return macro map. The key is name of the macro. The value is configuration file, where was macro found. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0db5c1f36055af0c890fb31a40ceae12"></a><!-- doxytag: member="GedConf::getCommands" ref="0db5c1f36055af0c890fb31a40ceae12" args="(const std::string macroName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="gedconf_8h.html#25f0021c29607fd2364999be3a07dcae">CommandVector</a> GedConf::getCommands </td>
<td>(</td>
<td class="paramtype">const std::string </td>
<td class="paramname"> <em>macroName</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return vector of commands for desired macro, empty vector if macro wasn't found. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>macroName</em> </td><td>Name of the macro. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return squence of commands. </dd></dl>
</div>
</div><p>
<a class="anchor" name="7a33e55897fb3f292eaf7a0571a0c52b"></a><!-- doxytag: member="GedConf::removeMacro" ref="7a33e55897fb3f292eaf7a0571a0c52b" args="(const std::string macroName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GedConf::removeMacro </td>
<td>(</td>
<td class="paramtype">const std::string </td>
<td class="paramname"> <em>macroName</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove macro from configuration file. It has no effect if macro isn't from last 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>macroName</em> </td><td>Macro name to remove. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a9cead25b68dc760b6aed8203d4cc881"></a><!-- doxytag: member="GedConf::addMacro" ref="a9cead25b68dc760b6aed8203d4cc881" args="(const char *macroName, const char *commandName, const char *commandParams)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GedConf::addMacro </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>macroName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>commandName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>commandParams</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>
Add macro or add command to existing macro. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>macroName</em> </td><td>Macro name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>commandName</em> </td><td>Command name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>commandParams</em> </td><td>Command data. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="08e1d61dfcc51a7d4e5b1846880bb4c5"></a><!-- doxytag: member="GedConf::getHelpDir" ref="08e1d61dfcc51a7d4e5b1846880bb4c5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string GedConf::getHelpDir </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return help directory. If help directory option is not found, return default help directory '../doc/help'. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Help directory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0321ecc1f611b2409177b5eb80406566"></a><!-- doxytag: member="GedConf::getImageDir" ref="0321ecc1f611b2409177b5eb80406566" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string GedConf::getImageDir </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return images directory. If images directory option is not found, return default help directory 'images'. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Images directory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="424a719d4edb0378ac4524422f23c8d9"></a><!-- doxytag: member="GedConf::getFont" ref="424a719d4edb0378ac4524422f23c8d9" args="(std::string &fileName, std::string &dpi, std::string &size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GedConf::getFont </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>dpi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>size</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>
Return font 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>fileName</em> </td><td>File containing font. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dpi</em> </td><td>Font resolution. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Base font size. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gedconf_8h-source.html">gedconf.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
classGedConf.html [Download]