root/library/doc/html/classbdm_1_1UIFile.html @ 654

Revision 651, 7.2 kB (checked in by mido, 16 years ago)

\doc directory cleaned a bit

Line 
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">
3<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.9 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1UIFile.html">UIFile</a>
67  </div>
68</div>
69<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>
75
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>
82
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)" -->
89void&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>
96</table>
97<hr><a name="_details"></a><h2>Detailed Description</h2>
98This class serves to load and/or save user-infos into/from configuration files stored on a hard-disk.
99<p>
100Firstly, 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>
101<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>
106In 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>
112</div>
113<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 7 17:34:46 2009 for mixpp by&nbsp;
114<a href="http://www.doxygen.org/index.html">
115<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
116</body>
117</html>
Note: See TracBrowser for help on using the browser.