Guiliani: CGUIProperties Class Reference

Guiliani Version 2.5 revision 7293 (documentation build 13)

This class allows for the global customisation of controls without the need to derive specialised objects. More...

#include <GUIProperties.h>

Public Member Functions
GlobalProperty_t	AddDynamicProperty (const CGUIValue &kPropertyValue)

void	AddObserver (const GlobalProperty_t ePropertyID, CGUIObserver *pObserver)

eC_Bool	GetGlobalBoolProperty (const GlobalProperty_t ePropertyID) const

eC_UInt	GetGlobalColorProperty (const GlobalProperty_t ePropertyID) const

eC_Float	GetGlobalFloatProperty (const GlobalProperty_t ePropertyID) const

eC_Int	GetGlobalIntegerProperty (const GlobalProperty_t ePropertyID) const

const CGUIValue &	GetGlobalProperty (const GlobalProperty_t ePropertyID) const

const eC_String	GetGlobalTextProperty (const GlobalProperty_t ePropertyID) const

eC_UInt	GetNOFProperties () const

eC_String	GetPropertyFilename () const

void	ReadGlobalPropertiesFromFile (const eC_String &kPath)

void	RemoveDynamicProperty (const GlobalProperty_t eID)

void	RemoveObserver (const GlobalProperty_t ePropertyID, CGUIObserver *pObserver)

void	SetGlobalBoolProperty (const GlobalProperty_t ePropertyID, const eC_Bool bPropertyValue)

void	SetGlobalColorProperty (const GlobalProperty_t ePropertyID, const eC_UInt uiPropertyValue)

void	SetGlobalFloatProperty (const GlobalProperty_t ePropertyID, const eC_Float fPropertyValue)

void	SetGlobalIntegerProperty (const GlobalProperty_t ePropertyID, const eC_Int iPropertyValue)

void	SetGlobalProperty (const GlobalProperty_t ePropertyID, const CGUIValue &kPropertyValue)

void	SetGlobalProperty (const GlobalProperty_t ePropertyID, const CGUIValue &kPropertyValue, const CGUIValue::GUIValue_t &eType)

void	SetGlobalTextProperty (const GlobalProperty_t ePropertyID, const eC_String &rkStr)

void	WriteGlobalPropertiesToFile (const eC_String &kPath) const

Static Public Member Functions
static void	CreateInstance ()

static void	DeleteInstance ()

Friends
class	CGUI

class	CGUIComponentManager

Detailed Description

This class allows for the global customisation of controls without the need to derive specialised objects.

It is possible to access the property values by using the Get - methods, or by registering an observer for a specific property.

Member Function Documentation

◆ AddDynamicProperty()

GlobalProperty_t CGUIProperties::AddDynamicProperty ( const CGUIValue & kPropertyValue )

Creates a dynamic property id, and sets its value.

Parameters

kPropertyValue The value that shall be set.

Returns: The dynamically created property id.

◆ CreateInstance()

static void CGUIProperties::CreateInstance ( )

static

Create Instance

◆ DeleteInstance()

static void CGUIProperties::DeleteInstance ( )

static

Delete Instance

◆ GetGlobalBoolProperty()

eC_Bool CGUIProperties::GetGlobalBoolProperty ( const GlobalProperty_t ePropertyID ) const

Get the value of a boolean property.

Parameters

ePropertyID The property id of the wanted property.

Returns: The value stored for the property.

◆ GetGlobalColorProperty()

eC_UInt CGUIProperties::GetGlobalColorProperty ( const GlobalProperty_t ePropertyID ) const

Get the value of a color property.

Parameters

ePropertyID The property id of the wanted property.

Returns: The value stored for the property.

◆ GetGlobalFloatProperty()

eC_Float CGUIProperties::GetGlobalFloatProperty ( const GlobalProperty_t ePropertyID ) const

Get the value of a float property.

Parameters

ePropertyID The property id of the wanted property.

Returns: The value stored for the property.

◆ GetGlobalIntegerProperty()

eC_Int CGUIProperties::GetGlobalIntegerProperty ( const GlobalProperty_t ePropertyID ) const

Get the value of an integer property.

Parameters

ePropertyID The property id of the wanted property.

Returns: The value stored for the property.

◆ GetGlobalProperty()

const CGUIValue & CGUIProperties::GetGlobalProperty ( const GlobalProperty_t ePropertyID ) const

Get the value of a property.

Parameters

ePropertyID The property id of the wanted property.

Returns: The value stored for the property.

◆ GetGlobalTextProperty()

