CFormattedCellListBoxData Class Reference

IMPORT_C void CFormattedCellListBoxData::AboutToDrawHighlightAnim

Destructor.

IMPORT_C CFormattedCellListBoxData::CFormattedCellListBoxData ( ) [protected]

C++ default constructor.

Member Function Documentation

IMPORT_C CCoeControl* CFormattedCellListBoxData::Control

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

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

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.

IMPORT_C void CFormattedCellListBoxData::ConstructLD ( ) [protected]

Second phase constructor.

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

void CFormattedCellListBoxData::CreateMarqueeControlL

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

Returns:: Current listbox instance or NULL.

void CFormattedCellListBoxData::CreatePictographInterfaceL

Creates marquee control.

Called by the listbox.

IMPORT_C TUint32 CFormattedCellListBoxData::CurrentItemTextWasClipped

Creates pictograph interface.

Only effective in Japanese variant. Called by the listbox.

TInt CFormattedCellListBoxData::CurrentMarqueeItemIndex

Tells whether current item has clipped text cells.

Returns:: bitfield of clipped subcells

void CFormattedCellListBoxData::DrawPopupFrame

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

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

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

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.

void CFormattedCellListBoxData::DrawDefaultHighlight	(	CWindowGc &	aGc,
		const TRect &	aItemRect,
		TBool	aHighlight
	)	const

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.

IMPORT_C void CFormattedCellListBoxData::DrawFormatted	(	TListItemProperties	aProperties,
		CWindowGc &	aGc,
		const TDesC *	aText,
		const TRect &	aRect,
		TBool	aHighlight,
		const TColors &	aColors
	)	const `[protected]`

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.

void CFormattedCellListBoxData::DrawFormattedSimple	(	TListItemProperties &	aProperties,
		CWindowGc &	aGc,
		const TDesC *	aText,
		const TRect &	aRect,
		TBool	aHighlight,
		const TColors &	aColors
	)	const `[protected]`

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.

IMPORT_C TBool CFormattedCellListBoxData::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.

Draws a popup frame.

Parameters:

aGc

Graphics context used for drawing.

void CFormattedCellListBoxData::DrawPopupHighlight	(	CWindowGc &	aGc,
		const TRect &	aItemRect,
		TBool	aHighlight
	)	const

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.

void CFormattedCellListBoxData::DrawSettingHighlight	(	CWindowGc &	aGc,
		const TRect &	aItemRect,
		TBool	aHighlight
	)	const

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.

IMPORT_C void CFormattedCellListBoxData::EnableMarqueeL

Enables or disables marquee.

Parameters:

aEnable ETrue if On, EFalse if Off.

void CFormattedCellListBoxData::EnableStretching

CFormattedCellListBoxDataExtension* CFormattedCellListBoxData::Extension ( ) const [protected]

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.

CFormattedCellListBoxDataExtension* CFormattedCellListBoxData::Extension ( ) [protected]

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.

void CFormattedCellListBoxData::FocusGained

void CFormattedCellListBoxData::FocusLost

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

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

TSize CFormattedCellListBoxData::GetSubCellIconSize

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

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

IMPORT_C CFont* CFormattedCellListBoxData::Font	(	const TListItemProperties &	aItemProperties,
		TInt	aSubCellIndex
	)	const

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.

void CFormattedCellListBoxData::HandleResourceChange

Handles the skin change situation.

Causes change of animation.

Parameters:

aType

Type of resource change.

IMPORT_C TBool CFormattedCellListBoxData::HasHighlightAnim

void CFormattedCellListBoxData::HideSecondRow

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

IMPORT_C const CAknsEffectAnim* CFormattedCellListBoxData::HighlightAnim

IMPORT_C CArrayPtr<CGulIcon>* CFormattedCellListBoxData::IconArray

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.

TBool CFormattedCellListBoxData::IsBackgroundDrawingEnabled

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

IMPORT_C TBool CFormattedCellListBoxData::IsMarqueeOn

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

Returns:: EFalse if transparent, ETrue otherwise.

TBool CFormattedCellListBoxData::IsScrollbarBackgroundDrawingEnabled

Determines if marquee is on.

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

IMPORT_C CAknLayoutData* CFormattedCellListBoxData::LayoutData

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

Returns:: ETrue if background is drawn after scrollbar, EFalse otherwise.

Gets layout data needed for separator lines drawing.

Deprecated:

Returns:: Layout data.

IMPORT_C TBool CFormattedCellListBoxData::LayoutInit

Gets LayOutInit flag used for drawing separator lines in lists.

Deprecated:

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

Two-phased constructor.

Returns:: Pointer to a new formatted cell listbox data object.

Reimplemented in CSettingItemEditingListBoxData, CFormGraphicListBoxData, CPopupFormattedListBoxData, and CFormattedCellGridData.

void CFormattedCellListBoxData::ResetMarquee

void CFormattedCellListBoxData::ResetSLSubCellArray

Resets the marquee animation data.

IMPORT_C TBool CFormattedCellListBoxData::RespectFocus

TBool CFormattedCellListBoxData::SecondRowHidden

Gets RespectFocus flag.

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

IMPORT_C const CFont* CFormattedCellListBoxData::RowAndSubCellFont	(	TInt	aRow,
		TInt	aSubCellIndex
	)	const

Gets font attached to the row and cell.

Parameters:

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

Returns:: Font handle.

IMPORT_C TAknSeparatorLinePosition CFormattedCellListBoxData::SeparatorLinePosition

IMPORT_C void CFormattedCellListBoxData::SetControl

Gets separator line position.

Returns:: Position of separator line.

IMPORT_C void CFormattedCellListBoxData::SetBackgroundSkinStyle	(	const TAknsItemID *	aId,
		const TRect &	aRect
	)

Modify properties of the skin context (background).

Parameters:

	aId	Skin background identifier.
	aRect	Skin background rectangle.

void CFormattedCellListBoxData::SetClippedByWrap	(	TUint32	aClippedCells,
		TBool	aUseClippedByWrap
	)

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

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!

void CFormattedCellListBoxData::SetCurrentItemIndex

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:

Index number of list item.

void CFormattedCellListBoxData::SetCurrentlyDrawnItemIndex

void CFormattedCellListBoxData::SetCurrentMarqueeItemIndex

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

Parameters:

IMPORT_C void CFormattedCellListBoxData::SetDrawBackground

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.

void CFormattedCellListBoxData::SetDrawScrollbarBackground

Enables or disables drawing background after scrollbar.

Parameters:

aDrawBackground Default is ETrue which means that Scrollbar is drawn first.

void CFormattedCellListBoxData::SetESSHighlightedTextColor

TAknsQsnTextColorsIndex

void CFormattedCellListBoxData::SetESSTextColor

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

TAknsQsnTextColorsIndex

IMPORT_C void CFormattedCellListBoxData::SetHighlightAnimBackgroundDrawer

Sets a text color if enhanced skin support is available.

IMPORT_C void CFormattedCellListBoxData::SetGraphicsSubCellL	(	TInt	aSubCellIndex,
		TBool	aIsGraphics
	)

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.

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

Set window line layout for the defined sub cell.

MListBoxAnimBackgroundDrawer *

aDrawer

Highlight animation drawer.

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

IMPORT_C void CFormattedCellListBoxData::SetIconArray

CArrayPtr< CGulIcon > *

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:

Pointer to the icon array.

IMPORT_C void CFormattedCellListBoxData::SetIconArrayL

CArrayPtr< CGulIcon > *

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:

Pointer to the icon array.

IMPORT_C void CFormattedCellListBoxData::SetItemCellSize

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.

IMPORT_C void CFormattedCellListBoxData::SetLayoutInit

Deprecated:

Sets LayOutInit flag used for drawing separator lines in lists.

IMPORT_C void CFormattedCellListBoxData::SetListEndSkinStyle	(	const TAknsItemID *	listEndId,
		const TRect &	aRect
	)

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

Parameters:

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

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

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.

IMPORT_C void CFormattedCellListBoxData::SetNotAlwaysDrawnSubCellL	(	TInt	aSubCellIndex,
		TBool	aIsNotAlwaysDrawn
	)

Sets whether drawing algorithm always draws the cell.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetNumberCellL	(	TInt	aSubCellIndex,
		TBool	aIsNumberCell
	)

Sets whether the cell is used for numbers.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetRespectFocus

Sets RespectFocus flag.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetSeparatorLinePosition

TAknSeparatorLinePosition

aPosition

Position in which separator line is placed.

Sets position of listbox separator line.

Parameters:

aPosition

IMPORT_C void CFormattedCellListBoxData::SetSkinEnabledL

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.

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

Set list higlight skin style.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetSkinParentPos

Modify position of the parent for list default context.

Parameters:

aPos

The new position.

IMPORT_C void CFormattedCellListBoxData::SetSkinPopupFrame	(	const TAknsItemID *	aFrameId,
		const TAknsItemID *	aFrameCenterId
	)

Set popup skin style.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetSkinPopupFramePosition	(	const TRect &	aOuterRect,
		const TRect &	aInnerRect
	)

Set popup skin frame position.

Parameters:

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

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

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

Parameters:

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

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

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

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

IMPORT_C void CFormattedCellListBoxData::SetSubCellAlignmentL	(	TInt	aSubCellIndex,
		CGraphicsContext::TTextAlign	aAlign
	)

Sets the alignment attached to the cell.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetSubCellBaselinePosL	(	TInt	aSubCellIndex,
		TInt	aPos
	)

Sets baseline position from top of the cell.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetSubCellColorsL	(	TInt	aSubCellIndex,
		const TColors &	aColors
	)

Sets colours attached to the cell.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetSubCellFontForRowL	(	TInt	aRowIndex,
		TInt	aSubCellIndex,
		const CFont *	aFont
	)

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.

IMPORT_C void CFormattedCellListBoxData::SetSubCellFontL	(	TInt	aSubCellIndex,
		const CFont *	aFont
	)

Sets the font attached to the cell.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetSubCellIconSize	(	TInt	aIndex,
		TSize	aSize
	)

Sets the size of the subcell's icon.

