CColumnListBoxData Class Reference

#include <mw/eikclbd.h>

Link against: eikctl.lib

class CColumnListBoxData : public CListBoxData

Inherits from

CColumnListBoxData
- CListBoxData

Nested Classes and Structures

CColumnListBoxData::TColors

Public Member Functions
	~CColumnListBoxData()
IMPORT_C void	AboutToDrawHighlightAnim()
IMPORT_C CGraphicsContext::TTextAlign	ColumnAlignment(TInt)
IMPORT_C TInt	ColumnBaselinePos(TInt)
IMPORT_C const CFont *	ColumnFont(TInt)
IMPORT_C TInt	ColumnHorizontalGap(TInt)
IMPORT_C TBool	ColumnIsGraphics(TInt)
IMPORT_C TBool	ColumnIsNumber(TInt)
IMPORT_C TBool	ColumnIsOptional(TInt)
IMPORT_C TMargins	ColumnMargins(TInt)
IMPORT_C CGraphicsContext::TPenStyle	ColumnSeparatorStyle(TInt)
IMPORT_C TInt	ColumnTextClipGap(TInt)
IMPORT_C TInt	ColumnWidthPixel(TInt)
IMPORT_C CCoeControl *	Control()
void	CreateMarqueeControlL()
void	CreatePictographInterfaceL()
IMPORT_C TUint32	CurrentItemTextWasClipped()
TInt	CurrentMarqueeItemIndex()
virtual IMPORT_C void	Draw(const TListItemProperties &, CWindowGc &, const TDesC *, const TRect &, TBool, const TColors &)
IMPORT_C TBool	DrawHighlightAnim(CBitmapContext &, const TRect &)
void	DrawSimple(const TListItemProperties &, CWindowGc &, const TDesC *, const TRect &, TBool, const TColors &)
IMPORT_C void	EnableMarqueeL(TBool)
void	EnableStretching(const TBool)
void	FocusGained()
void	FocusLost()
IMPORT_C CFont *	Font(const TListItemProperties &, TInt)
TSize	GetSubCellIconSize(TInt)
void	HandleResourceChange(TInt)
IMPORT_C TBool	HasHighlightAnim()
IMPORT_C const CAknsEffectAnim *	HighlightAnim()
IMPORT_C CArrayPtr< CGulIcon > *	IconArray()
TBool	KineticScrollingEnabled()
IMPORT_C TInt	LastColumn()
IMPORT_C CAknLayoutData *	LayoutData()
IMPORT_C TBool	LayoutInit()
IMPORT_C TBool	MakeColumnRect(TInt, TRect &)
IMPORT_C CColumnListBoxData *	NewL()
void	ResetMarquee()
IMPORT_C void	ResetSLSubCellArray()
IMPORT_C const CFont *	RowAndColumnFont(TInt, TInt)
IMPORT_C TAknSeparatorLinePosition	SeparatorLinePosition()
IMPORT_C void	SetColumnAlignmentL(TInt, CGraphicsContext::TTextAlign)
IMPORT_C void	SetColumnBaselinePosL(TInt, TInt)
IMPORT_C void	SetColumnFontForRowL(TInt, TInt, const CFont *)
IMPORT_C void	SetColumnFontL(TInt, const CFont *)
IMPORT_C void	SetColumnHorizontalGapL(TInt, TInt)
IMPORT_C void	SetColumnMarginsL(TInt, TMargins)
IMPORT_C void	SetColumnSeparatorStyleL(TInt, CGraphicsContext::TPenStyle)
IMPORT_C void	SetColumnTextClipGapL(TInt, TInt)
IMPORT_C void	SetColumnUnderlined(TBitFlags32)
IMPORT_C void	SetColumnWidthPixelL(TInt, TInt)
IMPORT_C void	SetConditionalSubCellL(TInt, const TAknTextLineLayout &, TInt)
IMPORT_C void	SetControl(CCoeControl *)
void	SetCurrentItemIndex(TInt)
void	SetCurrentMarqueeItemIndex(TInt)
void	SetESSHighlightedTextColor(TRgb)
void	SetESSTextColor(TRgb)
IMPORT_C void	SetGraphicSubCellL(TInt, const TAknWindowLineLayout &)
IMPORT_C void	SetGraphicsColumnL(TInt, TBool)
IMPORT_C void	SetHighlightAnimBackgroundDrawer(MColumnListBoxAnimBackgroundDrawer *)
IMPORT_C void	SetIconArray(CArrayPtr< CGulIcon > *)
IMPORT_C void	SetItemCellSize(const TSize &)
IMPORT_C void	SetLayoutInit(TBool)
IMPORT_C void	SetListEndSkinStyle(const TAknsItemID *, const TRect &)
IMPORT_C void	SetMarqueeParams(const TInt, const TInt, const TInt)
IMPORT_C void	SetMarqueeParams(const TInt, const TInt, const TInt, const TInt)
IMPORT_C void	SetNumberColumnL(TInt, TBool)
IMPORT_C void	SetOptionalColumnL(TInt, TBool)
IMPORT_C void	SetSeparatorLinePosition(TAknSeparatorLinePosition)
void	SetSkinBackgroundContext(CAknsListBoxBackgroundControlContext *)
IMPORT_C void	SetSkinEnabledL(TBool)
IMPORT_C void	SetSkinHighlightFrame(const TAknsItemID , const TAknsItemID )
IMPORT_C void	SetSkinStyle(const TAknsItemID *, const TRect &)
IMPORT_C void	SetStretchableConditionalSubCellL(TInt, const TAknTextComponentLayout &, const TAknTextComponentLayout &, TInt, TInt)
IMPORT_C void	SetStretchableGraphicSubCellL(TInt, const TAknWindowComponentLayout &, const TAknWindowComponentLayout &)
IMPORT_C void	SetStretchableTextSubCellL(TInt, const TAknTextComponentLayout &, const TAknTextComponentLayout &)
IMPORT_C void	SetSubCellIconSize(TInt, TSize)
IMPORT_C void	SetTextSubCellL(TInt, const TAknTextLineLayout &)
void	SetupSkinContextL()
IMPORT_C MAknsControlContext *	SkinBackgroundContext()
IMPORT_C TBool	StretchingEnabled()
IMPORT_C void	SubCellsMightIntersect(const TBool)
TBool	UsesScalableLayoutData()

