Symbian^3 Application Developer Library >

CLmkDlgSelectorImplBase Class Reference

class CLmkDlgSelectorImplBase : public CLmkSelectorImplBase

Base class for common ui selectors (dialog-based). During implementation it was noticed that pre-selection indexes cause difficulties and some refactoring could be done to make the code easier to read and maintain.

Inherits from

  • CLmkDlgSelectorImplBase
Public Member Functions
~CLmkDlgSelectorImplBase ()
TInt ExecuteL ( TPosLmItemId &, TBool )
TInt ExecuteL ( RArray < TPosLmItemId > &, TBool )
TInt ExecuteL ( TInt &)
TInt ExecuteL ( CArrayFix < TInt > &)
TInt ExecuteL ( CArrayFix < TInt > &, TPtrC )
void GetDlgResources ( TBool , TInt &, TInt &, TInt &)
TCoeHelpContext HelpContext ()
TInt ListMarkedItemCountL ()
TInt ListVisibleItemCount ()
MLmkListMemento * MementoL ()
void SetDialogTitleL (const TDesC &)
void SetEmptyDlgLabel ( TInt , TInt )
IMPORT_C void SetMopParent ( MObjectProvider *)
void SetSelectorImplParent ( CLmkDlgSelectorImplBase *)
void StopExecutionL ()
Protected Member Functions
CLmkDlgSelectorImplBase ( CPosLandmarkDatabase &)
void BaseConstructL ()
void CheckHideCoordinateL ()
void DynInitDlgMenuPaneL ( TInt , CEikMenuPane *)
void HandleClosingEventL ()
void HandleLaunchingEventL ()
void HandleListProviderError ( TInt )
void HandleListProviderEvent ( TLmkListProviderEventType )
TKeyResponse HandleNavigationEventL (const TKeyEvent &)
void ProcessCommandL ( TInt )
Private Member Functions
void RetrySetPreSelectedL ()
Inherited Functions
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()
CLmkSelectorImplBase::CLmkSelectorImplBase(CPosLandmarkDatabase &)
CLmkSelectorImplBase::ListProvider()const
CLmkSelectorImplBase::Restore(const CEikListBox &,const CLmkListProviderBase &,TBool)
CLmkSelectorImplBase::SetMemento(MLmkListMemento &)
CLmkSelectorImplBase::SetupIconMgrLC()
CLmkSelectorImplBase::SetupListProviderL()
CLmkSelectorImplBase::Store(const CEikListBox &,const CLmkListProviderBase &,TBool)
CLmkSelectorImplBase::~CLmkSelectorImplBase()
Protected Attributes
TInt iCurrentLabelPrimResource
TInt iCurrentLabelSecResource
CLmkSelectorDialog * iDialog
TBool iIsHideHelp
MObjectProvider * iMopParent
CLmkDlgSelectorImplBase * iSelectorImplParent
Private Attributes
TLmkListProviderEventType iDlgSelectorImplBaseLatestListEvent
const RArray < TPosLmItemId > * iInputSelectedItems
HBufC * iTitle
Inherited Attributes
CLmkSelectorImplBase::iDb
CLmkSelectorImplBase::iEnv
CLmkSelectorImplBase::iIconMgr
CLmkSelectorImplBase::iListProvider
CLmkSelectorImplBase::iLmkUiUtils
CLmkSelectorImplBase::iMemento

Constructor & Destructor Documentation

CLmkDlgSelectorImplBase(CPosLandmarkDatabase &)

CLmkDlgSelectorImplBase ( CPosLandmarkDatabase & aDb ) [protected]

C++ default constructor.

Parameters

CPosLandmarkDatabase & aDb

~CLmkDlgSelectorImplBase()

~CLmkDlgSelectorImplBase ( )

Destructor.

Member Functions Documentation

BaseConstructL()

void BaseConstructL ( ) [protected]

By default Symbian 2nd phase constructor is private.

CheckHideCoordinateL()

void CheckHideCoordinateL ( ) [protected]

Check whether Coordinates has to be hidden.

DynInitDlgMenuPaneL(TInt, CEikMenuPane *)

void DynInitDlgMenuPaneL ( TInt aResourceId,
CEikMenuPane * aMenuPane
) [protected]

Parameters

TInt aResourceId
CEikMenuPane * aMenuPane

ExecuteL(TPosLmItemId &, TBool)

TInt ExecuteL ( TPosLmItemId & aOpenedItem,
TBool aAlwaysModifyOpened = EFalse
) [virtual]

Runs single item selection dialog.

Parameters

TPosLmItemId & aOpenedItem contains output selection id
TBool aAlwaysModifyOpened = EFalse if ETrue then highlighted item is set to aOpenedItem even if dialog was cancelled

ExecuteL(RArray< TPosLmItemId > &, TBool)

TInt ExecuteL ( RArray < TPosLmItemId > & aSelectedItems,
TBool aAlwaysModifySelected = EFalse
) [virtual]

