Guiliani  Version 2.4 revision 5970 (build 3)
CGUIColorPropertyObserver Class Reference

This observer provides the base-interface for controls when using color-properties. More...

#include <GUIColorPropertyObserver.h>

Inheritance diagram for CGUIColorPropertyObserver:

Classes

struct  ColorProperty_t
 

Public Member Functions

 CGUIColorPropertyObserver ()
 default-constructor
 
 ~CGUIColorPropertyObserver ()
 destructor
 
eC_UInt AddColorProperty (const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)
 
void AddColorProperty (const eC_UInt &uiIndex, const eC_Bool &bColorIsProperty, const eC_UInt &uiColorValue, const GlobalProperty_t &eColorProperty)
 
ColorValue_t GetColorProperty (const eC_UInt &uiIndex) const
 
eC_UInt GetColorValue (const eC_UInt &uiIndex) const
 
virtual void OnColorPropertyChange ()
 
virtual void OnNotification ()
 Called by CGUISubject whenever an observed object triggers an update.
 
void RemoveColorProperty (const eC_UInt &uiIndex)
 
void SetColorProperty (const eC_UInt &uiIndex, const eC_UInt &uiColorValue)
 
void SetColorProperty (const eC_UInt &uiIndex, const GlobalProperty_t &eColorProperty)
 
void SetColorProperty (const eC_UInt &uiIndex, const ColorValue_t &kColorValue)
 
- Public Member Functions inherited from CGUIObserver
 CGUIObserver ()
 Default constructor.
 
virtual ~CGUIObserver ()
 Default destructor. Notifies all subjects of destruction.
 
const eC_TListDoubleLinked< CGUISubject * > & GetSubjectList () const
 
virtual void OnNotification (const eC_String &kMessage)
 
virtual void OnNotification (const CGUIObject *const pkUpdatedObject)
 
virtual void OnNotification (const CGUIValue &kObservedValue, const CGUIObject *const pkUpdatedObject, const eC_UInt uiX=0, const eC_UInt uiY=0)
 
void SetAutoDelete (const eC_Bool bAutoDelete)
 

Additional Inherited Members

- Protected Member Functions inherited from CGUIObserver
virtual void AddSubject (CGUISubject *pSubjectToAdd)
 
virtual void RemoveSubject (CGUISubject *pSubjectToRemove)
 

Detailed Description

This observer provides the base-interface for controls when using color-properties.

Member Function Documentation

◆ AddColorProperty() [1/2]

eC_UInt CGUIColorPropertyObserver::AddColorProperty ( const eC_Bool &  bColorIsProperty,
const eC_UInt &  uiColorValue,
const GlobalProperty_t eColorProperty 
)

Add a new color-property

Parameters
bColorIsPropertyIf true the color will reference a property
uiColorValuethe color as ARGB
eColorPropertythe referenced property
Returns
the index of the new color-property

◆ AddColorProperty() [2/2]

void CGUIColorPropertyObserver::AddColorProperty ( const eC_UInt &  uiIndex,
const eC_Bool &  bColorIsProperty,
const eC_UInt &  uiColorValue,
const GlobalProperty_t eColorProperty 
)

Add a new color-property

Parameters
uiIndexindex of the new color-property
bColorIsPropertyIf true the color will reference a property
uiColorValuethe color as ARGB
eColorPropertythe referenced property

◆ GetColorProperty()

ColorValue_t CGUIColorPropertyObserver::GetColorProperty ( const eC_UInt &  uiIndex) const

Get the color-property for writing to stream

Parameters
uiIndexindex of the color-property
Returns
color-property for streaming

◆ GetColorValue()

eC_UInt CGUIColorPropertyObserver::GetColorValue ( const eC_UInt &  uiIndex) const

Get the color-property as ARGB-value

Parameters
uiIndexindex of the color-property
Returns
color as ARGB-value

◆ OnColorPropertyChange()

virtual void CGUIColorPropertyObserver::OnColorPropertyChange ( )
inlinevirtual

this slot is called when color-properties have changed

Reimplemented in CGUIWheel.

◆ RemoveColorProperty()

void CGUIColorPropertyObserver::RemoveColorProperty ( const eC_UInt &  uiIndex)

Remove a color-property. This will also remove registration in property-handler

Parameters
uiIndexindex of the color-property to remove

◆ SetColorProperty() [1/3]

void CGUIColorPropertyObserver::SetColorProperty ( const eC_UInt &  uiIndex,
const eC_UInt &  uiColorValue 
)

Set a color-property

Parameters
uiIndexindex of the color-property
uiColorValuethe color as ARGB

◆ SetColorProperty() [2/3]

void CGUIColorPropertyObserver::SetColorProperty ( const eC_UInt &  uiIndex,
const GlobalProperty_t eColorProperty 
)

Set a color-property

Parameters
uiIndexindex of the color-property
eColorPropertythe color as property

◆ SetColorProperty() [3/3]

void CGUIColorPropertyObserver::SetColorProperty ( const eC_UInt &  uiIndex,
const ColorValue_t kColorValue 
)

Set a color-property

Parameters
uiIndexindex of the color-property
kColorValuethe color as read from stream

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