CAknNoteDialog Class Reference

class CAknNoteDialog : public CEikDialog

The note dialog.

Displays a note to the user for:
  • Giving notifications.

  • Asking questions.

  • Showing progress.

CAknNoteControl, CAknNoteAttributes, CAknText

Inherits from

Public Member Functions
CAknNoteDialog()
CAknNoteDialog(const TTone &, const TTimeout &)
CAknNoteDialog(CEikDialog **, const TTone &, const TTimeout &)
~CAknNoteDialog()
IMPORT_C TIntExecuteDlgLD(const TTimeout, const TTone, TInt)
IMPORT_C TIntExecuteDlgLD(const TTone, TInt)
IMPORT_C TIntExecuteDlgLD(TInt, TInt)
IMPORT_C voidExitSleepingDialog()
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C voidLayoutAndDraw()
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C TIntRunDlgLD(const TTimeout, const TTone)
IMPORT_C TIntRunDlgLD(const TTone)
IMPORT_C TIntRunDlgLD()
IMPORT_C TIntRunDlgLD(TInt)
IMPORT_C TIntRunLD()
IMPORT_C voidSetCurrentLabelL(TInt, const TDesC &)
IMPORT_C voidSetIconL(CEikImage *)
IMPORT_C voidSetImageL(CEikImage *)
IMPORT_C voidSetTextL(const TDesC &)
IMPORT_C voidSetTextNumberL(TInt)
IMPORT_C voidSetTextPluralityL(const TBool)
IMPORT_C voidSetTextProcessing(TBool)
IMPORT_C voidSetTextWrapping(TBool)
IMPORT_C voidSetTimeout(const TTimeout &)
IMPORT_C voidSetTone(const TTone &)
Protected Member Functions
IMPORT_C CAknNoteAttributes *ControlAttributes()
IMPORT_C CAknNoteControl *NoteControl()
IMPORT_C voidPlayTone()
IMPORT_C voidPostLayoutDynInitL()
IMPORT_C voidPreLayoutDynInitL(void)
IMPORT_C voidReportUserActivity()
IMPORT_C voidSetNoMemoryAllocation()
IMPORT_C voidSetSizeAndPosition(const TSize &)
IMPORT_C CAknKeySoundSystem *SoundSystem()
IMPORT_C TIntStaticDeleteL(TAny *)
IMPORT_C voidTransferControlAttributes()
Private Member Functions
IMPORT_C voidCAknNoteDialog_Reserved()
IMPORT_C voidCEikDialog_Reserved_1()
IMPORT_C voidCEikDialog_Reserved_2()
TInt CallbackStartAnimationL(TAny *)
voidCreateExtensionL()
voidDbgCheckSelfPtr(CEikDialog **)
IMPORT_C void *ExtensionInterface(TUid)
voidSetSkinBackGroundRect()
IMPORT_C voidSizeChanged()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MaximumWidth()const
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
CEikBorderedControl::Border()const
CEikBorderedControl::CEikBorderedControl()
CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
CEikBorderedControl::HasBorder()const
CEikBorderedControl::SetAdjacent(TInt)
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
CEikBorderedControl::SetBorder(TInt)
CEikDialog::ActivateFirstPageL()const
CEikDialog::ActivePageId()const
CEikDialog::ActivePageIndex()const
CEikDialog::AddAutoDateEditorL(const TDesC &,TInt,const TTime &,const TTime &,TBool,TTime *)
CEikDialog::AddAutoDurationEditorL(const TDesC &,TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &,TBool,TTimeIntervalSeconds *)
CEikDialog::AddAutoFixedPointEditorL(const TDesC &,TInt,TInt,TInt,TInt *,TInt)
CEikDialog::AddAutoFloatEditorL(const TDesC &,TInt,const TReal &,const TReal &,TReal *)
CEikDialog::AddAutoGlobalTextEditorL(const TDesC &,TInt,TInt,TInt,TInt,TInt,CGlobalText *,TInt,TInt)
CEikDialog::AddAutoNumberEditorL(const TDesC &,TInt,TInt,TInt,TInt *)
CEikDialog::AddAutoRangeEditorL(const TDesC &,TInt,TInt,TInt,HBufC *,SEikRange *)
CEikDialog::AddAutoRichTextEditorL(const TDesC &,TInt,TInt,TInt,TInt,TInt,CGlobalText *,TInt,TInt)
CEikDialog::AddAutoSecretEditorL(const TDesC &,TInt,TDes *)
CEikDialog::AddAutoTextEditorL(const TDesC &,TInt,TInt,TInt,TInt,TDes *)
CEikDialog::AddAutoTimeAndDateEditorL(const TDesC &,TInt,const TTime &,const TTime &,TBool,TBool,HBufC *,TTime *)
CEikDialog::AddAutoTimeEditorL(const TDesC &,TInt,const TTime &,const TTime &,TBool,TTime *)
CEikDialog::AddAutoTimeOffsetEditorL(const TDesC &,TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &,TBool,TTimeIntervalSeconds *)
CEikDialog::AdjustAllIdsOnPage(TInt,TInt)
CEikDialog::BorderStyle()
CEikDialog::ButtonCommandObserver()const
CEikDialog::ButtonGroupContainer()const
CEikDialog::CEikDialog()
CEikDialog::ComponentControl(TInt)const
CEikDialog::ConstructAutoDialogLC(TInt,TInt)
CEikDialog::ConstructSleepingAlertDialogL(TInt)
CEikDialog::ConstructSleepingDialogL(TInt)
CEikDialog::Control(TInt)const
CEikDialog::ControlCaption(TInt)const
CEikDialog::ControlOrNull(TInt)const
CEikDialog::ControlsOnPage(RArray< CEikCaptionedControl * > &,TInt)const
CEikDialog::ConvertCustomControlTypeToBaseControlType(TInt)const
CEikDialog::CountComponentControls()const
CEikDialog::CreateCustomControlL(TInt)
CEikDialog::CreateLineByTypeL(const TDesC &,TInt,TInt,TAny *)
CEikDialog::CreateLineByTypeL(const TDesC &,TInt,TInt,TInt,TAny *)
CEikDialog::CurrentLine()const
CEikDialog::DeclareAutoDateEditor(TInt,TTime *)
CEikDialog::DeclareAutoDurationEditor(TInt,TTimeIntervalSeconds *)
CEikDialog::DeclareAutoFixedPointEditor(TInt,TInt *)
CEikDialog::DeclareAutoNumberEditor(TInt,TInt *)
CEikDialog::DeclareAutoRangeEditor(TInt,SEikRange *)
CEikDialog::DeclareAutoSecretEditor(TInt,TDes *)
CEikDialog::DeclareAutoTextEditorL(TInt,TDes *)
CEikDialog::DeclareAutoTimeAndDateEditor(TInt,TTime *)
CEikDialog::DeclareAutoTimeEditor(TInt,TTime *)
CEikDialog::DeclareAutoTimeOffsetEditor(TInt,TTimeIntervalSeconds *)
CEikDialog::DeclareItemAuto(TInt,TInt,TAny *)
CEikDialog::DeleteLine(TInt,TBool)
CEikDialog::DialogFlags()
CEikDialog::DurationEditorValue(TInt)const
CEikDialog::ExecuteLD(TInt)
CEikDialog::Extension()const
CEikDialog::FindLineIndex(const CCoeControl &)const
CEikDialog::FixedPointEditorDecimal(TInt)const
CEikDialog::FixedPointEditorValue(TInt)const
CEikDialog::FloatEditorValue(TInt)const
CEikDialog::FloatingPointEditorValue(TInt)const
CEikDialog::FocusChanged(TDrawNow)
CEikDialog::FormFlagsFromActivePage()
CEikDialog::GetAutoValuesFromPage(CEikCapCArray *)
CEikDialog::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CEikDialog::GetCustomAutoValue(TAny *,TInt,const CCoeControl *)
CEikDialog::GetEdwinText(TDes &,TInt)const
CEikDialog::GetFileName(TFileName *,TInt)const
CEikDialog::GetFirstLineOnFirstPageOrNull()
CEikDialog::GetLabelText(TDes &,TInt)const
CEikDialog::GetLineByLineAndPageIndex(TInt,TInt)const
CEikDialog::GetNumberOfLinesOnPage(TInt)const
CEikDialog::GetNumberOfPages()const
CEikDialog::GetSecretEditorText(TDes &,TInt)const
CEikDialog::GetTextEditorText(CGlobalText *&,TInt)
CEikDialog::HandleControlEventL(CCoeControl *,TCoeEvent)
CEikDialog::HandleControlStateChangeL(TInt)
CEikDialog::HandleDialogPageEventL(TInt)
CEikDialog::HandleInteractionRefused(TInt)
CEikDialog::IdOfFocusControl()const
CEikDialog::InputCapabilities()const
CEikDialog::InsertLineL(TInt,TInt,TInt)
CEikDialog::IsEditable()const
CEikDialog::Layout()
CEikDialog::Line(TInt)const
CEikDialog::LineChangedL(TInt)
CEikDialog::ListBoxCurrentItem(TInt)const
CEikDialog::MakeLineVisible(TInt,TBool)
CEikDialog::MakePanelButtonVisible(TInt,TBool)
CEikDialog::MakeVisible(TBool)
CEikDialog::MakeWholeLineVisible(TInt,TBool)
CEikDialog::MappedCommandId(TInt)
CEikDialog::MopSupplyObject(TTypeUid)
CEikDialog::NumberEditorValue(TInt)const
CEikDialog::OkToExitL(TInt)
CEikDialog::PageChangedL(TInt)
CEikDialog::PreferredSize(const TSize &)const
CEikDialog::PrepareContext(CWindowGc &)const
CEikDialog::PrepareForFocusTransitionL()
CEikDialog::PrepareLC(TInt)
CEikDialog::PublishDialogL(TInt,TUid)
CEikDialog::RangeEditorValue(TInt)const
CEikDialog::ReadResourceLC(TInt)
CEikDialog::RegisterDialgWithPageSelector()
CEikDialog::ResetLineMinimumSizes()
CEikDialog::ResetSecretEditor(TInt)
CEikDialog::RotateFocusByL(TInt)
CEikDialog::RouseSleepingDialog()
CEikDialog::SetControlCaptionL(TInt,TInt)
CEikDialog::SetControlCaptionL(TInt,const TDesC &)
CEikDialog::SetDurationEditorMinAndMax(TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &)
CEikDialog::SetDurationEditorValue(TInt,const TTimeIntervalSeconds &)
CEikDialog::SetEditableL(TBool)
CEikDialog::SetEdwinTextL(TInt,const TDesC *)
CEikDialog::SetFileNameL(TInt,const TDesC *)
CEikDialog::SetFixedPointEditorDecimal(TInt,TInt)
CEikDialog::SetFixedPointEditorValueL(TInt,TInt)
CEikDialog::SetFloatEditorMinAndMax(TInt,TInt,TInt)
CEikDialog::SetFloatEditorValueL(TInt,TReal)
CEikDialog::SetFloatingPointEditorValueL(TInt,const TReal *)
CEikDialog::SetInitialCurrentLine()
CEikDialog::SetLabelL(TInt,TInt)
CEikDialog::SetLabelL(TInt,const TDesC &)
CEikDialog::SetLabelReserveLengthL(TInt,TInt)
CEikDialog::SetLineDimmedNow(TInt,TBool)
CEikDialog::SetLineNonFocusing(TInt)
CEikDialog::SetListBoxCurrentItem(TInt,TInt)
CEikDialog::SetMediatorObserver(MAknDialogMediatorObserver *)
CEikDialog::SetMultilineQuery(TBool)
CEikDialog::SetNumberEditorMinAndMax(TInt,TInt,TInt)
CEikDialog::SetNumberEditorValue(TInt,TInt)
CEikDialog::SetPageDensePacking(TInt,TBool)
CEikDialog::SetPageDimmedNow(TInt,TBool)
CEikDialog::SetRangeEditorMinAndMax(TInt,TInt,TInt)
CEikDialog::SetRangeEditorValue(TInt,const SEikRange &)
CEikDialog::SetTTimeEditorMinAndMax(TInt,const TTime &,const TTime &)
CEikDialog::SetTTimeEditorValue(TInt,const TTime &)
CEikDialog::SetTextEditorTextL(TInt,const CGlobalText *)
CEikDialog::SetTimeOffsetEditorMinAndMax(TInt,const TTimeIntervalSeconds &,const TTimeIntervalSeconds &)
CEikDialog::SetTimeOffsetEditorValue(TInt,const TTimeIntervalSeconds &)
CEikDialog::SetTitleL(TInt)
CEikDialog::SetTitleL(const TDesC &)
CEikDialog::SlideDialog()
CEikDialog::SwapButtonGroupContainer(CEikButtonGroupContainer *)
CEikDialog::SwitchLineLatency(TInt,TInt)
CEikDialog::TTimeEditorValue(TInt)const
CEikDialog::TimeOffsetEditorValue(TInt)const
CEikDialog::Title()const
CEikDialog::TryChangeFocusToL(TInt)
CEikDialog::TryExitL(TInt)
CEikDialog::UpdatePageL(TBool)
CEikDialog::WriteInternalStateL(RWriteStream &)const
CEikDialog::~CEikDialog()
Public Member Enumerations
enumTTimeout { EUndefinedTimeout = 0, ENoTimeout = 0, EShortTimeout = 1500000, ELongTimeout = 3000000, EShortestTimeout = 500000 }
enumTTone { ENoTone = 0, EConfirmationTone = EAvkonSIDConfirmationTone, EWarningTone = EAvkonSIDWarningTone, EErrorTone = EAvkonSIDErrorTone }
Inherited Enumerations
CCoeControl:TZoomType
CEikDialog:@169
Protected Attributes
CAknNoteAttributes *iControlAttributes
CEikDialog **iSelfPtr
TInt iTimeoutInMicroseconds
CPeriodic *iTimer
TTone iTone
Private Attributes
CAknNoteDialogExtension *iNoteExtension
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder

Constructor & Destructor Documentation

CAknNoteDialog()

IMPORT_CCAknNoteDialog()

C++ default constructor.

Initialises the tone to ENoTone and the timeout to ENoTimeout.

TTone , TTimeout.

CAknNoteDialog(const TTone &, const TTimeout &)

IMPORT_CCAknNoteDialog(const TTone &aTone,
const TTimeout &aTimeout = ENoTimeout
)

C++ default constructor.

Initialises the tone to aTone and the timeout to aTimeout.

TTone , TTimeout.

Parameters

const TTone & aToneThe tone to be played.
const TTimeout & aTimeout = ENoTimeoutThe timeout (microseconds). Default is ENoTimeout.

CAknNoteDialog(CEikDialog **, const TTone &, const TTimeout &)

IMPORT_CCAknNoteDialog(CEikDialog **aSelfPtr,
const TTone &aTone = ENoTone,
const TTimeout &aTimeout = ENoTimeout
)

C++ default constructor.

Initialises the tone to aTone and the timeout to aTimeout. Accepts a pointer to CEikDialog*. This must be the address of the dialog pointer. When the dialog deletes itself after a timeout, the address pointed to by this pointer is set to NULL. The dialog must not be on the stack, it must be on the heap!

TTone , TTimeout.

Parameters

