MAUI::Engine Class Reference

#include <MAUI/Engine.h>

Inheritance diagram for MAUI::Engine:

List of all members.

---

Detailed Description

This class manages the MAUI widget system. It is mainly of interest when when developing custom widgets.

Public Types
enum	{ MAX_WIDGET_DEPTH = 16 }
Public Member Functions
void	setMain (Widget *main)
virtual	~Engine ()
void	setDefaultFont (Font *systemFont)
Font *	getDefaultFont ()
void	setDefaultSkin (WidgetSkin *systemSkin)
WidgetSkin *	getDefaultSkin ()
void	idle ()
void	requestUIUpdate ()
void	repaint ()
bool	isOverlayShown ()
void	showOverlay (int x, int y, Widget *overlay)
void	hideOverlay ()
Static Public Member Functions
static Engine &	getSingleton ()
Protected Attributes
Widget *	overlay
Point	overlayPosition
Widget *	main
Font *	defaultFont
WidgetSkin *	defaultSkin
bool	characterInputActive
Static Protected Attributes
static Engine *	singletonPtr

---

Member Enumeration Documentation

anonymous enum

Enumerator: MAX_WIDGET_DEPTH

---

Constructor & Destructor Documentation

virtual MAUI::Engine::~Engine (   )  [virtual]

---

Member Function Documentation

void MAUI::Engine::setMain (  Widget *  main  )

Sets the widget that is main to the application, constituting the root of the UI tree

void MAUI::Engine::setDefaultFont (  Font *  systemFont  )

Sets the default font to be used by Widgets when they are not assigned any particular font.

Font* MAUI::Engine::getDefaultFont (   )

Returns the MAUI-wide default font

void MAUI::Engine::setDefaultSkin (  WidgetSkin *  systemSkin  )

Sets the default skin to be used by Widgets when they are not assigned any particular skin.

WidgetSkin* MAUI::Engine::getDefaultSkin (   )

Returns the MAUI-wide default skin

void MAUI::Engine::idle (   )  [virtual]

This function is called once per event loop. Implements MAUtil::IdleListener.

void MAUI::Engine::requestUIUpdate (   )

Widgets call this function when they require repainting. It will cause any dirty widgets to be redrawn in the next iteration of the event loop.

void MAUI::Engine::repaint (   )

Actually performs repainting

static Engine& MAUI::Engine::getSingleton (   )  [static]

Returns a reference to the single instance of this class, using lazy initialization.

bool MAUI::Engine::isOverlayShown (   )

void MAUI::Engine::showOverlay (  int  x, int  y, Widget *  overlay )

void MAUI::Engine::hideOverlay (   )

---

Member Data Documentation

Widget* MAUI::Engine::overlay [protected]

Point MAUI::Engine::overlayPosition [protected]

Widget* MAUI::Engine::main [protected]

Font* MAUI::Engine::defaultFont [protected]

WidgetSkin* MAUI::Engine::defaultSkin [protected]

Engine* MAUI::Engine::singletonPtr [static, protected]

bool MAUI::Engine::characterInputActive [protected]

---