pl7::Application Class Reference

#include <Application.h>

Inheritance diagram for pl7::Application:

List of all members.

Public Member Functions
	Application (void)
virtual	~Application (void)
unsigned int	GetExitCode () const
console::Logger *	GetLogger ()
console::Console *	GetConsole ()
xl7::scripting::VirtualMachine *	GetVM ()
xl7::PreConfig *	GetPreConfig ()
fl7::Shell *	GetShell ()
bool	Run ()
void	PostQuit (unsigned int exit_code=0)
void	SetRestartFlag (bool restart)
bool	RegisterApplicationState (ApplicationState *app_state)
std::vector< cl7::string_type >	GetApplicationStateNames () const
bool	NotifyApplicationState (ApplicationState *app_state)
bool	NotifyApplicationState (const cl7::string_type &app_state_name)
Protected Member Functions
virtual bool	OnInit ()
virtual bool	OnShutdown ()
Friends
void	_dx_window_quit_callback (void *user_data)

---

Constructor & Destructor Documentation

pl7::Application::Application

(

void

)

Default constructor.

pl7::Application::~Application

(

void

)

[virtual]

Destructor.

---

Member Function Documentation

std::vector< cl7::string_type > pl7::Application::GetApplicationStateNames

(

)

const

Returns a list containing the names of all registered application states.

console::Console* pl7::Application::GetConsole

(

)

[inline]

Returns the (debug) console.

unsigned int pl7::Application::GetExitCode

(

)

const [inline]

Returns the exit code of the application instance.

console::Logger* pl7::Application::GetLogger

(

)

[inline]

Returns the HTML logger.

xl7::PreConfig* pl7::Application::GetPreConfig

(

)

[inline]

Returns the XiaoLabs configuration structure.

fl7::Shell* pl7::Application::GetShell

(

)

[inline]

Returns the shell holding the system GUI elements.

xl7::scripting::VirtualMachine* pl7::Application::GetVM

(

)

[inline]

Returns the virtual machine.

bool pl7::Application::NotifyApplicationState

(

const cl7::string_type &

app_state_name

)

Notifies the next application state to activate.

bool pl7::Application::NotifyApplicationState

(

ApplicationState *

app_state

)

Notifies the next application state to activate.

bool pl7::Application::OnInit

(

)

[protected, virtual]

Will be called on initialization of the application. Override this function in your derived class to enhance the standard initialization process performed by the default implementation.

bool pl7::Application::OnShutdown

(

)

[protected, virtual]

Will be called on shutdown of the application. Override this function in your derived class to enhance the standard shutdown process performed by the default implementation or you have overridden OnInit as well.

void pl7::Application::PostQuit

(

unsigned int

exit_code = 0

)

[inline]

bool pl7::Application::RegisterApplicationState

(

ApplicationState *

app_state

)

Adds a new application state to manage.

bool pl7::Application::Run

(

)

Runs the application instance. Initializes the engine components, starts the main message loop, and shuts down the engine components. Eventually, the application gets restarted and the whole running processes will be iterated again.

void pl7::Application::SetRestartFlag

(

bool

restart

)

[inline]

---

Friends And Related Function Documentation

void _dx_window_quit_callback

(

void *

user_data

)

[friend]

The quit callback function for the DirectX window.

---

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

• ProgLabs/Application.h
• ProgLabs/Application.cpp