GUI base class for any Guiliani application. More...

#include <GUI.h>

Inheritance diagram for CGUI:

[legend]

Public Member Functions
void	DisableMouseCursor ()

virtual void	DoCallAPI (const eC_String &kAPI, const eC_String &kParam)

virtual eC_Bool	DoPostDraw ()

void	EnableMouseCursor ()

eC_Bool	FocusAny ()

void	FourWayFocusNext (FourWayFocus_t eFocusDirection)

eC_UInt	GetIdleTime () const

virtual CGUIObject *	LoadDialog (const eC_String &kDialogName, eC_Bool &bUseSnapshot, GUIBitmapPlaneID_t &eBitmapPlaneID)

virtual void	NotifyOfDestruction (const CGUIObject *pDestroyedObject)

void	Quit ()
	Quit the GUI's main loop after the current cycle is complete.

virtual void	RequestQuit ()
	request quit

eC_Bool	Run ()

eC_Bool	RunOnce ()

void	SetCursorImage (const ImageResource_t &eImage)

Public Member Functions inherited from CGUICompositeObject
	CGUICompositeObject ()

	CGUICompositeObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)

	CGUICompositeObject (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)

	CGUICompositeObject (const CGUICompositeObject &kSource)

virtual	~CGUICompositeObject ()
	This destructor is automatically virtual, as the base class destructor is virtual.

virtual eC_Bool	AddObject (CGUIObject *pkObject)

eC_Bool	BringToFront (CGUIObject *pkObject)

eC_Bool	CanBeCyclicFocussed () const

virtual eC_Bool	DoPostDraw ()

void	DrawOnTop (CGUIObject *pkObject)

void	DrawOnTopOf (CGUIObject const pkObject, CGUIObject const pDrawOnTopOf)

virtual CGUIObject *	FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)

void	Flip (const eC_Bool &rbVertical)

eC_Bool	FocusAny ()

virtual eC_Bool	FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)

virtual eC_Bool	FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)

CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName)

const CGUIObject *	GetAndCheckObjectByID (ObjectHandle_t eObjID, const eC_String &kObjectName) const

CGUIObject *	GetChild (const eC_UInt uIndex)

CGUIObject *	GetChild (const eC_UInt uIndex) const

const ObjectPtrList &	GetChildObjectsList () const

const ObjectPtrList &	GetDrawOrderList () const

eC_Int	GetIndexOfChild (const CGUIObject *pkObject) const

eC_UInt	GetNumberOfChildren () const

CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)

const CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const

eC_Bool	InsertChildAt (const eC_UInt cuiIndex, CGUIObject *pkChild)

void	InvalidateChildren ()
	Invalidates all chidren, but not this parent.

eC_Bool	IsAncestorOf (const CGUIObject *pkObject) const

virtual eC_Bool	IsCompositeObject () const

eC_Bool	LowerOneLevel (CGUIObject *pkObject)

CGUICompositeObject &	operator= (const CGUICompositeObject &kSource)

eC_Bool	RaiseOneLevel (CGUIObject *pkObject)

virtual void	ReadFromStream ()

virtual void	RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const

void	RemoveAllChildren ()

virtual void	RemoveObject (CGUIObject *pkObject)

void	Rotate (const eC_UInt &ruiDegrees, const eC_Bool &rbFirst=false)

eC_Bool	SendToBack (CGUIObject *pkObject)

virtual void	SetClickThrough (const eC_Bool &bClickThrough)

virtual void	SetClickThrough (const eC_Bool &bClickThrough, const eC_Bool &bChildrenClickThrough)

void	SetCyclicFocus (const eC_Bool &bCyclicFocus)

virtual void	SetDisabled (const eC_Bool &bDisabled)

virtual void	SetDisabled (const eC_Bool &bDisabled, const eC_Bool &bChildrenDisabled)

virtual void	SetFocussable (const eC_Bool &bFocussable)

virtual void	SetFocussable (const eC_Bool &bFocussable, const eC_Bool &bChildrenFocussable)

virtual void	SetGrayedOut (const eC_Bool &bGrayedOut)

virtual void	SetGrayedOut (const eC_Bool &bGrayedOut, const eC_Bool &bChildrenGrayedOut)

virtual void	SetHeight (const eC_Value &vY)

virtual void	SetInvisible (const eC_Bool &bInvisible)

virtual void	SetInvisible (const eC_Bool &bInvisible, const eC_Bool &bChildrenInvisible)

