WGUI Class Reference

This class prescribes the interface to the GUI. More...

#include <WGUI.h>

Inheritance diagram for WGUI:

List of all members.

Public Member Functions
	WGUI (int argc, char **argv)
	Constructor.
virtual	~WGUI ()
	Destructor.
virtual const WFlag< bool > &	isInitialized () const
	Returns the init flag.
virtual int	run ()=0
	Runs the GUI.
virtual boost::shared_ptr < WCustomWidget >	openCustomWidget (std::string title, WGECamera::ProjectionMode projectionMode, boost::shared_ptr< WCondition > shutdownCondition)=0
	Instruct the MainWindow to open a new custom widget.
virtual void	closeCustomWidget (std::string title)=0
	Instruct the MainWindow to close a custom widget.

Protected Attributes
WFlag< bool >	m_isInitialized
	Flag determining whether the GUI is properly initialized.
int	m_argc
	Number of command line arguments given.
char **	m_argv
	Command line arguments given.

---

Detailed Description

This class prescribes the interface to the GUI.

It basically is an abstract class defining the interface common to all possible GUI implementations.

Definition at line 53 of file WGUI.h.

---

Constructor & Destructor Documentation

WGUI::WGUI	(	int	argc,
		char **	argv
	)

Constructor.

Parameters:

argc	number of arguments given on command line.
argv	arguments given on command line.

Definition at line 29 of file WGUI.cpp.

WGUI::~WGUI ( )

virtual

Destructor.

Definition at line 37 of file WGUI.cpp.

---

Member Function Documentation

virtual void WGUI::closeCustomWidget ( std::string  title )

pure virtual

Instruct the MainWindow to close a custom widget.

Parameters:

title

The title of the widget

const WFlag< bool > & WGUI::isInitialized ( ) const

virtual

Returns the init flag.

Returns:

Reference to the flag.

Definition at line 41 of file WGUI.cpp.

References m_isInitialized.

virtual boost::shared_ptr< WCustomWidget > WGUI::openCustomWidget ( std::string  title, WGECamera::ProjectionMode  projectionMode, boost::shared_ptr< WCondition >  shutdownCondition  )

pure virtual

Instruct the MainWindow to open a new custom widget.

Parameters:

title	the title of the widget
projectionMode	the kind of projection which should be used
shutdownCondition	condition to wait for the shutdown of a module

Returns:

the created widget

virtual int WGUI::run ( )

pure virtual

Runs the GUI.

All initialization should be done here.

Returns:

the return code.

---

Member Data Documentation

int WGUI::m_argc

protected

Number of command line arguments given.

Definition at line 111 of file WGUI.h.

char** WGUI::m_argv

protected

Command line arguments given.

Definition at line 116 of file WGUI.h.

WFlag< bool > WGUI::m_isInitialized

protected

Flag determining whether the GUI is properly initialized.

Definition at line 106 of file WGUI.h.

Referenced by isInitialized().

---

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

• WGUI.h
• WGUI.cpp