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: EngineUI 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.6 --> |
---|
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>EngineUI Class Reference</h1><!-- doxytag: class="EngineUI" --><!-- doxytag: inherits="UserInfo< Engine >" -->User info for strings. |
---|
27 | <a href="#_details">More...</a> |
---|
28 | <p> |
---|
29 | <div class="dynheader"> |
---|
30 | Inheritance diagram for EngineUI:</div> |
---|
31 | <div class="dynsection"> |
---|
32 | <p><center><img src="classEngineUI__inherit__graph.png" border="0" usemap="#EngineUI__inherit__map" alt="Inheritance graph"></center> |
---|
33 | <map name="EngineUI__inherit__map"> |
---|
34 | <area shape="rect" href="classUserInfo.html" title="UserInfo\< Engine \>" alt="" coords="5,183,152,209"><area shape="rect" href="classUserInfoCore.html" title="UserInfoCore class is for internal purposes only. Use UserInfo<T> instead." alt="" coords="36,7,140,33"><area shape="rect" href="classUserInfo.html" title="The main user info template class." alt="" coords="95,87,207,113"></map> |
---|
35 | <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> |
---|
36 | <div class="dynheader"> |
---|
37 | Collaboration diagram for EngineUI:</div> |
---|
38 | <div class="dynsection"> |
---|
39 | <p><center><img src="classEngineUI__coll__graph.png" border="0" usemap="#EngineUI__coll__map" alt="Collaboration graph"></center> |
---|
40 | <map name="EngineUI__coll__map"> |
---|
41 | <area shape="rect" href="classUserInfo.html" title="UserInfo\< Engine \>" alt="" coords="225,305,372,332"><area shape="rect" href="classUserInfoCore.html" title="UserInfoCore class is for internal purposes only. Use UserInfo<T> instead." alt="" coords="288,103,392,129"><area shape="rect" href="classUserInfo.html" title="The main user info template class." alt="" coords="355,209,467,236"><area shape="rect" href="classStringAttribute.html" title="Class encapsulating all the necessary stuff to work with a string attribute." alt="" coords="123,103,237,129"><area shape="rect" href="classAttribute.html" title="User Info base class." alt="" coords="49,7,127,33"><area shape="rect" href="classDoubleAttribute.html" title="Class encapsulating all the necessary stuff to work with the double attribute." alt="" coords="5,156,128,183"></map> |
---|
42 | <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> |
---|
43 | |
---|
44 | <p> |
---|
45 | <a href="classEngineUI-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
46 | <tr><td></td></tr> |
---|
47 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
48 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba55eba106280ea1ae26b0a93df101e1"></a><!-- doxytag: member="EngineUI::build" ref="ba55eba106280ea1ae26b0a93df101e1" args="()" --> |
---|
49 | Engine * </td><td class="memItemRight" valign="bottom"><a class="el" href="classEngineUI.html#ba55eba106280ea1ae26b0a93df101e1">build</a> ()</td></tr> |
---|
50 | |
---|
51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns object of templated type filled with data stored in this <a class="el" href="classUserInfo.html" title="The main user info template class.">UserInfo</a> instance <br></td></tr> |
---|
52 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="089b8a3ad514b17ae564a27328655126"></a><!-- doxytag: member="EngineUI::Save" ref="089b8a3ad514b17ae564a27328655126" args="(char *fileName)" --> |
---|
53 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#089b8a3ad514b17ae564a27328655126">Save</a> (char *fileName)</td></tr> |
---|
54 | |
---|
55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Save <a class="el" href="classUserInfo.html" title="The main user info template class.">UserInfo</a> to the file (typically with an XML extension). <br></td></tr> |
---|
56 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="920c54d79132041a520180d083a6c503"></a><!-- doxytag: member="EngineUI::Load" ref="920c54d79132041a520180d083a6c503" args="(char *fileName)" --> |
---|
57 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#920c54d79132041a520180d083a6c503">Load</a> (char *fileName)</td></tr> |
---|
58 | |
---|
59 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Load <a class="el" href="classUserInfo.html" title="The main user info template class.">UserInfo</a> from the file (typically with an XML extension). <br></td></tr> |
---|
60 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51c1823208b719eec546b98bb855e272"></a><!-- doxytag: member="EngineUI::Attach" ref="51c1823208b719eec546b98bb855e272" args="(MappedElements &externalElements)" --> |
---|
61 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#51c1823208b719eec546b98bb855e272">Attach</a> (MappedElements &externalElements)</td></tr> |
---|
62 | |
---|
63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This method is the key method to connect the element to its parent UI element. <br></td></tr> |
---|
64 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f673ea7ee23cc87e89d1530f94817800"></a><!-- doxytag: member="EngineUI::ParseElement" ref="f673ea7ee23cc87e89d1530f94817800" args="(DOMElement *element)" --> |
---|
65 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#f673ea7ee23cc87e89d1530f94817800">ParseElement</a> (DOMElement *element)</td></tr> |
---|
66 | |
---|
67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Fills internal attributes and descendant elements according DOMElement. <br></td></tr> |
---|
68 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="22ca1ef5a10740e4107cd5a7e9a72856"></a><!-- doxytag: member="EngineUI::FillElement" ref="22ca1ef5a10740e4107cd5a7e9a72856" args="(DOMElement &element)" --> |
---|
69 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#22ca1ef5a10740e4107cd5a7e9a72856">FillElement</a> (DOMElement &element)</td></tr> |
---|
70 | |
---|
71 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Fills DOMElement according internal attributes and descendant elements. <br></td></tr> |
---|
72 | <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> |
---|
73 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="460f39281a1aa18d6d13fa5106121643"></a><!-- doxytag: member="EngineUI::producer" ref="460f39281a1aa18d6d13fa5106121643" args="" --> |
---|
74 | <a class="el" href="classStringAttribute.html">StringAttribute</a> </td><td class="memItemRight" valign="bottom"><b>producer</b></td></tr> |
---|
75 | |
---|
76 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d045de5c74b161e9a0dafbeb5e1c66de"></a><!-- doxytag: member="EngineUI::consumption" ref="d045de5c74b161e9a0dafbeb5e1c66de" args="" --> |
---|
77 | <a class="el" href="classDoubleAttribute.html">DoubleAttribute</a> </td><td class="memItemRight" valign="bottom"><b>consumption</b></td></tr> |
---|
78 | |
---|
79 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b63907af7cfccefeab209f8381962092"></a><!-- doxytag: member="EngineUI::help" ref="b63907af7cfccefeab209f8381962092" args="" --> |
---|
80 | <a class="el" href="classStringAttribute.html">StringAttribute</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#b63907af7cfccefeab209f8381962092">help</a></td></tr> |
---|
81 | |
---|
82 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Explanation for an user is the only obligatory attribute. <br></td></tr> |
---|
83 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
---|
84 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20783b9cdbef32b584be96851a8f9862"></a><!-- doxytag: member="EngineUI::elements" ref="20783b9cdbef32b584be96851a8f9862" args="" --> |
---|
85 | MappedElements </td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#20783b9cdbef32b584be96851a8f9862">elements</a></td></tr> |
---|
86 | |
---|
87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">MappiLength of the output vector. <br></td></tr> |
---|
88 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aa6753c220a54aba613bfa3cc115d1c8"></a><!-- doxytag: member="EngineUI::attributes" ref="aa6753c220a54aba613bfa3cc115d1c8" args="" --> |
---|
89 | <a class="el" href="classAttribute.html#342750acf29e4c37d009301ef5075111">Attribute::MappedAttributes</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classUserInfo.html#aa6753c220a54aba613bfa3cc115d1c8">attributes</a></td></tr> |
---|
90 | |
---|
91 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Length of the output vector. <br></td></tr> |
---|
92 | </table> |
---|
93 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
94 | User info for strings. <hr>The documentation for this class was generated from the following file:<ul> |
---|
95 | <li>work/git/mixpp/tests/testUI.cpp</ul> |
---|
96 | </div> |
---|
97 | <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 16 17:22:08 2008 for mixpp by |
---|
98 | <a href="http://www.doxygen.org/index.html"> |
---|
99 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> |
---|
100 | </body> |
---|
101 | </html> |
---|