Protected Member Functions
	CColumnListBoxData()
IMPORT_C void	ConstructLD()
IMPORT_C void	ConstructLD(const TAknsItemID &)
IMPORT_C void	DrawText(CWindowGc &, const TRect &, const TDesC &, const TDesC &, const TInt, const CGraphicsContext::TTextAlign, const CFont &, const TBool, const TBool)

Inherited Attributes
	CListBoxData::iBoldFont
	CListBoxData::iBoldItalicFont
	CListBoxData::iItalicFont
	CListBoxData::iNormalFont
	CListBoxData::iSearchString

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()
	CListBoxData::Alignment()const
	CListBoxData::CListBoxData()
	CListBoxData::ConstructFontL(const CFont *,TFontStyle,CFontsWithStyle &)
	CListBoxData::ConstructL(const CFont *)
	CListBoxData::DrawItem(CWindowGc &,const TRect &,const TDesC &,const CFont &,const TInt,const CGraphicsContext::TTextAlign)const
	CListBoxData::Font(const TListItemProperties &)const
	CListBoxData::FontBoundValues()const
	CListBoxData::IsSearchString()const
	CListBoxData::NONSHARABLE_CLASS(CFontsWithStyle)
	CListBoxData::RegenerateFonts(CFontsWithStyle &,TInt)
	CListBoxData::SetAlignmentL(CGraphicsContext::TTextAlign)
	CListBoxData::SetFontHeight(TInt)
	CListBoxData::SetSearchStringL(const TDesC *)
	CListBoxData::SetSkinBackgroundControlContextL(MAknsControlContext *)
	CListBoxData::SetupGc(const TListItemProperties &,CWindowGc &)const
	CListBoxData::SkinBackgroundControlContext()const
	CListBoxData::UpdateFontBoundValues(const CFont &)
	CListBoxData::~CListBoxData()

Detailed Description

The CColumnListBoxData class handles the data required to draw a column list box.

The class performs drawing for CColumnListBoxItemDrawer. Columns are numbered from 0 from left to right, and extra column data can be set for each.

N.B.: The standard width of a column drawn by CColumnListListBoxData is 0 pixels, so at the very least a column width should be set for each column in a column list box.

