Class CQikListBoxRowView

class CQikListBoxRowView : public CQikListBoxViewBase;

Description

Row based ListBox specific view. The items get their layout by the CQikListBoxLayoutPairs. The view is created internally by the listbox but can also be created externally.

Derivation

• MQikListBoxModelObserver - The MQikListBoxModelObserver class is used by MQikListBoxModel for notifying about changes in the data in order to update the selection array
• 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
• CCoeControl - Control base class from which all other controls are derived
• CQikListBoxViewBase - This is the base class for CQikListBoxRowView and CQikListBoxGridView
• CQikListBoxRowView - Row based ListBox specific view

Members

Defined in CQikListBoxRowView:
ActivateL(), CQikListBoxRowView(), CellSize(), CenteredScrolling(), ComponentControl(), ConstructFromResourceL(), ConstructL(), CountComponentControls(), ESimple, EWithWrapping, FocusChanged(), GetColorUseListL(), GetHelpContext(), HScrollBarModel(), HandleControlArrayEventL(), HandleListBoxScrollEventL(), HandleModelChangeL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HasBorder(), InputCapabilities(), MakeVisible(), MinimumSize(), MopSupplyObject(), MoveHighlightToNextItemL(), MoveHighlightToPrevItemL(), MoveToCurrentItemL(), MoveToRowL(), MoveViewDownL(), MoveViewPageDownL(), MoveViewPageUpL(), MoveViewUpL(), OfferKeyEventL(), PopulateViewL(), PositionChanged(), PrepareForFocusGainL(), PrepareForFocusLossL(), RequestRelayout(), ScrollPaneWidth(), ScrollRepeatInterval(), SetAdjacent(), SetCenteredScrolling(), SetContainerWindowL(), SetDemarcationFromItemToView(), SetDimmed(), SetHighlightMargin(), SetLayoutManagerL(), SetNeighbor(), SetParent(), SetScrollPaneWidth(), SetShowPartiallyVisibleItemsL(), SetTextBaselineSpacing(), ShowPartiallyVisibleItems(), SizeChanged(), TSpecializedMinimumSize, TextBaselineOffset(), UpdateScrollBarModels(), VScrollBarModel(), ~CQikListBoxRowView()

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