virtual void	SetWidth (const eC_Value &vX)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIObject
	CGUIObject ()

	CGUIObject (CGUICompositeObject *const pkParent, const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIObject (CGUICompositeObject *const pkParent, const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)

	CGUIObject (const CGUIObject &kSource)

virtual	~CGUIObject ()

void	AddValueObserver (CGUIObserver *pkObserver)

eC_Bool	CalculateInvalidatedRect (CGUIRect &rRect) const

virtual eC_Bool	ClaimFocus ()

virtual void	CreateSnapshot (eC_UInt uiBackColor=0x00)

eC_Bool	DataPoolConnectorExists () const

void	DeleteSnapshot ()

virtual void	DisableSnapshotDrawing (eC_Bool bDeleteSnapshot=true)

virtual eC_Bool	DoDraw ()

virtual eC_Bool	DoDrawSnapshot ()

virtual void	EnableSnapshotDrawing ()

virtual CGUIObject *	FindObject (const eC_Value &vAbsX, const eC_Value &vAbsY)

virtual eC_Bool	FocusAny ()

virtual eC_Bool	FocusNext (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)

virtual eC_Bool	FocusPrevious (CGUIObject *const pRefObj=NULL, const eC_Bool &bSubTreeOfRefObjDone=false)

CGUIRect	GetAbsRect () const

eC_Value	GetAbsXPos () const

eC_Value	GetAbsXPosCenter () const

eC_Value	GetAbsXPosREdge () const

eC_Value	GetAbsYPos () const

eC_Value	GetAbsYPosBEdge () const

eC_Value	GetAbsYPosCenter () const

eC_UByte	GetAlpha () const

CGUIBehaviourDecorator *	GetBehaviour ()

const CGUIBehaviourDecorator *	GetBehaviour () const

GUIBitmapPlaneID_t	GetBitmapID () const

CGUIBitmapPlane &	GetBitmapPlane () const

CGUIRect	GetCurrentAbsRect () const

eC_Value	GetCurrentAbsXPos () const

eC_Value	GetCurrentAbsXPosCenter () const

eC_Value	GetCurrentAbsXPosREdge () const

eC_Value	GetCurrentAbsYPos () const

eC_Value	GetCurrentAbsYPosBEdge () const

eC_Value	GetCurrentAbsYPosCenter () const

CDataPoolConnector &	GetDataPoolConnector ()

eC_Value	GetDistanceBottom () const

eC_Value	GetDistanceRight () const

eC_Value	GetHalfHeight () const

eC_Value	GetHalfWidth () const

eC_Value	GetHeight () const

ObjectHandle_t	GetID () const

CGUILayouter *	GetLayouter ()

const CGUILayouter *	GetLayouter () const

ObjectHandle_t	GetNeighborBottomID () const

ObjectHandle_t	GetNeighborLeftID () const

ObjectHandle_t	GetNeighborRightID () const

ObjectHandle_t	GetNeighborTopID () const

CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false)

const CGUIObject *	GetObjectByID (const ObjectHandle_t &eID, const eC_Bool &bOnlyVisible=false) const

CGUIRect	GetOriginRect () const

CGUICompositeObject *	GetParent ()

const CGUICompositeObject *	GetParent () const

CGUIRect	GetRelRect () const

eC_Value	GetRelXPos () const

eC_Value	GetRelXPosCenter () const

eC_Value	GetRelXPosREdge () const

eC_Value	GetRelYPos () const

eC_Value	GetRelYPosBEdge () const

eC_Value	GetRelYPosCenter () const

UUID_t	GetUUID () const

eC_Value	GetWidth () const

void	InvalidateArea ()

eC_Bool	IsClickable () const

eC_Bool	IsClickThrough () const

virtual eC_Bool	IsCompositeObject () const

eC_Bool	IsDescendantOf (const CGUIObject *const pAncestor) const

eC_Bool	IsDisabled () const

eC_Bool	IsDragable () const

eC_Bool	IsDragged () const

eC_Bool	IsDrawingSnapshot () const

eC_Bool	IsFocussable () const

eC_Bool	IsFocussed () const

eC_Bool	IsGrayedOut () const

virtual eC_Bool	IsHighlightable () const

eC_Bool	IsHighlighted () const

eC_Bool	IsInvisible () const

eC_Bool	IsPressed () const

eC_Bool	IsStopFocus () const

