MGUI::APP_MAIN Class Reference

Base class for main application instance. More...

#include <mgui/appmain.h>

Inheritance diagram for MGUI::APP_MAIN:

[legend]List of all members.

Public Member Functions
	APP_MAIN ()
const char *	GetCmdParm (int idx) const
int	GetCmdParmCount () const
void	RemoveCmdParm (int idx)
virtual	~APP_MAIN ()=0
Static Public Member Functions
void	Exit ()
APP_BASE *	GetBaseInstance ()
APP_MAIN *	GetMainInstance ()
Private Member Functions
virtual void	v_ExitInstance ()
virtual bool	v_InitInstance ()

---

Detailed Description

Base class for main application instance.

A class must be derived from APP_MAIN and a single instance must be declared at file (static global) scope in the main application module. Only one instance of this class may be defined per executable. See also: APP_BASE.

Definition at line 174 of file appmain.h.

---

Constructor & Destructor Documentation

MGUI::APP_MAIN::APP_MAIN (   )

Constructor.

virtual MGUI::APP_MAIN::~APP_MAIN (   )  [pure virtual]

Destructor.

---

Member Function Documentation

void MGUI::APP_MAIN::Exit (   )  [inline, static]

Terminate the event loop and exit application normally. Definition at line 178 of file appmain.h.

APP_BASE* MGUI::APP_MAIN::GetBaseInstance (   )  [inline, static]

Get reference to the single APP_BASE instance for this executable. Definition at line 181 of file appmain.h.

const char* MGUI::APP_MAIN::GetCmdParm (  int  idx  )  const [inline]

Get command-line parameter for specified index. Parameters: idx  Command parameter index Definition at line 199 of file appmain.h.

int MGUI::APP_MAIN::GetCmdParmCount (   )  const [inline]

Get number of command-line parameters. Definition at line 195 of file appmain.h.

APP_MAIN* MGUI::APP_MAIN::GetMainInstance (   )  [inline, static]

Get reference to the single APP_MAIN instance for this executable. Definition at line 185 of file appmain.h.

void MGUI::APP_MAIN::RemoveCmdParm (  int  idx  )

Remove command-line parameter at specified index. Note, idx must be > 0 as first entry cannot be removed.

virtual void MGUI::APP_MAIN::v_ExitInstance (   )  [private, virtual]

Called just prior to application exit. May be overridden to clean up allocated instance resource.

virtual bool MGUI::APP_MAIN::v_InitInstance (   )  [private, virtual]

Called at application startup. Normally overridden if multiple 'processes' are built into a single executable. In this case the command line parameters may be processed to determine which process to invoke and call a function or method to create a static instance of a derived APP_BASE class for that process.

---

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

• mgui/appmain.h

---