CEikDialog ** aSelfPtrPointer to the address of the dialog.
const TTone & aTone = ENoTone= ENoTone The tone.
const TTimeout & aTimeout = ENoTimeout= ENoTimeout The timeout (microseconds).

~CAknNoteDialog()

IMPORT_C~CAknNoteDialog()[virtual]

Destructor.

Deletes timer and control attributes. If the self pointer is not null, sets the pointer to point to NULL.

Member Functions Documentation

CAknNoteDialog_Reserved()

IMPORT_C voidCAknNoteDialog_Reserved()[private, virtual]

CEikDialog_Reserved_1()

IMPORT_C voidCEikDialog_Reserved_1()[private, virtual]

CEikDialog_Reserved_2()

IMPORT_C voidCEikDialog_Reserved_2()[private, virtual]

CallbackStartAnimationL(TAny *)

TInt CallbackStartAnimationL(TAny *aThis)[private, static]

Parameters

TAny * aThis

ControlAttributes()

IMPORT_C CAknNoteAttributes *ControlAttributes()[protected]

Gets the control attributes.

If the control has already been created this method return the attributes stored inside the control. If not then the local attributes are returned. The local attributes are transferred to the control in PreLayoutDynInitL().

Derived classes should use this method when trying to access the control attributes.

Control attributes.

