Class CQikListBoxGridView

class CQikListBoxGridView : public CQikListBoxViewBase;

Description

Grid ListBox specific view. The view is created internally by the listbox but can also be created externally. The grid view structures items in a grid of equally sized cells. The number of column and rows can be set to change the grid size.

If there are more items that fit in a single view frame a scrollbar can be used. This view support either vertical or horizontal scrollbar. Horizontal scrollbar allows for horizontal scrolling of the view, i.e the view is scrolled sideways something that might be useful in landscape UI mode.

Layouts used should not be row aware but instead be dynamic in filling both width and height of the cell, this way a change in cell size (change in grid size) will allow for automatic recalculation of the items size to fit the new cell size.

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
• CQikListBoxGridView - Grid ListBox specific view

Members

Defined in CQikListBoxGridView:
ActivateL(), CQikListBoxGridView(), CQikListBoxGridView(), CellSize(), ComponentControl(), ConstructFromResourceL(), ConstructL(), CountComponentControls(), FocusChanged(), GetColorUseListL(), GetHelpContext(), GridSize(), HScrollBarModel(), HandleControlArrayEventL(), HandleListBoxScrollEventL(), HandleModelChangeL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HasBorder(), InputCapabilities(), MakeVisible(), MinimumSize(), MopSupplyObject(), MoveDownL(), MoveHighlightToItemAboveL(), MoveHighlightToItemBelowL(), MoveHighlightToItemDownLeftL(), MoveHighlightToItemDownRightL(), MoveHighlightToItemUpLeftL(), MoveHighlightToItemUpRightL(), MoveHighlightToNextItemL(), MoveHighlightToPrevItemL(), MovePageDownL(), MovePageUpL(), MoveToCurrentItemL(), MoveToRowL(), MoveUpL(), OfferKeyEventL(), PopulateViewL(), PositionChanged(), PositionItemsL(), PrepareForFocusGainL(), PrepareForFocusLossL(), RequestRelayout(), ScrollDirection(), ScrollRepeatInterval(), SetAdjacent(), SetContainerWindowL(), SetDemarcationFromItemToView(), SetDimmed(), SetGridSizeL(), SetLayoutManagerL(), SetNeighbor(), SetParent(), SetScrollDirectionL(), SetTextBaselineSpacing(), SizeChanged(), TextBaselineOffset(), UpdateScrollBarModels(), VScrollBarModel(), ~CQikListBoxGridView()

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

IMPORT_C CQikListBoxGridView();

Description

Constructor.

IMPORT_C CQikListBoxGridView(TUint aFlags);

Description

Parameters

TUint aFlags

virtual IMPORT_C ~CQikListBoxGridView();

Description

Destructor

IMPORT_C void ConstructL();

Description

Completes the construction of a CQikListBoxGridView .

virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);

Description

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

Parameters

TResourceReader &aReader A resource reader pointing to a QIK_LISTBOX_GRID_VIEW resource.

IMPORT_C TSize GridSize() const;

Description

Returns the grid size, i.e number of columns and rows.

Return value

TSize A TSize where iWidth represents the number of columns while iHeight represents the number of rows.

IMPORT_C void SetGridSizeL(const TSize &aGridSize);

Description

Sets the grid size, i.e number of columns and rows.

Parameters

const TSize &aGridSize iWidth will set the number of columns while iHeight sets the number of rows. Both iWidth and iHeight must be greater than 0.

Panic codes

EQikListBoxPanicIllegalGridSize If iWidth or iHeight is not > 0. Debug builds 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 Debug builds only. EQikListBoxViewBaseIsUnlocked View is locked for transition effects. Debug builds only.

See also:

• CCoeControl::OfferKeyEventL()

virtual IMPORT_C void HandlePointerEventL(const TPointerEvent &aPointerEvent);

Description

Handles pointer events. This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer.

Parameters

const TPointerEvent &aPointerEvent The pointer event.

See also:

• CCoeControl::HandlePointerEventL()

IMPORT_C void SetScrollDirectionL(TQikListBoxScrollDirection aDirection);

Description

Sets whether the grid list box should be laid out horizontally or vertically. Vertical is the default behavior of the grid list box, showing a vertical scroll bar that lets you scroll down/up. Horizontal behavior could be useful in landscape mode etc., where the scroll bar will let you scroll the list box horizontally.

This method does not alter the scrollbar visibility set, this has to be explicitly done through the List Box API. When in horizontal scrolling mode the HScrollBarVisibility applies and when in vertical scrolling mode the VScrollBarVisibility applies.

