Optika  Development
 All Classes Files Functions Variables Typedefs Pages
List of all members
Optika::MetaWindow Class Reference

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

#include <Optika_metawindow.hpp>

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

Public Member Functions

Constructors/Destructor
 MetaWindow (RCP< ParameterList > validParameters, RCP< DependencySheet > dependencySheet=null, void(*customFunc)(RCP< const ParameterList >)=NULL, QString fileName=QString(), const std::string actionButtonText="submit", const std::string actionNoSaveButtonText="")
 Constructs a MainWindow object. More...
 
 ~MetaWindow ()
 Deconstructer for the metawindow.
 
Getters and Setters
void setAboutInfo (QString aboutInfo)
 Adds the information specified to the about dialog of the GUI. More...
 
QString getAboutInfo ()
 Gets the information to be added to the about dialog of the GUI. More...
 
void setActionButtonText (QString newText)
 Sets the action button text. More...
 
QString getActionButtonText ()
 Gets the text being displayed int he action button. More...
 

Protected Member Functions

Overridden from QWidget
void closeEvent (QCloseEvent *event)
 Handles any QCloseEvents for the metawindow. More...
 

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 ( RCP< ParameterList >  validParameters,
RCP< DependencySheet >  dependencySheet = null,
void(*)(RCP< const ParameterList >)  customFunc = NULL,
QString  fileName = QString(),
const std::string  actionButtonText = "submit",
const std::string  actionNoSaveButtonText = "" 
)

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 action button.
fileNameThe name of a save file that may store previous values used by a user for the Parameter List specified by validParameters.

Member Function Documentation

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

Handles any QCloseEvents for the metawindow.

Parameters
eventThe QCloseEvent that was issued.

References Optika::TreeModel::isSaved().

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.
QString Optika::MetaWindow::getActionButtonText ( )

Gets the text being displayed int he action button.

Returns
The text being displayed in the action button.
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.
void Optika::MetaWindow::setActionButtonText ( QString  newText)

Sets the action button text.

Parameters
textThe text to put in the action button.

The documentation for this class was generated from the following files: