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

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

Parameters:

aAnimationIID

Skin ItemID of the constructed animation. Passing KAknsIIDNone will disable highlight animation.

Second phase constructor.

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

Ability for a skin subsystem to access Mop chain through current listbox control.

Returns:

Current listbox instance or NULL.

Creates marquee control.

Called by the listbox.

Creates pictograph interface.

Only effective in Japanese variant. Called by the listbox.

Tells whether current item has clipped text cells.

Returns:

bitfield of clipped subcells

Gets the current list item index that is / was drawn by marquee.

Returns:

Index of the item that is / was drawn by marquee.

From CListBoxData.

Draw() is the most important method in CEikFormattedCellListBoxData. This is the only method that needs to be implemented in this class and it draws the whole list item.

Parameters:

	aProperties	Properties attached to the list item.
	aGc	Graphics Context used for drawing the list item.
	aText	A text string describing the list item cells.
	aRect	The area of the screen for the whole list item.
	aHighlight	Whether the list item is selected.
	aColors	The colours used for drawing the item.

Renders a default animated highlight.

Parameters:

	aGc	Graphics context used for drawing.
	aItemRect	the area of the screen for drawing.
	aHighlight	If ETrue highlight is rendered if EFalse, nothing is done.

Main drawing algorithm used for drawing S60 list item.

Draw() method should call this method after clearing the list item area and drawing the highlight.

Parameters:

	aProperties	Properties attached to the list item.
	aGc	Graphics Context used for drawing the list item.
	aText	A text string describing the list item cells.
	aRect	The area of the screen for the whole list item.
	aHighlight	Whether the list item is selected.
	aColors	The colors used for drawing the item.

Panic:

EAknPanicFormattedCellListInvalidBitmapIndex The defined bitmap index is invalid.

Panic:

EAknPanicOutOfRange The defined index is out of the range.

Draws list items.

Parameters:

	aProperties	Properties attached to the list item.
	aGc	Graphics Context used for drawing the list item.
	aText	A text string describing the list item cells.
	aRect	The area of the screen for the whole list item.
	aHighlight	Whether the list item is selected.
	aColors	The colors used for drawing the item.

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.

Draws a popup frame.

Parameters:

aGc

Graphics context used for drawing.

Renders a popup animated highlight.

Parameters:

	aGc	Graphics context used for drawing.
	aItemRect	the area of the screen for drawing.
	aHighlight	If ETrue highlight is rendered if EFalse, nothing is done.

Renders a settings animated highlight.

Parameters:

	aGc	Graphics context used for drawing.
	aItemRect	the area of the screen for drawing.
	aHighlight	If ETrue highlight is rendered if EFalse, nothing is done.

Enables or disables marquee.

Parameters:

aEnable

ETrue if On, EFalse if Off.

Gets list box extension, which is used for adding more funtionality to list boxes without destroying compatibility with previous versions.

Returns:

Pointer to the list box extension.

Gets list box extension, which is used for adding more funtionality to list boxes without destroying compatibility with previous versions.

Returns:

Pointer to the list box extension.

Function that is called when the owning control has gained the focus.

Causes that animation is continued because the control is visible and focused.

Function that is called when the owning control has lost the focus.

Causes the animation to pause, even if the control is partially visible.

Font access to the font used in subcell.

Parameters:

	aItemProperties	Not used in code.
	aSubCellIndex	Index number of the subcell.

Returns:

Font used in subcell.

Gets the size of the subcell's icon.

Handles the skin change situation.

Causes change of animation.

Parameters:

aType

Type of resource change.

Returns:

ETrue if highlight animation exists, EFalse otherwise.

Gets animation used for drawing the list highlight.

May return NULL, in which 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.

Returns:

Animation used for drawing the list highlight.

Gets the icon array used when drawing bitmaps for the listbox items.

Checks if the list is transparent and drawing the background that would fall behind it.

Returns:

EFalse if transparent, ETrue otherwise.

Determines if marquee is on.

Returns:

Flag indicating if marquee is on (ETrue on, EFalse off)

Is the listbox drawing the background behind the scrollbar or not.

Returns:

ETrue if background is drawn after scrollbar, EFalse otherwise.

Deprecated:

Returns:

Layout data.

Deprecated:

Two-phased constructor.

Returns:

Pointer to a new formatted cell listbox data object.

Reimplemented in CSettingItemEditingListBoxData, CFormGraphicListBoxData, CPopupFormattedListBoxData, and CFormattedCellGridData.

Resets the marquee animation data.

Gets RespectFocus flag.

Returns:

RespectFocus flag. ETrue if list item highlights are only shown when the list is has been focused on.

Gets font attached to the row and cell.

Parameters:

	aRow	Index number of the row.
	aSubCellIndex	Index number of the subcell.

Returns:

Font handle.

Gets separator line position.

Returns:

Position of separator line.

Modify properties of the skin context (background).

Parameters:

	aId	Skin background identifier.
	aRect	Skin background rectangle.

Support for new layouts.

Ability for a skin subsystem to access mop chain through current listbox control.

Parameters:

aControlOrNull

Current listbox instance or NULL. Cannot be other control than the current listbox!

Sets the current list item index (not for marquee).

Since Symbian 3.0 causes highlight animation to change its background (only if the current item index changes). Don't call this method if the index is not the current item index.

Parameters:

aIndex

Index number of list item.

Sets the current list item index that was drawn by marquee.

Parameters:

aIndex

Index of list item.

Enables or disables transparency effect i.e.

does the listbox draw its own background or not.

Parameters:

aDrawBackground

EFalse enables transparency, ETrue disables.

Enables or disables drawing background after scrollbar.

Parameters:

aDrawBackground

Default is ETrue which means that Scrollbar is drawn first.

Set a highlighted text color if enhanced skin support is available.

Sets a text color if enhanced skin support is available.

Sets whether drawing algorithm considers the text string in list item as unicode text string displayable on the screen, or as string representation of an index to icon array.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aIsGraphics	ETrue if graphics cell, EFalse if text cell.

Set window line layout for the defined sub cell.

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

Highlight animation drawer.

SetIconArray sets the icon array used when drawing bitmaps.

The array can be modified (no need to call this method when modifying), even in MdcaPoint() or MdcaCount() methods of MDesCArray class. See also CTextListBoxModel::SetItemTextArray().

The most common way to crash a listbox is by forgetting to call this method, or the list item string for graphics cell is not an index of a bitmap.

Parameters:

aArray

Pointer to the icon array.

Sets the icon array used when drawing bitmaps.

The array can be modified (no need to call this method when modifying), even in MdcaPoint() or MdcaCount() methods of MDesCArray class. See also CTextListBoxModel::SetItemTextArray().

The most common way to crash a listbox is by forgetting to call this method, or the list item string for graphics cell is not an index of a bitmap.

Parameters:

aArray

Pointer to the icon array.

Changes item cell size and 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:

aSize

New cell size.

Deprecated:

Modify properties of the skin context (list ending)*.

Parameters:

	listEndId	List ending skin background identifier.
	aRect	List ending background area from LAF.

Customizes marquee default behavior.

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

Parameters:

	aLoops	Max number of loops to be executed (default 1).
	aScrollAmount	The amount of pixels scrolled per frame (default 6).
	aScrollDelay	The delay between each loop (in microseconds, default 1000000 microseconds).
	aInterval	The interval between frame updates after the initial delay, in microseconds.

Sets whether drawing algorithm always draws the cell.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aIsNotAlwaysDrawn	If ETrue, empty string disables cell.

Sets whether the cell is used for numbers.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aIsNumberCell	New value for the flag.

Sets RespectFocus flag.

Parameters:

aBool

Value of RespectFocus flag. ETrue means that the list item highlight is only shown if list is focused on.

Sets position of listbox separator line.

Parameters:

aPosition

Position in which separator line is placed.

Sets whether skins are enabled on this list.

The default value is determined from global setting from CAknAppUi.

Parameters:

aEnabled

If ETrue skins are set enabled. If EFalse skins are set disabled.

Reimplemented from CListBoxData.

Set list higlight skin style.

Parameters:

	aFrameId	The id for the frame.
	aFrameCenterId	The id for the frame center.

Modify position of the parent for list default context.

Parameters:

aPos

The new position.

Set popup skin style.

Parameters:

	aFrameId	The id for the frame.
	aFrameCenterId	The id for the frame center.

Set popup skin frame position.

Parameters:

	aOuterRect	Outer position of the frame.
	aInnerRect	Inner position of the frame.

Modify properties of the skin context (AB-column).

Parameters:

	aId	Skin background identifier.
	aTileRect	Skin background area from LAF.

Sets the alignment attached to the cell.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aAlign	Alignment that is attached to the cell

Sets baseline position from top of the cell.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aPos	Position which is set for the item.

Sets colours attached to the cell.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aColors	Text and background colors.

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

Parameters:

	aRowIndex	Row, which subcells are to be changed.
	aSubCellIndex	Index number of the subcell.
	aFont	Font to be used.

Sets the font attached to the cell.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aFont	Font to attach to the cell.

Sets the size of the subcell's icon.

Sets margins for the content inside the cell.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aMargins	Margins for the content inside the cell.

Sets cell position inside an item.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aPosition	New position for cell.

Sets whether vertical line is drawn to the right side of the cell.

Parameters:

	aSubCell	Index number of the subcell.
	aStyle	Style of a pen used to draw a line for the right side of the cell.

Sets cell size in pixels.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aSize	Cell size.

Sets the amount of pixels truncation grows a text element.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aGap	The amount of pixels that are required for growing the text element when it is truncated.

Enables or disables underlining per text subcell 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 subcell will be underlined.

Parameters:

aUnderlinedCells

Bitmask of cells to be underlined.

Support for new layouts.

Set text line layout for the defined sub cell.

Modifies whether the cell can overlap with one of the previous cells.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aIsTransparent	ETrue if transparent, EFalse if not.

Create and set the defaul skin context.

Needed by the dynamic skin support.

Disables logical-to-visual conversion in subcells between indexes.

Parameters:

	aFirstIndex	First subcell not to use logical-to-visual conversion.
	aSecondIndex	Last subcell not to use logical-to-visual conversion.

Access to the background context of the listbox.

Returns:

Skin background context.

SkinEnabled checks whether skins are enabled on this list.

Returns:

ETrue if enabled, EFalse if disabled.

Gets the alignment attached to the cell.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

Alignment of the text.

Gets baseline position from top of the cell.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

Baseline y-position.

Gets colours attached to the cell.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

Text and background colors.

Gets font attached to the cell.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

Handle to the attached font.

Checks whetherdrawing algorithm considers the text string in list item as unicode text string displayable on the screen, or as string representation of an index to icon array.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

ETrue if graphics cell, EFalse if text cell.

Checks whether drawing algorithm always draws the cell or whether empty string in list item can disable the drawing of the cell.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

ETrue when empty string disables cell, EFalse if always drawn.

Checks whether the cell is used for numbers.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

ETrue if enabled, EFalse if disabled.

Determines whether this cell can overlap with one of the previous cells.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

ETrue if cell overlaps another one, EFalse if cell allocates area from other cells.

Gets margins used for the content inside the cell.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

Margins in pixels.

Gets cell position inside an item.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

Cell position.

Checks whether vertical line is drawn to the right side of the cell.

Parameters:

aColumn

Index number of the subcell.

Returns:

Style of pen used to draw a line for the right side of the cell.

Gets cell size in pixels.

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

Cell size.

Gets the amount of pixels text margins is grown if it is truncated.

This is usually very small number used to make the layout look more balanced when text is truncated. (the glyph used for truncation is almost empty and on narrow text elements, it looks odd if the truncated text element is exactly same size as non-truncated version.)

Parameters:

aSubCellIndex

Index number of the subcell.

Returns:

Amount of pixels that are used for growing the text margins in truncation.

enables certain highlight skinning for radibutton / checkbox set style lists

should be used only by avkon internally

Enable or disable logical to visual reordering in listbox data text drawing.

By default, it is enabled. This has any effect only when bidirectional text is rendered.

If you convert text to visual order prior to passing it to the listbox (for example by wrapping text to lines with methods in AknBidiTextUtils), then you should disable conversion in listbox by calling this method.

Parameters:

aUseConversion

Enable (ETrue) or disable (EFalse) conversion.

Checks if the list box uses scalable layouts.

Indicates if sub cell is using its own colors rather than common colors.

Parameters:

aSubCell

Index number of the subcell.

Returns:

Boolean indicating whether own colors enabled. ETrue enabled, EFalse disabled.