CreateExtensionL()

voidCreateExtensionL()[private]

DbgCheckSelfPtr(CEikDialog **)

voidDbgCheckSelfPtr(CEikDialog **aSelfPtr)[private]

Parameters

CEikDialog ** aSelfPtr

ExecuteDlgLD(const TTimeout, const TTone, TInt)

IMPORT_C TIntExecuteDlgLD(const TTimeoutaTimeout,
const TToneaTone,
TIntaResourceID
)

Set timeout, tone, resource ID and then initialize and launch the dialog.

This method is deprecated and should not be used.

Zero, unless it is a waiting dialog. For a waiting dialog, the return value is the ID of the button that closed the dialog, or zero if it was the cancel button (EEikBidCancel).

Parameters

const TTimeout aTimeoutWanted timeout in microseconds.
const TTone aToneAlarm tone.
TInt aResourceIDThe ID of the wanted resource.

ExecuteDlgLD(const TTone, TInt)

IMPORT_C TIntExecuteDlgLD(const TToneaTone,
TIntaResourceID
)

Set tone, resource ID and then initialize and launch the dialog.

This method is deprecated and should not be used.

Zero, unless it is a waiting dialog. For a waiting dialog, the return value is the ID of the button that closed the dialog, or zero if it was the cancel button (EEikBidCancel).

