CSnakingListBoxView Class Reference

#include <mw/eiklbv.h>

Link against: mpxalbumarteditordialog.lib

class CSnakingListBoxView : public CListBoxView

Inherits from

CSnakingListBoxView
- CListBoxView

Protected Attributes
TInt	iColumnWidth

Public Member Functions
	CSnakingListBoxView()
	~CSnakingListBoxView()
virtual IMPORT_C void	CalcBottomItemIndex()
virtual IMPORT_C void	CalcDataWidth()
IMPORT_C void	CalcItemIndexFromRowAndColIndexes(TInt &, TInt, TInt)
virtual IMPORT_C TInt	CalcNewTopItemIndexSoItemIsVisible(TInt)
IMPORT_C void	CalcRowAndColIndexesFromItemIndex(TInt, TInt &, TInt &)
virtual IMPORT_C TInt	CalculateHScrollOffsetSoItemIsVisible(TInt)
TInt	ColumnWidth()
virtual IMPORT_C void	Draw(const TRect *)
virtual IMPORT_C void	HScroll(TInt)
virtual IMPORT_C TPoint	ItemPos(TInt)
virtual IMPORT_C TSize	ItemSize(TInt)
virtual IMPORT_C void	MoveCursorL(TCursorMovement, TSelectionMode)
virtual IMPORT_C TInt	NumberOfItemsPerColumn()
virtual IMPORT_C TInt	NumberOfItemsThatFitInRect(const TRect &)
virtual IMPORT_C TBool	ScrollToMakeItemVisible(TInt)
IMPORT_C void	SetColumnWidth(TInt)
virtual IMPORT_C void	SetItemHeight(TInt)
virtual IMPORT_C void	SetTopItemIndex(TInt)
virtual IMPORT_C TInt	VisibleWidth(const TRect &)
virtual IMPORT_C TBool	XYPosToItemIndex(TPoint, TInt &)

Protected Member Functions
IMPORT_C void	ClearUnusedItemSpace(TInt, TInt)
IMPORT_C void	DrawColumnRange(TInt, TInt)
virtual IMPORT_C void	DrawItemRange(TInt, TInt)
IMPORT_C void	MoveToNextColumnL(TSelectionMode)
IMPORT_C void	MoveToPreviousColumnL(TSelectionMode)
IMPORT_C void	UpdateHScrollOffsetBasedOnTopItemIndex()

Inherited Attributes
	CListBoxView::iBottomItemIndex
	CListBoxView::iCurrentItemIndex
	CListBoxView::iDataWidth
	CListBoxView::iDisableVerticalLineDrawing
	CListBoxView::iExtension
	CListBoxView::iFlags
	CListBoxView::iGc
	CListBoxView::iGroupWin
	CListBoxView::iHScrollOffset
	CListBoxView::iItemDrawer
	CListBoxView::iItemHeight
	CListBoxView::iListEmptyText
	CListBoxView::iModel
	CListBoxView::iSpare
	CListBoxView::iTopItemIndex
	CListBoxView::iVerticalOffset
	CListBoxView::iViewRect
	CListBoxView::iWin

Inherited Enumerations
	CListBoxView:TCursorMovement
	CListBoxView:TFlags
	CListBoxView:TSelectionMode

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()
	CListBoxView::BackColor()const
	CListBoxView::BottomItemIndex()const
	CListBoxView::CEikListBox
	CListBoxView::CListBoxView()
	CListBoxView::ClearFlags(TInt)
	CListBoxView::ClearSelection()
	CListBoxView::ClearSelection(TBool)
	CListBoxView::ClearSelectionAnchorAndActiveIndex()
	CListBoxView::ConstructL(MListBoxModel ,CListItemDrawer ,CWsScreenDevice ,RWindowGroup ,RWindow *,const TRect &,TInt)
	CListBoxView::CurrentItemIndex()const
	CListBoxView::DataWidth()const
	CListBoxView::DeselectItem(TInt)
	CListBoxView::DeselectRangeL(TInt,TInt)
	CListBoxView::DisableVerticalLineDrawing(TBool)
	CListBoxView::DrawEmptyList(const TRect &)const
	CListBoxView::DrawItem(TInt)const
	CListBoxView::DrawMatcherCursor()
	CListBoxView::EmptyListText()const
	CListBoxView::Flags()const
	CListBoxView::GetSelectionIndexesL(CSelectionIndexArray *)const
	CListBoxView::HScrollOffset()const
	CListBoxView::HideMatcherCursor()
	CListBoxView::IsVisible()const
	CListBoxView::ItemDrawer()const
	CListBoxView::ItemHeight()const
	CListBoxView::ItemIsPartiallyVisible(TInt)const
	CListBoxView::ItemIsSelected(TInt)const
	CListBoxView::ItemIsVisible(TInt)const
	CListBoxView::ItemOffsetInPixels()const
	CListBoxView::MatcherCursorPos()const
	CListBoxView::RedrawDisabled()const
	CListBoxView::SelectItemL(TInt)
	CListBoxView::SelectRangeL(TInt,TInt)
	CListBoxView::SelectionIndexes()const
	CListBoxView::SetAnchor(TInt)
	CListBoxView::SetBackColor(TRgb)
	CListBoxView::SetCurrentItemIndex(TInt)
	CListBoxView::SetDimmed(TBool)
	CListBoxView::SetDisableRedraw(TBool)
	CListBoxView::SetEmphasized(TBool)
	CListBoxView::SetFlags(TInt)
	CListBoxView::SetHScrollOffset(TInt)
	CListBoxView::SetItemOffsetInPixels(TInt)
	CListBoxView::SetListEmptyTextL(const TDesC &)
	CListBoxView::SetMatcherCursor(TBool)
	CListBoxView::SetMatcherCursorColor(TRgb)
	CListBoxView::SetMatcherCursorPos(TInt)
	CListBoxView::SetPaintedSelection(TBool)
	CListBoxView::SetScrolling(TBool)
	CListBoxView::SetSelectionIndexesL(const CSelectionIndexArray *)
	CListBoxView::SetTextColor(TRgb)
	CListBoxView::SetViewRect(const TRect &)
	CListBoxView::SetVisibilityObserver(MListVisibilityObserver *)
	CListBoxView::TextColor()const
	CListBoxView::ToggleItemL(TInt)
	CListBoxView::TopItemIndex()const
	CListBoxView::UpdateSelectionL(TSelectionMode)
	CListBoxView::VScrollTo(TInt)
	CListBoxView::VScrollTo(TInt,TRect &)
	CListBoxView::VerticalMoveToItemL(TInt,TSelectionMode)
	CListBoxView::ViewRect()const
	CListBoxView::~CListBoxView()

