root/doc/latex/classuistring.tex @ 172

\section{uistring Class Reference}
\label{classuistring}\index{uistring@{uistring}}
User info for strings.  


{\tt \#include $<$userinfo.h$>$}

Inheritance diagram for uistring:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=46pt]{classuistring__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for uistring:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=82pt]{classuistring__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
void {\bf getsummary} (std::string \&{\bf S})\label{classuistring_e386e7738fec80d6ef80a14ac03e05e4}

\begin{CompactList}\small\item\em returns a summary of its contents (used in dialogs) \item\end{CompactList}\item 
{\bf uistring} (std::string com, {\bf uibase} $\ast$par=NULL)\label{classuistring_1853e3ed6881106360042949287c7dab}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
void {\bf askuser} ()\label{classuistring_cb9eb5da0ad7bcb09f0d59b037954eec}

\begin{CompactList}\small\item\em interaction with the user \item\end{CompactList}\item 
void {\bf save} (std::ostream \&os)\label{classuistring_2f3c4c4ed42f720969dd6922063b784a}

\begin{CompactList}\small\item\em Save to file. \item\end{CompactList}\item 
void {\bf load} (std::istream \&is)\label{classuistring_382d63a6a9ec8f10b9ceb2ed197f6e20}

\begin{CompactList}\small\item\em load from file \item\end{CompactList}\item 
void {\bf set\_\-value} (std::string S0)\label{classuistring_89e96a96faca08d1847cd73cf8aaae9a}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\item 
virtual bool {\bf isvalid} ()\label{classuibase_e7403110752e92a31db563556124742e}

\begin{CompactList}\small\item\em test if the info is valid \item\end{CompactList}\item 
int {\bf get\_\-level} ()\label{classuibase_e05d51c68e5e690110208ebad4c0a037}

\begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
std::string {\bf S}\label{classuistring_64e705aa389c10f7bc52b3860c40a2fd}

\begin{CompactList}\small\item\em Values. \item\end{CompactList}\item 
string {\bf name}\label{classuibase_b093af7c0a2a8b9bc3e71c1dc83779c3}

\begin{CompactList}\small\item\em String identifier of a field. \item\end{CompactList}\item 
string {\bf help}\label{classuibase_4bf69e2353bf0620e0dd714e0d92473a}

\begin{CompactList}\small\item\em Explanation for a user what the field means. \item\end{CompactList}\item 
{\bf uibase} $\ast$ {\bf parent}\label{classuibase_0b6ae5af990c9edfa34fe9e1ea95afe7}

\begin{CompactList}\small\item\em Possible parent of the userinfo. \item\end{CompactList}\item 
int {\bf ilevel}\label{classuibase_d903be35ad6f3932eb5d8df8777e0fa1}

\begin{CompactList}\small\item\em Indentation level, i.e. number of parents. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
User info for strings. 

The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
work/mixpp/bdm/userinfo.h\end{CompactItemize}