This class is not intended for user derivation.

Constructor & Destructor Documentation

CColumnListBoxData ( )

IMPORT_C

CColumnListBoxData

(

)

[protected]

C++ default constructor.

~CColumnListBoxData ( )

IMPORT_C

~CColumnListBoxData

(

)

Destructor.

Member Function Documentation

AboutToDrawHighlightAnim ( )

IMPORT_C void

AboutToDrawHighlightAnim

(

)

const

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

Since: S60 3.0

ColumnAlignment ( TInt )

IMPORT_C CGraphicsContext::TTextAlign

ColumnAlignment

(

TInt

aColumn

)

const

Gets the text alignment for the specified column.

Parameter	Description
aColumn	The index of the column for which the alignment is obtained.

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

ColumnBaselinePos ( TInt )

IMPORT_C TInt

ColumnBaselinePos

(

TInt

aColumn

)

const

Gets column's baseline.

Parameter	Description
aColumn	target column.

Returns: Vertical position.

ColumnFont ( TInt )

IMPORT_C const CFont *

ColumnFont

(

TInt

aColumn

)

const

Gets font used by the column.

Parameter	Description
aColumn	Target column.

Returns: Used font.

ColumnHorizontalGap ( TInt )

IMPORT_C TInt

ColumnHorizontalGap

(

TInt

aColumn

)

const

Not used in S60.

ColumnIsGraphics ( TInt )

IMPORT_C TBool

ColumnIsGraphics

(

TInt

aColumn

)

const

Checks whether the column contains graphics.

Parameter	Description
aColumn	Target column.

Returns: ETrue if column contains graphics.

ColumnIsNumber ( TInt )

IMPORT_C TBool

ColumnIsNumber

(

TInt

aColumn

)

const

Checks if the column is a number.

Parameter	Description
aColumn	Target column.

Returns: ETrue if it is a number.

ColumnIsOptional ( TInt )

IMPORT_C TBool

ColumnIsOptional

(

TInt

aColumn

)

const

Checks whether the column is optional.

Parameter	Description
aColumn	Target column.

Returns: ETrue if the column is optional.

ColumnMargins ( TInt )

IMPORT_C TMargins

ColumnMargins

(

TInt

aColumn

)

const

Gets column's margins.

Parameter	Description
aColumn	Target column.

Returns: The columns margins.

ColumnSeparatorStyle ( TInt )

IMPORT_C CGraphicsContext::TPenStyle

ColumnSeparatorStyle

(

TInt

aColumn

)

const

Not used in S60.

ColumnTextClipGap ( TInt )

IMPORT_C TInt

ColumnTextClipGap

(

TInt

aSubCellIndex

)

const

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

Parameter	Description
aSubCellIndex	Index to target column.

Returns: TextClipGap.

ColumnWidthPixel ( TInt )

IMPORT_C TInt

ColumnWidthPixel

(

TInt

aColumn

)

const

Gets the specified column s width in pixels.

Parameter	Description
aColumn	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.

ConstructLD ( )

IMPORT_C void

ConstructLD

(

)

[protected]

A second phase constructor.

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

ConstructLD ( const TAknsItemID & )

IMPORT_C void

ConstructLD

(

const TAknsItemID &

aAnimationIID

)

[protected]

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

Since: 3.0

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

Control ( )

IMPORT_C CCoeControl *

Control

(

)

const

Gets CCoeControl for component.

Returns: Pointer to the used CCoeControl.

CreateMarqueeControlL ( )

void

CreateMarqueeControlL

(

)

Creates a marquee control for the CColumnListBoxData and redraw.

CreatePictographInterfaceL ( )

void

CreatePictographInterfaceL

(

)

Creates a pictograph interface for the CColumnListBoxData.

CurrentItemTextWasClipped ( )

IMPORT_C TUint32

CurrentItemTextWasClipped

(

)

const

Tells whether current item has clipped text cells

Since: S60 3.2

Returns: bitfield of clipped columns

CurrentMarqueeItemIndex ( )

TInt

CurrentMarqueeItemIndex

(

)

Gets current marquee item index.

Returns: Current marquee item index.

Draw ( const TListItemProperties &, CWindowGc &, const TDesC *, const TRect &, TBool, const TColors & )

IMPORT_C void	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.

Parameter	Description
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.

