CColumnListBoxData Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Data Structures

Destructor.

C++ default constructor.

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:

aColumn

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

Returns:

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

Gets column's baseline.

Parameters:

aColumn

target column.

Returns:

Vertical position.

Gets font used by the column.

Parameters:

aColumn

Target column.

Returns:

Used font.

Not used in S60.

Checks whether the column contains graphics.

Parameters:

aColumn

Target column.

Returns:

ETrue if column contains graphics.

Checks if the column is a number.

Parameters:

aColumn

Target column.

Returns:

ETrue if it is a number.

Checks whether the column is optional.

Parameters:

aColumn

Target column.

Returns:

ETrue if the column is optional.

Gets column's margins.

Parameters:

aColumn

Target column.

Returns:

The columns margins.

Not used in S60.

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

Parameters:

aSubCellIndex

Index to target column.

Returns:

TextClipGap.

Gets the specified column’s width in pixels.

Parameters:

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.

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.

A second phase constructor.

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

Gets CCoeControl for component.

Returns:

Pointer to the used CCoeControl.

Creates a marquee control for the CColumnListBoxData and redraw.

Creates a pictograph interface for the CColumnListBoxData.

Tells whether current item has clipped text cells.

Returns:

bitfield of clipped columns

Gets current marquee item index.

Returns:

Current marquee item index.

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.

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.

internal

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.

Called when the CColumnListBoxData is unselected.

Informs the CColumnListBoxData extension that the focus has been lost.

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.

Handles changing of an resource.

Only supports skin change.

Parameters:

aType

Defines the resource that has changed.

Returns:

ETrue if highlight animation exists, EFalse otherwise.

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.

Gets the icon array.

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

Returns:

Pointer to the icon array.

Gets the index of the last defined column.

Returns:

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

Deprecated:

Returns:

Requested layout data.

Deprecated:

Returns:

ETrue if initialized.

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.

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.

Resets marquee control.

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.

Gives out separator line position.

Returns:

Separator position.

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.

Sets columns baseline position.

Parameters:

	aColumn	Target column.
	aPos	Wanted position.

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.

Sets column's font.

Parameters:

	aColumn	Target column.
	aFont	Wanted font.

Not used in S60.

Sets column's margins.

Parameters:

	aColumn	Target column.
	aMargins	Wanted margins.

Not used in S60.

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.

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.

Sets CCoeControl for current component.

Parameters:

aControl

Current listbox control instance, cannot be any other control.

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.

Sets the index for current marquee item.

Parameters:

aIndex

Item index.

Sets text colour for highlighted text.

Parameters:

aHighlightedTextColor

Wanted colour.

Sets text colour.

Parameters:

aTextColor

Wanted colour.

Sets whether the column shows graphics.

Parameters:

	aColumn	Target column.
	aIsGraphics	Wanted setting.

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.

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.

Deprecated:

Parameters:

aValue

Wanted value (ETrue = initialized).

Sets skin style for the end of the list.

Parameters:

	aId	Wanted skins item ID.
	aRect	Skin tile size.

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.

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.

Sets whether the column is a number.

Parameters:

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

Sets whether the column is optional.

Parameters:

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

Sets position of listbox line.

Parameters:

aPosition

Wanted position.

Sets background skin context.

Changes ownership as well.

Parameters:

aContext

Wanted background skin control context.

Enables/Disables skin.

Parameters:

aEnabled

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

Reimplemented from CListBoxData.

Sets skin for the highlighted frame.

Parameters:

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

Sets style for the skin fot list tiles.

Parameters:

	aId	Wanted skins item ID.
	aTileRect	Skin tile size.

Sets the subcell icon size.

Parameters:

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

Setup skin control context for handling background skins.

if no skin control context is found one is created.

Gets background skin context.

Returns:

Component's skin control context.