root/doc/latex/classuibase.tex @ 250

\section{uibase Class Reference}
\label{classuibase}\index{uibase@{uibase}}
User Info base class.  


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

Inheritance diagram for uibase:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=400pt]{classuibase__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for uibase:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=66pt]{classuibase__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf uibase} (string com=\char`\"{}Abstract class, please ignore!\char`\"{}, uibase $\ast$par=NULL)\label{classuibase_2f0551822ed7af25f8e7ffbe7c0a8f97}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual void {\bf getsummary} (std::string \&S)\label{classuibase_de805f1ce9c1b261dc47d57c506d36f1}

\begin{CompactList}\small\item\em returns a summary of its contents (used in dialogs) \item\end{CompactList}\item 
virtual void {\bf askuser} ()\label{classuibase_d28232d94715c153afb9280a8a4552eb}

\begin{CompactList}\small\item\em interaction with the user \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 
virtual {\bf $\sim$uibase} ()\label{classuibase_1972e8d075e083e0f033ac2e4fee3a7a}

\begin{CompactList}\small\item\em for future use \item\end{CompactList}\item 
virtual void {\bf save} (std::ostream \&os)\label{classuibase_6986cef72dc78d8caaddf05481dc9eb2}

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

\begin{CompactList}\small\item\em load from file \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 
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 base class. 

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. 

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