DrawHighlightAnim ( CBitmapContext &, const TRect & )

IMPORT_C TBool	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 }

Since: 3.1

Parameter	Description
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.

DrawSimple ( const TListItemProperties &, CWindowGc &, const TDesC *, const TRect &, TBool, const TColors & )

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

internal

DrawText ( CWindowGc &, const TRect &, const TDesC &, const TDesC &, const TInt, const CGraphicsContext::TTextAlign, const CFont &, const TBool, const TBool )

IMPORT_C void	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.

Since: S60 2.8

Parameter	Description
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.

EnableMarqueeL ( TBool )

IMPORT_C void

EnableMarqueeL

(

TBool

aEnable

)

Enables or disables the marquee.

Parameter	Description
aEnable	ETrue = On. EFalse = Off.

EnableStretching ( const TBool )

void

EnableStretching

(

const TBool

aEnabled

)

FocusGained ( )

void

FocusGained

(

)

FocusLost ( )

void

FocusLost

(

)

Called when the CColumnListBoxData is unselected. Informs the CColumnListBoxData extension that the focus has been lost.

Font ( const TListItemProperties &, TInt )

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

Gets the specified font for the specified column.

Parameter	Description
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.

GetSubCellIconSize ( TInt )

TSize

GetSubCellIconSize

(

TInt

aIndex

)

Gets subcell icon size.

Parameter	Description
aIndex	Index of the wanted subcell.

Returns: Size of the subcell.

HandleResourceChange ( TInt )

void

HandleResourceChange

(

TInt

aType

)

Handles changing of an resource. Only supports skin change.

Parameter	Description
aType	Defines the resource that has changed.

HasHighlightAnim ( )

IMPORT_C TBool

HasHighlightAnim

(

)

const

Since: 3.1

Returns: ETrue if highlight animation exists, EFalse otherwise.

HighlightAnim ( )

IMPORT_C const CAknsEffectAnim *

HighlightAnim

(

)

const

Gets the highlight animation .

Since: S60 3.0

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.

IconArray ( )

IMPORT_C CArrayPtr< CGulIcon > *

IconArray

(

)

const

Gets the icon array.

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

Returns: Pointer to the icon array.

KineticScrollingEnabled ( )

TBool

KineticScrollingEnabled

(

)

const

Returns ETrue if kinetic scrolling is enabled.

LastColumn ( )

IMPORT_C TInt

LastColumn

(

)

const

Gets the index of the last defined column.

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

LayoutData ( )

IMPORT_C CAknLayoutData *

LayoutData

(

)

const

Deprecated

Gives out layout data for separator line drawing.

Returns: Requested layout data.

LayoutInit ( )

IMPORT_C TBool

LayoutInit

(

)

const

Deprecated

Checks if the layout has been initialized.

Returns: ETrue if initialized.

MakeColumnRect ( TInt, TRect & )

IMPORT_C TBool	MakeColumnRect	(	TInt	aColumn,
			TRect &	aRect
		)

Gets the specified column s surrounding rectangle.

Parameter	Description
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.

NewL ( )

IMPORT_C 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.

ResetMarquee ( )

void

ResetMarquee

(

)

Resets marquee control.

ResetSLSubCellArray ( )

IMPORT_C void

ResetSLSubCellArray

(

)

RowAndColumnFont ( TInt, TInt )

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

Gets the font attached to the row and cell.

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

Returns: Font handle.

SeparatorLinePosition ( )

IMPORT_C TAknSeparatorLinePosition

SeparatorLinePosition

(

)

const

Gives out separator line position.

Returns: Separator position.

SetColumnAlignmentL ( TInt, CGraphicsContext::TTextAlign )

IMPORT_C void	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.

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

SetColumnBaselinePosL ( TInt, TInt )

IMPORT_C void	SetColumnBaselinePosL	(	TInt	aColumn,
			TInt	aPos
		)

Sets columns baseline position.

Parameter	Description
aColumn	Target column.
aPos	Wanted position.

SetColumnFontForRowL ( TInt, TInt, const CFont * )

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

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

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

SetColumnFontL ( TInt, const CFont * )

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

Sets column's font.

Parameter	Description
aColumn	Target column.
aFont	Wanted font.

SetColumnHorizontalGapL ( TInt, TInt )

