Collapse all Symbian^3 Product Developer Library

Hs::IHsDataObserver Class Reference

class Hs::IHsDataObserver

An observer interface. Client must implement it to be able to get information about occuring Execute actions from the Homescreen Publishing API.

 class ObserverClass : public IHsDataObserver
 {
      void handleEvent( std::string aWidgetName, 
			IHsDataObserver::EEvent aEvent)
      {
      }
 
      void handleItemEvent( std::string aWidgetName,
        	std::string aWidgetItemName,
       	IHsDataObserver::EItemEvent aEvent)
      {
      }
 }
 ObserverClass* dataObserver = new ObserverClass();
 HsWidgetPublisher* hsPublisher = new HsWidgetPublisher( dataObserver );

Public Member Functions
void	handleEvent(std::string, IHsDataObserver::EEvent)
void	handleItemEvent(std::string, std::string, IHsDataObserver::EItemEvent)

Public Member Enumerations
enum	EEvent { EUnknown = 0, EActivate = 1, EDeactivate = 2, ESuspend = 3, EResume = 4, EPluginshutdown = 5 }
enum	EItemEvent { EUnknownItemEvent = 0, ESelect = 1 }

Member Functions Documentation

handleEvent(std::string, IHsDataObserver::EEvent)

void	handleEvent	(	std::string	aWidgetName,
			IHsDataObserver::EEvent	aEvent
		)	[pure virtual]

Intended to handle an event that occured on a widget. This would include EActivate, EDeactivate, ESuspend, EReusume.

Parameters

std::string aWidgetName	Name of the widget that event is envoked for.
IHsDataObserver::EEvent aEvent	Event type that has taken place.

handleItemEvent(std::string, std::string, IHsDataObserver::EItemEvent)

void	handleItemEvent	(	std::string	aWidgetName,
			std::string	aWidgetItemName,
			IHsDataObserver::EItemEvent	aEvent
		)	[pure virtual]

Intended to handle an event that occured on a widget's item. This would include ESelection.

Parameters

std::string aWidgetName	Name of the widget that event is envoked for.
std::string aWidgetItemName
IHsDataObserver::EItemEvent aEvent

Member Enumerations Documentation

Enum EEvent

Defines the events that may take place for a homescreen widget.

Enumerators

EUnknown = 0
EActivate = 1
EDeactivate = 2
ESuspend = 3
EResume = 4
EPluginshutdown = 5

Enum EItemEvent

Defines the events that may take place for a homescreen widget item.

Enumerators

EUnknownItemEvent = 0
ESelect = 1