Optika GUI Toolik Version of the Day
Public Member Functions | Protected Member Functions | Private Slots | Private Member Functions | Private Attributes
Optika::MetaWindow Class Reference

#include <Optika_metawindow.hpp>

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)

Private Slots

void resetModel ()
bool saveFileAs ()
void saveFile ()
void loadFile ()
bool saveCurrentUnsavedFile ()
void loadRecentDoc ()
void showAbout ()
void initiateSearch ()
void submit ()

Private Member Functions

void initilization (void(*customFunc)(Teuchos::RCP< const Teuchos::ParameterList >)=0)
void createMenus ()
void createActions ()
void load ()
void loadLastSettings ()
void saveSettings ()
void addRecentDocument (QString recentDocument)
void updateRecentDocsMenu ()

Private Attributes

SearchWidgetsearchWidget
QAction * resetAct
QAction * loadAct
QAction * saveAct
QAction * saveAsAct
QAction * quitAct
QAction * aboutAct
QAction * searchAct
QMenu * fileMenu
QMenu * recentMenu
QMenu * helpMenu
QString aboutInfo
void(* customFunc )(Teuchos::RCP< const Teuchos::ParameterList >)
QString currentLoadDir
QString currentSaveDir
QStringList recentDocsList
TreeViewview
TreeModelmodel
Delegatedelegate

Detailed Description

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

Definition at line 115 of file Optika_metawindow.hpp.


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.

Definition at line 125 of file Optika_metawindow.cpp.

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.

Definition at line 130 of file Optika_metawindow.cpp.

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.

Definition at line 135 of file Optika_metawindow.cpp.

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.

Definition at line 140 of file Optika_metawindow.cpp.

Optika::MetaWindow::~MetaWindow ( )

Deconstructer for the metawindow

Definition at line 145 of file Optika_metawindow.cpp.


Member Function Documentation

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.

Definition at line 451 of file Optika_metawindow.cpp.

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.

Definition at line 455 of file Optika_metawindow.cpp.

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

Handles any QCloseEvents for the metawindow.

Parameters:
eventThe QCloseEvent that was issued.

Definition at line 149 of file Optika_metawindow.cpp.

void Optika::MetaWindow::initilization ( void(*)(Teuchos::RCP< const Teuchos::ParameterList >)  customFunc = 0) [private]

Common initialization shared by both constructors.

Parameters:
customFuncThe function to run whenever the user clicks the submit button.

Definition at line 165 of file Optika_metawindow.cpp.

void Optika::MetaWindow::createMenus ( ) [private]

Creates all the menus for the metawindow.

Definition at line 192 of file Optika_metawindow.cpp.

void Optika::MetaWindow::createActions ( ) [private]

Creates all necessary actions used in the menut items.

Definition at line 211 of file Optika_metawindow.cpp.

void Optika::MetaWindow::load ( ) [private]

Loads previous parameter settings.

Definition at line 243 of file Optika_metawindow.cpp.

void Optika::MetaWindow::loadLastSettings ( ) [private]

Loads the last state of the MetaWindow (things like window size and screen position).

Definition at line 252 of file Optika_metawindow.cpp.

void Optika::MetaWindow::saveSettings ( ) [private]

Saves the state of the MetaWindow (things like window size and screen position).

Definition at line 306 of file Optika_metawindow.cpp.

void Optika::MetaWindow::addRecentDocument ( QString  recentDocument) [private]

Currently under developement

Definition at line 345 of file Optika_metawindow.cpp.

void Optika::MetaWindow::updateRecentDocsMenu ( ) [private]

Currently under developement

Definition at line 353 of file Optika_metawindow.cpp.

void Optika::MetaWindow::resetModel ( ) [private, slot]

Resets the treemodel to its default state.

Definition at line 362 of file Optika_metawindow.cpp.

bool Optika::MetaWindow::saveFileAs ( ) [private, slot]

Saves the parameter list settings to a user specified file.

Definition at line 369 of file Optika_metawindow.cpp.

void Optika::MetaWindow::saveFile ( ) [private, slot]

Saves the current solver to the file the user has already specified.

Definition at line 384 of file Optika_metawindow.cpp.

void Optika::MetaWindow::loadFile ( ) [private, slot]

Loads a solver the user was previously working on and had saved.

Definition at line 395 of file Optika_metawindow.cpp.

bool Optika::MetaWindow::saveCurrentUnsavedFile ( ) [private, slot]

Asks the user whether or not they would like to currently save the file they are working on. Should be used when the user has modified the file and is about to perform an action that would cause those modifiation to be lost.

Definition at line 402 of file Optika_metawindow.cpp.

void Optika::MetaWindow::loadRecentDoc ( ) [private, slot]

Loads a document from the set of recent documents

Definition at line 416 of file Optika_metawindow.cpp.

void Optika::MetaWindow::showAbout ( ) [private, slot]

Shows information about the program.

Definition at line 431 of file Optika_metawindow.cpp.

void Optika::MetaWindow::initiateSearch ( ) [private, slot]

Starts a search for a parituclar Parameter or ParameterList.

Definition at line 438 of file Optika_metawindow.cpp.

void Optika::MetaWindow::submit ( ) [private, slot]

What should happen when the user clicks the submit button.

Definition at line 442 of file Optika_metawindow.cpp.


Member Data Documentation

Widgets comprising the MetaWindow

Definition at line 201 of file Optika_metawindow.hpp.

QAction* Optika::MetaWindow::resetAct [private]

Definition at line 202 of file Optika_metawindow.hpp.

QAction * Optika::MetaWindow::loadAct [private]

Definition at line 202 of file Optika_metawindow.hpp.

QAction * Optika::MetaWindow::saveAct [private]

Definition at line 202 of file Optika_metawindow.hpp.

QAction * Optika::MetaWindow::saveAsAct [private]

Definition at line 202 of file Optika_metawindow.hpp.

QAction * Optika::MetaWindow::quitAct [private]

Definition at line 202 of file Optika_metawindow.hpp.

QAction * Optika::MetaWindow::aboutAct [private]

Definition at line 202 of file Optika_metawindow.hpp.

QAction * Optika::MetaWindow::searchAct [private]

Definition at line 202 of file Optika_metawindow.hpp.

QMenu* Optika::MetaWindow::fileMenu [private]

Definition at line 203 of file Optika_metawindow.hpp.

QMenu * Optika::MetaWindow::recentMenu [private]

Definition at line 203 of file Optika_metawindow.hpp.

QMenu * Optika::MetaWindow::helpMenu [private]

Definition at line 203 of file Optika_metawindow.hpp.

QString Optika::MetaWindow::aboutInfo [private]

Any additional about information that should be displayed in the about dialog.

Definition at line 208 of file Optika_metawindow.hpp.

Definition at line 213 of file Optika_metawindow.hpp.

Load and save directory paths

Definition at line 218 of file Optika_metawindow.hpp.

Definition at line 218 of file Optika_metawindow.hpp.

QStringList Optika::MetaWindow::recentDocsList [private]

A list of recently used documents.

Definition at line 223 of file Optika_metawindow.hpp.

The TreeView being used in the metawindow.

Definition at line 228 of file Optika_metawindow.hpp.

The TreeModel being used to display the inputs.

Definition at line 233 of file Optika_metawindow.hpp.

The deleages being used to modify any input values.

Definition at line 238 of file Optika_metawindow.hpp.


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