IMPORT_C void	SetColumnHorizontalGapL	(	TInt	aColumn,
			TInt	aGap
		)

Not used in S60.

SetColumnMarginsL ( TInt, TMargins )

IMPORT_C void	SetColumnMarginsL	(	TInt	aColumn,
			TMargins	aMargins
		)

Sets column's margins.

Parameter	Description
aColumn	Target column.
aMargins	Wanted margins.

SetColumnSeparatorStyleL ( TInt, CGraphicsContext::TPenStyle )

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

Not used in S60.

SetColumnTextClipGapL ( TInt, TInt )

IMPORT_C void	SetColumnTextClipGapL	(	TInt	aSubCellIndex,
			TInt	aSize
		)

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

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

SetColumnUnderlined ( TBitFlags32 )

IMPORT_C void

SetColumnUnderlined

(

TBitFlags32

aUnderlinedColumns

)

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.

Since: S60 3.0

Parameter	Description
aUnderlinedColumns	Bitmask of columns to be underlined.

SetColumnWidthPixelL ( TInt, TInt )

IMPORT_C void	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.

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

SetConditionalSubCellL ( TInt, const TAknTextLineLayout &, TInt )

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

SetControl ( CCoeControl * )

IMPORT_C void

SetControl

(

CCoeControl *

aControl

)

Sets CCoeControl for current component.

Parameter	Description
aControl	Current listbox control instance, cannot be any other control.

SetCurrentItemIndex ( TInt )

void

SetCurrentItemIndex

(

TInt

aIndex

)

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.

Since: S60 2.6

Parameter	Description
aIndex	The new index for the current item.

SetCurrentMarqueeItemIndex ( TInt )

void

SetCurrentMarqueeItemIndex

(

TInt

aIndex

)

Sets the index for current marquee item.

Parameter	Description
aIndex	Item index.

SetESSHighlightedTextColor ( TRgb )

void

SetESSHighlightedTextColor

(

TRgb

aHighlightedTextColor

)

Sets text colour for highlighted text.

Parameter	Description
aHighlightedTextColor	Wanted colour.

SetESSTextColor ( TRgb )

void

SetESSTextColor

(

TRgb

aTextColor

)

Sets text colour.

Parameter	Description
aTextColor	Wanted colour.

SetGraphicSubCellL ( TInt, const TAknWindowLineLayout & )

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

SetGraphicsColumnL ( TInt, TBool )

IMPORT_C void	SetGraphicsColumnL	(	TInt	aColumn,
			TBool	aIsGraphics
		)

Sets whether the column shows graphics.

Parameter	Description
aColumn	Target column.
aIsGraphics	Wanted setting.

SetHighlightAnimBackgroundDrawer ( MColumnListBoxAnimBackgroundDrawer * )

IMPORT_C void

SetHighlightAnimBackgroundDrawer

(

MColumnListBoxAnimBackgroundDrawer *

aDrawer

)

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

Since: S60 3.0

Parameter	Description
aDrawer	New background drawer.

SetIconArray ( CArrayPtr< CGulIcon > * )

IMPORT_C void

SetIconArray

(

CArrayPtr< CGulIcon > *

aArray

)

Sets icon array.

Parameter	Description
aArray	Wanted icon collection .

SetItemCellSize ( const TSize & )

IMPORT_C void

SetItemCellSize

(

const TSize &

aSizeInPixels

)

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.

Since: S60 3.0

Parameter	Description
aSizeInPixels	New size in pixels for the Item cell.

SetLayoutInit ( TBool )

IMPORT_C void

SetLayoutInit

(

TBool

aValue

)

const

Deprecated

Sets the initialization .

Parameter	Description
aValue	Wanted value (ETrue = initialized).

SetListEndSkinStyle ( const TAknsItemID *, const TRect & )

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

Sets skin style for the end of the list.

Parameter	Description
aId	Wanted skins item ID.
aRect	Skin tile size.

SetMarqueeParams ( const TInt, const TInt, const TInt )

IMPORT_C void	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.

Since: S60 2.8

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

SetMarqueeParams ( const TInt, const TInt, const TInt, const TInt )

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

Customizes marquee default behaviour.

Since: S60 2.8

Parameter	Description
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.

SetNumberColumnL ( TInt, TBool )