Parameters

const TTone aToneAlarm tone.
TInt aResourceIDThe ID of the wanted resource.

ExecuteDlgLD(TInt, TInt)

IMPORT_C TIntExecuteDlgLD(TIntaResourceId,
TIntaNoteControlId = 0
)

Set note control ID, resource ID and then initialize and launch the dialog.

This method is deprecated and should not be used.

Zero, unless it is a waiting dialog. For a waiting dialog, the return value is the ID of the button that closed the dialog, or zero if it was the cancel button (EEikBidCancel).

Parameters

TInt aResourceIdThe ID of the wanted resource.
TInt aNoteControlId = 0Not used.

ExitSleepingDialog()

IMPORT_C voidExitSleepingDialog()

From CEikDialog.

Exits a sleeping dialog without deleting it.

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

From CAknControl.

Parameters

TUid aInterface

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

From CCoeControl.

Processes the pointer event directed to the dialog.

Parameters

const TPointerEvent & aPointerEventThe pointer event directed to the notedialog.

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[virtual]

From CCoeControl.

Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.

Parameters

TInt aTypeTarget resource type.

LayoutAndDraw()

IMPORT_C voidLayoutAndDraw()

Do layout and draw the note dialog.

Needed when changing control components (e.g. the text) dynamically. This is needed because the size of the dialog might change (e.g. because of bigger text displayed in more lines, etc.) Set methods call LayoutAndDraw() if there is a change that might affect the dialog layout (e.g. text becames bigger and hence requires an extra line).

Derived classes that implement this kind of methods should call LayoutAndDraw().

NoteControl()

IMPORT_C CAknNoteControl *NoteControl()[protected]

Gets the Note control.

Returns the first control on the active page, which is of type CAknNoteControl. If no control is found (usually because the control has not been created yet) then this method returns NULL.

Derived classes must use this method to get access to the note control.

Pointer to the note control or NULL.

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

From CCoeControl.

Handles key events.

Any event which is not a key press is forwarded to CEikDialog::OfferKeyEventL. ' Short key press dismiss the note by calling StaticDeleteL.

StaticDeleteL() , TKeyEvent, TEventCode.

Indicates whether or not the key event was used by this control. EKeyWasConsumed if the control takes action on the key event or EKeyWasNotConsumed otherwise.

Parameters

const TKeyEvent & aKeyEventKey event details.
TEventCode aTypeType of event (key down, key press, key release, etc).

PlayTone()

IMPORT_C voidPlayTone()[protected]

Plays a tone.

The tone must be previously specified. The sound ID is set depending on the tone type. The tone is played using CAknKeySoundSystem::playSound(). Derived classes must call this method if they override RunLD() and they wish to play a tone.

panic

EAknPanicNullPointer

TTone , CAknKeySoundSystem, CAknNoteDialog::RunLD().

PostLayoutDynInitL()

IMPORT_C voidPostLayoutDynInitL()[protected, virtual]

From CEikDialog.

Performs dynamic operations after the layout.

Called by the Uikon framework after the dialog layout is executed, this method can be overrwritten to perform specific operations.

The following operations are performed:-
  • StartAnimationL() is called.

CAknNoteControl::StartAnimationL().

PreLayoutDynInitL(void)

IMPORT_C voidPreLayoutDynInitL(void)[protected, virtual]

From CEikDialog.

Performs dynamic operations before the layout.

Called by the Uikon framework before the dialog layout is executed, this method can be overrwritten to perform specific operations.

The following operations are performed:-
  • The control attributes are transferred to the control. The local control attributes are copied into the real control attributes. The local attributes are then deleted.

  • If a timeout has been specified the timer is started. The callback is StaticDeleteL.