void	NotifyValueObservers (const CGUIValue &kValue, const eC_UInt uiX=0, const eC_UInt uiY=0)

CGUIObject &	operator= (const CGUIObject &kSource)

virtual void	ReadFromStream ()

virtual void	RefreshLayout (CGUILayouter::eMovedEdges_t eMovedEdges) const

void	RemoveValueObserver (CGUIObserver *pkObserver)

void	RenderToBitmap (eC_UInt uiBitmapID, eC_Value vXOffset=eC_FromInt(0), eC_Value vYOffset=eC_FromInt(0))

eC_Bool	RequestFocus ()

void	SetAlpha (eC_UByte ubAlpha)

void	SetBehaviour (CGUIBehaviourDecorator *pkBehaviour)

void	SetClickThrough (const eC_Bool &bClickThrough)

virtual void	SetDisabled (const eC_Bool &bDisabled)

virtual void	SetFocussable (const eC_Bool &bFocussable)

virtual void	SetGrayedOut (const eC_Bool &bGrayOut)

virtual void	SetHeight (const eC_Value &vY)

void	SetID (const ObjectHandle_t &eID)

virtual void	SetInvisible (const eC_Bool &bInvisible)

void	SetLayouter (CGUILayouter *pLayouter)

void	SetNeighborBottomID (const ObjectHandle_t eNewNeighborBottomID)

void	SetNeighborIDs (const ObjectHandle_t eNewNeighborLeftID, const ObjectHandle_t eNewNeighborRightID, const ObjectHandle_t eNewNeighborTopID, const ObjectHandle_t eNewNeighborBottomID)

void	SetNeighborLeftID (const ObjectHandle_t eNewNeighborLeftID)

void	SetNeighborRightID (const ObjectHandle_t eNewNeighborRightID)

void	SetNeighborTopID (const ObjectHandle_t eNewNeighborTopID)

virtual void	SetParent (CGUICompositeObject *const pkParent)

void	SetRelRect (const CGUIRect &kNewRect)

virtual void	SetRelXPos (const eC_Value &vX)

void	SetRelXPosCenter (const eC_Value &vXCenter)

void	SetRelXPosREdge (const eC_Value &vX)

virtual void	SetRelYPos (const eC_Value &vY)

void	SetRelYPosBEdge (const eC_Value &vY)

void	SetRelYPosCenter (const eC_Value &vYCenter)

void	SetStopFocus (const eC_Bool &bDontFocusToParent)

void	SetUUID (const UUID_t &kUUID)

virtual eC_Bool	SetValue (CDataPoolEntry &rkValue)

virtual eC_Bool	SetValue (const CGUIValue &rkValue)

virtual void	SetWidth (const eC_Value &vX)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIBehaviour
virtual eC_Bool	DoScale (const eC_Value &vDelta)

virtual eC_Bool	DoUserEvent (CGUIEvent *const pEvent)

virtual void	OnCreate ()

virtual void	OnDataPool (const DataPoolResource_t &eID)

virtual void	OnDelete ()

virtual void	OnHide ()

virtual void	OnShow ()

