root/doc/latex/classAttribute.tex @ 142

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

Latex doc

Line 
1\section{Attribute Class Reference}
2\label{classAttribute}\index{Attribute@{Attribute}}
3User Info base class. 
4
5
6{\tt \#include $<$userinfo.h$>$}
7
8Inheritance diagram for Attribute:\nopagebreak
9\begin{figure}[H]
10\begin{center}
11\leavevmode
12\includegraphics[width=164pt]{classAttribute__inherit__graph}
13\end{center}
14\end{figure}
15\subsection*{Public Types}
16\begin{CompactItemize}
17\item 
18typedef map$<$ const XMLCh $\ast$const, {\bf Attribute} $\ast$const, GlobalXercesConnector::Comparator $>$ {\bf MappedAttributes}\label{classAttribute_342750acf29e4c37d009301ef5075111}
19
20\begin{CompactList}\small\item\em Type definition of mapping which transforms names to the related attributes. \item\end{CompactList}\end{CompactItemize}
21\subsection*{Public Member Functions}
22\begin{CompactItemize}
23\item 
24{\bf Attribute} (const string name)\label{classAttribute_31c94d75bbe6b2834b1ef633cb8565fb}
25
26\begin{CompactList}\small\item\em The only constructor which fills the transcodedName attribute. \item\end{CompactList}\item 
27{\bf $\sim$Attribute} ()\label{classAttribute_28ab087bb886728670e4ae5791bc2ea8}
28
29\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
30virtual void {\bf Set} (const string str)=0\label{classAttribute_bfb68f3502af06cda0f61390526e1c2f}
31
32\begin{CompactList}\small\item\em Set accessor to this attribute converting input string into a properly-typed value. \item\end{CompactList}\item 
33virtual const string {\bf Get} ()=0\label{classAttribute_ebeef001a0f4176900f643f529c549b8}
34
35\begin{CompactList}\small\item\em Get accessor converting stored value into a string. \item\end{CompactList}\item 
36void {\bf Attach} ({\bf MappedAttributes} \&externalAttributes)\label{classAttribute_abd94a0487d662f28264f4faa214d894}
37
38\begin{CompactList}\small\item\em This method is the key method to connect the attribute to the related UI element. \item\end{CompactList}\item 
39void {\bf FillAttribute} (DOMElement \&element)\label{classAttribute_387a68e5de7b1e31022022493f00cbff}
40
41\begin{CompactList}\small\item\em This method add and DOMAttribute node to the DOMElement passed as an argument. \item\end{CompactList}\end{CompactItemize}
42
43
44\subsection{Detailed Description}
45User Info base class.
46
47This 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.
48
49The documentation for this class was generated from the following files:\begin{CompactItemize}
50\item 
51work/mixpp/bdm/userinfo.h\item 
52work/mixpp/bdm/userinfo.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.