root/doc/latex/classStringAttribute.tex @ 140

Revision 140, 3.1 kB (checked in by smidl, 16 years ago)

Latex doc

Line 
1\section{StringAttribute Class Reference}
2\label{classStringAttribute}\index{StringAttribute@{StringAttribute}}
3Class encapsulating all the necessary stuff to work with a string attribute. 
4
5
6{\tt \#include $<$userinfo.h$>$}
7
8Inheritance diagram for StringAttribute:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=65pt]{classStringAttribute__inherit__graph}
13\end{center}
14\end{figure}
15Collaboration diagram for StringAttribute:\nopagebreak
16\begin{figure}[H]
17\begin{center}
18\leavevmode
19\includegraphics[width=81pt]{classStringAttribute__coll__graph}
20\end{center}
21\end{figure}
22\subsection*{Public Types}
23\begin{CompactItemize}
24\item 
25typedef map$<$ const XMLCh $\ast$const, {\bf Attribute} $\ast$const, GlobalXercesConnector::Comparator $>$ {\bf MappedAttributes}\label{classAttribute_342750acf29e4c37d009301ef5075111}
26
27\begin{CompactList}\small\item\em Type definition of mapping which transforms names to the related attributes. \item\end{CompactList}\end{CompactItemize}
28\subsection*{Public Member Functions}
29\begin{CompactItemize}
30\item 
31{\bf StringAttribute} (const string name)
32\begin{CompactList}\small\item\em User Info base class. \item\end{CompactList}\item 
33void {\bf Set} (const string str)\label{classStringAttribute_a02e791125f2f8e53e5d9beda8291408}
34
35\begin{CompactList}\small\item\em Set accessor to this attribute converting input string into a properly-typed value. \item\end{CompactList}\item 
36const string {\bf Get} ()\label{classStringAttribute_2e43e29b9da9b9c1eab65e11f4bf4518}
37
38\begin{CompactList}\small\item\em Get accessor converting stored value into a string. \item\end{CompactList}\item 
39void {\bf Attach} ({\bf MappedAttributes} \&externalAttributes)\label{classAttribute_abd94a0487d662f28264f4faa214d894}
40
41\begin{CompactList}\small\item\em This method is the key method to connect the attribute to the related UI element. \item\end{CompactList}\item 
42void {\bf FillAttribute} (DOMElement \&element)\label{classAttribute_387a68e5de7b1e31022022493f00cbff}
43
44\begin{CompactList}\small\item\em This method add and DOMAttribute node to the DOMElement passed as an argument. \item\end{CompactList}\end{CompactItemize}
45\subsection*{Public Attributes}
46\begin{CompactItemize}
47\item 
48string \textbf{value}\label{classStringAttribute_e55ae245a8ae9e16236695bd5121f744}
49
50\end{CompactItemize}
51
52
53\subsection{Detailed Description}
54Class encapsulating all the necessary stuff to work with a string attribute.
55
56\subsection{Constructor \& Destructor Documentation}
57\index{StringAttribute@{StringAttribute}!StringAttribute@{StringAttribute}}
58\index{StringAttribute@{StringAttribute}!StringAttribute@{StringAttribute}}
59\subsubsection[StringAttribute]{\setlength{\rightskip}{0pt plus 5cm}StringAttribute::StringAttribute (const string {\em name})}\label{classStringAttribute_a507cdfd19fa54e8a6cf22ffb45e5c81}
60
61
62User Info base class.
63
64This 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.
65
66The documentation for this class was generated from the following files:\begin{CompactItemize}
67\item 
68work/mixpp/bdm/userinfo.h\item 
69work/mixpp/bdm/userinfo.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.