CAknNoteWrapper Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcdlg.lib

Capability Information

Required Capabilities

None

#include <aknnotewrappers.h>

Inherits CAknNoteDialog.

Inherited by CAknResourceNoteDialog.

Detailed Description

Base class for implementing commonly used notes.

Public Member Functions
IMPORT_C  CAknNoteWrapper ()
  Class default constructor.
IMPORT_C  CAknNoteWrapper (CAknNoteWrapper **aSelfPtr)
  Another class constructor.
IMPORT_C TInt  ExecuteLD (TInt aResId)
  Construct and display the dialog.
IMPORT_C TInt  ExecuteLD (TInt aResId, const TDesC &aPrompt)
  Construct and display the dialog.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl HandlePointerEventL Processes the pointer event directed at any note dialogs.
virtual IMPORT_C void  HandleDialogPageEventL (TInt aEventID)
  HandleDialogPageEventL is the interface method used by CEikDialogPage to signal the note that the some event happened on dialog page.

Constructor & Destructor Documentation

IMPORT_C CAknNoteWrapper::CAknNoteWrapper (   ) 
 

Class default constructor.

Does not do anything

IMPORT_C CAknNoteWrapper::CAknNoteWrapper (  CAknNoteWrapper **  aSelfPtr  ) 
 

Another class constructor.

Accept self pointer to CEikDialog* in order to NULL client pointer when a non modal note is dismissed.

Parameters:
aSelfPtr  Address of the dialog pointer

Member Function Documentation

IMPORT_C TInt CAknNoteWrapper::ExecuteLD (  TInt  aResId,
const TDesC &  aPrompt
) 
 

Construct and display the dialog.

Construct a TAknNoteResData object by reading from resource file. Set the prompt calling SetTextL. Set the timeout, set the tone (unless they have already been set) and call RunLD.

See also:
SetTimeout, SetTone
Parameters:
aResId  Resource file ID
aPrompt  Note text
IMPORT_C TInt CAknNoteWrapper::ExecuteLD (  TInt  aResId  )  [virtual]
 

Construct and display the dialog.

Create a TAknNoteResData object by reading from resource file. Set the timeout, set the tone (unless they have already been set) and call RunLD.

See also:
SetTimeout, SetTone
Parameters:
aResId  Resource file ID

Reimplemented from CEikDialog.

virtual IMPORT_C void CAknNoteWrapper::HandleDialogPageEventL (  TInt  aEventID  )  [virtual]
 

HandleDialogPageEventL is the interface method used by CEikDialogPage to signal the note that the some event happened on dialog page.

Parameters:
aEventID  event to be handled

Reimplemented from CEikDialog.

IMPORT_C void CAknNoteWrapper::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  )  [virtual]
 

From CCoeControl HandlePointerEventL Processes the pointer event directed at any note dialogs.

Parameters:
aPointerEvent  the pointer event to be processed.

Reimplemented from CAknNoteDialog.

Reimplemented in CAknResourceNoteDialog, CAknConfirmationNote, CAknInformationNote, CAknErrorNote, and CAknWarningNote.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top