[99] | 1 | \section{uistring Class Reference} |
---|
| 2 | \label{classuistring}\index{uistring@{uistring}} |
---|
| 3 | User info for strings. |
---|
| 4 | |
---|
| 5 | |
---|
| 6 | {\tt \#include $<$userinfo.h$>$} |
---|
| 7 | |
---|
| 8 | Inheritance diagram for uistring:\nopagebreak |
---|
| 9 | \begin{figure}[H] |
---|
| 10 | \begin{center} |
---|
| 11 | \leavevmode |
---|
| 12 | \includegraphics[width=46pt]{classuistring__inherit__graph} |
---|
| 13 | \end{center} |
---|
| 14 | \end{figure} |
---|
| 15 | Collaboration diagram for uistring:\nopagebreak |
---|
| 16 | \begin{figure}[H] |
---|
| 17 | \begin{center} |
---|
| 18 | \leavevmode |
---|
| 19 | \includegraphics[width=82pt]{classuistring__coll__graph} |
---|
| 20 | \end{center} |
---|
| 21 | \end{figure} |
---|
| 22 | \subsection*{Public Member Functions} |
---|
| 23 | \begin{CompactItemize} |
---|
| 24 | \item |
---|
| 25 | void {\bf getsummary} (std::string \&{\bf S})\label{classuistring_e386e7738fec80d6ef80a14ac03e05e4} |
---|
| 26 | |
---|
| 27 | \begin{CompactList}\small\item\em returns a summary of its contents (used in dialogs) \item\end{CompactList}\item |
---|
| 28 | {\bf uistring} (std::string com, {\bf uibase} $\ast$par=NULL)\label{classuistring_1853e3ed6881106360042949287c7dab} |
---|
| 29 | |
---|
| 30 | \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item |
---|
| 31 | void {\bf askuser} ()\label{classuistring_cb9eb5da0ad7bcb09f0d59b037954eec} |
---|
| 32 | |
---|
| 33 | \begin{CompactList}\small\item\em interaction with the user \item\end{CompactList}\item |
---|
| 34 | void {\bf save} (std::ostream \&os)\label{classuistring_2f3c4c4ed42f720969dd6922063b784a} |
---|
| 35 | |
---|
| 36 | \begin{CompactList}\small\item\em Save to file. \item\end{CompactList}\item |
---|
| 37 | void {\bf load} (std::istream \&is)\label{classuistring_382d63a6a9ec8f10b9ceb2ed197f6e20} |
---|
| 38 | |
---|
| 39 | \begin{CompactList}\small\item\em load from file \item\end{CompactList}\item |
---|
| 40 | void {\bf set\_\-value} (std::string S0)\label{classuistring_89e96a96faca08d1847cd73cf8aaae9a} |
---|
| 41 | |
---|
| 42 | \begin{CompactList}\small\item\em access function \item\end{CompactList}\item |
---|
| 43 | virtual bool {\bf isvalid} ()\label{classuibase_e7403110752e92a31db563556124742e} |
---|
| 44 | |
---|
| 45 | \begin{CompactList}\small\item\em test if the info is valid \item\end{CompactList}\item |
---|
| 46 | int {\bf get\_\-level} ()\label{classuibase_e05d51c68e5e690110208ebad4c0a037} |
---|
| 47 | |
---|
| 48 | \begin{CompactList}\small\item\em access function \item\end{CompactList}\end{CompactItemize} |
---|
| 49 | \subsection*{Protected Attributes} |
---|
| 50 | \begin{CompactItemize} |
---|
| 51 | \item |
---|
| 52 | std::string {\bf S}\label{classuistring_64e705aa389c10f7bc52b3860c40a2fd} |
---|
| 53 | |
---|
| 54 | \begin{CompactList}\small\item\em Values. \item\end{CompactList}\item |
---|
| 55 | string {\bf name}\label{classuibase_b093af7c0a2a8b9bc3e71c1dc83779c3} |
---|
| 56 | |
---|
| 57 | \begin{CompactList}\small\item\em String identifier of a field. \item\end{CompactList}\item |
---|
| 58 | string {\bf help}\label{classuibase_4bf69e2353bf0620e0dd714e0d92473a} |
---|
| 59 | |
---|
| 60 | \begin{CompactList}\small\item\em Explanation for a user what the field means. \item\end{CompactList}\item |
---|
| 61 | {\bf uibase} $\ast$ {\bf parent}\label{classuibase_0b6ae5af990c9edfa34fe9e1ea95afe7} |
---|
| 62 | |
---|
| 63 | \begin{CompactList}\small\item\em Possible parent of the userinfo. \item\end{CompactList}\item |
---|
| 64 | int {\bf ilevel}\label{classuibase_d903be35ad6f3932eb5d8df8777e0fa1} |
---|
| 65 | |
---|
| 66 | \begin{CompactList}\small\item\em Indentation level, i.e. number of parents. \item\end{CompactList}\end{CompactItemize} |
---|
| 67 | |
---|
| 68 | |
---|
| 69 | \subsection{Detailed Description} |
---|
| 70 | User info for strings. |
---|
| 71 | |
---|
| 72 | The documentation for this class was generated from the following file:\begin{CompactItemize} |
---|
| 73 | \item |
---|
| 74 | work/mixpp/bdm/userinfo.h\end{CompactItemize} |
---|