Inherited Type Definitions
	CListBoxView::CSelectionIndexArray

Member Attribute Documentation

iColumnWidth

TInt

iColumnWidth

[protected]

Constructor & Destructor Documentation

CSnakingListBoxView ( )

IMPORT_C

CSnakingListBoxView

(

)

~CSnakingListBoxView ( )

IMPORT_C

~CSnakingListBoxView

(

)

Member Function Documentation

CalcBottomItemIndex ( )

IMPORT_C void

CalcBottomItemIndex

(

)

[virtual]

Reimplemented from CListBoxView::CalcBottomItemIndex()

Recalculates the index of the bottom item in the list by using the top item index and the size of the display.

This function is called by the owning list box control when either the size of the list box or the number of items in its model changes.

CalcDataWidth ( )

IMPORT_C void

CalcDataWidth

(

)

[virtual]

Reimplemented from CListBoxView::CalcDataWidth()

Recalculates the data width of this list box view from the item width of its list item drawer. This method is called directly by CEikListBox when the list box s size changes or when data is added.

CalcItemIndexFromRowAndColIndexes ( TInt &, TInt, TInt )

IMPORT_C void	CalcItemIndexFromRowAndColIndexes	(	TInt &	aItemIndex,
			TInt	aRowIndex,
			TInt	aColIndex
		)	const

CalcNewTopItemIndexSoItemIsVisible ( TInt )

IMPORT_C TInt

CalcNewTopItemIndexSoItemIsVisible

(

TInt

aItemIndex

)

const [virtual]

Reimplemented from CListBoxView::CalcNewTopItemIndexSoItemIsVisible(TInt)const

Calculates which item should be selected in order to make a particular item visible. Calling VScrollTo(CalcNewTopItemIndexSoItemIsVisible(idx)), for example, would make the item whose index is idx visible.

Parameter	Description
aItemIndex	The index of the new top item.

Returns: The item to be selected.

CalcRowAndColIndexesFromItemIndex ( TInt, TInt &, TInt & )

IMPORT_C void	CalcRowAndColIndexesFromItemIndex	(	TInt	aItemIndex,
			TInt &	aRowIndex,
			TInt &	aColIndex
		)	const

CalculateHScrollOffsetSoItemIsVisible ( TInt )

IMPORT_C TInt

CalculateHScrollOffsetSoItemIsVisible

(

TInt

aItemIndex

)

[virtual]

ClearUnusedItemSpace ( TInt, TInt )

IMPORT_C void	ClearUnusedItemSpace	(	TInt	aStartItemIndex,
			TInt	aEndItemIndex
		)	const [protected]

ColumnWidth ( )

TInt

ColumnWidth

(

)

const [inline]

Draw ( const TRect * )

IMPORT_C void

Draw

(

const TRect *

aClipRect = NULL

)

const [virtual]

Reimplemented from CListBoxView::Draw(const TRect *)const

Draws every visible item into the specified rectangle.

As implemented in CListBoxView, this function's argument is ignored and the internal viewing rectangle is used. See SetViewRect().

panic: EEikPanicListBoxNoModel Panics if the list box model for this class has not been defined.

Parameter	Description
aClipRect	The rectangle to draw into, this is ignored. Default value is NULL.

DrawColumnRange ( TInt, TInt )

IMPORT_C void	DrawColumnRange	(	TInt	aStartColIndex,
			TInt	aEndColIndex
		)	const [protected]

DrawItemRange ( TInt, TInt )

IMPORT_C void	DrawItemRange	(	TInt	aStartItemIndex,
			TInt	aEndItemIndex
		)	const [protected, virtual]

