| 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: uistring Class Reference</title> |
|---|
| 4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
|---|
| 5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
|---|
| 6 | </head><body> |
|---|
| 7 | <!-- Generated by Doxygen 1.5.5 --> |
|---|
| 8 | <div class="navigation" id="top"> |
|---|
| 9 | <div class="tabs"> |
|---|
| 10 | <ul> |
|---|
| 11 | <li><a href="index.html"><span>Main Page</span></a></li> |
|---|
| 12 | <li><a href="pages.html"><span>Related Pages</span></a></li> |
|---|
| 13 | <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
|---|
| 14 | <li><a href="files.html"><span>Files</span></a></li> |
|---|
| 15 | </ul> |
|---|
| 16 | </div> |
|---|
| 17 | <div class="tabs"> |
|---|
| 18 | <ul> |
|---|
| 19 | <li><a href="annotated.html"><span>Class List</span></a></li> |
|---|
| 20 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
|---|
| 21 | <li><a href="functions.html"><span>Class Members</span></a></li> |
|---|
| 22 | </ul> |
|---|
| 23 | </div> |
|---|
| 24 | </div> |
|---|
| 25 | <div class="contents"> |
|---|
| 26 | <h1>uistring Class Reference</h1><!-- doxytag: class="uistring" --><!-- doxytag: inherits="uibase" -->User info for strings. |
|---|
| 27 | <a href="#_details">More...</a> |
|---|
| 28 | <p> |
|---|
| 29 | <code>#include <<a class="el" href="userinfo_8h-source.html">userinfo.h</a>></code> |
|---|
| 30 | <p> |
|---|
| 31 | <div class="dynheader"> |
|---|
| 32 | Inheritance diagram for uistring:</div> |
|---|
| 33 | <div class="dynsection"> |
|---|
| 34 | <p><center><img src="classuistring__inherit__graph.png" border="0" usemap="#uistring__inherit__map" alt="Inheritance graph"></center> |
|---|
| 35 | <map name="uistring__inherit__map"> |
|---|
| 36 | <area shape="rect" href="classuibase.html" title="User Info base class." alt="" coords="8,7,67,31"></map> |
|---|
| 37 | <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> |
|---|
| 38 | <div class="dynheader"> |
|---|
| 39 | Collaboration diagram for uistring:</div> |
|---|
| 40 | <div class="dynsection"> |
|---|
| 41 | <p><center><img src="classuistring__coll__graph.png" border="0" usemap="#uistring__coll__map" alt="Collaboration graph"></center> |
|---|
| 42 | <map name="uistring__coll__map"> |
|---|
| 43 | <area shape="rect" href="classuibase.html" title="User Info base class." alt="" coords="47,111,105,135"></map> |
|---|
| 44 | <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> |
|---|
| 45 | |
|---|
| 46 | <p> |
|---|
| 47 | <a href="classuistring-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
|---|
| 48 | <tr><td></td></tr> |
|---|
| 49 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
|---|
| 50 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e386e7738fec80d6ef80a14ac03e05e4"></a><!-- doxytag: member="uistring::getsummary" ref="e386e7738fec80d6ef80a14ac03e05e4" args="(std::string &S)" --> |
|---|
| 51 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuistring.html#e386e7738fec80d6ef80a14ac03e05e4">getsummary</a> (std::string &<a class="el" href="classuistring.html#64e705aa389c10f7bc52b3860c40a2fd">S</a>)</td></tr> |
|---|
| 52 | |
|---|
| 53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns a summary of its contents (used in dialogs) <br></td></tr> |
|---|
| 54 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1853e3ed6881106360042949287c7dab"></a><!-- doxytag: member="uistring::uistring" ref="1853e3ed6881106360042949287c7dab" args="(std::string com, uibase *par=NULL)" --> |
|---|
| 55 | </td><td class="memItemRight" valign="bottom"><a class="el" href="classuistring.html#1853e3ed6881106360042949287c7dab">uistring</a> (std::string com, <a class="el" href="classuibase.html">uibase</a> *par=NULL)</td></tr> |
|---|
| 56 | |
|---|
| 57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr> |
|---|
| 58 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb9eb5da0ad7bcb09f0d59b037954eec"></a><!-- doxytag: member="uistring::askuser" ref="cb9eb5da0ad7bcb09f0d59b037954eec" args="()" --> |
|---|
| 59 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuistring.html#cb9eb5da0ad7bcb09f0d59b037954eec">askuser</a> ()</td></tr> |
|---|
| 60 | |
|---|
| 61 | <tr><td class="mdescLeft"> </td><td class="mdescRight">interaction with the user <br></td></tr> |
|---|
| 62 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2f3c4c4ed42f720969dd6922063b784a"></a><!-- doxytag: member="uistring::save" ref="2f3c4c4ed42f720969dd6922063b784a" args="(std::ostream &os)" --> |
|---|
| 63 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuistring.html#2f3c4c4ed42f720969dd6922063b784a">save</a> (std::ostream &os)</td></tr> |
|---|
| 64 | |
|---|
| 65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Save to file. <br></td></tr> |
|---|
| 66 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="382d63a6a9ec8f10b9ceb2ed197f6e20"></a><!-- doxytag: member="uistring::load" ref="382d63a6a9ec8f10b9ceb2ed197f6e20" args="(std::istream &is)" --> |
|---|
| 67 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuistring.html#382d63a6a9ec8f10b9ceb2ed197f6e20">load</a> (std::istream &is)</td></tr> |
|---|
| 68 | |
|---|
| 69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">load from file <br></td></tr> |
|---|
| 70 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="89e96a96faca08d1847cd73cf8aaae9a"></a><!-- doxytag: member="uistring::set_value" ref="89e96a96faca08d1847cd73cf8aaae9a" args="(std::string S0)" --> |
|---|
| 71 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuistring.html#89e96a96faca08d1847cd73cf8aaae9a">set_value</a> (std::string S0)</td></tr> |
|---|
| 72 | |
|---|
| 73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">access function <br></td></tr> |
|---|
| 74 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7403110752e92a31db563556124742e"></a><!-- doxytag: member="uistring::isvalid" ref="e7403110752e92a31db563556124742e" args="()" --> |
|---|
| 75 | virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#e7403110752e92a31db563556124742e">isvalid</a> ()</td></tr> |
|---|
| 76 | |
|---|
| 77 | <tr><td class="mdescLeft"> </td><td class="mdescRight">test if the info is valid <br></td></tr> |
|---|
| 78 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e05d51c68e5e690110208ebad4c0a037"></a><!-- doxytag: member="uistring::get_level" ref="e05d51c68e5e690110208ebad4c0a037" args="()" --> |
|---|
| 79 | int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#e05d51c68e5e690110208ebad4c0a037">get_level</a> ()</td></tr> |
|---|
| 80 | |
|---|
| 81 | <tr><td class="mdescLeft"> </td><td class="mdescRight">access function <br></td></tr> |
|---|
| 82 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
|---|
| 83 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="64e705aa389c10f7bc52b3860c40a2fd"></a><!-- doxytag: member="uistring::S" ref="64e705aa389c10f7bc52b3860c40a2fd" args="" --> |
|---|
| 84 | std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuistring.html#64e705aa389c10f7bc52b3860c40a2fd">S</a></td></tr> |
|---|
| 85 | |
|---|
| 86 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Values. <br></td></tr> |
|---|
| 87 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b093af7c0a2a8b9bc3e71c1dc83779c3"></a><!-- doxytag: member="uistring::name" ref="b093af7c0a2a8b9bc3e71c1dc83779c3" args="" --> |
|---|
| 88 | string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#b093af7c0a2a8b9bc3e71c1dc83779c3">name</a></td></tr> |
|---|
| 89 | |
|---|
| 90 | <tr><td class="mdescLeft"> </td><td class="mdescRight">String identifier of a field. <br></td></tr> |
|---|
| 91 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4bf69e2353bf0620e0dd714e0d92473a"></a><!-- doxytag: member="uistring::help" ref="4bf69e2353bf0620e0dd714e0d92473a" args="" --> |
|---|
| 92 | string </td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#4bf69e2353bf0620e0dd714e0d92473a">help</a></td></tr> |
|---|
| 93 | |
|---|
| 94 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Explanation for a user what the field means. <br></td></tr> |
|---|
| 95 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0b6ae5af990c9edfa34fe9e1ea95afe7"></a><!-- doxytag: member="uistring::parent" ref="0b6ae5af990c9edfa34fe9e1ea95afe7" args="" --> |
|---|
| 96 | <a class="el" href="classuibase.html">uibase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#0b6ae5af990c9edfa34fe9e1ea95afe7">parent</a></td></tr> |
|---|
| 97 | |
|---|
| 98 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Possible parent of the userinfo. <br></td></tr> |
|---|
| 99 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d903be35ad6f3932eb5d8df8777e0fa1"></a><!-- doxytag: member="uistring::ilevel" ref="d903be35ad6f3932eb5d8df8777e0fa1" args="" --> |
|---|
| 100 | int </td><td class="memItemRight" valign="bottom"><a class="el" href="classuibase.html#d903be35ad6f3932eb5d8df8777e0fa1">ilevel</a></td></tr> |
|---|
| 101 | |
|---|
| 102 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Indentation level, i.e. number of parents. <br></td></tr> |
|---|
| 103 | </table> |
|---|
| 104 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
|---|
| 105 | User info for strings. <hr>The documentation for this class was generated from the following file:<ul> |
|---|
| 106 | <li>work/mixpp/bdm/<a class="el" href="userinfo_8h-source.html">userinfo.h</a></ul> |
|---|
| 107 | </div> |
|---|
| 108 | <hr size="1"><address style="text-align: right;"><small>Generated on Fri May 9 23:06:45 2008 for mixpp by |
|---|
| 109 | <a href="http://www.doxygen.org/index.html"> |
|---|
| 110 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> |
|---|
| 111 | </body> |
|---|
| 112 | </html> |
|---|
