PixelLightAPI  .
Protected Member Functions | Protected Attributes
PLGui::GuiApplication Class Reference

Gui application class. More...

#include <GuiApplication.h>

Inheritance diagram for PLGui::GuiApplication:
Inheritance graph
[legend]

List of all members.

Protected Member Functions

virtual PLGUI_API bool OnStart () override
 Initialization function that is called prior to OnInit()
virtual PLGUI_API void OnStop () override
 De-initialization function that is called after OnDeInit()
virtual PLGUI_API void Main () override
 Main function.
virtual PLGUI_API void OnCreateMainWindow ()
 Called when application should open it's main window.

Protected Attributes

PLCore::EventHandler EventHandlerOnDestroy
Widgetm_pMainWindow

Detailed Description

Gui application class.

Remarks:
An application class for a typical GUI application. Runs a main loop that does the necessary message processing and provides methods to manage a main application window.

Member Function Documentation

virtual PLGUI_API bool PLGui::GuiApplication::OnStart ( ) [override, protected, virtual]

Initialization function that is called prior to OnInit()

Returns:
'true' if all went fine, else 'false' which will stop the application
Remarks:
The default implementation does the following tasks:

Reimplemented from PLCore::CoreApplication.

virtual PLGUI_API void PLGui::GuiApplication::OnStop ( ) [override, protected, virtual]

De-initialization function that is called after OnDeInit()

Remarks:
The default implementation does the following tasks:
  • Everything that CoreApplication::OnStop() does
  • De-initialize system GUI

Reimplemented from PLCore::CoreApplication.

virtual PLGUI_API void PLGui::GuiApplication::Main ( ) [override, protected, virtual]

Main function.

Remarks:
The default implementation does the following tasks:
  • Run GUI main loop (processing GUI messages)
  • Exit loop when either the GUI or the application has been stopped

Reimplemented from PLCore::CoreApplication.

virtual PLGUI_API void PLGui::GuiApplication::OnCreateMainWindow ( ) [protected, virtual]

Called when application should open it's main window.

Remarks:
Use this function to create a main window and set as pointer to it using SetMainWindow(). The default implementation does the following tasks:
  • If a GUI filename is provided, create a window by loading that file
  • Otherwise, create an empty top-level window

Member Data Documentation

Main window of the application (can be a null pointer)


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:32
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported