OpenWalnut  1.5.0dev
Public Member Functions | Protected Attributes | List of all members
WUI Class Referenceabstract

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

#include <WUI.h>

+ Inheritance diagram for WUI:
+ Collaboration diagram for WUI:

Public Member Functions

 WUI (int argc, char **argv)
 Constructor. More...
 
virtual ~WUI ()
 Destructor. More...
 
virtual const WFlag< bool > & isInitialized () const
 Returns the init flag. More...
 
virtual int run ()=0
 Runs the UI. More...
 
virtual WUIWidgetFactory::SPtr getWidgetFactory () const =0
 Returns the widget factory of the UI. More...
 

Protected Attributes

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

Detailed Description

This class prescribes the interface to the UI.

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

Definition at line 50 of file WUI.h.

Constructor & Destructor Documentation

◆ WUI()

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

Constructor.

Parameters
argcnumber of arguments given on command line.
argvarguments given on command line.

Definition at line 29 of file WUI.cpp.

◆ ~WUI()

WUI::~WUI ( )
virtual

Destructor.

Definition at line 37 of file WUI.cpp.

Member Function Documentation

◆ getWidgetFactory()

virtual WUIWidgetFactory::SPtr WUI::getWidgetFactory ( ) const
pure virtual

Returns the widget factory of the UI.

Use it to create custom widgets.

Returns
the factory. Use this to create your widget instances.

Implemented in WScriptUI, and WQtGui.

◆ isInitialized()

const WFlag< bool > & WUI::isInitialized ( ) const
virtual

Returns the init flag.

Returns
Reference to the flag.

Definition at line 41 of file WUI.cpp.

References m_isInitialized.

◆ run()

virtual int WUI::run ( )
pure virtual

Runs the UI.

All initialization should be done here.

Returns
the return code.

Implemented in WScriptUI, and WQtGui.

Member Data Documentation

◆ m_argc

int WUI::m_argc
protected

Number of command line arguments given.

Definition at line 95 of file WUI.h.

Referenced by WQtGui::run().

◆ m_argv

char** WUI::m_argv
protected

Command line arguments given.

Definition at line 100 of file WUI.h.

Referenced by WQtGui::run(), and WScriptUI::run().

◆ m_isInitialized

WFlag< bool > WUI::m_isInitialized
protected

Flag determining whether the UI is properly initialized.

Definition at line 90 of file WUI.h.

Referenced by isInitialized(), WQtGui::run(), and WScriptUI::run().


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