root/doc/xml/classStringAttribute.xml @ 187

Revision 187, 10.0 kB (checked in by smidl, 16 years ago)

doc

Line 
1<?xml version='1.0' encoding='UTF-8' standalone='no'?>
2<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.5.6">
3  <compounddef id="classStringAttribute" kind="class" prot="public">
4    <compoundname>StringAttribute</compoundname>
5    <basecompoundref refid="classAttribute" prot="public" virt="non-virtual">Attribute</basecompoundref>
6    <includes refid="userinfo_8h" local="no">userinfo.h</includes>
7      <sectiondef kind="public-attrib">
8      <memberdef kind="variable" id="classStringAttribute_1e55ae245a8ae9e16236695bd5121f744" prot="public" static="no" mutable="no">
9        <type>string</type>
10        <definition>string StringAttribute::value</definition>
11        <argsstring></argsstring>
12        <name>value</name>
13        <briefdescription>
14        </briefdescription>
15        <detaileddescription>
16        </detaileddescription>
17        <inbodydescription>
18        </inbodydescription>
19        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="127" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="127" bodyend="-1"/>
20        <referencedby refid="classCarUI_1931b042d42e04cb6ac84ee2a28d8ca3c" compoundref="testUI_8cpp" startline="74" endline="78">CarUI::build</referencedby>
21        <referencedby refid="classEngineUI_1ba55eba106280ea1ae26b0a93df101e1" compoundref="testUI_8cpp" startline="32" endline="35">EngineUI::build</referencedby>
22      </memberdef>
23      </sectiondef>
24      <sectiondef kind="public-func">
25      <memberdef kind="function" id="classStringAttribute_1a507cdfd19fa54e8a6cf22ffb45e5c81" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
26        <type></type>
27        <definition>StringAttribute::StringAttribute</definition>
28        <argsstring>(const string name)</argsstring>
29        <name>StringAttribute</name>
30        <param>
31          <type>const string</type>
32          <declname>name</declname>
33        </param>
34        <briefdescription>
35<para>User Info base class. </para>        </briefdescription>
36        <detaileddescription>
37<para>This class is used to store information about parameters of an object. It support loading and saving of the information and, potentially, interaction with the user. </para>        </detaileddescription>
38        <inbodydescription>
39        </inbodydescription>
40        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="128" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="140" bodyend="144"/>
41      </memberdef>
42      <memberdef kind="function" id="classStringAttribute_1a02e791125f2f8e53e5d9beda8291408" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
43        <type>void</type>
44        <definition>void StringAttribute::Set</definition>
45        <argsstring>(const string str)</argsstring>
46        <name>Set</name>
47        <reimplements refid="classAttribute_1bfb68f3502af06cda0f61390526e1c2f">Set</reimplements>
48        <param>
49          <type>const string</type>
50          <declname>str</declname>
51        </param>
52        <briefdescription>
53<para>Set accessor to this attribute converting input string into a properly-typed value. </para>        </briefdescription>
54        <detaileddescription>
55        </detaileddescription>
56        <inbodydescription>
57        </inbodydescription>
58        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="129" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="146" bodyend="149"/>
59      </memberdef>
60      <memberdef kind="function" id="classStringAttribute_12e43e29b9da9b9c1eab65e11f4bf4518" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
61        <type>const string</type>
62        <definition>const string StringAttribute::Get</definition>
63        <argsstring>()</argsstring>
64        <name>Get</name>
65        <reimplements refid="classAttribute_1ebeef001a0f4176900f643f529c549b8">Get</reimplements>
66        <briefdescription>
67<para>Get accessor converting stored value into a string. </para>        </briefdescription>
68        <detaileddescription>
69        </detaileddescription>
70        <inbodydescription>
71        </inbodydescription>
72        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="130" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="151" bodyend="154"/>
73      </memberdef>
74      <memberdef kind="function" id="classAttribute_1abd94a0487d662f28264f4faa214d894" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
75        <type>void</type>
76        <definition>void Attribute::Attach</definition>
77        <argsstring>(MappedAttributes &amp;externalAttributes)</argsstring>
78        <name>Attach</name>
79        <param>
80          <type><ref refid="classAttribute_1342750acf29e4c37d009301ef5075111" kindref="member">MappedAttributes</ref> &amp;</type>
81          <declname>externalAttributes</declname>
82        </param>
83        <briefdescription>
84<para>This method is the key method to connect the attribute to the related UI element. </para>        </briefdescription>
85        <detaileddescription>
86        </detaileddescription>
87        <inbodydescription>
88        </inbodydescription>
89        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="91" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="73" bodyend="77"/>
90      </memberdef>
91      <memberdef kind="function" id="classAttribute_1387a68e5de7b1e31022022493f00cbff" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
92        <type>void</type>
93        <definition>void Attribute::FillAttribute</definition>
94        <argsstring>(DOMElement &amp;element)</argsstring>
95        <name>FillAttribute</name>
96        <param>
97          <type>DOMElement &amp;</type>
98          <declname>element</declname>
99        </param>
100        <briefdescription>
101<para>This method add and DOMAttribute node to the DOMElement passed as an argument. </para>        </briefdescription>
102        <detaileddescription>
103        </detaileddescription>
104        <inbodydescription>
105        </inbodydescription>
106        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="93" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.cpp" bodystart="79" bodyend="90"/>
107        <references refid="classAttribute_1ebeef001a0f4176900f643f529c549b8">Attribute::Get</references>
108      </memberdef>
109      </sectiondef>
110      <sectiondef kind="public-type">
111      <memberdef kind="typedef" id="classAttribute_1342750acf29e4c37d009301ef5075111" prot="public" static="no">
112        <type>map&lt; const XMLCh *const, <ref refid="classAttribute" kindref="compound">Attribute</ref> *const, GlobalXercesConnector::Comparator &gt;</type>
113        <definition>typedef map&lt;const XMLCh* const, Attribute* const, GlobalXercesConnector::Comparator&gt; Attribute::MappedAttributes</definition>
114        <argsstring></argsstring>
115        <name>MappedAttributes</name>
116        <briefdescription>
117<para>Type definition of mapping which transforms names to the related attributes. </para>        </briefdescription>
118        <detaileddescription>
119        </detaileddescription>
120        <inbodydescription>
121        </inbodydescription>
122        <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="79" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="79" bodyend="-1"/>
123      </memberdef>
124      </sectiondef>
125    <briefdescription>
126<para>Class encapsulating all the necessary stuff to work with a string attribute. </para>    </briefdescription>
127    <detaileddescription>
128    </detaileddescription>
129    <inheritancegraph>
130      <node id="1124">
131        <label>Attribute</label>
132        <link refid="classAttribute"/>
133      </node>
134      <node id="1123">
135        <label>StringAttribute</label>
136        <link refid="classStringAttribute"/>
137        <childnode refid="1124" relation="public-inheritance">
138        </childnode>
139      </node>
140    </inheritancegraph>
141    <collaborationgraph>
142      <node id="1126">
143        <label>Attribute</label>
144        <link refid="classAttribute"/>
145      </node>
146      <node id="1127">
147        <label>string</label>
148      </node>
149      <node id="1125">
150        <label>StringAttribute</label>
151        <link refid="classStringAttribute"/>
152        <childnode refid="1126" relation="public-inheritance">
153        </childnode>
154        <childnode refid="1127" relation="usage">
155          <edgelabel>value</edgelabel>
156        </childnode>
157      </node>
158    </collaborationgraph>
159    <location file="/home/smidl/work/git/mixpp/bdm/userinfo.h" line="125" bodyfile="/home/smidl/work/git/mixpp/bdm/userinfo.h" bodystart="124" bodyend="131"/>
160    <listofallmembers>
161      <member refid="classAttribute_1abd94a0487d662f28264f4faa214d894" prot="public" virt="non-virtual"><scope>StringAttribute</scope><name>Attach</name></member>
162      <member refid="classAttribute_131c94d75bbe6b2834b1ef633cb8565fb" prot="public" virt="non-virtual"><scope>StringAttribute</scope><name>Attribute</name></member>
163      <member refid="classAttribute_1387a68e5de7b1e31022022493f00cbff" prot="public" virt="non-virtual"><scope>StringAttribute</scope><name>FillAttribute</name></member>
164      <member refid="classStringAttribute_12e43e29b9da9b9c1eab65e11f4bf4518" prot="public" virt="virtual"><scope>StringAttribute</scope><name>Get</name></member>
165      <member refid="classAttribute_1342750acf29e4c37d009301ef5075111" prot="public" virt="non-virtual"><scope>StringAttribute</scope><name>MappedAttributes</name></member>
166      <member refid="classStringAttribute_1a02e791125f2f8e53e5d9beda8291408" prot="public" virt="virtual"><scope>StringAttribute</scope><name>Set</name></member>
167      <member refid="classStringAttribute_1a507cdfd19fa54e8a6cf22ffb45e5c81" prot="public" virt="non-virtual"><scope>StringAttribute</scope><name>StringAttribute</name></member>
168      <member refid="classStringAttribute_1e55ae245a8ae9e16236695bd5121f744" prot="public" virt="non-virtual"><scope>StringAttribute</scope><name>value</name></member>
169      <member refid="classAttribute_128ab087bb886728670e4ae5791bc2ea8" prot="public" virt="non-virtual"><scope>StringAttribute</scope><name>~Attribute</name></member>
170    </listofallmembers>
171  </compounddef>
172</doxygen>
Note: See TracBrowser for help on using the browser.