HScroll ( TInt )

IMPORT_C void

HScroll

(

TInt

aHScrollAmount

)

[virtual]

Reimplemented from CListBoxView::HScroll(TInt)

Scrolls horizontally by the specified number of pixels.

Parameter	Description
aHScrollAmount	The distance to scroll by in pixels. A negative value scrolls to the left, a positive value scrolls to the right.

ItemPos ( TInt )

IMPORT_C TPoint

ItemPos

(

TInt

aItemIndex

)

const [virtual]

Reimplemented from CListBoxView::ItemPos(TInt)const

Gets the on-screen position of an item.

Parameter	Description
aItemIndex	Index of an item.

Returns: Position of the item.

ItemSize ( TInt )

IMPORT_C TSize

ItemSize

(

TInt

aItemIndex = 0

)

const [virtual]

Reimplemented from CListBoxView::ItemSize(TInt)const

Gets the on-screen size of an item.

As implemented in CListBoxView, all items report the same size. The size returned may be larger than the width of the list box view, but will not be smaller.

Parameter	Description
aItemIndex	Index of an item. Default value is 0.

Returns: Size of the item.

MoveCursorL ( TCursorMovement, TSelectionMode )

IMPORT_C void	MoveCursorL	(	TCursorMovement	aCursorMovement,
			TSelectionMode	aSelectionMode
		)	[virtual]

Reimplemented from CListBoxView::MoveCursorL(TCursorMovement,TSelectionMode)

Moves the current item cursor in the specified direction. This function is called by CEikListBox in response to user input.

Parameter	Description
aCursorMovement	The cursor movement to apply.
aSelectionMode	The selection mode of the calling list box.

MoveToNextColumnL ( TSelectionMode )

IMPORT_C void

MoveToNextColumnL

(

TSelectionMode

aSelectionMode

)

[protected]

MoveToPreviousColumnL ( TSelectionMode )

IMPORT_C void

MoveToPreviousColumnL

(

TSelectionMode

aSelectionMode

)

[protected]

NumberOfItemsPerColumn ( )

IMPORT_C TInt

NumberOfItemsPerColumn

(

)

const [virtual]

NumberOfItemsThatFitInRect ( const TRect & )

IMPORT_C TInt

NumberOfItemsThatFitInRect

(

const TRect &

aRect

)

const [virtual]

Reimplemented from CListBoxView::NumberOfItemsThatFitInRect(const TRect &)const

Gets the number of items that will fit into a given rectangle.

Parameter	Description
aRect	The rectangle.

Returns: The number of items that will fit into the given rectangle.

ScrollToMakeItemVisible ( TInt )

IMPORT_C TBool

ScrollToMakeItemVisible

(

TInt

aItemIndex

)

[virtual]

Reimplemented from CListBoxView::ScrollToMakeItemVisible(TInt)

Scrolls vertically to make a particular item visible.

Parameter	Description
aItemIndex	The item to make visible.

Returns: ETrue if any scrolling was done, EFalse if no scrolling was necessary.

SetColumnWidth ( TInt )

IMPORT_C void

SetColumnWidth

(

TInt

aColumnWidth

)

SetItemHeight ( TInt )

IMPORT_C void

SetItemHeight

(

TInt

aItemHeight

)

[virtual]

Reimplemented from CListBoxView::SetItemHeight(TInt)

Sets the item height.

Parameter	Description
aItemHeight	New item height.

SetTopItemIndex ( TInt )

IMPORT_C void

SetTopItemIndex

(

TInt

aItemIndex

)

[virtual]

Reimplemented from CListBoxView::SetTopItemIndex(TInt)

Sets the item at the top of the view by its index in the list of all items. This function also invokes CalcBottomItemIndex().

panic: EEikPanicListBoxInvalidTopItemIndexSpecified Panics if the given index is not valid.

Parameter	Description
aItemIndex	Index of the item to start the view at.

UpdateHScrollOffsetBasedOnTopItemIndex ( )

IMPORT_C void

UpdateHScrollOffsetBasedOnTopItemIndex

(

)

[protected]

VisibleWidth ( const TRect & )

IMPORT_C TInt

VisibleWidth

(

const TRect &

aRect

)

const [virtual]

Reimplemented from CListBoxView::VisibleWidth(const TRect &)const

Gets the visible width of the specified rectangle in pixels. This function is called by CListBoxView itself on its own viewing rectangle.

Parameter	Description
aRect	The rectangle to get the visible width for.

Returns: Visible width of aRect.

XYPosToItemIndex ( TPoint, TInt & )

IMPORT_C TBool	XYPosToItemIndex	(	TPoint	aPosition,
			TInt &	aItemIndex
		)	const [virtual]

Reimplemented from CListBoxView::XYPosToItemIndex(TPoint,TInt &)const

Converts a pixel position into an item index.

The function returns ETrue and sets aItemIndex to the index of the item whose bounding box contains aPosition. Returns EFalse if no such item exists.

Parameter	Description
aPosition	A position relative to the origin of the list box control.
aItemIndex	Is set to the item at that position.

Returns: ETrue if there was an item at aPosition.