Show
Ignore:
Timestamp:
08/30/09 22:13:15 (15 years ago)
Author:
smidl
Message:

doc

Files:
1 modified

Legend:

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

    r590 r591  
    1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 
    2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> 
     1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     2<html xmlns="http://www.w3.org/1999/xhtml"> 
     3<head> 
     4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 
    35<title>mixpp: bdm::UIFile Class Reference</title> 
    4 <link href="tabs.css" rel="stylesheet" type="text/css"> 
    5 <link href="doxygen.css" rel="stylesheet" type="text/css"> 
    6 </head><body> 
    7 <!-- Generated by Doxygen 1.5.8 --> 
     6<link href="tabs.css" rel="stylesheet" type="text/css"/> 
     7<link href="doxygen.css" rel="stylesheet" type="text/css"/> 
     8</head> 
     9<body> 
     10<!-- Generated by Doxygen 1.6.1 --> 
    811<script type="text/javascript"> 
    912<!-- 
     
    6871</div> 
    6972<div class="contents"> 
    70 <h1>bdm::UIFile Class Reference</h1><!-- doxytag: class="bdm::UIFile" -->This class serves to load and/or save user-infos into/from configuration files stored on a hard-disk.   
    71 <a href="#_details">More...</a> 
    72 <p> 
    73 <code>#include &lt;<a class="el" href="user__info_8h-source.html">user_info.h</a>&gt;</code> 
    74 <p> 
     73<h1>bdm::UIFile Class Reference</h1><!-- doxytag: class="bdm::UIFile" --> 
     74<p>This class serves to load and/or save user-infos into/from configuration files stored on a hard-disk.   
     75<a href="#_details">More...</a></p> 
    7576 
    76 <p> 
    77 <a href="classbdm_1_1UIFile-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> 
    78 <tr><td></td></tr> 
    79 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 
    80 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="77274c827f87f16bd6671df8a0cc1e33"></a><!-- doxytag: member="bdm::UIFile::UIFile" ref="77274c827f87f16bd6671df8a0cc1e33" args="()" --> 
    81 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#77274c827f87f16bd6671df8a0cc1e33">UIFile</a> ()</td></tr> 
     77<p><code>#include &lt;<a class="el" href="user__info_8h_source.html">user_info.h</a>&gt;</code></p> 
    8278 
    83 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create empty file instance prepared to store Settings. <br></td></tr> 
    84 <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)" --> 
    85 &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> 
    86  
    87 <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="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)" --> 
    89 void&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> 
    90  
    91 <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="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5bce10d88c71f6147d58baa8400ff61f"></a><!-- doxytag: member="bdm::UIFile::operator Setting &amp;" ref="5bce10d88c71f6147d58baa8400ff61f" args="()" --> 
    93 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#5bce10d88c71f6147d58baa8400ff61f">operator Setting &amp;</a> ()</td></tr> 
    94  
    95 <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> 
     79<p><a href="classbdm_1_1UIFile-members.html">List of all members.</a></p> 
     80<table border="0" cellpadding="0" cellspacing="0"> 
     81<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> 
     82<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77274c827f87f16bd6671df8a0cc1e33"></a><!-- doxytag: member="bdm::UIFile::UIFile" ref="a77274c827f87f16bd6671df8a0cc1e33" args="()" --> 
     83&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#a77274c827f87f16bd6671df8a0cc1e33">UIFile</a> ()</td></tr> 
     84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create empty file instance prepared to store Settings. <br/></td></tr> 
     85<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56b491cf846ddd6b47198ff67bbf87e4"></a><!-- doxytag: member="bdm::UIFile::UIFile" ref="a56b491cf846ddd6b47198ff67bbf87e4" args="(const string &amp;file_name)" --> 
     86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#a56b491cf846ddd6b47198ff67bbf87e4">UIFile</a> (const string &amp;file_name)</td></tr> 
     87<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="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f8af28a0d8ef1a4956e198df0beb5ba"></a><!-- doxytag: member="bdm::UIFile::save" ref="a1f8af28a0d8ef1a4956e198df0beb5ba" args="(const string &amp;file_name)" --> 
     89void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#a1f8af28a0d8ef1a4956e198df0beb5ba">save</a> (const string &amp;file_name)</td></tr> 
     90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save all the stored Settings into the configuration file file_name. <br/></td></tr> 
     91<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5bce10d88c71f6147d58baa8400ff61f"></a><!-- doxytag: member="bdm::UIFile::operator Setting &amp;" ref="a5bce10d88c71f6147d58baa8400ff61f" args="()" --> 
     92&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1UIFile.html#a5bce10d88c71f6147d58baa8400ff61f">operator Setting &amp;</a> ()</td></tr> 
     93<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> 
    9694</table> 
    97 <hr><a name="_details"></a><h2>Detailed Description</h2> 
    98 This class serves to load and/or save user-infos into/from configuration files stored on a hard-disk.  
    99 <p> 
    100 Firstly, 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> 
     95<hr/><a name="_details"></a><h2>Detailed Description</h2> 
     96<p>This class serves to load and/or save user-infos into/from configuration files stored on a hard-disk. </p> 
     97<p>Firstly, 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> 
    10198<div class="fragment"><pre class="fragment">        CAudi audi; 
    102         <a class="code" href="classbdm_1_1UIFile.html#77274c827f87f16bd6671df8a0cc1e33" title="Create empty file instance prepared to store Settings.">UIFile</a> file; 
    103         <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>); 
    104         file.save(<span class="stringliteral">"cars.cfg"</span>); 
    105 </pre></div><p> 
    106 In the other way round, when loading object from a configuration file, the appropriate code looks like this:<p> 
    107 <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         CAudi *audi = UI::build&lt;CAudi&gt;(file,<span class="stringliteral">"TT"</span>); 
    109 </pre></div><p> 
    110 <a class="el" href="ui_page.html">User Infos and their use</a> <hr>The documentation for this class was generated from the following files:<ul> 
    111 <li><a class="el" href="user__info_8h-source.html">user_info.h</a><li>user_info.cpp</ul> 
     99        <a class="code" href="classbdm_1_1UIFile.html#a77274c827f87f16bd6671df8a0cc1e33" title="Create empty file instance prepared to store Settings.">UIFile</a> file; 
     100        <a class="code" href="classbdm_1_1UIFile.html#a1f8af28a0d8ef1a4956e198df0beb5ba" title="Save all the stored Settings into the configuration file file_name.">UI::save</a>( audi, file, <span class="stringliteral">&quot;TT&quot;</span>); 
     101        file.save(<span class="stringliteral">&quot;cars.cfg&quot;</span>); 
     102</pre></div><p>In the other way round, when loading object from a configuration file, the appropriate code looks like this:</p> 
     103<div class="fragment"><pre class="fragment">        <a class="code" href="classbdm_1_1UIFile.html#a77274c827f87f16bd6671df8a0cc1e33" title="Create empty file instance prepared to store Settings.">UIFile</a> file(<span class="stringliteral">&quot;cars.cfg&quot;</span>); 
     104        CAudi *audi = UI::build&lt;CAudi&gt;(file,<span class="stringliteral">&quot;TT&quot;</span>); 
     105</pre></div><p><a class="el" href="ui_page.html">User Infos and their use</a> </p> 
     106<hr/>The documentation for this class was generated from the following files:<ul> 
     107<li><a class="el" href="user__info_8h_source.html">user_info.h</a></li> 
     108<li>user_info.cpp</li> 
     109</ul> 
    112110</div> 
    113 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 20:49:46 2009 for mixpp by&nbsp; 
     111<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Aug 30 22:10:50 2009 for mixpp by&nbsp; 
    114112<a href="http://www.doxygen.org/index.html"> 
    115 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> 
     113<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> 
    116114</body> 
    117115</html>