Hs::IHsDataObserver Class Reference

Link against: hswidgetpublisher.lib

#include <hsdataobserver.h>

Detailed Description

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 Types

enum  EEvent {
  EUnknown = 0, EActivate = 1, EDeactivate = 2, ESuspend = 3,
  EResume = 4
}
 Defines the events that may take place for a homescreen widget. More...
enum  EItemEvent { EUnknownItemEvent = 0, ESelect = 1 }
 Defines the events that may take place for a homescreen widget item. More...

Public Member Functions

virtual void handleEvent (std::string aWidgetName, IHsDataObserver::EEvent aEvent)=0
 Intended to handle an event that occured on a widget.
virtual void handleItemEvent (std::string aWidgetName, std::string aWidgetItemName, IHsDataObserver::EItemEvent aEvent)=0
 Intended to handle an event that occured on a widget's item.

Member Enumeration Documentation

enum Hs::IHsDataObserver::EEvent
 

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

Enumerator:
EUnknown  Unknown event: Means that event has not been defined.
EActivate  Activation event: Means that widget has been added to HS as content.
EDeactivate  Deactivation event: Means that widget has been removed frm.
ESuspend  Suspension event: Means that HS reading widget data is suspended.
EResume  Resume event. Means that HS reading widget data is resumed.
enum Hs::IHsDataObserver::EItemEvent
 

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

Enumerator:
EUnknownItemEvent  Unknown event: Means that event has note been defined.
ESelect  Selection event: Means that the widget item has been selected.

Member Function Documentation

virtual void Hs::IHsDataObserver::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:
aWidgetName Name of the widget that event is envoked for.
aEvent Event type that has taken place.
virtual void Hs::IHsDataObserver::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:
aWidgetName Name of the widget that event is envoked for.
awidgetItemName Name of the item that event is envoked for.
aAEvent Event type that has taken place
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top