CColumnListBoxData Class Reference

IMPORT_C void CColumnListBoxData::AboutToDrawHighlightAnim

Destructor.

IMPORT_C CColumnListBoxData::CColumnListBoxData ( ) [protected]

C++ default constructor.

Member Function Documentation

IMPORT_C CGraphicsContext::TTextAlign CColumnListBoxData::ColumnAlignment

This method should be called before drawing animated highlight.

It will sync the animation with the background under the current highlight (only when current item index has changed).

Gets the text alignment for the specified column.

Parameters:

The index of the column for which the alignment is obtained.

Returns:: The text alignment for the specified column. The default is ELeft.

IMPORT_C TInt CColumnListBoxData::ColumnBaselinePos

Gets column's baseline.

Parameters:

IMPORT_C const CFont* CColumnListBoxData::ColumnFont

target column.

Returns:: Vertical position.

Gets font used by the column.

Parameters:

IMPORT_C TInt CColumnListBoxData::ColumnHorizontalGap

Returns:: Used font.

Not used in S60.

IMPORT_C TBool CColumnListBoxData::ColumnIsGraphics

Checks whether the column contains graphics.

Parameters:

IMPORT_C TBool CColumnListBoxData::ColumnIsNumber

Returns:: ETrue if column contains graphics.

Checks if the column is a number.

Parameters:

IMPORT_C TBool CColumnListBoxData::ColumnIsOptional

Returns:: ETrue if it is a number.

Checks whether the column is optional.

Parameters:

IMPORT_C TMargins CColumnListBoxData::ColumnMargins

Returns:: ETrue if the column is optional.

Gets column's margins.

Parameters:

IMPORT_C CGraphicsContext::TPenStyle CColumnListBoxData::ColumnSeparatorStyle

Returns:: The columns margins.

Not used in S60.

IMPORT_C TInt CColumnListBoxData::ColumnTextClipGap

Gets TextClipGap, the gap between words in a text clip, for the given column.

Parameters:

aSubCellIndex

Index to target column.

Returns:: TextClipGap.

IMPORT_C TInt CColumnListBoxData::ColumnWidthPixel

Gets the specified column’s width in pixels.

Parameters:

The index of the column for which the width is obtained.

Returns:: The specified column’s width in pixels. Zero is returned if no column exists at the specified index.

IMPORT_C void CColumnListBoxData::ConstructLD ( const TAknsItemID & aAnimationIID ) [protected]

Second phase constructor for subclasses that want to override highlight animation creation.

Parameters:

aAnimationIID Skin item identifier of the constructed animation. Passing KAknsIIDNone will disable highlight animation.

IMPORT_C void CColumnListBoxData::ConstructLD ( ) [protected]

A second phase constructor.

Highlight animation will be created by default (if it is provided by the skin).

IMPORT_C CCoeControl* CColumnListBoxData::Control

void CColumnListBoxData::CreateMarqueeControlL

Gets CCoeControl for component.

Returns:: Pointer to the used CCoeControl.

void CColumnListBoxData::CreatePictographInterfaceL

Creates a marquee control for the CColumnListBoxData and redraw.

IMPORT_C TUint32 CColumnListBoxData::CurrentItemTextWasClipped

Creates a pictograph interface for the CColumnListBoxData.

TInt CColumnListBoxData::CurrentMarqueeItemIndex

Tells whether current item has clipped text cells.

Returns:: bitfield of clipped columns

IMPORT_C void CColumnListBoxData::EnableMarqueeL

Gets current marquee item index.

Returns:: Current marquee item index.

virtual IMPORT_C void CColumnListBoxData::Draw	(	const TListItemProperties &	aItemProperties,
		CWindowGc &	aGc,
		const TDesC *	aText,
		const TRect &	aRect,
		TBool	aHighlight,
		const TColors &	aColors
	)	const `[virtual]`

Draws a single row.

The text aText is parsed into columns and is split using KColumnListSeparator. Text or bitmaps are drawn according to whether the column has been set as a graphical column (see SetGraphicsColumnL()). Column cells within the row are drawn from left to right.

Parameters:

	aItemProperties	The properties of each column in the row.
	aGc	The graphics context to draw into.
	aText	The text to parse and draw.
	aRect	Bounding rectangle for the entire row.
	aHighlight	`ETrue` to draw the item highlighted. `EFalse` otherwise.
	aColors	The colours to use if the item is highlighted.

