Optika GUI Toolik Version of the Day
Optika::OptikaGUI Class Reference

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

#include <Optika_GUI.hpp>

List of all members.

Constructors

 OptikaGUI (RCP< ParameterList > validParameters, RCP< DependencySheet > dependencySheet=null, void(*customFunc)(RCP< const ParameterList >)=NULL)
 Constructs an OptikaGUI object.
 OptikaGUI (const std::string &xmlFileName, void(*customFunc)(RCP< const ParameterList >)=NULL)
 Constructs an OptikaGUI object.

Execution Functions

void exec ()
 Runs the GUI and gets the user input.

Getters and Setters

void setAboutInfo (const std::string &aboutInfo)
 Adds the information specified to the about dialog of the GUI.
void setActionButtonText (const std::string &text)
 Sets the text in the "action" button".
void setWindowTitle (const std::string &title)
 Sets the title of the GUI window that is displayed to the user.
void setWindowIcon (const std::string &filePath)
 Sets the window icon to the image specified in the filePath.
void setStyleSheet (const std::string &filePath)
 Sets the QT style sheet that should be used for the GUI.
void setCustomFunction (void(*customFunc)(RCP< const ParameterList >))
 Sets the custom function to be used in the GUI. When ever the user clicks the action button, this function will be run.
std::string getWindowTitle ()
 Gets the window title.
std::string getWindowIcon ()
 Gets the file path describing the location of the file being used for the window icon.
std::string getStyleSheet ()
 Gets the file path describing the location of the file being used as the QT Style Sheet.
std::string getAboutInfo ()
 Gets the information to be added to the about dialog of the GUI.

Private Members

RCP< ParameterListvalidParameters
 A list of parameters from which the users may specify values.
RCP< DependencySheetdependencySheet
 A sheet listing any dependencies between parameters in the validParameters.
std::string title
 A string containing the window title.
std::string iconFilePath
 File path to the image that should be used as the window icon.
std::string styleSheetFilePath
 File path to the QT style sheet to be used for the GUI.
std::string aboutInfo
 Information to be added to the about dialog of the GUI.
std::string actionButtonText
 Text to display in the action button.
void(* customFunc )(RCP< const ParameterList >)
 The custom function to be run whenever the user clicks the action button.

Detailed Description

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

Definition at line 85 of file Optika_GUI.hpp.


Constructor & Destructor Documentation

Optika::OptikaGUI::OptikaGUI ( RCP< ParameterList validParameters,
RCP< DependencySheet dependencySheet = null,
void(*)(RCP< const ParameterList >)  customFunc = NULL 
)

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.
customFuncA custom function for Optika to run upon the user clicking the action button.

Definition at line 68 of file Optika_GUI.cpp.

Optika::OptikaGUI::OptikaGUI ( const std::string &  xmlFileName,
void(*)(RCP< const ParameterList >)  customFunc = NULL 
)

Constructs an OptikaGUI object.

Parameters:
xmlFileNameName of an XML file describing the GUI.
customFuncA custom function for Optika to run upon the user clicking the action button.

Definition at line 77 of file Optika_GUI.cpp.


Member Function Documentation

void Optika::OptikaGUI::exec ( )

Runs the GUI and gets the user input.

Definition at line 86 of file Optika_GUI.cpp.

void Optika::OptikaGUI::setAboutInfo ( const 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.

Definition at line 142 of file Optika_GUI.cpp.

void Optika::OptikaGUI::setActionButtonText ( const std::string &  text)

Sets the text in the "action" button".

Parameters:
textThe text for the action button

Definition at line 146 of file Optika_GUI.cpp.

void Optika::OptikaGUI::setWindowTitle ( const 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.

Definition at line 126 of file Optika_GUI.cpp.

void Optika::OptikaGUI::setWindowIcon ( const 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.

Definition at line 130 of file Optika_GUI.cpp.

void Optika::OptikaGUI::setStyleSheet ( const 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.

Definition at line 134 of file Optika_GUI.cpp.

void Optika::OptikaGUI::setCustomFunction ( void(*)(RCP< const ParameterList >)  customFunc)

Sets the custom function to be used in the GUI. When ever the user clicks the action button, this function will be run.

Parameters:
Thecustom function to be run whenever the user clicks the action button.

Definition at line 138 of file Optika_GUI.cpp.

std::string Optika::OptikaGUI::getWindowTitle ( )

Gets the window title.

Returns:
A string containing the window title.

Definition at line 150 of file Optika_GUI.cpp.

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.

Definition at line 154 of file Optika_GUI.cpp.

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.

Definition at line 158 of file Optika_GUI.cpp.

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.

Definition at line 162 of file Optika_GUI.cpp.


Member Data Documentation

A list of parameters from which the users may specify values.

Definition at line 218 of file Optika_GUI.hpp.

A sheet listing any dependencies between parameters in the validParameters.

Definition at line 223 of file Optika_GUI.hpp.

std::string Optika::OptikaGUI::title [private]

A string containing the window title.

Definition at line 228 of file Optika_GUI.hpp.

std::string Optika::OptikaGUI::iconFilePath [private]

File path to the image that should be used as the window icon.

Definition at line 233 of file Optika_GUI.hpp.

File path to the QT style sheet to be used for the GUI.

Definition at line 238 of file Optika_GUI.hpp.

std::string Optika::OptikaGUI::aboutInfo [private]

Information to be added to the about dialog of the GUI.

Definition at line 243 of file Optika_GUI.hpp.

std::string Optika::OptikaGUI::actionButtonText [private]

Text to display in the action button.

Definition at line 248 of file Optika_GUI.hpp.

void(* Optika::OptikaGUI::customFunc)(RCP< const ParameterList >) [private]

The custom function to be run whenever the user clicks the action button.

Definition at line 253 of file Optika_GUI.hpp.


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