IMPORT_C void CFormattedCellListBoxData::SetSubCellMarginsL	(	TInt	aSubCellIndex,
		TMargins	aMargins
	)

Sets margins for the content inside the cell.

Parameters:

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

IMPORT_C void CFormattedCellListBoxData::SetSubCellPositionL	(	TInt	aSubCellIndex,
		TPoint	aPosition
	)

Sets cell position inside an item.

Parameters:

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

void CFormattedCellListBoxData::SetSubCellRealSize	(	TInt	aSubCellIndex,
		TSize	aRealSize
	)	const

void CFormattedCellListBoxData::SetSubCellRealTextSize	(	TInt	aSubCellIndex,
		TSize	aRealSize
	)	const

IMPORT_C void CFormattedCellListBoxData::SetSubCellRightSeparatorStyleL	(	TInt	aSubCell,
		CGraphicsContext::TPenStyle	aStyle
	)

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.

IMPORT_C void CFormattedCellListBoxData::SetSubCellSizeL	(	TInt	aSubCellIndex,
		TSize	aSize
	)

Sets cell size in pixels.

Parameters:

	aSubCellIndex	Index number of the subcell.
	aSize	Cell size.

IMPORT_C void CFormattedCellListBoxData::SetSubCellTextClipGapL	(	TInt	aSubCellIndex,
		TInt	aGap
	)

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.

IMPORT_C void CFormattedCellListBoxData::SetSubcellUnderlined

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.

void CFormattedCellListBoxData::SetTextSubCellL	(	TInt	aSubCell,
		const TAknTextLineLayout &	aTextLayout
	)

Support for new layouts.

Set text line layout for the defined sub cell.

IMPORT_C void CFormattedCellListBoxData::SetTransparentSubCellL	(	TInt	aSubCellIndex,
		TBool	aIsTransparent
	)

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.

void CFormattedCellListBoxData::SetupSkinContextL

IMPORT_C MAknsControlContext* CFormattedCellListBoxData::SkinBackgroundContext

Create and set the defaul skin context.

Needed by the dynamic skin support.

void CFormattedCellListBoxData::SetWordWrappedSubcellIndices	(	TInt	aFirstIndex,
		TInt	aSecondIndex
	)

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.

IMPORT_C TBool CFormattedCellListBoxData::SkinEnabled

Access to the background context of the listbox.

Returns:: Skin background context.

TBool CFormattedCellListBoxData::StretchingEnabled

SkinEnabled checks whether skins are enabled on this list.

Returns:: ETrue if enabled, EFalse if disabled.

IMPORT_C CGraphicsContext::TTextAlign CFormattedCellListBoxData::SubCellAlignment

Gets the alignment attached to the cell.

Parameters:

IMPORT_C TInt CFormattedCellListBoxData::SubCellBaselinePos

Returns:: Alignment of the text.

Gets baseline position from top of the cell.

Parameters:

IMPORT_C const TColors& CFormattedCellListBoxData::SubCellColors

Returns:: Baseline y-position.

Gets colours attached to the cell.

Parameters:

IMPORT_C const CFont* CFormattedCellListBoxData::SubCellFont

Returns:: Text and background colors.

Gets font attached to the cell.

Parameters:

IMPORT_C TBool CFormattedCellListBoxData::SubCellIsGraphics

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:

IMPORT_C TBool CFormattedCellListBoxData::SubCellIsNotAlwaysDrawn

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:

IMPORT_C TBool CFormattedCellListBoxData::SubCellIsNumberCell

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

Checks whether the cell is used for numbers.

Parameters:

IMPORT_C TBool CFormattedCellListBoxData::SubCellIsTransparent

Returns:: ETrue if enabled, EFalse if disabled.

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

Parameters:

IMPORT_C TMargins CFormattedCellListBoxData::SubCellMargins

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:

IMPORT_C TPoint CFormattedCellListBoxData::SubCellPosition

Returns:: Margins in pixels.

Gets cell position inside an item.

Parameters:

TSize CFormattedCellListBoxData::SubCellRealSize

Returns:: Cell position.

TSize CFormattedCellListBoxData::SubCellRealTextSize

IMPORT_C CGraphicsContext::TPenStyle CFormattedCellListBoxData::SubCellRightSeparatorStyle

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

Parameters:

aColumn

IMPORT_C TSize CFormattedCellListBoxData::SubCellSize

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

Gets cell size in pixels.

Parameters:

void CFormattedCellListBoxData::SubCellsMightIntersect

Returns:: Cell size.

IMPORT_C TInt CFormattedCellListBoxData::SubCellTextClipGap

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:

void CFormattedCellListBoxData::ToggleDropShadows

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

TBool CFormattedCellListBoxData::UseHighlightIconSwapping

void CFormattedCellListBoxData::UseHighlightIconSwapping

enables certain highlight skinning for radibutton / checkbox set style lists

should be used only by avkon internally

IMPORT_C void CFormattedCellListBoxData::UseLogicalToVisualConversion

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.

void CFormattedCellListBoxData::UseScalableLayoutData

TBool CFormattedCellListBoxData::UsesScalableLayoutData