CDataPoolConnector Class Reference

Connects a GUIObject to the DataPool. DataPoolConnectors are used to observe values within the DataPool. GUIObjects, which are observing entries in the datapool must have a DataPoolConnector. A DataPoolConnector will be notified of changes to the DataPool via the OnNotification(DataPoolEntry&) Interface, and will notify its observers via the NotifyObservers (const CGUIValue&, const CGUIObject* const, const eC_UInt, const eC_UInt) interface if the value of its GUIObject changes. More...

#include <GUIDataPool.h>

Inheritance diagram for CDataPoolConnector:

Public Member Functions
	CDataPoolConnector (CGUIObject *pkParentObject=NULL)
virtual void	OnNotification (CDataPoolEntry &kObservedValue)
void	SetParentObject (CGUIObject *pkParentObject)
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 ()
	Called by CGUISubject whenever an observed object triggers an update. More...
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)
virtual void	OnNotification (const eC_String &kMessage)
void	SetAutoDelete (const eC_Bool bAutoDelete)
Public Member Functions inherited from CGUISubject
	CGUISubject ()
	Default constructor.
virtual	~CGUISubject ()
	Default destructor.
void	AddObserver (CGUIObserver *pObserver)
void	ClearObservers ()
	Removes all observers from the internal list.
const eC_TListDoubleLinked< CGUIObserver * > &	GetObserverList () const
void	NotifyObservers ()
void	NotifyObservers (const CGUIObject *const pkUpdatedObject)
void	NotifyObservers (const CGUIValue &kObservedValue, const CGUIObject *const pkUpdatedObject, const eC_UInt uiX=0, const eC_UInt uiY=0)
void	NotifyObservers (const eC_String &kMessage)
void	RemoveObserver (CGUIObserver *pObserver)

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

Detailed Description

Connects a GUIObject to the DataPool. DataPoolConnectors are used to observe values within the DataPool. GUIObjects, which are observing entries in the datapool must have a DataPoolConnector. A DataPoolConnector will be notified of changes to the DataPool via the OnNotification(DataPoolEntry&) Interface, and will notify its observers via the NotifyObservers (const CGUIValue&, const CGUIObject* const, const eC_UInt, const eC_UInt) interface if the value of its GUIObject changes.

The "data pool" module is providing all means for on the fly data updates of GUI controls. It supports automatic notification on data updates and enables easy data binding. The "data pool" offers connectors to attach single variables, arrays or even complex data structure including databases. Furthermore, the "data pool" ensures that all data access is performed Thread Save (Class: CGUIDataPool).

Constructor & Destructor Documentation

CDataPoolConnector()

CDataPoolConnector::CDataPoolConnector ( CGUIObject *  pkParentObject = NULL )

inline

Constructs a DataPoolConnector and attaches it to the given Object

Parameters

pkParentObject

Pointer to object to which the DataPoolConnector shall be attached

Member Function Documentation

OnNotification()

virtual void CDataPoolConnector::OnNotification ( CDataPoolEntry &  kObservedValue )

virtual

Called by the DataPool if an entry has changed

Parameters

kObservedValue

DataPoolEntry contain the updated value(s)

SetParentObject()

void CDataPoolConnector::SetParentObject ( CGUIObject *  pkParentObject )

inline

Sets the pointer to the parent CGUIObject to which this DataPoolConnector is attached

Parameters

pkParentObject

Pointer to object to which the DataPoolConnector shall be attached

---

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

• GUIDataPool.h