MEikDialogPageObserver Class Reference

API published in: S60 1st Ed

Link against: eikdlg.lib eikcoctl.lib

Capability Information

Required Capabilities

None


#include <eikdpobs.h>

Inherited by CEikDialog.


Detailed Description

The MEikDialogPageObserver class specifies an interface through which the behaviour of the pages of a dialog may be observed.

Public Types

enum   TFormControlTypes {
  EUnknownType, EEdwinDerived, EMfneDerived, EPopfieldDerived,
  ESecretEditorDerived, ESliderDerived, EColourSelectionGridDerived
}
  It is necessary to know from which base class a control has been derived from in order to use the correct layout method. More...
enum   TDialogPageObserverEvents { EDialogPageTapped }

Public Member Functions

virtual void  PrepareForFocusTransitionL ()=0
  Prepares for focus transition from the current line e.g.
virtual void  PageChangedL (TInt aPageId)=0
  Takes any action required when the active dialog page is changed to aPageId.
virtual void  LineChangedL (TInt aControlId)=0
  Takes any action required when the current line is changed to aControlId.
virtual SEikControlInfo  CreateCustomControlL (TInt aControlType)=0
  Creates a custom control of type aControlType and returns the control information for the custom control which is created.
virtual TFormControlTypes  ConvertCustomControlTypeToBaseControlType (TInt aControlType) const =0
  ConvertCustomControlTypeToKnownControlType Used for custom control, to provide a mapping for forms between custom controls and the base types that the layout knows how to deal with.
virtual void  GetCustomAutoValue (TAny *aReturnValue, TInt aControlType, const CCoeControl *aControl)=0
  Gets the custom auto value for the custom control aControl of type aControlType with return value aReturnValue.
virtual void  HandleDialogPageEventL (TInt aEventID)=0
  Takes any action required when the dialog page event happens.

Member Enumeration Documentation

enum MEikDialogPageObserver::TDialogPageObserverEvents
 
Enumerator:
EDialogPageTapped 
enum MEikDialogPageObserver::TFormControlTypes
 

It is necessary to know from which base class a control has been derived from in order to use the correct layout method.

These are all the known form control base types.

Enumerator:
EUnknownType 
EEdwinDerived 
EMfneDerived 
EPopfieldDerived 
ESecretEditorDerived 
ESliderDerived 
EColourSelectionGridDerived 

Member Function Documentation

virtual TFormControlTypes MEikDialogPageObserver::ConvertCustomControlTypeToBaseControlType TInt  aControlType  )  const [pure virtual]
 

ConvertCustomControlTypeToKnownControlType Used for custom control, to provide a mapping for forms between custom controls and the base types that the layout knows how to deal with.

For example an edwin derived custom control could return EEikCtEdwin

Implemented in CEikDialog.

virtual SEikControlInfo MEikDialogPageObserver::CreateCustomControlL TInt  aControlType  )  [pure virtual]
 

Creates a custom control of type aControlType and returns the control information for the custom control which is created.

Called when creating a line on the dialog page if the Eikon control factory does not recognise the type aControlType.

Implemented in CAknSelectionListDialog, and CEikDialog.

virtual void MEikDialogPageObserver::GetCustomAutoValue TAny *  aReturnValue,
TInt  aControlType,
const CCoeControl *  aControl
[pure virtual]
 

Gets the custom auto value for the custom control aControl of type aControlType with return value aReturnValue.

This method is included in the interface to support deprecated legacy code only.

Implemented in CEikDialog.

virtual void MEikDialogPageObserver::HandleDialogPageEventL TInt  aEventID  )  [pure virtual]
 

Takes any action required when the dialog page event happens.

Implemented in CAknColourSelectionGrid, CAknNoteWrapper, and CEikDialog.

virtual void MEikDialogPageObserver::LineChangedL TInt  aControlId  )  [pure virtual]
 

Takes any action required when the current line is changed to aControlId.

Implemented in CEikDialog.

virtual void MEikDialogPageObserver::PageChangedL TInt  aPageId  )  [pure virtual]
 

Takes any action required when the active dialog page is changed to aPageId.

Implemented in CEikDialog.

virtual void MEikDialogPageObserver::PrepareForFocusTransitionL  )  [pure virtual]
 

Prepares for focus transition from the current line e.g.

to validate the contents of the current control.

Implemented in CAknForm, and CEikDialog.


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

Copyright © Nokia Corporation 2001-2008
Back to top