Optika Development
Public Member Functions
Optika::OptikaGUI Class Reference

#include <Optika_GUI.hpp>

List of all members.

Public Member Functions

 OptikaGUI (Teuchos::RCP< Teuchos::ParameterList > validParameters)
 OptikaGUI (Teuchos::RCP< Teuchos::ParameterList > validParameters, Teuchos::RCP< DependencySheet > dependencySheet)
void exec ()
void setAboutInfo (std::string aboutInfo)
void setWindowTitle (std::string title)
void setWindowIcon (std::string filePath)
void setStyleSheet (std::string filePath)
void setCustomFunction (void(*customFunc)(Teuchos::RCP< const Teuchos::ParameterList >))
std::string getWindowTitle ()
std::string getWindowIcon ()
std::string getStyleSheet ()
std::string getAboutInfo ()

Detailed Description

A class that allows the user to create and customize their Optika GUI.


Constructor & Destructor Documentation

Optika::OptikaGUI::OptikaGUI ( Teuchos::RCP< Teuchos::ParameterList >  validParameters)

Constructs an OptikaGUI object.

Parameters:
validParametersA list of parameters from which the users may specify values.
Optika::OptikaGUI::OptikaGUI ( Teuchos::RCP< Teuchos::ParameterList >  validParameters,
Teuchos::RCP< DependencySheet dependencySheet 
)

Constructs an OptikaGUI object.

Parameters:
validParametersA list of parameters from which the users may specify values.
dependencySheetA sheet listing any dependencies between parameters in the validParameters ParameterList.

Member Function Documentation

void Optika::OptikaGUI::exec ( )

Runs the GUI and gets the user input.

std::string Optika::OptikaGUI::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.
std::string Optika::OptikaGUI::getStyleSheet ( )

Gets the file path describing the location of the file being used as the QT Style Sheet.

Returns:
The file path describing the location of the file being used as the QT Style Sheet.
std::string Optika::OptikaGUI::getWindowIcon ( )

Gets the file path describing the location of the file being used for the window icon.

Returns:
The file path describing the location of the file being used for the window icon.
std::string Optika::OptikaGUI::getWindowTitle ( )

Gets the window title.

Returns:
A string containing the window title.
void Optika::OptikaGUI::setAboutInfo ( std::string  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::OptikaGUI::setCustomFunction ( void(*)(Teuchos::RCP< const Teuchos::ParameterList >)  customFunc)

Sets the custom function to be used in the GUI. When ever the user hits submit, this function will be run.

Parameters:
Thecustom function to be run whenever the user hits submit.
void Optika::OptikaGUI::setStyleSheet ( std::string  filePath)

Sets the QT style sheet that should be used for the GUI.

Parameters:
filePathFile path to the QT style sheet to be used for the GUI.
void Optika::OptikaGUI::setWindowIcon ( std::string  filePath)

Sets the window icon to the image specified in the filePath.

Parameters:
filePathFile path to the image that should be used as the window icon.
void Optika::OptikaGUI::setWindowTitle ( std::string  title)

Sets the title of the GUI window that is displayed to the user.

Parameters:
titleA string containing what the title of the GUI window should be.

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