Collapse all Symbian^3 Application Developer Library

CAknInfoPopupNoteController Class Reference

class CAknInfoPopupNoteController : public CTimer

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.).

avkon.lib

Since: Series 60 3.0

Inherits from

CAknInfoPopupNoteController
- CTimer
  - CActive
    - CBase

Public Member Functions
	~CAknInfoPopupNoteController ()
IMPORT_C void	AddObserverL (const MAknInfoPopupNoteObserver &)
IMPORT_C void	HideInfoPopupNote ()
IMPORT_C void	HideWhenAppFaded (const TBool )
IMPORT_C CAknInfoPopupNoteController *	NewL ()
void	NotifyObservers ( MAknInfoPopupNoteObserver::TAknInfoPopupNoteEvent )
IMPORT_C void	RemoveObserver (const MAknInfoPopupNoteObserver &)
IMPORT_C void	RestoreDefaultPosition ()
IMPORT_C void	SetPositionAndAlignment (const TPoint &, const TGulAlignmentValue &)
IMPORT_C void	SetPositionByHighlight (const TRect &)
IMPORT_C void	SetTextL (const TDesC &)
IMPORT_C void	SetTimeDelayBeforeShow ( TInt )
IMPORT_C void	SetTimePopupInView ( TInt )
IMPORT_C void	SetTone (const TTone &)
IMPORT_C void	SetTooltipModeL (const TBool )
IMPORT_C void	ShowInfoPopupNote ()

Protected Member Functions
void	DoCancel ()

Private Member Functions
	CAknInfoPopupNoteController ()
void	ConstructL ()
void	PlayTone ()
void	RunL ()

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CTimer::After(TTimeIntervalMicroSeconds32)
	CTimer::At(const TTime &)
	CTimer::AtUTC(const TTime &)
	CTimer::CTimer(TInt)
	CTimer::HighRes(TTimeIntervalMicroSeconds32)
	CTimer::Inactivity(TTimeIntervalSeconds)
	CTimer::Lock(TTimerLockSpec)
	CTimer::~CTimer()

Public Member Enumerations
enum	TTone { ENoTone = 0, EConfirmationTone = EAvkonSIDConfirmationTone, EWarningTone = EAvkonSIDWarningTone, EErrorTone = EAvkonSIDErrorTone }

Private Member Enumerations
enum	TInfoPopupNoteState { EHidden , EWaitingToShow , EShowing }

Inherited Enumerations
	CActive:TPriority

Private Attributes
RPointerArray < MAknInfoPopupNoteObserver >	iObservers
CAknInfoPopupNote *	iPopup
TInfoPopupNoteState	iState
TInt	iTimeDelayBeforeShow
TInt	iTimeInView
TTone	iTone

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CAknInfoPopupNoteController()

CAknInfoPopupNoteController

(

)

[private]

C++ default constructor.

~CAknInfoPopupNoteController()

~CAknInfoPopupNoteController

(

)

[virtual]

Destructor.

Member Functions Documentation

AddObserverL(const MAknInfoPopupNoteObserver &)

IMPORT_C void

AddObserverL

(

const MAknInfoPopupNoteObserver &

aObserver

)

Adds an observer for the pop-up.

Parameters

const MAknInfoPopupNoteObserver & aObserver

The observer to be added.

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

DoCancel()

void

DoCancel

(

)

[protected, virtual]

From CTimer . Cancels an outstanding asynchronous request.

HideInfoPopupNote()

IMPORT_C void

HideInfoPopupNote

(

)

Hide popup immediately.

HideWhenAppFaded(const TBool)

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)

Since: 3.1

Parameters

const TBool aHide

ETrue when hidden, EFalse when shown or controlled externally

NewL()

IMPORT_C CAknInfoPopupNoteController *

NewL

(

)

[static]

Two-phased constructor.

NotifyObservers(MAknInfoPopupNoteObserver::TAknInfoPopupNoteEvent)

void

NotifyObservers

(

MAknInfoPopupNoteObserver::TAknInfoPopupNoteEvent

aEvent

)

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

Parameters

MAknInfoPopupNoteObserver::TAknInfoPopupNoteEvent aEvent

The event, of which the observers are notified.

PlayTone()

void

PlayTone

(

)

[private]

Play the tone.

RemoveObserver(const MAknInfoPopupNoteObserver &)

IMPORT_C void

RemoveObserver

(

const MAknInfoPopupNoteObserver &

aObserver

)

Removes an observer from the pop-up.

Parameters

const MAknInfoPopupNoteObserver & aObserver

The observer to be removed.

RestoreDefaultPosition()

IMPORT_C void

RestoreDefaultPosition

(

)

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

Since: 3.1

RunL()

void

RunL

(

)

[private, virtual]

Show popup. Called by system framework.

SetPositionAndAlignment(const TPoint &, const TGulAlignmentValue &)

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

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

Since: 3.1

Parameters

const TPoint & aPosition	The position, where pop-up note is displayed.
const TGulAlignmentValue & aAlignment	Specifies the part of pop-up note that will be aligned with the given position.

SetPositionByHighlight(const TRect &)

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. 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.

Since: 3.1

Parameters

const TRect & aHighlightRect

Screen-relative rectangle used to calculate pop-up's position.

SetTextL(const TDesC &)

IMPORT_C void

SetTextL

(

const TDesC &

aText

)

Set text to show in popup. If given text is too long for popup, it is truncated.

Parameters

const TDesC & aText

Text to show in popup.

SetTimeDelayBeforeShow(TInt)

IMPORT_C void

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

TInt aMilliSeconds

Wanted delay time in milliseconds.

SetTimePopupInView(TInt)

IMPORT_C void

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

TInt aMilliSeconds

Wanted show time in milliseconds. if set to 0, popup is shown until HideInfoPopupNote is called

SetTone(const TTone &)

IMPORT_C void

SetTone

(

const TTone &

aTone

)

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

Parameters

const TTone & aTone

The tone

SetTooltipModeL(const TBool)

IMPORT_C void

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.

Since: 3.1

Parameters

const TBool aTooltipMode

ETrue to set tooltip mode on, EFalse to set it off.

ShowInfoPopupNote()

IMPORT_C void

ShowInfoPopupNote

(

)

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

Member Enumerations Documentation

Enum TInfoPopupNoteState

Enumerators

EHidden
EWaitingToShow
EShowing

Enum 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

Enumerators

ENoTone = 0	No tone is played.
EConfirmationTone = EAvkonSIDConfirmationTone	A confirmation tone is played.
EWarningTone = EAvkonSIDWarningTone	A warning tone is played.
EErrorTone = EAvkonSIDErrorTone	An error tone is played.