Optika Development
Public Member Functions | Protected Member Functions
Optika::MetaWindow Class Reference

#include <Optika_metawindow.hpp>

Collaboration diagram for Optika::MetaWindow:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 MetaWindow (Teuchos::RCP< Teuchos::ParameterList > validParameters, QString fileName=QString())
 MetaWindow (Teuchos::RCP< Teuchos::ParameterList > validParameters, void(*customFunc)(Teuchos::RCP< const Teuchos::ParameterList >), QString fileName=QString())
 MetaWindow (Teuchos::RCP< Teuchos::ParameterList > validParameters, Teuchos::RCP< DependencySheet > dependencySheet, QString fileName=QString())
 MetaWindow (Teuchos::RCP< Teuchos::ParameterList > validParameters, Teuchos::RCP< DependencySheet > dependencySheet, void(*customFunc)(Teuchos::RCP< const Teuchos::ParameterList >), QString fileName=QString())
 ~MetaWindow ()
void setAboutInfo (QString aboutInfo)
QString getAboutInfo ()

Protected Member Functions

void closeEvent (QCloseEvent *event)

Detailed Description

The Main Window that contains all other widgets in the Optika GUI. For all undocumented functions please refer to the Qt API.


Constructor & Destructor Documentation

Optika::MetaWindow::MetaWindow ( Teuchos::RCP< Teuchos::ParameterList >  validParameters,
QString  fileName = QString() 
)

Constructs a MainWindow object.

Parameters:
validParametersThe Parameter List the metawindow will display and the user will edit.
fileNameThe name of a save file that may store previous values used by a user for the Parameter List specified by validParameters.
Optika::MetaWindow::MetaWindow ( Teuchos::RCP< Teuchos::ParameterList >  validParameters,
void(*)(Teuchos::RCP< const Teuchos::ParameterList >)  customFunc,
QString  fileName = QString() 
)

Constructs a MainWindow object.

Parameters:
validParametersThe Parameter List the metawindow will display and the user will edit.
customFuncThe function to run whenever the user clicks the submit button.
fileNameThe name of a save file that may store previous values used by a user for the Parameter List specified by validParameters.
Optika::MetaWindow::MetaWindow ( Teuchos::RCP< Teuchos::ParameterList >  validParameters,
Teuchos::RCP< DependencySheet dependencySheet,
QString  fileName = QString() 
)

Constructs a MainWindow object.

Parameters:
validParametersThe Parameter List the metawindow will display and the user will edit.
dependencySheetA sheet listing any dependencies between parameters in the validParameters ParameterList.
fileNameThe name of a save file that may store previous values used by a user for the Parameter List specified by validParameters.
Optika::MetaWindow::MetaWindow ( Teuchos::RCP< Teuchos::ParameterList >  validParameters,
Teuchos::RCP< DependencySheet dependencySheet,
void(*)(Teuchos::RCP< const Teuchos::ParameterList >)  customFunc,
QString  fileName = QString() 
)

Constructs a MainWindow object.

Parameters:
validParametersThe Parameter List the metawindow will display and the user will edit.
dependencySheetA sheet listing any dependencies between parameters in the validParameters ParameterList.
customFuncThe function to run whenever the user clicks the submit button.
fileNameThe name of a save file that may store previous values used by a user for the Parameter List specified by validParameters.
Optika::MetaWindow::~MetaWindow ( )

Deconstructer for the metawindow


Member Function Documentation

void Optika::MetaWindow::closeEvent ( QCloseEvent *  event) [protected]

Handles any QCloseEvents for the metawindow.

Parameters:
eventThe QCloseEvent that was issued.
QString Optika::MetaWindow::getAboutInfo ( )

Gets the information to be added to the about dialog of the GUI.

Returns:
the information to be added to the about dialog of the GUI.
void Optika::MetaWindow::setAboutInfo ( QString  aboutInfo)

Adds the information specified to the about dialog of the GUI.

Parameters:
aboutInfoInformation to be added to the about dialog of the GUI.

The documentation for this class was generated from the following files:
 All Classes Functions Variables Typedefs Enumerations