UIQ Technology
Symbian OS Library

UIQ 3.1 SDK        UIQ developer portal

[Index] [Spacer] [Previous] [Next]



Location: ContacuiListDialog.h
Link against: qcontacui.lib

Class CContactUiListDialog

class CContactUiListDialog : public CEikDialog, public MQikListBoxObserver, public MContactsAppModelObserver, public MQikCommandHandler, public MQikCommandListOwner;

Description

Contacts shared UI list dialog.

This dialog is used to display contact items in a list. The user can select one or more items in the list. A filter is specified on construction of the dialog. This defines the type of data that can be retrieved by the dialog. Only items in the list which have one or more fields matching this filter can be selected.

To use this class, you must allocate an array of CContacuiReturnData objects and pass a reference to this object to the dialog launch method. This array is used to hold pointers to the data contained in each of the selected items. The data is a contact item ID and the contents of one or more field which matches the filter specified when launching the dialog.

If a selected contact item has more than one field which matches the filter, (e.g. multiple telephone numbers or email addresses) the data could be shown either directly below the name (the EListDialogNoFisheye must be set in the filter argument) or in an highlighted item layout (fisheye).

Derivation

  • MEikBorderedControl - Interface for bordered controls
  • MObjectProvider - An interface that allows an object to be part of a network of object providers
  • CBase - Base class for all classes to be instantiated on the heap
  • Members

    Defined in CContactUiListDialog:
    OfferKeyEventL(), RunDlgLD(), RunDlgLD(), RunDlgLD()

    Inherited from CBase:
    Delete(), Extension_(), operator new()

    Inherited from CCoeControl:
    AccumulatedZoom(), ActivateGc(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentArrayExists(), Components(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), GetColor(), GetGc(), GetTextDrawer(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleRedrawEvent(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MaximumWidth(), MopNext(), Observer(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionRelativeToScreen(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), Reserved_2(), ResetGc(), ScreenFont(), SetAllowStrayPointers(), SetBackground(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetControlContext(), SetCornerAndSize(), SetExtent(), SetExtentToWholeScreen(), SetFocus(), SetFocusing(), SetFontProviderL(), SetGc(), SetGloballyCapturing(), SetHitTest(), SetMaximumWidth(), SetMopParent(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetSize(), SetSizeWithoutNotification(), SetUniqueHandle(), SetZoomFactorL(), Size(), SystemGc(), TZoomType, TextDrawer(), UniqueHandle(), Window(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

    Inherited from CEikBorderedControl:
    Draw(), PositionChanged(), WriteInternalStateL(), iBorder

    Inherited from CEikDialog:
    ActivateFirstPageL(), ActivateL(), ActivePageId(), ActivePageIndex(), AddCommandListL(), AddTabL(), AdjustAllIdsOnPage(), Border(), CEikDialog_Reserved_3(), CEikDialog_Reserved_4(), CEikDialog_Reserved_5(), CEikDialog_Reserved_6(), ComponentControl(), ConstructFromResourceL(), ConstructSleepingAlertDialogL(), ConstructSleepingDialogL(), Control(), ControlCaption(), ControlOrNull(), CountComponentControls(), CreateCustomControlL(), CreateLineByTypeL(), CurrentLine(), DeleteCommandListL(), DeleteLine(), DisableTitlePointerEvents(), DynInitOrDeleteCommandL(), EAllPersistence, ELandscapePersistence, ENoPersistence, EPortraitPersistence, ESoftkeyStyleSmallPersistence, ExecuteLD(), ExitSleepingDialog(), FindCompatibleUiConfig(), FindLineIndex(), FocusChanged(), GetColorUseListL(), GetHelpContext(), HandleAttemptDimmedSelectionL(), HandleCommandL(), HandleControlArrayEventL(), HandleControlEventL(), HandleControlStateChangeL(), HandleInteractionRefused(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HandleUiConfigChangedL(), HasBorder(), IdOfFocusControl(), InputCapabilities(), InsertLineL(), IsCommandListActive(), Layout(), Line(), LineChangedL(), MakeLineVisible(), MakeVisible(), MakeWholeLineVisible(), MapCommandHandler(), MinimumSize(), MopSupplyObject(), OkToExitL(), PageChangedL(), Persistence(), PostLayoutDynInitL(), PreLayoutDynInitL(), PreferredSize(), PrepareForFocusGainL(), PrepareForFocusLossL(), PrepareForFocusTransitionL(), PrepareForcedExitL(), PrepareLC(), RequestRelayout(), ResetLineMinimumSizes(), RotateFocusByL(), RouseSleepingDialog(), RunLD(), SetActivePageL(), SetAdjacent(), SetBorder(), SetCategoryModelAsCommandsL(), SetContainerWindowL(), SetControlCaptionL(), SetDimmed(), SetHelpContext(), SetInitialCurrentLine(), SetLayoutManagerL(), SetLineDimmedNow(), SetLineNonFocusing(), SetNeighbor(), SetPageDensePacking(), SetPageDimmedNow(), SetParent(), SetPersistence(), SetSizeAndPosition(), SetTextBaselineSpacing(), SetTitleL(), SetTitleLeftImageL(), SizeChanged(), SwapCommandListL(), SwitchLineLatency(), TPersistenceFlag, TextBaselineOffset(), Title(), TryChangeFocusToL(), TryExitL(), operator class MQikCommandListOwner &(), operator class MQikCommandListOwner *(), operator const class MQikCommandListOwner &(), operator const class MQikCommandListOwner *()

    Inherited from MCoeControlObserver:
    EEventInteractionRefused, EEventPrepareFocusTransition, EEventRequestCancel, EEventRequestExit, EEventRequestFocus, EEventStateChanged, MCoeControlObserver_Reserved1(), MCoeControlObserver_Reserved2(), TCoeEvent

    Inherited from MEikBorderedControl:
    ETypeId, anonymous

    Inherited from MObjectProvider:
    MObjectProvider_Reserved1(), MObjectProvider_Reserved2(), MopGetObject(), MopGetObjectNoChaining()

    Inherited from MQikListBoxObserver:
    EEventBottomReached, EEventCustomStart, EEventDimmedItemConfirmedAttempt, EEventEmptyListBoxActioned, EEventHighlightMoved, EEventItemConfirmed, EEventItemHighlighted, EEventItemTapped, EEventMatchBufferChanged, EEventMatchBufferFull, EEventSelectionChanged, EEventSlotIndexChanged, EEventTopReached, HandleListBoxEventL(), TQikListBoxEvent

    See also:


    Member functions


    RunDlgLD()

    static IMPORT_C TBool RunDlgLD(RPointerArray< CContacuiReturnData > &aResultArray, TInt aFlags, TInt aFilter);

    Description

    Launches the dialog.

    Parameters

    RPointerArray< CContacuiReturnData > &aResultArray

    A reference to an array that holds pointers to the data contained in each of the selected items

    TInt aFlags

    To select single/multiple select, if distribution lists should be visible etc (TListDialogFlags).

    TInt aFilter

    If the list should include landline/mobile phone numbers, emails etc (CContactDatabase ::TContactViewFilter)

    Return value

    TBool

    EFalse if the dialog was dismissed, otherwise ETrue.


    RunDlgLD()

    static IMPORT_C TBool RunDlgLD(RPointerArray< CContacuiReturnData > &aResultArray, TInt aFlags, TInt aFilter, TSortOrderHighlightedItemLayout aSortOrder);

    Description

    Launches the dialog.

    Parameters

    RPointerArray< CContacuiReturnData > &aResultArray

    A reference to an array that holds pointers to the data contained in each of the selected items

    TInt aFlags

    To select single/multiple select, if distribution lists should be visible etc (TListDialogFlags).

    TInt aFilter

    If the list should include landline/mobile phone numbers, emails etc (CContactDatabase ::TContactViewFilter)

    TSortOrderHighlightedItemLayout aSortOrder

    To select if the if a preferred phone number or the first mobile number will be listed first among the numbers

    Return value

    TBool

    EFalse if the dialog was dismissed, otherwise ETrue.


    RunDlgLD()

    static IMPORT_C TBool RunDlgLD(RPointerArray< CContacuiReturnData > &aResultArray, TInt aFlags, TInt aFilter, TSortOrderHighlightedItemLayout aSortOrder, TBool aSimCategoryAvailable);

    Description

    Launches the dialog.

    Parameters

    RPointerArray< CContacuiReturnData > &aResultArray

    A reference to an array that holds pointers to the data contained in each of the selected items

    TInt aFlags

    To select single/multiple select, if distribution lists should be visible etc (TListDialogFlags).

    TInt aFilter

    If the list should include landline/mobile phone numbers, emails etc (CContactDatabase ::TContactViewFilter)

    TSortOrderHighlightedItemLayout aSortOrder

    To select if the if a preferred phone number or the first mobile number will be listed first among the numbers

    TBool aSimCategoryAvailable

    Return value

    TBool

    EFalse if the dialog was dismissed, otherwise ETrue.


    OfferKeyEventL()

    virtual TKeyResponse OfferKeyEventL(const TKeyEvent &aKeyEvent, TEventCode aType);

    Description

    Parameters

    const TKeyEvent &aKeyEvent

    TEventCode aType

    Return value

    TKeyResponse