CAknNoteAttributes, TTimer, SetEditableL().

Parameters

void

ReportUserActivity()

IMPORT_C voidReportUserActivity()const [protected]

Indicates that there is user activity.

Resets timers which are monitoring user inactivity. This will disable functionality that checks for user inactivity by listening to these timers.

Derived classes must call this method if they override RunLD() and they wish to report user activity in order to dismiss applications such as the screen saver.

User::ResetInactivityTime() .

RunDlgLD(const TTimeout, const TTone)

IMPORT_C TIntRunDlgLD(const TTimeoutaTimeout,
const TToneaTone
)

Set timeout and tone and run the dialog.

This method is deprecated and should not be used.

The ID of the button used to dismiss the dialog.

Parameters

const TTimeout aTimeoutWanted timeout in microseconds.
const TTone aToneWanted alarm tone.

RunDlgLD(const TTone)

IMPORT_C TIntRunDlgLD(const TToneaTone)

Set tone and run the dialog.

This method is deprecated and should not be used.

The ID of the button used to dismiss the dialog.

Parameters

const TTone aToneWanted alarm tone.

RunDlgLD()

IMPORT_C TIntRunDlgLD()

Run the dialog.

This method is deprecated and should not be used.

The ID of the button used to dismiss the dialog.

RunDlgLD(TInt)

IMPORT_C TIntRunDlgLD(TIntaNoteControlId)

Set NoteControlID and run the dialog.

This method is deprecated and should not be used.

The ID of the button used to dismiss the dialog.

Parameters

TInt aNoteControlIdNot used.

RunLD()

IMPORT_C TIntRunLD()[virtual]

From @ CEikDialog.

Executes a dialog.

Plays a tone (if one was defined) and simulates user activity. Forwards call to CEikDialog::RunLD().

The ID of the button used to dismiss the dialog.

SetCurrentLabelL(TInt, const TDesC &)

IMPORT_C voidSetCurrentLabelL(TIntaControlId,
const TDesC &aLabel
)

Sets a new label for the specified dialog.

This method is deprecated. SetTextL() method should be used instead.

Parameters

TInt aControlIdNot used.
const TDesC & aLabelThe new label.

SetIconL(CEikImage *)

IMPORT_C voidSetIconL(CEikImage *aIcon)

Sets the dialog icon.

Changes the number type icon in the note control.

Overrides the icon which was set in the resource file. The dialog takes ownership of the pointer The numbertype icon is the small icon which is bottom left in the note (thumbnail icon).

Parameters

CEikImage * aIconPointer to the icon.

SetImageL(CEikImage *)

IMPORT_C voidSetImageL(CEikImage *aImage)

Set the dialog image.

Change the image in the note control. Override the image which was set in the resource file. The dialog takes ownership of the pointer. The note image is the big image or icon which is top right.

Parameters

CEikImage * aImagePointer to the new image.

SetNoMemoryAllocation()

IMPORT_C voidSetNoMemoryAllocation()[protected]

Sets an indication that memory should not be allocated.

This method is reserved for CEikAlert usage.

SetSizeAndPosition(const TSize &)

IMPORT_C voidSetSizeAndPosition(const TSize &aSize)[protected, virtual]

From CEikDialog.

Sets the size and the position for the layout.

The dialog height and width are retrieved from the control (if it exists already).If it does not exist, then default values are used. The client rect is obtained from the application UI. AknLayoutUtils::LayoutControl is then executed using the client rect and the note width and height.

AknLayoutUtils::LayoutControl() .

Parameters

const TSize & aSizeNot used.

SetSkinBackGroundRect()

voidSetSkinBackGroundRect()[private]

SetTextL(const TDesC &)

IMPORT_C voidSetTextL(const TDesC &aLabel)

Sets the dialog text.

This method can set a formatted text, e.g. "You have 1 new message". It can however set an unformatted text as well, e.g. "You have \%d messages". The plurality of the dialog must be previously specified - if not singular plurality is used unless there was no singular text specified in the resource file.

SetTextNumberL() , SetTextPluralityL().

Parameters

const TDesC & aLabelThe note text.

SetTextNumberL(TInt)

IMPORT_C voidSetTextNumberL(TIntaNumber)

Sets the number in the dialog text.