IMPORT_C TBool CColumnListBoxData::DrawHighlightAnim	(	CBitmapContext &	aGc,
		const TRect &	aRect
	)	const

The preferred method for drawing highlight animation in derived classes.

Before calling this method you should check that highlight animation exists by calling HasHighlightAnim. In case of draw failure you should default to normal skinned highlight drawing. For example:

TBool drawOk = EFalse;

if( HasHighlightAnim() ) { drawOk = DrawHighlightAnim( gc, rect ); }

if( !drawOk ) { ...do normal skinned draw }

Parameters:

	aGc	Graphics context for blitting animation frame
	aRect	Target rect for blitting animation frame

Returns:: The draw status, ETrue if drawing was ok, EFalse otherwise.

void CColumnListBoxData::DrawSimple	(	const TListItemProperties &	aItemProperties,
		CWindowGc &	aGc,
		const TDesC *	aText,
		const TRect &	aRect,
		TBool	aHighlight,
		const TColors &	aColors
	)	const

internal

IMPORT_C void CColumnListBoxData::DrawText	(	CWindowGc &	aGc,
		const TRect &	aTextRect,
		const TDesC &	aText,
		const TDesC &	aClippedText,
		const TInt	aBaselineOffset,
		const CGraphicsContext::TTextAlign	aAlign,
		const CFont &	aFont,
		const TBool	aHighlight,
		const TBool	aIsTextClipped
	)	const `[protected]`

Wraps the text drawing functinality with & without marquee into one function, so that inherited classes can modify their own drawing behaviour more easily.

Parameters:

	aGc	Window graphics context controller.
	aTextRect	The area where the text is drawn.
	aText	The whole text. Not clipped.
	aClippedText	Clipped / truncated text.
	aBaselineOffset	An offset from the top of the box to the text baseline.
	aAlign	The text alignment mode (default is left, rather than centre or right).
	aFont	Wanted font.
	aHighlight	Does the current item have highlight.
	aIsTextClipped	Is the current item clipped.

Enables or disables the marquee.

Parameters:

aEnable ETrue = On. EFalse = Off.

void CColumnListBoxData::EnableStretching

void CColumnListBoxData::FocusGained

void CColumnListBoxData::FocusLost

TSize CColumnListBoxData::GetSubCellIconSize

Called when the CColumnListBoxData is unselected.

Informs the CColumnListBoxData extension that the focus has been lost.

IMPORT_C CFont* CColumnListBoxData::Font	(	const TListItemProperties &	aItemProperties,
		TInt	aColumn
	)	const

Gets the specified font for the specified column.

Parameters:

	aItemProperties	Whether the required font is: bold, italic, bold and italic or normal.
	aColumn	The index of the column for which the font is obtained.

Returns:: The specified column’s, specified font. Null, the default, if no font is set for the column.

Gets subcell icon size.

Parameters:

aIndex

Index of the wanted subcell.

Returns:: Size of the subcell.

void CColumnListBoxData::HandleResourceChange

Handles changing of an resource.

Only supports skin change.

Parameters:

aType

Defines the resource that has changed.

IMPORT_C TBool CColumnListBoxData::HasHighlightAnim

IMPORT_C const CAknsEffectAnim* CColumnListBoxData::HighlightAnim

Returns:: ETrue if highlight animation exists, EFalse otherwise.

IMPORT_C CArrayPtr<CGulIcon>* CColumnListBoxData::IconArray

Gets the highlight animation .

Returns:: CAknsEffectAnim that is used for when the highlighted list is drawn. May return NULL, in this case the normal skinned highlight should be drawn. This pointer is valid only during the draw -> you should not store it locally outside draw scope.

IMPORT_C TInt CColumnListBoxData::LastColumn

Gets the icon array.

These icons contain the bitmaps that are displayed in graphical columns.

Returns:: Pointer to the icon array.

IMPORT_C CAknLayoutData* CColumnListBoxData::LayoutData

Gets the index of the last defined column.

Returns:: The index of the last defined column or KErrNotFound if no column has been defined.

Gives out layout data for separator line drawing.

Deprecated:

Returns:: Requested layout data.

IMPORT_C TBool CColumnListBoxData::LayoutInit

Checks if the layout has been initialized.

Deprecated:

Returns:: ETrue if initialized.