Runs multiple item selection dialog. aSelectedItems is used as both input and output parameter (i.e. if a non-empty array is given then those items are marked selected by default.

Parameters

RArray < TPosLmItemId > & aSelectedItems contains input/output selection id(s)
TBool aAlwaysModifySelected = EFalse if ETrue then selected items are set to aSelectedItems even if dialog was cancelled

ExecuteL(TInt &)

TInt ExecuteL ( TInt & aOpenedItem ) [virtual]

Runs single item selection dialog. This method is mainly targeted for internal use within LmkUi component.

Parameters

TInt & aOpenedItem contains output selection index

ExecuteL(CArrayFix< TInt > &)

TInt ExecuteL ( CArrayFix < TInt > & aSelectedItems ) [virtual]

Runs multiple item selection dialog. This method is mainly targeted for internal use within LmkUi component. aSelectedItems is used as both input and output parameter (i.e. if a non-empty array is given then those items are marked selected by default.

Parameters

CArrayFix < TInt > & aSelectedItems contains input/output selection indexes

ExecuteL(CArrayFix< TInt > &, TPtrC)

TInt ExecuteL ( CArrayFix < TInt > & aSelectedItems,
TPtrC aTitlePaneText
) [virtual]

Parameters

CArrayFix < TInt > & aSelectedItems
TPtrC aTitlePaneText

GetDlgResources(TBool, TInt &, TInt &, TInt &)

void GetDlgResources ( TBool aIsSingleSelector,
TInt & aTitlePaneResource,
TInt & aMenuBarResource,
TInt & aDialogResource
) const [pure virtual]

Template method implemented by the subclass and called by the base class.

Parameters

TBool aIsSingleSelector
TInt & aTitlePaneResource
TInt & aMenuBarResource
TInt & aDialogResource

HandleClosingEventL()

void HandleClosingEventL ( ) [protected]

HandleLaunchingEventL()

void HandleLaunchingEventL ( ) [protected]

HandleListProviderError(TInt)

void HandleListProviderError ( TInt aError ) [protected]

Parameters

TInt aError

HandleListProviderEvent(TLmkListProviderEventType)

void HandleListProviderEvent ( TLmkListProviderEventType aEvent ) [protected]

Parameters

TLmkListProviderEventType aEvent

HandleNavigationEventL(const TKeyEvent &)

TKeyResponse HandleNavigationEventL ( const TKeyEvent & aKeyEvent ) [protected]

Parameters

const TKeyEvent & aKeyEvent

HelpContext()

TCoeHelpContext HelpContext ( ) const [virtual]

Template method called by the base class, implemented by the subclass if dialog has a help. Base class implementation returns null help context.

ListMarkedItemCountL()

TInt ListMarkedItemCountL ( ) [virtual]

Return number of marked items

ListVisibleItemCount()

TInt ListVisibleItemCount ( ) [virtual]

Return number of visible items

MementoL()

MLmkListMemento * MementoL ( ) [virtual]

Creates a memento (but does not set it with SetMemento() ).

ProcessCommandL(TInt)

void ProcessCommandL ( TInt aCommandId ) [protected]

Parameters

TInt aCommandId

RetrySetPreSelectedL()

void RetrySetPreSelectedL ( ) [private]

Internal helper function which attempts to read indexes corresponding to stored lm item ids and to set them as selected in the listbox.

SetDialogTitleL(const TDesC &)

void SetDialogTitleL ( const TDesC & aTitle ) [virtual]

Parameters

const TDesC & aTitle

SetEmptyDlgLabel(TInt, TInt)

void SetEmptyDlgLabel ( TInt aLabelPrimRes,
TInt aLabelSecRes
) [virtual]

Stores the empty dialog label

Parameters

TInt aLabelPrimRes
TInt aLabelSecRes

SetMopParent(MObjectProvider *)

IMPORT_C void SetMopParent ( MObjectProvider * aParent )

Object provider mechanism.

Parameters

MObjectProvider * aParent parent object

SetSelectorImplParent(CLmkDlgSelectorImplBase *)

void SetSelectorImplParent ( CLmkDlgSelectorImplBase * aParent )

Selector implementation parent receives observed events when any of the base class's observation methods is executed.

Parameters

CLmkDlgSelectorImplBase * aParent parent of this selector implementor

StopExecutionL()

void StopExecutionL ( ) [virtual]

Member Data Documentation

TInt iCurrentLabelPrimResource

TInt iCurrentLabelPrimResource [protected]

TInt iCurrentLabelSecResource

TInt iCurrentLabelSecResource [protected]

CLmkSelectorDialog * iDialog

CLmkSelectorDialog * iDialog [protected]

Own: Note that iDialog is a dynamic object which can be accessed between HandleLaunchingEventL() & HandleClosingEventL() .

TLmkListProviderEventType iDlgSelectorImplBaseLatestListEvent

TLmkListProviderEventType iDlgSelectorImplBaseLatestListEvent [private]

const RArray< TPosLmItemId > * iInputSelectedItems

const RArray < TPosLmItemId > * iInputSelectedItems [private]

Ref: items to be set marked when provider gets ready if it wasn't ready when ExecuteL() was called

TBool iIsHideHelp

TBool iIsHideHelp [protected]

MObjectProvider * iMopParent

MObjectProvider * iMopParent [protected]

CLmkDlgSelectorImplBase * iSelectorImplParent

CLmkDlgSelectorImplBase * iSelectorImplParent [protected]

HBufC * iTitle

HBufC * iTitle [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.