Inherited from CCoeControl:
AccumulatedZoom(), ActivateGc(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), Components(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), GetColor(), GetGc(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleRedrawEvent(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MaximumWidth(), Observer(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionRelativeToScreen(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), Reserved_CCoeControl_10(), Reserved_CCoeControl_11(), Reserved_CCoeControl_12(), Reserved_CCoeControl_13(), 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(), WriteInternalStateL(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

Inherited from CQikListBoxViewBase:
AddedItemsArray(), BaseConstructFromResourceL(), ClearMatchBufferL(), ConsumeMatchCharacterL(), CurrentItem(), CurrentItemIndex(), CurrentSlotId(), DoHandleContentSwappingL(), DoReverseSelectionL(), EGridView, ENoRepeatEvent, ERepeatContentSwapping, ERepeatMovingDown, ERepeatMovingUp, ERowView, HandleContentSwappingL(), HandleDragOutside(), HasHighlightEnabled(), HasMultipleSelect(), HeightInRows(), Highlight(), HighlightStyle(), IncomingItemsArray(), IsHighlightInView(), IsItemInView(), ItemArray(), LastPopulationDirection(), ListBoxOrNull(), Looping(), LoopingEnabled(), Mirroring(), Model(), NewOrCachedItemL(), NextFocusableIndexL(), PreviousFocusableIndexL(), PreviousTransitionTopIndex(), RepeatEvent(), RepeatRect(), ReportEventToListBoxL(), ResetIncomingItemsArray(), SetCurrentItemIndexL(), SetHeightInRows(), SetHighlightEnabled(), SetHighlightStyle(), SetLastPopulationDirection(), SetLooping(), SetMatchBufferL(), SetMultipleSelect(), SetPreviousTransitionTopIndex(), SetRepeatEvent(), SetTransitionViewType(), SwappedItemsArray(), TViewRepeatEvents, TViewType, TappedItem(), TransitionViewType(), TrimCache(), UpdateHighlight(), ViewMargins(), iStates

Inherited from MObjectProvider:
MopGetObject(), MopGetObjectNoChaining()

Inherited from MQikListBoxModelObserver:
EQikListBoxAllDataRemoved, EQikListBoxDataInserted, EQikListBoxDataRemoved, EQikListBoxDataSwapped, EQikListBoxDataUpdated, EQikListBoxModelBeginUpdate, EQikListBoxModelEndUpdate, TModelEvent

See also:

• TSpecializedMinimumSize
• for special cases of minimum size calculation.

IMPORT_C CQikListBoxRowView();

Description

Constructor.

IMPORT_C ~CQikListBoxRowView();

Description

Destructor.

IMPORT_C void ConstructL();

Description

Completes the construction of a CQikListBoxRowView .

virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);

Description

Completes the construction of a new CQikListBoxRowView . This method reads its data from a view struct.

Parameters

TResourceReader &aReader A resource reader

IMPORT_C void SetScrollPaneWidth(TInt aWidth);

Description

Effectively sets the width the items in the view will be, if aWidth is wider than the view itself, the horizontal scrollbar becomes usable (be sure to set the visibility mode of the horizontal scrollbar to an appropriate mode). If aWidth is less than the width of the view itself nothing is done.

Parameters

TInt aWidth The new width.

See also:

• CQikListBox::SetScrollbarVisibility

IMPORT_C TInt ScrollPaneWidth() const;

Description

Returns the width used to size the items in the view.

Return value

TInt The width.

See also:

• SetScrollPaneWidth

IMPORT_C TBool CenteredScrolling(TInt &aCenterValue) const;

Description

Gets the settings for centered scrolling

Parameters

TInt &aCenterValue Value for centered scrolling behavior. See SetCenteredScrolling() for more information.

Return value

TBool ETrue if the ListBox uses centered scrolling

IMPORT_C void SetCenteredScrolling(TQikListBoxProperty aCentered, TInt aCenterValue);

Description

Sets the centered item scrolling behavior for the ListBox. The centered scrolling is activated when scrolling up or down and there are items to be scrolled into view

Parameters

TQikListBoxProperty aCentered Can be set to System, On or Off TInt aCenterValue If aCentered is on, it is possible to set the behavior of the scrolling using this value. -1 means that the highlight will be in the center of the ListBox. Zero or a positive value will place the highlight offset from the top and bottom when scrolling up or down

IMPORT_C TBool ShowPartiallyVisibleItems() const;

Description

Returns the setting for showing partially visible items.

Return value

TBool ETrue if partially visible items are shown.

IMPORT_C void SetShowPartiallyVisibleItemsL(TQikListBoxProperty aShowPartiallyVisibleItems);

Description

Sets the setting for showing partially visible items.

Partial visible items means showing the top/bottom item (depending on navigation direction) partially when it doesn't fit as whole in the ListBox view.

Parameters

TQikListBoxProperty aShowPartiallyVisibleItems System, on or off.

IMPORT_C void SetHighlightMargin(const TMargins &aLeftMargin);

Description

Sets the left margin of the hightlight and then updates the view.

Parameters

const TMargins &aLeftMargin The margins that should be used to change the extent of the highlight.

Panic codes

EQikListBoxPanicLeftMarginCannotBeNegative If some, or all of the margins in aMargin is negatve (debug build only).

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

Description

Handles navigation and incremental matching.

Parameters

const TKeyEvent &aKeyEvent The key event TEventCode aType The type of key event

Return value

TKeyResponse Indicates whether or not the key event was used.

Panic codes

EQikListBoxPanicModelUpdatedNotCalledAfterChangingData EQikListBoxPanicIllegalUnlockStatus

See also:

• CCoeControl::OfferKeyEventL()

virtual IMPORT_C void HandlePointerEventL(const TPointerEvent &aPointerEvent);

Description

Handles pointer events.

Parameters

const TPointerEvent &aPointerEvent The pointer event.

See also:

• CCoeControl::HandlePointerEventL()

virtual IMPORT_C TSize MinimumSize();

Description

Calculates the minimum size for the view and its items. The calculation is based on the "height in rows" set on the view. For "height in rows" equal or greater than zero CQikListBoxViewBase::MinimumSize shall be called. "height in rows" less than zero might be treated in special ways, see CQikListBoxViewBase::SetHeightInRows for options.

This method in only used when creating derived views, for minimum size of the ListBox see CQikListBox::MinimumSize.

Return value

TSize The minimum size of the view.

See also:

• CQikListBoxViewBase::MinimumSize
• CQikListBoxViewBase::SetHeightInRows

protected: virtual IMPORT_C void PopulateViewL(TQikListBoxPopulationDirection aDirection);

Description

Populates the view with items.

Parameters

TQikListBoxPopulationDirection aDirection If the view should be populated from the top data index down or bottom data index up.

See also:

• CQikListBoxViewBase::PopulateViewL()

protected: IMPORT_C TKeyResponse MoveHighlightToPrevItemL();

Description

Moves the highlight to the previous item.

Return value

TKeyResponse If the key was used or not.

protected: IMPORT_C TKeyResponse MoveHighlightToNextItemL();

Description

Moves the highlight to the next item.

Return value

TKeyResponse If the key was used or not.

protected: IMPORT_C void MoveToRowL(TInt aRowIndex);

Description

Move window to the indexed row.

Parameters

TInt aRowIndex

Panic codes

EQikListBoxPanicInvalidRowIndex If the parameter aRowIndex is out of bounds (debug build only).

See also:

• CQikListBoxViewBase::MoveToRowL()

protected: virtual IMPORT_C TSize CellSize() const;

Description

The cell size for the row view equals the size of the row view.

Return value

TSize

See also:

• CQikListBoxViewBase::CellSize

protected: IMPORT_C TKeyResponse MoveViewUpL();

Description

Moves the view up one item.

Return value

TKeyResponse If the key was used or not.

protected: IMPORT_C TKeyResponse MoveViewDownL();

Description

Moves the view down one item.

Return value

TKeyResponse If the key was used or not.

protected: IMPORT_C TKeyResponse MoveViewPageUpL();

Description

Moves the view to the previous page.

Return value

TKeyResponse If the key was used or not.

protected: IMPORT_C TKeyResponse MoveViewPageDownL();

Description

Moves the view to the next page.

Return value

TKeyResponse If the key was used or not.

protected: virtual IMPORT_C TBool UpdateScrollBarModels();

Description

Updates the scrollbar model for the vertical scrollbar.

Return value

TBool

See also:

• CQikListBoxViewBase::UpdateScrollBarModels

protected: virtual IMPORT_C TInt ScrollRepeatInterval() const;

Description

Get the scroll repeat interval for the row view.

Return value

TInt The scroll repeat interval.

protected: virtual IMPORT_C const TEikScrollBarModel *VScrollBarModel() const;

Description

Return value

const TEikScrollBarModel *

See also:

• CQikListBoxViewBase::VScrollbarModel()

protected: virtual IMPORT_C const TEikScrollBarModel *HScrollBarModel() const;

Description

Return value

const TEikScrollBarModel *

See also:

• CQikListBoxViewBase::HScrollbarModel()

protected: virtual IMPORT_C void HandleListBoxScrollEventL(CEikScrollBar *aScrollBar, TEikScrollEvent aEventType);

Description

Observers scroll events from the scrollbars.

Parameters

CEikScrollBar *aScrollBar TEikScrollEvent aEventType The event.

See also:

• MEikScrollBarObserver

protected: virtual IMPORT_C void SizeChanged();

Description

Reacts on a size change event.

See also:

• CCoeControl::SizeChanged()

virtual IMPORT_C void SetDimmed(TBool aDimmed);

Description

Parameters

TBool aDimmed

See also:

• CCoeControl::SetDimmed()

virtual IMPORT_C void PrepareForFocusLossL();

Description

See also:

• CCoeControl::PrepareForFocusLossL()

virtual IMPORT_C void PrepareForFocusGainL();

Description

See also:

• CCoeControl::PrepareForFocusGainL()

virtual IMPORT_C void GetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList) const;

Description

Parameters

CArrayFix< TCoeColorUse > &aColorUseList

See also:

• CCoeControl::GetColorUseListL()

virtual IMPORT_C void HandleResourceChange(TInt aType);

Description

Parameters

TInt aType

See also:

• CCoeControl::HandleResourceChange()

virtual IMPORT_C TCoeInputCapabilities InputCapabilities() const;

Description

Return value

TCoeInputCapabilities

See also:

• CCoeControl::InputCapabilities()

virtual IMPORT_C TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

Description

Parameters

TTypeUid aId

Return value

TTypeUid::Ptr

See also:

• CCoeControl::MopSupplyObject()

virtual IMPORT_C void MakeVisible(TBool aVisible);

Description

Parameters

TBool aVisible

See also:

• CCoeControl::MakeVisible()

virtual IMPORT_C void ActivateL();

Description

See also:

• CCoeControl::ActivateL()

virtual IMPORT_C void SetAdjacent(TInt aAdjacent);

Description

Parameters

TInt aAdjacent

See also:

• CCoeControl::SetAdjacent()

virtual IMPORT_C void SetNeighbor(CCoeControl *aNeighbor);

Description

Parameters

CCoeControl *aNeighbor

See also:

• CCoeControl::SetNeighbor()

virtual IMPORT_C TBool HasBorder() const;

Description

Return value

TBool

See also:

• CCoeControl::HasBorder()

virtual IMPORT_C void GetHelpContext(TCoeHelpContext &aContext) const;

Description

Parameters

TCoeHelpContext &aContext

See also:

• CCoeControl::GetHelpContext()

virtual IMPORT_C TInt SetParent(CCoeControl *aParent);

Description

Parameters

CCoeControl *aParent

Return value

TInt

See also:

• CCoeControl::SetParent()

virtual IMPORT_C void SetLayoutManagerL(MCoeLayoutManager *aLayout);

Description

Parameters

MCoeLayoutManager *aLayout

See also:

• CCoeControl::SetLayoutManagerL()

virtual IMPORT_C TBool RequestRelayout(const CCoeControl *aChildControl);

Description

Parameters

const CCoeControl *aChildControl

Return value

TBool

See also:

• CCoeControl::RequestRelayout()

virtual IMPORT_C TInt TextBaselineOffset(const TSize &aSize) const;

Description

Parameters

const TSize &aSize

Return value

TInt

See also:

• CCoeControl::TextBaselineOffset()

virtual IMPORT_C void SetTextBaselineSpacing(TInt aSpacing);

Description

Parameters

TInt aSpacing

See also:

• CCoeControl::SetTextBaselineSpacing()

virtual IMPORT_C void SetDemarcationFromItemToView(TInt aItemIndex, const TVwsViewId &aViewUid);

Description

Parameters

TInt aItemIndex const TVwsViewId &aViewUid

See also:

• CQikListBoxViewBase::SetDemarcationFromItemToView()

protected: virtual IMPORT_C CCoeControl *ComponentControl(TInt aIndex) const;

Description

Parameters

TInt aIndex

Return value

CCoeControl *

See also:

• CCoeControl::ComponentControl()

protected: virtual IMPORT_C TInt CountComponentControls() const;

Description

Return value

TInt

See also:

• CCoeControl::CountComponentControls()

protected: virtual IMPORT_C void SetContainerWindowL(const CCoeControl &aContainer);

Description

Parameters

const CCoeControl &aContainer

See also:

• CCoeControl::SetContainerWindowL()

protected: virtual IMPORT_C void HandlePointerBufferReadyL();

Description

See also:

• CCoeControl::HandlePointerBufferReadyL()

protected: virtual IMPORT_C void FocusChanged(TDrawNow aDrawNow);

Description

Parameters

TDrawNow aDrawNow

See also:

• CCoeControl::FocusChanged()

protected: virtual IMPORT_C void PositionChanged();

Description

See also:

• CCoeControl::PositionChanged()

protected: virtual IMPORT_C void HandleControlArrayEventL(CCoeControlArray::TEvent aEvent, const CCoeControlArray *aArray, CCoeControl *aControl, TInt aControlId);

Description

Parameters

CCoeControlArray::TEvent aEvent const CCoeControlArray *aArray CCoeControl *aControl TInt aControlId

See also:

• CCoeControl::HandleControlArrayEventL()

protected: virtual IMPORT_C void HandleModelChangeL(TModelEvent aEvent, TInt aItemIndex, TInt aItemSecond);

Description

Parameters

TModelEvent aEvent TInt aItemIndex TInt aItemSecond

See also:

• MQikListBoxModelObserver::HandleModelChangeL()

protected: virtual IMPORT_C TBool MoveToCurrentItemL();

Description

Return value

TBool

See also:

• CQikListBoxViewBase::MoveToCurrentItemL()

TSpecializedMinimumSize

Description

Can be used to set specific minimum size calculation by supplying corresponding enum to CQikListBoxViewBase::SetHeightInRows. These values can not be set through resource file, the minimum size modes must be enable manually in code.

ESimple Does a calculation on both width and height. Limitations/Rules: ListBox may only have one layout pair added to it. The layouts in the layout pair is not allowed to have any dynamic height types, i.e rows may not have height_type set to EQikListBoxHeightTypeGrab and the layout may not have height_type EQikListBoxLayoutheightFill. All text content types must have minimum lines and maximum lines value of 1 respectivaley. The ListBox may or may not assert on these rules in debug builds. EWithWrapping Does a calculation on height based on a fixed width. Prior to the minimum size calculation the maximum width must be set on the ListBox using CQikListBox::SetMaximumWidth. This calculation will be complete in the sense that it will also calculate the height of text contents type with variable height, i.e a maximum lines greater than minimum lines. Limitations/Rules: ListBox may only have one layout pair added to it. The layouts in the layout pair is not allowed to have any dynamic height types, i.e rows may not have height_type set to EQikListBoxHeightTypeGrab and the layout may not have height_type EQikListBoxLayoutheightFill. The ListBox may or may not assert on these rules in debug builds.