Parameters

TQikListBoxScrollDirection aDirection Direction of scrolling/layout of items.

Panic codes

EQikListBoxPanicListBoxIsNull If the view has no affiliated ListBox. Debug builds only.

See also:

• CQikListBox::VScrollBarVisibility
• CQikListBox::HScrollBarVisibility

IMPORT_C TQikListBoxScrollDirection ScrollDirection() const;

Description

Return value

TQikListBoxScrollDirection EQikHorizontalDirection if the grid view is scrolled and laid out horizontally, EQikVerticalDirection if vertically.

protected: virtual IMPORT_C void PopulateViewL(TQikListBoxPopulationDirection aDirection);

Description

Populates the view.

Parameters

TQikListBoxPopulationDirection aDirection The direction (top/bottom index) to populate from

See also:

• CQikListBoxViewBase::PopulateViewL()

protected: IMPORT_C void PositionItemsL();

Description

Adjust the item positions to make room for the highlight layout.

protected: IMPORT_C void MoveHighlightToPrevItemL();

Description

Move selection to the previous item. Moves window so the selected item becomes visible.

protected: IMPORT_C void MoveHighlightToNextItemL();

Description

Move selection to the next item. Moves window so the selected item becomes visible.

protected: IMPORT_C void MoveHighlightToItemAboveL();

Description

Move selection to the item above, in the same column. Moves window so the selected item becomes visible.

protected: IMPORT_C void MoveHighlightToItemBelowL();

Description

Move selection to the item below, in the same column. Moves window so the selected item becomes visible.

protected: IMPORT_C void MoveHighlightToItemUpLeftL();

Description

Moves the highlight to the item that is up and left of the current item. If the left edge is reached the highlight is only moved up if possible. If the top is reached the highlight is only moved left if possible. No looping is done.

protected: IMPORT_C void MoveHighlightToItemUpRightL();

Description

Moves the highlight to the item that is up and right of the current item. If the right edge is reached the highlight is only moved up if possible. If the top is reached the highlight is only moved right if possible. No looping is done.

protected: IMPORT_C void MoveHighlightToItemDownLeftL();

Description

Moves the highlight to the item that is down and left of the current item. If the left edge is reached the highlight is only moved down if possible. If the bottom is reached the highlight is only moved left if possible. No looping is done.

protected: IMPORT_C void MoveHighlightToItemDownRightL();

Description

Moves the highlight to the item that is down and right of the current item. If the right edge is reached the highlight is only moved down if possible. If the bottom is reached the highlight is only moved right if possible. No looping is done.

protected: IMPORT_C void MoveToRowL(TInt aRowIndex);

Description

Move the window to the indexed row.

Parameters

TInt aRowIndex The row index to move to.

Panic codes

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

See also:

• CQikListBoxViewBase::MoveToRowL()

protected: IMPORT_C TBool MoveUpL();

Description

Move the window up one step.

Return value

TBool EFalse if the windows is not moved because the top item is already in view.

See also:

• CQikListBoxViewBase::MoveUpL()

protected: IMPORT_C TBool MoveDownL();

Description

Move window down one step.

Return value

TBool EFalse if the windows is not moved because the bottom item is already in view.

See also:

• CQikListBoxViewBase::MoveDownL()

protected: IMPORT_C TBool MovePageUpL();

Description

Move window up one page.

Return value

TBool EFalse if the windows is not moved because the top item is already in view.

See also:

• CQikListBoxViewBase::MovePageUpL()

protected: IMPORT_C TBool MovePageDownL();

Description

Move window down one page.

Return value

TBool EFalse if the windows is not moved because the bottom item is already in view.

See also:

• CQikListBoxViewBase::MovePageDownL()

protected: virtual IMPORT_C TSize CellSize() const;

Description

Return value

TSize

See also:

• CQikListBoxViewBase::CellSize

protected: virtual IMPORT_C TBool UpdateScrollBarModels();

Description

Calculate the scrollbar span.

Return value

TBool

See also:

• CQikListBoxViewBase::UpdateScrollBarModels()

protected: virtual IMPORT_C TInt ScrollRepeatInterval() const;

Description

Get the scroll repeat interval for a specific 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

Parameters

CEikScrollBar *aScrollBar TEikScrollEvent aEventType The event.

See also:

• MEikScrollBarObserver

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()

protected: 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 SizeChanged();

Description

See also:

• CCoeControl::SizeChanged()

protected: virtual IMPORT_C TSize MinimumSize();

Description

Return value

TSize

See also:

• CCoeControl::MinimumSize()

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()