%
% API Documentation for nMOLDYN
% Module nMOLDYN.GUI.PDBSnapshotGeneratorDialog
%
% 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.PDBSnapshotGeneratorDialog \textit{(module)}|(}
\section{Module nMOLDYN.GUI.PDBSnapshotGeneratorDialog}

    \label{nMOLDYN:GUI:PDBSnapshotGeneratorDialog}
\begin{alltt}
This modules implements I\{File--{\textgreater}Frame snapshot\} dialog.

Classes:
    * PDBSnapshotGeneratorDialog: creates I\{File--{\textgreater}Frame snapshot\} dialog used to 
      extract a PDB file from one or several trajectory frame(s).
\end{alltt}


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

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

    \label{nMOLDYN:GUI:PDBSnapshotGeneratorDialog:PDBSnapshotGeneratorDialog}
\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.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog}}
\end{tabular}

Sets up a dialog used to export one or several trajectory frames into a PDB
file.

\textbf{Note:} if a trajectory has been previously loaded in nMOLDYN this will be the one 
proposed for extraction by default. Otherwise, the user can still choose a 
trajectory to visualize from the dialog.




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

  \subsubsection{Methods}

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

    \vspace{0.5ex}

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

    \raggedright \textbf{\_\_init\_\_}(\textit{self}, \textit{parent}, \textit{title}={\tt None}, \textit{trajectory}={\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:PDBSnapshotGeneratorDialog:PDBSnapshotGeneratorDialog:body}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog \textit{(module)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog \textit{(class)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog.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:PDBSnapshotGeneratorDialog:PDBSnapshotGeneratorDialog:buttonbox}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog \textit{(module)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog \textit{(class)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog.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:PDBSnapshotGeneratorDialog:PDBSnapshotGeneratorDialog:ok}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog \textit{(module)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog \textit{(class)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog.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:PDBSnapshotGeneratorDialog:PDBSnapshotGeneratorDialog:cancel}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog \textit{(module)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog \textit{(class)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog.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:PDBSnapshotGeneratorDialog:PDBSnapshotGeneratorDialog:validate}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog \textit{(module)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog \textit{(class)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog.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:PDBSnapshotGeneratorDialog:PDBSnapshotGeneratorDialog:apply}
    \index{nMOLDYN \textit{(package)}!nMOLDYN.GUI \textit{(package)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog \textit{(module)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog \textit{(class)}!nMOLDYN.GUI.PDBSnapshotGeneratorDialog.PDBSnapshotGeneratorDialog.apply \textit{(method)}}

    \vspace{0.5ex}

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

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

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

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

    \vspace{0.5ex}

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

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

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    Ths method is called when the user clicks on the 'Browse' button of the
    trajectory visualization dialog. It opens a file browser. After the 
    file selection some of the dialog widgets are updated with the 
    informations coming from the loaded trajectory.

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

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