SkyGI::Application Class Reference

Inheritance diagram for SkyGI::Application:[legend]Collaboration diagram for SkyGI::Application:[legend]List of all members.

Public Member Functions
	Application (const char *szApplicationName, int argc=0, char *argv[]=NULL)
	~Application ()
virtual int	Run ()
virtual bool	Quit (int iReturnCode=0)
void	AddWindow (Window *pWindow)
bool	RemoveWindow (Window *pWindow)
bool	ValidWindow (Window *pWindow)
MessageQueue *	GetMessageQueue ()
EventQueue *	GetEventQueue ()
Catalog *	LoadCatalog (const String &szSubFolder)
Catalog *	LoadCatalog (const String &szSubFolder, Language nLanguage)
void	SetCatalog (Catalog *pCatalog)
Catalog *	GetCatalog ()
String	GetApplicationPath ()
String	GetApplicationDirectory ()
DesktopCommunicationInterface *	GetApplicationInterface ()
void	Terminate (DesktopCommunicationMessage *pMessage, Variant pVariant)
Static Public Member Functions
static Application *	GetInstance ()
static void	CreateDebugWindow ()
static DebugWindow *	GetDebugWindow ()
static DebugProvider *	Debug ()
Classes
class	Private

---

Detailed Description

Application

Description:

The Application Object represents the main part of your application. In the constructor of an Application derived class you should create your windows. Use the Run() method to start message dispatching. Once all windows are destroyed Run() will automatically return.

See also:

EventQueue

Examples:

eventsource.cpp.

---

Constructor & Destructor Documentation

Application::Application	(	const char *	szApplicationName,
		int	argc = 0,
		char *	argv[] = NULL
	)

Application::~Application

(

)

---

Member Function Documentation

int Application::Run

(

)

[virtual]

Process and dispatch messages

Description:

The Run() function will return when either a quit message was received or when all opened windows are closed.

Returns:

Returns the optional return value passed by Quit()

See also:

Quit

bool Application::Quit

(

int

iReturnCode = 0

)

[virtual]

Post a quit message to the applications message queue

Description:

This will cause the MessageQueue to terminate processing messages and Run() will return with the optional specified return code.

Parameters:

iReturnCode

- optional return code for Run()

See also:

Run

Application * Application::GetInstance

(

)

[static]

Get the global application instance

Description:

Returns the global application instance which may be used to terminate the application by stopping the message processing.

See also:

Quit, Run

void Application::AddWindow

(

Window *

pWindow

)

bool Application::RemoveWindow

(

Window *

pWindow

)

bool Application::ValidWindow

(

Window *

pWindow

)

MessageQueue * Application::GetMessageQueue

(

)

EventQueue * Application::GetEventQueue

(

)

Catalog * Application::LoadCatalog

(

const String &

szSubFolder

)

Catalog * Application::LoadCatalog	(	const String &	szSubFolder,
		Language	nLanguage
	)

void Application::SetCatalog

(

Catalog *

pCatalog

)

Catalog * Application::GetCatalog

(

)

String Application::GetApplicationPath

(

)

String Application::GetApplicationDirectory

(

)

static void SkyGI::Application::CreateDebugWindow

(

)

[static]

static DebugWindow* SkyGI::Application::GetDebugWindow

(

)

[static]

DebugProvider * Application::Debug

(

)

[static]

DesktopCommunicationInterface * Application::GetApplicationInterface

(

)

void Application::Terminate	(	DesktopCommunicationMessage *	pMessage,
		Variant	pVariant
	)

---