CAknInfoPopupNoteController Class Reference

#include <mw/AknInfoPopupNoteController.h>

Link against: avkon.lib

class CAknInfoPopupNoteController : public CTimer

Inherits from

  • CAknInfoPopupNoteController
    Public Member Enumerations
    enumTTone { ENoTone, EConfirmationTone, EWarningTone, EErrorTone }
    Public Member Functions
    virtual ~CAknInfoPopupNoteController()
    IMPORT_C voidAddObserverL(const MAknInfoPopupNoteObserver &)
    IMPORT_C voidHideInfoPopupNote()
    IMPORT_C voidHideWhenAppFaded(const TBool)
    IMPORT_C CAknInfoPopupNoteController *NewL()
    voidNotifyObservers(MAknInfoPopupNoteObserver::TAknInfoPopupNoteEvent)
    IMPORT_C voidRemoveObserver(const MAknInfoPopupNoteObserver &)
    IMPORT_C voidRestoreDefaultPosition()
    IMPORT_C voidSetPositionAndAlignment(const TPoint &, const TGulAlignmentValue &)
    IMPORT_C voidSetPositionByHighlight(const TRect &)
    IMPORT_C voidSetTextL(const TDesC &)
    IMPORT_C voidSetTimeDelayBeforeShow(TInt)
    IMPORT_C voidSetTimePopupInView(TInt)
    IMPORT_C voidSetTone(const TTone &)
    IMPORT_C voidSetTooltipModeL(const TBool)
    IMPORT_C voidShowInfoPopupNote()
    Protected Member Functions
    virtual voidDoCancel()
    Inherited Attributes
    CActive::iStatus
    Inherited Enumerations
    CActive:TPriority
    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()

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

    Since
    Series 60 3.0

    Member Enumeration Documentation

    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

    EnumeratorValueDescription
    ENoTone0

    No tone is played.

    EConfirmationToneEAvkonSIDConfirmationTone

    A confirmation tone is played.

    EWarningToneEAvkonSIDWarningTone

    A warning tone is played.

    EErrorToneEAvkonSIDErrorTone

    An error tone is played.

    Constructor & Destructor Documentation

    ~CAknInfoPopupNoteController ( )

    ~CAknInfoPopupNoteController()[virtual]

    Destructor.

    Member Function Documentation

    AddObserverL ( const MAknInfoPopupNoteObserver & )

    IMPORT_C voidAddObserverL(const MAknInfoPopupNoteObserver &aObserver)

    Adds an observer for the pop-up.

    ParameterDescription
    aObserverThe observer to be added.

    DoCancel ( )

    voidDoCancel()[protected, virtual]

    Reimplemented from CTimer::DoCancel()

    From CTimer. Cancels an outstanding asynchronous request.

    HideInfoPopupNote ( )

    IMPORT_C voidHideInfoPopupNote()

    Hide popup immediately.

    HideWhenAppFaded ( const TBool )

    IMPORT_C voidHideWhenAppFaded(const TBoolaHide)
    Whether info popup note will be automatically hidden or not when app ui is faded (true by default)
    Since
    3.1
    ParameterDescription
    aHideETrue when hidden, EFalse when shown or controlled externally

    NewL ( )

    IMPORT_C CAknInfoPopupNoteController *NewL()[static]

    Two-phased constructor.

    NotifyObservers ( MAknInfoPopupNoteObserver::TAknInfoPopupNoteEvent )

    voidNotifyObservers(MAknInfoPopupNoteObserver::TAknInfoPopupNoteEventaEvent)

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

    ParameterDescription
    aEventThe event, of which the observers are notified.

    RemoveObserver ( const MAknInfoPopupNoteObserver & )

    IMPORT_C voidRemoveObserver(const MAknInfoPopupNoteObserver &aObserver)

    Removes an observer from the pop-up.

    ParameterDescription
    aObserverThe observer to be removed.

    RestoreDefaultPosition ( )

    IMPORT_C voidRestoreDefaultPosition()
    Restores the info pop-up note's default position discarding previously set values to position and alignment.
    Since
    3.1

    SetPositionAndAlignment ( const TPoint &, const TGulAlignmentValue & )

    IMPORT_C voidSetPositionAndAlignment(const TPoint &aPosition,
    const TGulAlignmentValue &aAlignment
    )
    Sets the position and alignment of the info pop-up note.
    Since
    3.1
    ParameterDescription
    aPositionThe position, where pop-up note is displayed.
    aAlignmentSpecifies the part of pop-up note that will be aligned with the given position.

    SetPositionByHighlight ( const TRect & )

    IMPORT_C voidSetPositionByHighlight(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
    ParameterDescription
    aHighlightRectScreen-relative rectangle used to calculate pop-up's position.

    SetTextL ( const TDesC & )

    IMPORT_C voidSetTextL(const TDesC &aText)

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

    ParameterDescription
    aTextText to show in popup.

    SetTimeDelayBeforeShow ( TInt )

    IMPORT_C voidSetTimeDelayBeforeShow(TIntaMilliSeconds)

    Set time delay period before popup is shown (in milliseconds). (if this isn't set, default delay time before show is 1 sec. )

    ParameterDescription
    aMilliSecondsWanted delay time in milliseconds.

    SetTimePopupInView ( TInt )

    IMPORT_C voidSetTimePopupInView(TIntaMilliSeconds)

    Set time period how long popup is in view (in milliseconds). (if this isn't set, default show time is 10 sec. )

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

    SetTone ( const TTone & )

    IMPORT_C voidSetTone(const TTone &aTone)

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

    ParameterDescription
    aToneThe tone

    SetTooltipModeL ( const TBool )

    IMPORT_C voidSetTooltipModeL(const TBoolaTooltipMode)
    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
    ParameterDescription
    aTooltipModeETrue to set tooltip mode on, EFalse to set it off.

    ShowInfoPopupNote ( )

    IMPORT_C voidShowInfoPopupNote()

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

    © Nokia 2011.