IMPORT_C void	SetNumberColumnL	(	TInt	aColumn,
			TBool	aIsNumber
		)

Sets whether the column is a number.

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

SetOptionalColumnL ( TInt, TBool )

IMPORT_C void	SetOptionalColumnL	(	TInt	aColumn,
			TBool	aIsOptional
		)

Sets whether the column is optional.

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

SetSeparatorLinePosition ( TAknSeparatorLinePosition )

IMPORT_C void

SetSeparatorLinePosition

(

TAknSeparatorLinePosition

aPosition

)

Sets position of listbox line.

Parameter	Description
aPosition	Wanted position.

SetSkinBackgroundContext ( CAknsListBoxBackgroundControlContext * )

void

SetSkinBackgroundContext

(

CAknsListBoxBackgroundControlContext *

aContext

)

Sets background skin context. Changes ownership as well.

Parameter	Description
aContext	Wanted background skin control context.

SetSkinEnabledL ( TBool )

IMPORT_C void

SetSkinEnabledL

(

TBool

aEnabled

)

Reimplemented from CListBoxData::SetSkinEnabledL(TBool)

Enables/Disables skin.

Parameter	Description
aEnabled	Sets whether the skins are enable or disabled ETrue for enabling skins.

SetSkinHighlightFrame ( const TAknsItemID , const TAknsItemID )

IMPORT_C void	SetSkinHighlightFrame	(	const TAknsItemID *	aFrameId,
			const TAknsItemID *	aFrameCenterId
		)

Sets skin for the highlighted frame.

Parameter	Description
aFrameId	Wanted skin's item ID for the frame.
aFrameCenterId	Wanted skin's item ID for the center of the frame.

SetSkinStyle ( const TAknsItemID *, const TRect & )

IMPORT_C void	SetSkinStyle	(	const TAknsItemID *	aId,
			const TRect &	aTileRect
		)

Sets style for the skin fot list tiles.

Parameter	Description
aId	Wanted skins item ID.
aTileRect	Skin tile size.

SetStretchableConditionalSubCellL ( TInt, const TAknTextComponentLayout &, const TAknTextComponentLayout &, TInt, TInt )

IMPORT_C void	SetStretchableConditionalSubCellL	(	TInt	aSubCell,
			const TAknTextComponentLayout &	aNormalLayout,
			const TAknTextComponentLayout &	aStretchedLayout,
			TInt	aNormalSubCell,
			TInt	aStretchedSubCell
		)

SetStretchableGraphicSubCellL ( TInt, const TAknWindowComponentLayout &, const TAknWindowComponentLayout & )

IMPORT_C void	SetStretchableGraphicSubCellL	(	TInt	aSubCell,
			const TAknWindowComponentLayout &	aNormalLayout,
			const TAknWindowComponentLayout &	aStretchedLayout
		)

SetStretchableTextSubCellL ( TInt, const TAknTextComponentLayout &, const TAknTextComponentLayout & )

IMPORT_C void	SetStretchableTextSubCellL	(	TInt	aSubCell,
			const TAknTextComponentLayout &	aNormalLayout,
			const TAknTextComponentLayout &	aStretchedLayout
		)

SetSubCellIconSize ( TInt, TSize )

IMPORT_C void	SetSubCellIconSize	(	TInt	aIndex,
			TSize	aSize
		)

Sets the subcell icon size.

Since: S60 2.8

Parameter	Description
aIndex	Index of the sub cell.
aSize	Size of the sub cell icon.

SetTextSubCellL ( TInt, const TAknTextLineLayout & )

IMPORT_C void	SetTextSubCellL	(	TInt	aSubCell,
			const TAknTextLineLayout &	aTextLayout
		)

SetupSkinContextL ( )

void

SetupSkinContextL

(

)

Setup skin control context for handling background skins. if no skin control context is found one is created.

SkinBackgroundContext ( )

IMPORT_C MAknsControlContext *

SkinBackgroundContext

(

)

const

Gets background skin context.

Returns: Component's skin control context.

StretchingEnabled ( )

IMPORT_C TBool

StretchingEnabled

(

)

const

SubCellsMightIntersect ( const TBool )

IMPORT_C void

SubCellsMightIntersect

(

const TBool

aMightIntersect

)

UsesScalableLayoutData ( )

TBool

UsesScalableLayoutData

(

)

const