Show
Ignore:
Timestamp:
08/05/09 00:16:53 (15 years ago)
Author:
mido
Message:

obnovena dokumentace, vcetne pridani mnoha novych doc-souboru do svn

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • library/doc/html/classbdm_1_1ParticularUI.html

    r401 r472  
    55<link href="doxygen.css" rel="stylesheet" type="text/css"> 
    66</head><body> 
    7 <!-- Generated by Doxygen 1.5.8 --> 
     7<!-- Generated by Doxygen 1.5.9 --> 
    88<script type="text/javascript"> 
    99<!-- 
    … …  
    5252      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li> 
    5353      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li> 
    54       <li><a href="modules.html"><span>Modules</span></a></li> 
    5554      <li class="current"><a href="annotated.html"><span>Classes</span></a></li> 
    5655      <li><a href="files.html"><span>Files</span></a></li> 
    … …  
    6968</div> 
    7069<div class="contents"> 
    71 <h1>bdm::ParticularUI&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="bdm::ParticularUI" --><!-- doxytag: inherits="bdm::UI" -->The only <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> descendant class which is not intended for direct use. It should be accessed within the <a class="el" href="user__info_8h.html#4f9de2f17e844047726487b99def99c6" title="Macro for registration of class into map of user-infos, registered class is scriptable...">UIREGISTER</a> macro only.   
    72 <a href="#_details">More...</a> 
    73 <p> 
    74 <code>#include &lt;<a class="el" href="user__info_8h-source.html">user_info.h</a>&gt;</code> 
     70<h1>bdm::ParticularUI&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="bdm::ParticularUI" --><!-- doxytag: inherits="bdm::UI" --><code>#include &lt;<a class="el" href="user__info_8h_source.html">user_info.h</a>&gt;</code> 
    7571<p> 
    7672 
    … …  
    8379 
    8480<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A method returning a brand new instance of class T, this method is the reason why there have to be a parameterless construcotor in class T. <br></td></tr> 
     81<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="3e3d8064ae10dfeddfe106a8dea1b038"></a><!-- doxytag: member="bdm::ParticularUI::factory" ref="3e3d8064ae10dfeddfe106a8dea1b038" args="(ParticularUI&lt; epdf_harness &gt;(&quot;epdf_harness&quot;))" --> 
     82template&lt;&gt; </td></tr> 
     83<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">const <a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a><br class="typebreak"> 
     84&lt; epdf_harness &gt; &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>factory</b> (<a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a>&lt; epdf_harness &gt;(&quot;epdf_harness&quot;))</td></tr> 
     85 
     86<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="d424cadb680b1a6e906744330df54e1d"></a><!-- doxytag: member="bdm::ParticularUI::factory" ref="d424cadb680b1a6e906744330df54e1d" args="(ParticularUI&lt; mpdf_harness &gt;(&quot;mpdf_harness&quot;))" --> 
     87template&lt;&gt; </td></tr> 
     88<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">const <a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a><br class="typebreak"> 
     89&lt; mpdf_harness &gt; &amp;&nbsp;</td><td class="memTemplItemRight" valign="bottom"><b>factory</b> (<a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a>&lt; mpdf_harness &gt;(&quot;mpdf_harness&quot;))</td></tr> 
     90 
    8591<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr> 
    8692<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18a208b7549160ae6aeb884dc2bcd90f"></a><!-- doxytag: member="bdm::ParticularUI::factory" ref="18a208b7549160ae6aeb884dc2bcd90f" args="" --> 
    8793static const <a class="el" href="classbdm_1_1ParticularUI.html">ParticularUI</a>&lt; T &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1ParticularUI.html#18a208b7549160ae6aeb884dc2bcd90f">factory</a></td></tr> 
    8894 
    89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The only instance of this class (each type T has its own instance) which is used as a factory for processing related <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a>. <br></td></tr> 
     95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The only instance of this class (each type T has its own instance) which is used as a factory for processing related <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a>. <br></td></tr> 
     96<tr><td colspan="2"><br><h2>Private Types</h2></td></tr> 
     97<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> { <b>optional</b>,  
     98<b>compulsory</b> 
     99 }</td></tr> 
     100 
     101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enumerical type used to determine whether the data for concrete Settingis is compulsory or optional. <br></td></tr> 
    90102<tr><td colspan="2"><br><h2>Static Private Member Functions</h2></td></tr> 
    91103<tr><td colspan="2"><div class="groupHeader">Initialization of classes</div></td></tr> 
    92 <tr><td colspan="2"><div class="groupText">The type T has to be a <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant class <br><br></div></td></tr> 
    93 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="dda27449f8bd19d54db9ccfb2644e908"></a><!-- doxytag: member="bdm::ParticularUI::build" ref="dda27449f8bd19d54db9ccfb2644e908" args="(const Setting &amp;element, const string &amp;name)" --> 
    94 template&lt;class T &gt; </td></tr> 
    95 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#dda27449f8bd19d54db9ccfb2644e908">build</a> (const Setting &amp;element, const string &amp;name)</td></tr> 
     104<tr><td colspan="2"><div class="groupText">The type T has to be a <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">bdm::root</a> descendant class <br><br></div></td></tr> 
     105<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     106<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#970297d6c758692135877dfa7a5eacb0">build</a> (const Setting &amp;element, const string &amp;name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
    96107 
    97 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The new instance of type T* is constructed and initialized with values stored in the Setting element[name]. <br></td></tr> 
    98 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="f0eccc7bbe4b680f3e1cb84b455a1125"></a><!-- doxytag: member="bdm::ParticularUI::build" ref="f0eccc7bbe4b680f3e1cb84b455a1125" args="(const Setting &amp;element, const int index)" --> 
    99 template&lt;class T &gt; </td></tr> 
    100 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#f0eccc7bbe4b680f3e1cb84b455a1125">build</a> (const Setting &amp;element, const int index)</td></tr> 
     108<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     109<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static T *&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#b8b2512d4762463cbf23314d45f1c5b1">build</a> (const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
    101110 
    102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The new instance of type T* is constructed and initialized with values stored in the Setting element[index]. <br></td></tr> 
    103111<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="6e2da6a142fecf5f21e0bb86a7211cb4"></a><!-- doxytag: member="bdm::ParticularUI::build" ref="6e2da6a142fecf5f21e0bb86a7211cb4" args="(const Setting &amp;element)" --> 
    104112template&lt;class T &gt; </td></tr> 
    … …  
    108116<tr><td colspan="2"><div class="groupHeader">Initialization of structures</div></td></tr> 
    109117<tr><td colspan="2"><div class="groupText">The type T has to be int, double, string, vec, ivec or mat. <br><br></div></td></tr> 
    110 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="652bfd23f5052e4f1cb317057d74a3e2"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="652bfd23f5052e4f1cb317057d74a3e2" args="(T &amp;instance, const Setting &amp;element, const string &amp;name)" --> 
     118<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     119<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#cd1667e6fec99ec64dabcb3ca2ff922d">get</a> (T &amp;instance, const Setting &amp;element, const string &amp;name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     120 
     121<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     122<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#6fb95ccb13515a3f23080a397dacaa0e">get</a> (T &amp;instance, const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     123 
     124<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="7d2ea138c7285565507fa61fbd9b038f"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="7d2ea138c7285565507fa61fbd9b038f" args="(T &amp;instance, const Setting &amp;element)" --> 
    111125template&lt;class T &gt; </td></tr> 
    112 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#652bfd23f5052e4f1cb317057d74a3e2">get</a> (T &amp;instance, const Setting &amp;element, const string &amp;name)</td></tr> 
    113  
    114 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element[name]. <br></td></tr> 
    115 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="3d04bb3d7dbcf0da0b4d5d3d5b7df51a"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="3d04bb3d7dbcf0da0b4d5d3d5b7df51a" args="(T &amp;instance, const Setting &amp;element, const int index)" --> 
    116 template&lt;class T &gt; </td></tr> 
    117 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#3d04bb3d7dbcf0da0b4d5d3d5b7df51a">get</a> (T &amp;instance, const Setting &amp;element, const int index)</td></tr> 
    118  
    119 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element[index]. <br></td></tr> 
    120 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="25747ac6d0232aa7102dbb316f65ddce"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="25747ac6d0232aa7102dbb316f65ddce" args="(T &amp;instance, const Setting &amp;element)" --> 
    121 template&lt;class T &gt; </td></tr> 
    122 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#25747ac6d0232aa7102dbb316f65ddce">get</a> (T &amp;instance, const Setting &amp;element)</td></tr> 
     126<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#7d2ea138c7285565507fa61fbd9b038f">get</a> (T &amp;instance, const Setting &amp;element)</td></tr> 
    123127 
    124128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing instance of type T is initialized with values stored in the Setting element directly. <br></td></tr> 
    125129<tr><td colspan="2"><div class="groupHeader">Initialization of arrays Array&lt;T&gt;</div></td></tr> 
    126130<tr><td colspan="2"><div class="groupText">The type T has to be int, double, string, vec, ivec or mat, or pointer to any <a class="el" href="classbdm_1_1root.html" title="Root class of BDM objects.">root</a> descendant. <br><br></div></td></tr> 
    127 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="00bb5f2a328d272b0a3ffbda1a902d54"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="00bb5f2a328d272b0a3ffbda1a902d54" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)" --> 
     131<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     132<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#81ce18ed0bb9993a634db2b99612ad66">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     133 
     134<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class T &gt; </td></tr> 
     135<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#29e450ed5560f81ef2f845e7b1021b71">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index, <a class="el" href="classbdm_1_1UI.html#88d02c1ffe93033af0f146e8008ab6e6">SettingPresence</a> settingPresence=optional)</td></tr> 
     136 
     137<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="c9fad8376d2f0857e719511f92f93998"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="c9fad8376d2f0857e719511f92f93998" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)" --> 
    128138template&lt;class T &gt; </td></tr> 
    129 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#00bb5f2a328d272b0a3ffbda1a902d54">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const string &amp;name)</td></tr> 
    130  
    131 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element[name]. <br></td></tr> 
    132 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="b6a224b6aea027e167d3d565b39144e0"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="b6a224b6aea027e167d3d565b39144e0" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)" --> 
    133 template&lt;class T &gt; </td></tr> 
    134 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#b6a224b6aea027e167d3d565b39144e0">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element, const int index)</td></tr> 
    135  
    136 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element[index]. <br></td></tr> 
    137 <tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="4fc5efdc58e4e184218b6d5beeb5ceab"></a><!-- doxytag: member="bdm::ParticularUI::get" ref="4fc5efdc58e4e184218b6d5beeb5ceab" args="(Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)" --> 
    138 template&lt;class T &gt; </td></tr> 
    139 <tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#4fc5efdc58e4e184218b6d5beeb5ceab">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)</td></tr> 
     139<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">static bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbdm_1_1UI.html#c9fad8376d2f0857e719511f92f93998">get</a> (Array&lt; T &gt; &amp;array_to_load, const Setting &amp;element)</td></tr> 
    140140 
    141141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The existing array of type T is initialized with values stored in the Setting element. <br></td></tr> 
    … …  
    181181 class bdm::ParticularUI&lt; T &gt;</h3> 
    182182 
    183 The only <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class and it is intended for internal purposes only.">UI</a> descendant class which is not intended for direct use. It should be accessed within the <a class="el" href="user__info_8h.html#4f9de2f17e844047726487b99def99c6" title="Macro for registration of class into map of user-infos, registered class is scriptable...">UIREGISTER</a> macro only. <hr>The documentation for this class was generated from the following file:<ul> 
    184 <li><a class="el" href="user__info_8h-source.html">user_info.h</a></ul> 
     183The only <a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> descendant class which is not intended for direct use. It should be accessed within the <a class="el" href="user__info_8h.html#4f9de2f17e844047726487b99def99c6" title="Macro for registration of class into map of user-infos, registered class is scriptable...">UIREGISTER</a> macro only. <a class="el" href="ui_page.html">User Infos and their use</a> <hr>The documentation for this class was generated from the following file:<ul> 
     184<li><a class="el" href="user__info_8h_source.html">user_info.h</a></ul> 
    185185</div> 
    186 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 1 13:05:57 2009 for mixpp by&nbsp; 
     186<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 5 00:06:57 2009 for mixpp by&nbsp; 
    187187<a href="http://www.doxygen.org/index.html"> 
    188 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     188<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> 
    189189</body> 
    190190</html>