CLmkCategorySelectorDlg Class Reference

#include <app/CLmkCategorySelectorDlg.h>

Link against: LmkCommonUiStub.lib

class CLmkCategorySelectorDlg : public CBase

Inherits from

  • CLmkCategorySelectorDlg
    Public Member Functions
    ~CLmkCategorySelectorDlg()
    IMPORT_C TIntExecuteLD(TLmkItemIdDbCombiInfo &)
    IMPORT_C TIntExecuteLD(RArray< TLmkItemIdDbCombiInfo > &)
    IMPORT_C CLmkCategorySelectorDlg *NewL(TBool)
    IMPORT_C voidSetMopParent(MObjectProvider *)
    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()

    Detailed Description

    This is a dialog class, which is used to launch category selector dialog and to get the selected category ids.It displays the categories present in landmarks database,as a list.The dialog can be a single selector or multiple selector dialog, depending upon argument passed by the client (in ExecuteLD function) at the time when it is launched.Based on whether it is a single selector or multiple selector dialog, user can select single category or multiple categories.

    Constructor & Destructor Documentation

    ~CLmkCategorySelectorDlg ( )

    IMPORT_C~CLmkCategorySelectorDlg()

    Destructor.

    Member Function Documentation

    ExecuteLD ( TLmkItemIdDbCombiInfo & )

    IMPORT_C TIntExecuteLD(TLmkItemIdDbCombiInfo &aSelected)
    This function launches the category selector dialog.Client use this function to launch single category selector dialog. This object is destroyed when this function returns or leaves.
    leave
    Leaves with system-wide leave codes.
    panic
    Panics with KLmkPanicNullMember, if the selector is not constructed properly.

    Returns: Returns non-zero if accepted, else zero.

    ExecuteLD ( RArray< TLmkItemIdDbCombiInfo > & )

    IMPORT_C TIntExecuteLD(RArray< TLmkItemIdDbCombiInfo > &aSelectedItems)

    This function launches the category selector dialog.Client use this function to launch multiple category selector dialog. This object is destroyed when this function returns or leaves. If the array(aSelectedItems) is passed with already filled cateogry ids, then such categories will be shown as selected when the dialog is launched,but if any of these ids do not exist in landmarks database,will be ignored.

    leave
    Leaves with system-wide leave codes.
    panic
    Panics with KLmkPanicNullMember, if the selector is not constructed properly.

    Returns: Returns non-zero if accepted, else zero.

    NewL ( TBool )

    IMPORT_C CLmkCategorySelectorDlg *NewL(TBoolaShowEmptyCategories = EFalse)[static]

    This is a static function, which create and return an instance of this class. Categories present in the landmark database, are shown in selector.

    leave
    Leaves with KErrNotSupported if framework functionality is not available.
    panic
    Panics with system-wide panic codes.
    ParameterDescription
    aShowEmptyCategoriesspecifies whether categories without landmarks are shown or not

    Returns: new instance of this class

    SetMopParent ( MObjectProvider * )

    IMPORT_C voidSetMopParent(MObjectProvider *aParent)

    This function sets the context - that is, the enclosing parent control - for this control.

    panic
    Panics with KLmkPanicNullMember, if the selector is not constructed properly.
    ParameterDescription
    aParentThe parent object which is the context for the control.
    © Nokia 2011.