---

BGUI Class Reference

#include <BGUI.h>

Collaboration diagram for BGUI:

[legend]List of all members.

---

Detailed Description

Main GUI manager class (singleton).

You cannot create BGUI instances yourself. There is only one instance, accessed using the get() method.

Public Member Functions
void	addScreen (BScreen *screen)
	Add a screen (as an event responder).
void	run ()
	Enter the run loop.
void	repaint (bool force=false)
	Repaint the GUI.
void	disableRedraws ()
	Disable automatic repainting.
void	enableRedraws ()
	Enable automatic repainting.
bool	redrawsDisabled ()
	Return whether automatic repainting is disabled.
BWidget *	selectedWidget ()
	Return the selected widget (if any).
void	selectWidget (BWidget *widget)
	Set the given widget as selected.
bool	backlight (bool &top, bool &bottom)
	Check whether the backlight is on.
bool	switchBacklight (bool top, bool bottom)
	Switch the backlight off or on.
bool	backlightBrightness (u8 &brightness)
	Query the backlight brightness.
bool	setBacklightBrightness (u8 brightness)
	Set the backlight brightness.
bool	powerOff ()
	Power off the DS.
const std::vector< BScreen * > &	screens ()
	Return the screens in the GUI.
Static Public Member Functions
BGUI *	get ()
	Return the global BGUI instance.
Protected Member Functions
u32	sendFIFO (u32 command)

---

Member Function Documentation

void BGUI::addScreen (  BScreen *    screen )

Add a screen (as an event responder).

bool BGUI::backlight (  bool &    top, bool &    bottom )

Check whether the backlight is on. This communicates with the arm7. The returned bool tells you whether the communication worked; the backlight flags are in the by-reference parameters top and bottom.

bool BGUI::backlightBrightness (  u8 &    brightness )

Query the backlight brightness. This communicates with the arm7. The returned bool tells you whether the communication worked; the backlight brightness is in the by-reference parameter brightness.

void BGUI::disableRedraws (    )

Disable automatic repainting.

void BGUI::enableRedraws (    )

Enable automatic repainting.

BGUI* BGUI::get (    )  [static]

Return the global BGUI instance.

bool BGUI::powerOff (    )

Power off the DS. This communicates with the arm7. The returned bool tells you whether the communication worked.

bool BGUI::redrawsDisabled (    )  [inline]

Return whether automatic repainting is disabled.

void BGUI::repaint (  bool    force = false )

Repaint the GUI. Normally, repainting is automatic. With this, you can issue repaints when you want (and not when the GUI wants). If force is true, the GUI will be repainted even if it thinks it doesn't need to.

void BGUI::run (    )

Enter the run loop.

const std::vector<BScreen*>& BGUI::screens (    )  [inline]

Return the screens in the GUI.

BWidget* BGUI::selectedWidget (    )  [inline]

Return the selected widget (if any).

void BGUI::selectWidget (  BWidget *    widget )

Set the given widget as selected.

u32 BGUI::sendFIFO (  u32    command )  [protected]

bool BGUI::setBacklightBrightness (  u8    brightness )

Set the backlight brightness. This communicates with the arm7. The returned bool tells you whether the communication worked.

bool BGUI::switchBacklight (  bool    top, bool    bottom )

Switch the backlight off or on. This communicates with the arm7. The returned bool tells you whether the communication worked.

---

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

• BGUI.h

---