IMPORT_C TBool CColumnListBoxData::MakeColumnRect	(	TInt	aColumn,
		TRect &	aRect
	)

Gets the specified column’s surrounding rectangle.

Parameters:

	aColumn	The index of the column for which the rectangle is obtained.
	aRect	On return contains the specified column’s rectangle.

Returns:: ETrue if successful. EFalse if a non-existent column was specified.

static IMPORT_C CColumnListBoxData* CColumnListBoxData::NewL ( ) [static]

Two-phased constructor.

Allocates and constructs a column list box data object.

Constructs an array in which the column data is held.

Returns:: New CColumnListBoxData.

void CColumnListBoxData::ResetMarquee

IMPORT_C void CColumnListBoxData::ResetSLSubCellArray

Resets marquee control.

IMPORT_C TAknSeparatorLinePosition CColumnListBoxData::SeparatorLinePosition

IMPORT_C const CFont* CColumnListBoxData::RowAndColumnFont	(	TInt	aRow,
		TInt	aColumn
	)	const

Gets the font attached to the row and cell.

Parameters:

	aRow	Index number of the row.
	aColumn	Index number of the column.

Returns:: Font handle.

IMPORT_C void CColumnListBoxData::SetColumnUnderlined

Gives out separator line position.

Returns:: Separator position.

IMPORT_C void CColumnListBoxData::SetColumnAlignmentL	(	TInt	aColumn,
		CGraphicsContext::TTextAlign	aAlign
	)

Sets the text alignment for the specified column.

If the column does not exist, it is added with the specified index to the array.

Parameters:

	aColumn	The index of the column for which alignment is set.
	aAlign	The text alignment to use. The default is `ELeft`.

IMPORT_C void CColumnListBoxData::SetColumnBaselinePosL	(	TInt	aColumn,
		TInt	aPos
	)

Sets columns baseline position.

Parameters:

	aColumn	Target column.
	aPos	Wanted position.

IMPORT_C void CColumnListBoxData::SetColumnFontForRowL	(	TInt	aRow,
		TInt	aColumn,
		const CFont *	aFont
	)

Sets the font attached to the cell for each row separately.

Parameters:

	aRow	Index number of the row.
	aColumn	Index number of the column.
	aFont	Font to be used.

IMPORT_C void CColumnListBoxData::SetColumnFontL	(	TInt	aColumn,
		const CFont *	aFont
	)

Sets column's font.

Parameters:

	aColumn	Target column.
	aFont	Wanted font.

IMPORT_C void CColumnListBoxData::SetColumnHorizontalGapL	(	TInt	aColumn,
		TInt	aGap
	)

Not used in S60.

IMPORT_C void CColumnListBoxData::SetColumnMarginsL	(	TInt	aColumn,
		TMargins	aMargins
	)

Sets column's margins.

Parameters:

	aColumn	Target column.
	aMargins	Wanted margins.

IMPORT_C void CColumnListBoxData::SetColumnSeparatorStyleL	(	TInt	aColumn,
		CGraphicsContext::TPenStyle	aStyle
	)

Not used in S60.

IMPORT_C void CColumnListBoxData::SetColumnTextClipGapL	(	TInt	aSubCellIndex,
		TInt	aSize
	)

Sets columns TextClipGap, the gap between words in a text clip.

Parameters:

	aSubCellIndex	Index of the target column.
	aSize	Wanted TextClipGap size.

Enables / disables underlining per text column, if and only if TListItemProperties also has underlining enabled.

If this method is not called and TListItemProperties has underlining enabled, drawing will revert to old style where only first text column will be underlined.

Parameters:

aUnderlinedColumns

Bitmask of columns to be underlined.

IMPORT_C void CColumnListBoxData::SetColumnWidthPixelL	(	TInt	aColumn,
		TInt	aWidth
	)

Sets the specified column’s width in pixels.

If the column does not exist, one is added at the specified index, with the specifed width.

Parameters:

	aColumn	The index of the column for which the width is to be set.
	aWidth	The width in pixels.

IMPORT_C void CColumnListBoxData::SetConditionalSubCellL	(	TInt	aSubCell,
		const TAknTextLineLayout &	aTextLayout,
		TInt	aAffectedSubCell
	)

IMPORT_C void CColumnListBoxData::SetControl

Sets CCoeControl for current component.

Parameters:

aControl

Current listbox control instance, cannot be any other control.

void CColumnListBoxData::SetCurrentItemIndex

Sets the current list item index.

Since S60 2.6 causes highlight animation tochange its background (only if the current item index changes). Do not call this method if the index is not the current item index.

Parameters:

aIndex

The new index for the current item.

void CColumnListBoxData::SetCurrentMarqueeItemIndex

Sets the index for current marquee item.

Parameters:

aIndex

Item index.

void CColumnListBoxData::SetESSHighlightedTextColor

TRgb

aHighlightedTextColor

void CColumnListBoxData::SetESSTextColor

Sets text colour for highlighted text.

Parameters:

aHighlightedTextColor

Wanted colour.

Sets text colour.

Parameters:

aTextColor

Wanted colour.

IMPORT_C void CColumnListBoxData::SetGraphicsColumnL	(	TInt	aColumn,
		TBool	aIsGraphics
	)

Sets whether the column shows graphics.

Parameters:

	aColumn	Target column.
	aIsGraphics	Wanted setting.

IMPORT_C void CColumnListBoxData::SetGraphicSubCellL	(	TInt	aSubCell,
		const TAknWindowLineLayout &	aGraphicLayout
	)

IMPORT_C void CColumnListBoxData::SetHighlightAnimBackgroundDrawer

MColumnListBoxAnimBackgroundDrawer *

aDrawer

IMPORT_C void CColumnListBoxData::SetIconArray

Sets the observer for overriding default highlight input layer drawing functionality.

Note that you should still call AboutToDrawHighlightAnim (it will call the observer if it is set).

Parameters:

aDrawer

New background drawer.

CArrayPtr< CGulIcon > *

aArray

IMPORT_C void CColumnListBoxData::SetItemCellSize

Sets icon array.

Parameters:

aArray

Wanted icon collection .

Changes item cell size & resizes highlight animation.

Called by list when item cell size changes. If you are using non-standard highlight sizes make sure to sync the list item cell size.

Parameters:

aSizeInPixels

New size in pixels for the Item cell.

IMPORT_C void CColumnListBoxData::SetLayoutInit

Deprecated:

Sets the initialization .

Parameters:

aValue Wanted value (ETrue = initialized).

IMPORT_C void CColumnListBoxData::SetListEndSkinStyle	(	const TAknsItemID *	aId,
		const TRect &	aRect
	)

Sets skin style for the end of the list.

Parameters:

	aId	Wanted skins item ID.
	aRect	Skin tile size.

IMPORT_C void CColumnListBoxData::SetMarqueeParams	(	const TInt	aLoops,
		const TInt	aScrollAmount,
		const TInt	aScrollDelay,
		const TInt	aInterval
	)

Customizes marquee default behaviour.

Parameters:

	aLoops	Max number of loops to be executed.
	aScrollAmount	The amount of pixels scrolled per iteration.
	aScrollDelay	The interval between iterations.
	aInterval	The interval between frame updates.

IMPORT_C void CColumnListBoxData::SetMarqueeParams	(	const TInt	aLoops,
		const TInt	aScrollAmount,
		const TInt	aScrollDelay
	)

Customizes marquee default behaviour.

Use this before enabling marquee ( EnableMarqueeL() ), otherwise marquee behaviour will change during animation.

Parameters:

	aLoops	Max number of loops to be executed.
	aScrollAmount	The amount of pixels scrolled per iteration.
	aScrollDelay	The interval between iterations.

IMPORT_C void CColumnListBoxData::SetNumberColumnL	(	TInt	aColumn,
		TBool	aIsNumber
	)

Sets whether the column is a number.

Parameters:

	aColumn	Target columun.
	aIsNumber	Wanted setting. `ETrue` if it is a number.

IMPORT_C void CColumnListBoxData::SetOptionalColumnL	(	TInt	aColumn,
		TBool	aIsOptional
	)

Sets whether the column is optional.

Parameters:

	aColumn	Target column.
	aIsOptional	Wanted setting, `ETrue` if column is optional.

IMPORT_C void CColumnListBoxData::SetSeparatorLinePosition

TAknSeparatorLinePosition

aPosition

void CColumnListBoxData::SetSkinBackgroundContext

Sets position of listbox line.

Parameters:

aPosition

Wanted position.

CAknsListBoxBackgroundControlContext *

aContext