virtual eC_Bool	DoClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoLongClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoDoubleClick (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoButtonDown (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoButtonUp (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoDrag (const eC_Value &vDeltaX=eC_FromInt(-1), const eC_Value &vDeltaY=eC_FromInt(-1), const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoDragEnd (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoMouseEnter (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoMouseLeave (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual eC_Bool	DoMouseMove (const eC_Value &vAbsX=eC_FromInt(-1), const eC_Value &vAbsY=eC_FromInt(-1))

virtual void	GetFocus ()

virtual void	LoseFocus ()

virtual eC_Bool	Decrease ()

virtual eC_Bool	Increase ()

virtual eC_Bool	DoKeyDown (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)

virtual eC_Bool	DoKeyUp (const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)

virtual eC_Bool	DoChar (const eC_UInt &uiKey, const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)

virtual eC_Bool	DoScroll (const eC_Value &vAbsX, const eC_Value &vAbsY, const eC_Value &vDelta, const eC_Bool &bModifierActive)

Public Member Functions inherited from CGUIStreamableObject
const eC_String &	GetXMLTag () const

virtual void	ReadFromStream ()

void	SetXMLTag (const eC_String &kXMLTag)

virtual void	WriteToStream (const eC_Bool bWriteClassID=false)

Public Member Functions inherited from CGUIAnimatable
virtual	~CGUIAnimatable ()
	Destructor. Removes all existing animation callbacks.

virtual void	DoAnimate (const eC_Value &vTimes=eC_FromInt(1))

virtual eC_Bool	IsAnimating () const

virtual void	StartAnimation ()

virtual void	StopAnimation ()

Static Public Member Functions
static CGUI &	GetInstance ()

static eC_String	GetLicenseString ()

static eC_String	GetPlatformString ()

static const eC_UInt	GetVersion ()

static const eC_String &	GetVersionString ()

static eC_Bool	IsCreated ()

static eC_Bool	IsLicenseActive ()

static eC_Bool	IsRunning ()

static eC_Bool	LoadGuilianiLicenseKey (const eC_String &kFilename)

static void	PrintLibraryInformation ()
	Prints information about the Guiliani revision and Configuration settings used while building this library.

static void	SetGuilianiLicenseKey (const eC_Char *pcLicenseKey)

Static Public Member Functions inherited from CGUIStreamableObject
static UUID_t	GenerateUUID ()

Protected Member Functions
	CGUI (const CGUIRect &kRect, const ObjectHandle_t &eID=NO_HANDLE)

	CGUI (const eC_Value &vX, const eC_Value &vY, const eC_Value &vWidth, const eC_Value &vHeight, const ObjectHandle_t &eID=NO_HANDLE)

virtual	~CGUI (void)
	Destructor.

Protected Member Functions inherited from CGUICompositeObject
virtual eC_Bool	FourWayNext (FourWayFocus_t eFocusDirection)

ObjectPtrList &	GetChildObjectsList ()

virtual void	HandleDraw (const CGUIRect &ClipRect)

Protected Member Functions inherited from CGUIObject
virtual eC_Bool	CreateBitmapPlane ()

virtual eC_Bool	FourWayNext (FourWayFocus_t eFocusDirection)

Protected Member Functions inherited from CGUIStreamableObject
eC_UInt	ReadStreamingHeader (const eC_UInt &uiClassVersion, const eC_UInt &uiClassMinVersion=0) const

void	WriteStreamingFooter (const eC_Bool &bWriteClassID) const

void	WriteStreamingHeader (const eC_Bool &bWriteClassID, const eC_Char *const pkClassIDTag, const eC_Int &iClassID, const eC_UInt &uiClassVersion) const

Static Protected Attributes
static const eC_Int	GUILIANI_VERSION_MAJOR
	major-version of Guiliani

static const eC_Int	GUILIANI_VERSION_MINOR
	minor-version of Guiliani

static volatile eC_Bool	ms_bRunning
	This boolean value specifies if the GUI is currently running.

Friends
class	CGUIDataPool

class	CGUILocalisationTable

class	CGUIObject

class	CGUIResourceManager

Additional Inherited Members
Public Types inherited from CGUIObject
enum	FourWayFocus_t { FOCUS_LEFT , FOCUS_RIGHT , FOCUS_UP , FOCUS_DOWN }

Static Public Attributes inherited from CGUICompositeObject
static const eC_Char	XMLTAG_CHILDREN []
	XML comment tag to be used before writing children to a stream.

static const eC_Char	XMLTAG_ENDCHILDREN []
	XML comment tag to be used after writing children to a stream.

Static Public Attributes inherited from CGUIObject
static const eC_Char	XMLTAG_ALPHA []
	XML tag to be used writing alpha-value into a stream.

static const eC_Char	XMLTAG_CLICKTHROUGH []
	XML tag to be used writing clickthrough-state into a stream.

static const eC_Char	XMLTAG_CONTROLCLASSID []
	XML tag to be used when writing a control class ID into a stream.

static const eC_Char	XMLTAG_DISABLED []
	XML tag to be used writing disabled-state into a stream.

static const eC_Char	XMLTAG_FOCUSSABLE []
	XML tag to be used writing focussable-state into a stream.

static const eC_Char	XMLTAG_GRAYEDOUT []
	XML tag to be used writing grayedout-state into a stream.

static const eC_Char	XMLTAG_HEIGHT []
	XML tag to be used writing height into a stream.

static const eC_Char	XMLTAG_INVISIBLE []
	XML tag to be used writing invisible-state into a stream.

static const eC_Char	XMLTAG_OBJECTID []
	XML tag to be used writing object id into a stream.

static const eC_Char	XMLTAG_OVERRIDDENNEIGHBORS []
	XML tag to be used writing overridden neighbors into a stream.

static const eC_Char	XMLTAG_UUID []
	XML tag to be used when writing a UUID into a stream.

static const eC_Char	XMLTAG_WIDTH []
	XML tag to be used writing width into a stream.

static const eC_Char	XMLTAG_XPOS []
	XML tag to be used writing x-position into a stream.

static const eC_Char	XMLTAG_YPOS []
	XML tag to be used writing y-position into a stream.

Static Public Attributes inherited from CGUIBehaviour
static const eC_Char	XMLTAG_BEHAVIOURCLASSID []
	XML tag to be used when writing a behaviour class ID into a stream.

static const eC_Char	XMLTAG_BEHAVIOURCOUNT []
	XML tag for count.

Static Public Attributes inherited from CGUIStreamableObject
static const eC_Char	XMLTAG_CLASSVERSION []

Protected Attributes inherited from CGUIObject
UUID_t	m_kUUID
	UUID of object.

Detailed Description

GUI base class for any Guiliani application.

The CGUI class is the application's interface for communicating with Guiliani. An application derives a class from this one and does its own special initialization in its constructor.

CGUI contains the application main loop which is started by executing the Run() method. The loop handles input events, processes pending animations and commands and initiates redrawing of the controls. If an application wants to end, it calls the Quit() method which makes Run() return after the next cycle.

Constructor & Destructor Documentation

◆ CGUI() [1/2]

CGUI::CGUI	(	const eC_Value &	vX,
		const eC_Value &	vY,
		const eC_Value &	vWidth,
		const eC_Value &	vHeight,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

protected

constructor

Parameters

vX	x-position
vY	y-position
vWidth	width
vHeight	height
eID	object-handle

◆ CGUI() [2/2]

CGUI::CGUI	(	const CGUIRect &	kRect,
		const ObjectHandle_t &	eID = `NO_HANDLE`
	)

protected

constructor

Parameters

kRect	position and size
eID	object-handle

Member Function Documentation

◆ DisableMouseCursor()

void CGUI::DisableMouseCursor ( )

Disable mouse-cursor

◆ DoCallAPI()

virtual void CGUI::DoCallAPI	(	const eC_String &	kAPI,
		const eC_String &	kParam
	)

inlinevirtual

This slot can be used to receive specific messages from the GUI inside the application.

Parameters

kAPI	a string for the API
kParam	a string for the parameter

◆ DoPostDraw()

virtual eC_Bool CGUI::DoPostDraw ( )

virtual

This slot is implemented for drawing an overlay, like the fake mouse cursor (CGUIFakeMouseCursor). Unlike DoDraw, which is being called BEFORE any children are being drawn, this method will be automatically called by the framework AFTER all children have been drawn.

Returns: True if anything was drawn, False otherwise

Reimplemented from CGUICompositeObject.

◆ EnableMouseCursor()

void CGUI::EnableMouseCursor ( )

Enable mouse-cursor

◆ FocusAny()

eC_Bool CGUI::FocusAny ( )

virtual

Special version of FocusAny which adds functionality that is needed by the framework. From the user's perspective the function does what is documented in the base class.

Returns: eC_Bool True if focus was obtained, False otherwise

See also: CGUICompositeObject::FocusAny

Reimplemented from CGUIObject.

◆ FourWayFocusNext()

void CGUI::FourWayFocusNext ( FourWayFocus_t eFocusDirection )

Called when the focus should be set to the next control that is in the given direction of the currently focused object. This function needs the event handler instance to already be created.

Parameters

eFocusDirection The focus direction

◆ GetIdleTime()

eC_UInt CGUI::GetIdleTime ( ) const

Returns the time that Guiliani may idle until the next animation or command timer expires.

Returns: The idle time in milliseconds.

◆ GetInstance()

static CGUI & CGUI::GetInstance ( )

inlinestatic

Returns the singleton GUI instance.

Returns: the Instance of the GUI

◆ GetLicenseString()

static eC_String CGUI::GetLicenseString ( )

static

Returns the license string of Guiliani

Returns: license-string

◆ GetPlatformString()

static eC_String CGUI::GetPlatformString ( )

static

Returns the platform string of Guiliani

Returns: license-string

◆ GetVersion()

static const eC_UInt CGUI::GetVersion ( )

static

Return the version number of Guiliani (0xXXYYRRRR)

Returns: Version number

◆ GetVersionString()

static const eC_String & CGUI::GetVersionString ( )

static

Returns the version number of Guiliani that was used during build.

Returns: Version number string

◆ IsCreated()

static eC_Bool CGUI::IsCreated ( )

inlinestatic

Check whether the instance of the GUI is constructed. This method does neither indicate whether the GUI is initialized nor whether it is running.

Returns: True if an instance was created, False else.

◆ IsLicenseActive()

static eC_Bool CGUI::IsLicenseActive ( )

static

get license-status

Returns: true if license is active

◆ IsRunning()

static eC_Bool CGUI::IsRunning ( )

inlinestatic

Check whether the instance of the GUI is running. 'Running' means that Run() has been called and Quit() has not been called.

Returns: True if the GUI is running, otherwise False.

◆ LoadDialog()

virtual CGUIObject * CGUI::LoadDialog	(	const eC_String &	kDialogName,
		eC_Bool &	bUseSnapshot,
		GUIBitmapPlaneID_t &	eBitmapPlaneID
	)

virtual

Load a dialog and determine if a snapshot exists

Parameters

kDialogName	name of the dialog
bUseSnapshot	will be set to true if a snapshot is used
eBitmapPlaneID	will be set to the used bitmap-plane

Returns: the loaded dialog

◆ LoadGuilianiLicenseKey()

static eC_Bool CGUI::LoadGuilianiLicenseKey ( const eC_String & kFilename )

static

Loads a Guiliani License key file and calls SetGuilianiLicenseKey() with the loaded key. Note that this needs to be done BEFORE constructing the root CGUI object!

Parameters

kFilename Name of the license file

Returns: True if the key file could be loaded, False otherwise.

◆ NotifyOfDestruction()

virtual void CGUI::NotifyOfDestruction ( const CGUIObject * pDestroyedObject )

inlinevirtual

This method slot will be called whenever a CGUIObject is destroyed. You may override this method in derived classes to plug-in any code which needs to be informed when a CGUIObject is destroyed.

Parameters

pDestroyedObject Pointer to object which has been destroyed.

◆ Run()

eC_Bool CGUI::Run ( )

Implements the loop that the application runs in. Call this method from the application's main function. It calls RunOnce() repeatedly and returns only after Quit() has been called.

Returns: Currently always False.

◆ RunOnce()

eC_Bool CGUI::RunOnce ( )

The 'body' of the main loop. Processes input events, commands and triggers redraws when necessary.

Call this method directly on platforms that have their own loop management and don't allow applications to run in a self-contained loop. You will need to determine the point at which to quit the application manually.

Returns: True before Quit() has been called, false after it has been called.

Remarks: This method always sets the internal 'running' state to true first. If one of the events or commands leads to a call to Quit() during application processing, the 'running' state is set to False. This allows for determining 'user quits' by examining the return value.

◆ SetCursorImage()

void CGUI::SetCursorImage ( const ImageResource_t & eImage )

Set image for mouse-cursor

Parameters

eImage image

◆ SetGuilianiLicenseKey()

static void CGUI::SetGuilianiLicenseKey ( const eC_Char * pcLicenseKey )

static

Sets a Guiliani License key to remove limitations of a Lite or Eval-Version. Note that this needs to be done BEFORE constructing the root CGUI object!

Parameters

pcLicenseKey your license key.

Friends And Related Function Documentation

◆ CGUIObject

friend class CGUIObject

friend

CGUI declares variables used by the 4-way focusing algorithm which CGUIObject and CGUICompositeObject access, but which no other classes should be able to access.

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

GUI.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CGUI() [1/2]

◆ CGUI() [2/2]

Member Function Documentation

◆ DisableMouseCursor()

◆ DoCallAPI()

◆ DoPostDraw()

◆ EnableMouseCursor()

◆ FocusAny()

◆ FourWayFocusNext()

◆ GetIdleTime()

◆ GetInstance()

◆ GetLicenseString()

◆ GetPlatformString()

◆ GetVersion()

◆ GetVersionString()

◆ IsCreated()

◆ IsLicenseActive()

◆ IsRunning()

◆ LoadDialog()

◆ LoadGuilianiLicenseKey()

◆ NotifyOfDestruction()

◆ Run()

◆ RunOnce()

◆ SetCursorImage()

◆ SetGuilianiLicenseKey()

Friends And Related Function Documentation

◆ CGUIObject