CAknInfoPopupNoteController Class Reference

API published in: S60 3rd Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <akninfopopupnotecontroller.h>

Detailed Description

The controller part of popup.

It is active object, and uses timer to show popup after specified time interval (default 1 sec.) and popup hides automaticly after an other period (default 10 sec.).


Public Types
enum   TTone { ENoTone = 0, EConfirmationTone = EAvkonSIDConfirmationTone, EWarningTone = EAvkonSIDWarningTone, EErrorTone = EAvkonSIDErrorTone }
  The tone played before the dialog is shown. More...

Public Member Functions
virtual  ~CAknInfoPopupNoteController ()
  Destructor.
IMPORT_C void  SetTimeDelayBeforeShow (TInt aMilliSeconds)
  Set time delay period before popup is shown (in milliseconds).
IMPORT_C void  SetTimePopupInView (TInt aMilliSeconds)
  Set time period how long popup is in view (in milliseconds).
IMPORT_C void  SetTextL (const TDesC &aText)
  Set text to show in popup.
IMPORT_C void  ShowInfoPopupNote ()
  Show popup after delay time (hide possible previous popup immediately) and hide popup again after setted time.
IMPORT_C void  HideInfoPopupNote ()
  Hide popup immediately.
IMPORT_C void  AddObserverL (const MAknInfoPopupNoteObserver &aObserver)
  Adds an observer for the pop-up.
IMPORT_C void  RemoveObserver (const MAknInfoPopupNoteObserver &aObserver)
  Removes an observer from the pop-up.
IMPORT_C void  SetPositionAndAlignment (const TPoint &aPosition, const TGulAlignmentValue &aAlignment)
  Sets the position and alignment of the info pop-up note.
IMPORT_C void  SetPositionByHighlight (const TRect &aHighlightRect)
  Sets the position of the info pop-up note so that it is aligned with the given rectangle as specified in the LAF data.
IMPORT_C void  RestoreDefaultPosition ()
  Restores the info pop-up note's default position discarding previously set values to position and alignment.
IMPORT_C void  SetTooltipModeL (const TBool aTooltipMode)
  Sets the tooltip mode.
void  NotifyObservers (MAknInfoPopupNoteObserver::TAknInfoPopupNoteEvent aEvent)
  Notifies the observers of the info popup note of an event.
IMPORT_C void  SetTone (const TTone &aTone)
  Set the tone to be played when the info popup note is shown.
IMPORT_C void  HideWhenAppFaded (const TBool aHide)
  Whether info popup note will be automatically hidden or not when app ui is faded (true by default).

Static Public Member Functions
static IMPORT_C CAknInfoPopupNoteController *  NewL ()
  Two-phased constructor.

Protected Member Functions
void  DoCancel ()
  From CTimer.

Member Enumeration Documentation

enum CAknInfoPopupNoteController::TTone
 

The tone played before the dialog is shown.

Application specific tones may be played by casting the application defined Sound ID (SID), to TTone

Enumerator:
ENoTone  No tone is played.
EConfirmationTone  A confirmation tone is played.
EWarningTone  A warning tone is played.
EErrorTone  An error tone is played.

Constructor & Destructor Documentation

virtual CAknInfoPopupNoteController::~CAknInfoPopupNoteController (   )  [virtual]
 

Destructor.

Member Function Documentation

IMPORT_C void CAknInfoPopupNoteController::AddObserverL (  const MAknInfoPopupNoteObserver &  aObserver  ) 
 

Adds an observer for the pop-up.

Parameters:
aObserver  The observer to be added.
void CAknInfoPopupNoteController::DoCancel (   )  [protected]
 

From CTimer.

Cancels an outstanding asynchronous request.

IMPORT_C void CAknInfoPopupNoteController::HideInfoPopupNote (   ) 
 

Hide popup immediately.

IMPORT_C void CAknInfoPopupNoteController::HideWhenAppFaded (  const TBool  aHide  ) 
 

Whether info popup note will be automatically hidden or not when app ui is faded (true by default).

Parameters:
aHide  ETrue when hidden, EFalse when shown or controlled externally
static IMPORT_C CAknInfoPopupNoteController* CAknInfoPopupNoteController::NewL (   )  [static]
 

Two-phased constructor.

void CAknInfoPopupNoteController::NotifyObservers (  MAknInfoPopupNoteObserver::TAknInfoPopupNoteEvent  aEvent  ) 
 

Notifies the observers of the info popup note of an event.

Parameters:
aEvent  The event, of which the observers are notified.
IMPORT_C void CAknInfoPopupNoteController::RemoveObserver (  const MAknInfoPopupNoteObserver &  aObserver  ) 
 

Removes an observer from the pop-up.

Parameters:
aObserver  The observer to be removed.
IMPORT_C void CAknInfoPopupNoteController::RestoreDefaultPosition (   ) 
 

Restores the info pop-up note's default position discarding previously set values to position and alignment.

IMPORT_C void CAknInfoPopupNoteController::SetPositionAndAlignment (  const TPoint &  aPosition,
const TGulAlignmentValue &  aAlignment
) 
 

Sets the position and alignment of the info pop-up note.

Parameters:
aPosition  The position, where pop-up note is displayed.
aAlignment  Specifies the part of pop-up note that will be aligned with the given position.
IMPORT_C void CAknInfoPopupNoteController::SetPositionByHighlight (  const TRect &  aHighlightRect  ) 
 

Sets the position of the info pop-up note so that it is aligned with the given rectangle as specified in the LAF data.

This is intented to be used in conjunction with lists and grids if the application wishes to implement a pop-up that follows lists/grids item highlight.

Parameters:
aHighlightRect  Screen-relative rectangle used to calculate pop-up's position.
IMPORT_C void CAknInfoPopupNoteController::SetTextL (  const TDesC &  aText  ) 
 

Set text to show in popup.

If given text is too long for popup, it is truncated.

Parameters:
aText  Text to show in popup.
IMPORT_C void CAknInfoPopupNoteController::SetTimeDelayBeforeShow (  TInt  aMilliSeconds  ) 
 

Set time delay period before popup is shown (in milliseconds).

(if this isn't set, default delay time before show is 1 sec. )

Parameters:
aMilliSeconds  Wanted delay time in milliseconds.
IMPORT_C void CAknInfoPopupNoteController::SetTimePopupInView (  TInt  aMilliSeconds  ) 
 

Set time period how long popup is in view (in milliseconds).

(if this isn't set, default show time is 10 sec. )

Parameters:
aMilliSeconds  Wanted show time in milliseconds.
IMPORT_C void CAknInfoPopupNoteController::SetTone (  const TTone &  aTone  ) 
 

Set the tone to be played when the info popup note is shown.

Parameters:
aTone  The tone
IMPORT_C void CAknInfoPopupNoteController::SetTooltipModeL (  const TBool  aTooltipMode  ) 
 

Sets the tooltip mode.

When tooltip mode is on, info pop-up note is displayed with only one line of text, and the width of the pop-up note depends on the text length.

Parameters:
aTooltipMode  ETrue to set tooltip mode on, EFalse to set it off.
IMPORT_C void CAknInfoPopupNoteController::ShowInfoPopupNote (   ) 
 

Show popup after delay time (hide possible previous popup immediately) and hide popup again after setted time.

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