%
% API Documentation for nMOLDYN
% Module nMOLDYN.GUI.PreferencesDialog
%
% Generated by epydoc 3.0.1
% [Thu Oct  8 17:00:01 2009]
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                          Module Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}|(}
\section{Module nMOLDYN.GUI.PreferencesDialog}

    \label{nMOLDYN:GUI:PreferencesDialog}
\begin{alltt}
This modules implements I\{File--{\textgreater}Preferences\} dialog.

Classes:
    * PreferencesDialog: creates I\{File--{\textgreater}Preferences\} dialog used to to set up nMOLDYN PREFERENCES variables.
\end{alltt}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                           Class Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.dummy \textit{(class)}|(}
\subsection{Class dummy}

    \label{nMOLDYN:GUI:PreferencesDialog:dummy}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                                Methods                                %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Methods}

    \label{nMOLDYN:GUI:PreferencesDialog:dummy:__init__}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.dummy \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.dummy.\_\_init\_\_ \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{\_\_init\_\_}(\textit{self})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.dummy \textit{(class)}|)}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                           Class Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}|(}
\subsection{Class PreferencesDialog}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog}
\begin{tabular}{cccccc}
% Line for nMOLDYN.GUI.Widgets.Toplevel, linespec=[False]
\multicolumn{2}{r}{\settowidth{\BCL}{nMOLDYN.GUI.Widgets.Toplevel}\multirow{2}{\BCL}{nMOLDYN.GUI.Widgets.Toplevel}}
&&
  \\\cline{3-3}
  &&\multicolumn{1}{c|}{}
&&
  \\
&&\multicolumn{2}{l}{\textbf{nMOLDYN.GUI.PreferencesDialog.PreferencesDialog}}
\end{tabular}

Sets up a dialog used to change some PREFERENCES.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                                Methods                                %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Methods}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:__init__}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.\_\_init\_\_ \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{\_\_init\_\_}(\textit{self}, \textit{parent}, \textit{title}={\tt None})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    The constructor.

\setlength{\parskip}{1ex}
      \textbf{Parameters}
      \vspace{-1ex}

      \begin{quote}
        \begin{Ventry}{xxxxxx}

          \item[parent]

          the parent widget.

          \item[title]

          a string specifying the title of the dialog.

            {\it (type=string)}

        \end{Ventry}

      \end{quote}

    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:body}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.body \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{body}(\textit{self}, \textit{master})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Create dialog body. Return widget that should have initial focus.

\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:buttonbox}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.buttonbox \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{buttonbox}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Add standard button box.

\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:ok}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.ok \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{ok}(\textit{self}, \textit{event}={\tt None})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:cancel}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.cancel \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{cancel}(\textit{self}, \textit{event}={\tt None})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:validate}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.validate \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{validate}(\textit{self})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:apply}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.apply \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{apply}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    This method will set the nMOLDYN configuration.

\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:changePage}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.changePage \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{changePage}(\textit{self})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:openDirectory}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.openDirectory \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{openDirectory}(\textit{self}, \textit{prefKey})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:openFilename}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.openFilename \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{openFilename}(\textit{self}, \textit{prefKey})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:savePreferences}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.savePreferences \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{savePreferences}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    This method will save the preferences defined in the configuration 
    dialog into a file.

\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{nMOLDYN:GUI:PreferencesDialog:PreferencesDialog:loadPreferences}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog.loadPreferences \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{loadPreferences}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    This method will load a preferences file and display its contents into 
    the configuration dialog..

\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}!nMOLDYN.GUI.PreferencesDialog.PreferencesDialog \textit{(class)}|)}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PreferencesDialog \textit{(module)}|)}