Sets a number in the note text. If the text specified in the resource file or via SetTextL() has a %d in it, e.g. "You have \%d new messages", this number is inserted at the location specified by %d.

Parameters

TInt aNumberThe number to be inserted in the text.

SetTextPluralityL(const TBool)

IMPORT_C voidSetTextPluralityL(const TBoolisPlural)

Sets the text plurality for the dialog.

Indicates whether to use plural or singular text. These texts must have been specified in the resource file.

SetTextNumberL() .

Parameters

const TBool isPluralETrue if plural text should be used, EFalse otherwise.

SetTextProcessing(TBool)

IMPORT_C voidSetTextProcessing(TBoolaEnabled)

Enables or disables all text processing done by the dialog. This includes text wrapping, text truncation and reordering of bidirectional text.

By default, it is enabled.

If text processing is disabled, lines are broken only at explicit line end characters and they are not truncated, but drawn as long as they fit. Also, the dialog does not handle reordering of the bidirectional text.

This method must be called before the text is set.

Parameters

TBool aEnabledEnables or disables all text processing.

SetTextWrapping(TBool)

IMPORT_C voidSetTextWrapping(TBoolaEnabled)

Enables or disables text wrapping.

Enables or disables text wrapping depending on the values of aEnabled (true enables text wrapping). When text wrapping is disabled a new line in the note dialog starts only after a newline character in the note text. If a line does not fit into the dialog width it is clipped (the last character is replaced with an ellipsis sign).

This method must be called before SetTextL as it only influences the wrapping of text that it is yet to be set via API.

Parameters

TBool aEnabledETrue for enabling text wrapping, EFalse for disabling it.

SetTimeout(const TTimeout &)

IMPORT_C voidSetTimeout(const TTimeout &aTimeout)

Sets the dialog timeout.

TTimeout .

Parameters

const TTimeout & aTimeoutThe dialog timeout.

SetTone(const TTone &)

IMPORT_C voidSetTone(const TTone &aTone)

Sets the dialog tone .

TTone .

Parameters

const TTone & aToneThe dialog tone.

SizeChanged()

IMPORT_C voidSizeChanged()[private, virtual]

SoundSystem()

IMPORT_C CAknKeySoundSystem *SoundSystem()const [protected]

Gets the used sound system.

Calls iEikonEnv->AppUi()->KeySounds() and returns the pointer returned by the called method. If there is no application UI return NULL.

CAknKeySoundSystem, CAknAppUi.

Pointer to the used CAknKeySoundSystem or NULL.

panic

EAknPanicNullPointer

StaticDeleteL(TAny *)

IMPORT_C TIntStaticDeleteL(TAny *aThis)[protected, static]

Deletes the note dialog.

Called when the timer completes, this method deletes the dialog. A reinterpret_cast to CAknNoteDialog* is performed on aThis. If the dialog is not a sleeping note then it is deleted. If it is a sleeping dialog then the timer is stopped, OkToExitL() is called with KErrCancel and ExitSleepingDialog is executed.

TTimer, OkToExitL(), ExitSleepingDialog().

Always returns EFalse.

Parameters

TAny * aThisPointer to the dialog.

TransferControlAttributes()

IMPORT_C voidTransferControlAttributes()[protected]

Transfers the control attributes from the dialog to the control.

Must be called by derived classes in PreLayoutDynInitL() if this method is not called then the set of API methods that were invoked before the control is created will not work.

Member Enumerations Documentation

Enum TTimeout

The timeout in microseconds for automatically deleting the dialog.

Enumerators

EUndefinedTimeout = 0

Deprecated (not used).

ENoTimeout = 0
EShortTimeout = 1500000
ELongTimeout = 3000000
EShortestTimeout = 500000

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.

Member Data Documentation

CAknNoteAttributes * iControlAttributes

CAknNoteAttributes *iControlAttributes[protected]

Note control attributes.

CAknNoteDialogExtension * iNoteExtension

CAknNoteDialogExtension *iNoteExtension[private]

CEikDialog ** iSelfPtr

CEikDialog **iSelfPtr[protected]

Used for notes that are not modal. The calling application has no way of knowing when the note is deleted.

TInt iTimeoutInMicroseconds

TInt iTimeoutInMicroseconds[protected]

Note timeout in microseconds.

CPeriodic * iTimer

CPeriodic *iTimer[protected]

Note timeout timer.

TTone iTone

TTone iTone[protected]

The tone to be played.