Show
Ignore:
Timestamp:
06/24/09 21:57:21 (15 years ago)
Author:
smidl
Message:

doc 2

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • library/doc/html/classbdm_1_1UIFile.html

    r397 r398  
    8282&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#77274c827f87f16bd6671df8a0cc1e33">UIFile</a> ()</td></tr> 
    8383 
    84 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">create empty file instance prepared to store Settings <br></td></tr> 
     84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create empty file instance prepared to store Settings. <br></td></tr> 
    8585<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="56b491cf846ddd6b47198ff67bbf87e4"></a><!-- doxytag: member="bdm::UIFile::UIFile" ref="56b491cf846ddd6b47198ff67bbf87e4" args="(const string &amp;file_name)" --> 
    8686&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#56b491cf846ddd6b47198ff67bbf87e4">UIFile</a> (const string &amp;file_name)</td></tr> 
    8787 
    88 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">creates instance and fills it from the configuration file file_name <br></td></tr> 
     88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates instance and fills it from the configuration file file_name. <br></td></tr> 
    8989<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f8af28a0d8ef1a4956e198df0beb5ba"></a><!-- doxytag: member="bdm::UIFile::save" ref="1f8af28a0d8ef1a4956e198df0beb5ba" args="(const string &amp;file_name)" --> 
    9090void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#1f8af28a0d8ef1a4956e198df0beb5ba">save</a> (const string &amp;file_name)</td></tr> 
    9191 
    92 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">save all the stored Settings into the configuration file file_name <br></td></tr> 
     92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save all the stored Settings into the configuration file file_name. <br></td></tr> 
    9393<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5bce10d88c71f6147d58baa8400ff61f"></a><!-- doxytag: member="bdm::UIFile::operator Setting &amp;" ref="5bce10d88c71f6147d58baa8400ff61f" args="()" --> 
    9494&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#5bce10d88c71f6147d58baa8400ff61f">operator Setting &amp;</a> ()</td></tr> 
    9595 
    96 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">this operator allows the ability of substituting Setting parameter by <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> instance <br></td></tr> 
     96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This operator allows the ability of substituting Setting parameter by <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> instance. <br></td></tr> 
    9797</table> 
    9898<hr><a name="_details"></a><h2>Detailed Description</h2> 
     
    101101Firstly, save some user-infos into the new <a class="el" href="classbdm_1_1UIFile.html" title="This class serves to load and/or save user-infos into/from configuration files stored...">UIFile</a> instance. Then, call the save method with a filename as its only argument:<p> 
    102102<div class="fragment"><pre class="fragment">        CAudi audi; 
    103         <a class="code" href="classbdm_1_1UIFile.html#77274c827f87f16bd6671df8a0cc1e33" title="create empty file instance prepared to store Settings">UIFile</a> file; 
    104         <a class="code" href="classbdm_1_1UIFile.html#1f8af28a0d8ef1a4956e198df0beb5ba" title="save all the stored Settings into the configuration file file_name">UI::save</a>( audi, file, <span class="stringliteral">"TT"</span>); 
     103        <a class="code" href="classbdm_1_1UIFile.html#77274c827f87f16bd6671df8a0cc1e33" title="Create empty file instance prepared to store Settings.">UIFile</a> file; 
     104        <a class="code" href="classbdm_1_1UIFile.html#1f8af28a0d8ef1a4956e198df0beb5ba" title="Save all the stored Settings into the configuration file file_name.">UI::save</a>( audi, file, <span class="stringliteral">"TT"</span>); 
    105105        file.save(<span class="stringliteral">"cars.cfg"</span>); 
    106106</pre></div><p> 
    107107In the other way round, when loading object from a configuration file, the appropriate code looks like this:<p> 
    108 <div class="fragment"><pre class="fragment">        <a class="code" href="classbdm_1_1UIFile.html#77274c827f87f16bd6671df8a0cc1e33" title="create empty file instance prepared to store Settings">UIFile</a> file(<span class="stringliteral">"cars.cfg"</span>); 
     108<div class="fragment"><pre class="fragment">        <a class="code" href="classbdm_1_1UIFile.html#77274c827f87f16bd6671df8a0cc1e33" title="Create empty file instance prepared to store Settings.">UIFile</a> file(<span class="stringliteral">"cars.cfg"</span>); 
    109109        CAudi *audi = UI::build&lt;CAudi&gt;(file,<span class="stringliteral">"TT"</span>); 
    110110</pre></div> <hr>The documentation for this class was generated from the following files:<ul> 
    111111<li><a class="el" href="user__info_8h-source.html">user_info.h</a><li>user_info.cpp</ul> 
    112112</div> 
    113 <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 23 19:52:52 2009 for mixpp by&nbsp; 
     113<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 24 21:53:05 2009 for mixpp by&nbsp; 
    114114<a href="http://www.doxygen.org/index.html"> 
    115115<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>