const eC_String CGUIProperties::GetGlobalTextProperty ( const GlobalProperty_t ePropertyID ) const

Get the value of a text property.

Parameters

ePropertyID The property id of the wanted property.

Returns: The value stored for the property.

◆ GetNOFProperties()

eC_UInt CGUIProperties::GetNOFProperties ( ) const

Returns the number of properties.

Returns: number of properties

◆ GetPropertyFilename()

eC_String CGUIProperties::GetPropertyFilename ( ) const

Return the name of the currently loaded property-file

Returns: name

◆ ReadGlobalPropertiesFromFile()

void CGUIProperties::ReadGlobalPropertiesFromFile ( const eC_String & kPath )

Reads all Properties from file. Streamingfile Reader has to initialized.

Parameters

kPath Path to the SourceFile.

See also: CGUIStreamReader

◆ RemoveDynamicProperty()

void CGUIProperties::RemoveDynamicProperty ( const GlobalProperty_t eID )

Removes a dynamically created property.

Parameters

eID	The id of the property to remove.

◆ RemoveObserver()

void CGUIProperties::RemoveObserver	(	const GlobalProperty_t	ePropertyID,
		CGUIObserver *	pObserver
	)

Removes an registered observer from a property.

Parameters

ePropertyID	The property id which shall no longer be observed.
pObserver	The observer to remove.

◆ SetGlobalBoolProperty()

void CGUIProperties::SetGlobalBoolProperty	(	const GlobalProperty_t	ePropertyID,
		const eC_Bool	bPropertyValue
	)

Set a boolean property.

Parameters

ePropertyID	The unique id of the property.
bPropertyValue	The property value to set for the property id.

See also: GetGlobalBoolProperty()

◆ SetGlobalColorProperty()

void CGUIProperties::SetGlobalColorProperty	(	const GlobalProperty_t	ePropertyID,
		const eC_UInt	uiPropertyValue
	)

Set a color property.

Parameters

ePropertyID	The unique id of the property.
uiPropertyValue	The property value to set for the property id as ARGB (32 Bit) value.

See also: GetGlobalColorProperty()

◆ SetGlobalFloatProperty()

void CGUIProperties::SetGlobalFloatProperty	(	const GlobalProperty_t	ePropertyID,
		const eC_Float	fPropertyValue
	)

Set a float property.

Parameters

ePropertyID	The unique id of the property.
fPropertyValue	The property value to set for the property id.

See also: GetGlobalFloatProperty()

◆ SetGlobalIntegerProperty()

void CGUIProperties::SetGlobalIntegerProperty	(	const GlobalProperty_t	ePropertyID,
		const eC_Int	iPropertyValue
	)

Set an integer property.

Parameters

ePropertyID	The unique id of the property.
iPropertyValue	The property value to set for the property id.

See also: GetGlobalIntegerProperty()

◆ SetGlobalProperty() [1/2]

void CGUIProperties::SetGlobalProperty	(	const GlobalProperty_t	ePropertyID,
		const CGUIValue &	kPropertyValue
	)

Set a GUIValue property.

Parameters

ePropertyID	The unique id of the property.
kPropertyValue	The property value to set for the property id.

See also: GetGlobalProperty()

◆ SetGlobalProperty() [2/2]

void CGUIProperties::SetGlobalProperty	(	const GlobalProperty_t	ePropertyID,
		const CGUIValue &	kPropertyValue,
		const CGUIValue::GUIValue_t &	eType
	)

Set a GUIValue property.

Parameters

ePropertyID	The unique id of the property.
kPropertyValue	The property value to set for the property id.
eType	The property type to set for the property id.

See also: GetGlobalProperty()

◆ SetGlobalTextProperty()

void CGUIProperties::SetGlobalTextProperty	(	const GlobalProperty_t	ePropertyID,
		const eC_String &	rkStr
	)

Set a text property.

Parameters

ePropertyID	The unique id of the property.
rkStr	The property value to set for the property id.

See also: GetGlobalTextProperty()

◆ WriteGlobalPropertiesToFile()

void CGUIProperties::WriteGlobalPropertiesToFile ( const eC_String & kPath ) const

Writes all Properties to file. Streamingfile Writer has to initialized.

Parameters

kPath Path to the DestinationFile.

See also: CGUIStreamWriter

Friends And Related Function Documentation

◆ CGUI

friend class CGUI

friend

◆ CGUIComponentManager

friend class CGUIComponentManager

friend

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

GUIProperties.h

CGUIProperties
Generated by 1.9.4