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

#include <Optika_GUI.hpp>

Constructors
	OptikaGUI (RCP< ParameterList > validParameters, RCP< DependencySheet > dependencySheet=null, void(*customFunc)(RCP< const ParameterList >)=NULL)
	Constructs an OptikaGUI object. More...

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

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

Getters and Setters
void	setAboutInfo (const std::string &aboutInfo)
	Adds the information specified to the about dialog of the GUI. More...

void	setActionButtonText (const std::string &text)
	Sets the text in the "action" button". More...

void	setWindowTitle (const std::string &title)
	Sets the title of the GUI window that is displayed to the user. More...

void	setWindowIcon (const std::string &filePath)
	Sets the window icon to the image specified in the filePath. More...

void	setStyleSheet (const std::string &filePath)
	Sets the QT style sheet that should be used for the GUI. More...

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. More...

std::string	getWindowTitle ()
	Gets the window title. More...

std::string	getWindowIcon ()
	Gets the file path describing the location of the file being used for the window icon. More...

std::string	getStyleSheet ()
	Gets the file path describing the location of the file being used as the QT Style Sheet. More...

std::string	getAboutInfo ()
	Gets the information to be added to the about dialog of the GUI. More...

Private Members
RCP< ParameterList >	validParameters
	A list of parameters from which the users may specify values. More...

RCP< DependencySheet >	dependencySheet
	A sheet listing any dependencies between parameters in the validParameters. More...

std::string	title
	A string containing the window title. More...

std::string	iconFilePath
	File path to the image that should be used as the window icon. More...

std::string	styleSheetFilePath
	File path to the QT style sheet to be used for the GUI. More...

std::string	aboutInfo
	Information to be added to the about dialog of the GUI. More...

std::string	actionButtonText
	Text to display in the action button. More...

void(*	customFunc )(RCP< const ParameterList >)
	The custom function to be run whenever the user clicks the action button. More...

Detailed Description

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

Definition at line 147 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

validParameters	A list of parameters from which the users may specify values.
dependencySheet	A sheet listing any dependencies between parameters in the validParameters ParameterList.
customFunc	A custom function for Optika to run upon the user clicking the action button.

Definition at line 159 of file Optika_GUI.cpp.

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

Constructs an OptikaGUI object.

Parameters

xmlFileName	Name of an XML file describing the GUI.
customFunc	A custom function for Optika to run upon the user clicking the action button.

Definition at line 168 of file Optika_GUI.cpp.

Member Function Documentation

void Optika::OptikaGUI::exec ( )

Runs the GUI and gets the user input.

Definition at line 177 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

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

Definition at line 233 of file Optika_GUI.cpp.

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

Sets the text in the "action" button".

Parameters

text	The text for the action button

Definition at line 237 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

title A string containing what the title of the GUI window should be.

Definition at line 217 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

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

Definition at line 221 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

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

Definition at line 225 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

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

Definition at line 229 of file Optika_GUI.cpp.

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

Gets the window title.

Returns: A string containing the window title.

Definition at line 241 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 245 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 249 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 253 of file Optika_GUI.cpp.

Member Data Documentation

RCP<ParameterList> Optika::OptikaGUI::validParameters

private

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

Definition at line 280 of file Optika_GUI.hpp.

RCP<DependencySheet> Optika::OptikaGUI::dependencySheet

private

A sheet listing any dependencies between parameters in the validParameters.

Definition at line 285 of file Optika_GUI.hpp.

std::string Optika::OptikaGUI::title

private

A string containing the window title.

Definition at line 290 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 295 of file Optika_GUI.hpp.

std::string Optika::OptikaGUI::styleSheetFilePath

private

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

Definition at line 300 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 305 of file Optika_GUI.hpp.

std::string Optika::OptikaGUI::actionButtonText

private

Text to display in the action button.

Definition at line 310 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 315 of file Optika_GUI.hpp.

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

Constructors

Execution Functions

Getters and Setters

Private Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation