CColumnListBoxData Class Reference

class CColumnListBoxData : public CListBoxData

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.

Inherits from

Public Member Functions
~CColumnListBoxData()
IMPORT_C voidAboutToDrawHighlightAnim()
IMPORT_C CGraphicsContext::TTextAlignColumnAlignment(TInt)
IMPORT_C TIntColumnBaselinePos(TInt)
IMPORT_C const CFont *ColumnFont(TInt)
IMPORT_C TIntColumnHorizontalGap(TInt)
IMPORT_C TBoolColumnIsGraphics(TInt)
IMPORT_C TBoolColumnIsNumber(TInt)
IMPORT_C TBoolColumnIsOptional(TInt)
IMPORT_C TMarginsColumnMargins(TInt)
IMPORT_C CGraphicsContext::TPenStyleColumnSeparatorStyle(TInt)
IMPORT_C TIntColumnTextClipGap(TInt)
IMPORT_C TIntColumnWidthPixel(TInt)
IMPORT_C CCoeControl *Control()
voidCreateMarqueeControlL()
voidCreatePictographInterfaceL()
IMPORT_C TUint32CurrentItemTextWasClipped()
TInt CurrentMarqueeItemIndex()
IMPORT_C voidDraw(const TListItemProperties &, CWindowGc &, const TDesC *, const TRect &, TBool, const TColors &)
IMPORT_C TBoolDrawHighlightAnim(CBitmapContext &, const TRect &)
voidDrawSimple(const TListItemProperties &, CWindowGc &, const TDesC *, const TRect &, TBool, const TColors &)
IMPORT_C voidEnableMarqueeL(TBool)
voidEnableStretching(const TBool)
voidFocusGained()
voidFocusLost()
IMPORT_C CFont *Font(const TListItemProperties &, TInt)
TSize GetSubCellIconSize(TInt)
voidHandleResourceChange(TInt)
IMPORT_C TBoolHasHighlightAnim()
IMPORT_C const CAknsEffectAnim *HighlightAnim()
IMPORT_C CArrayPtr< CGulIcon > *IconArray()
TBool KineticScrollingEnabled()
IMPORT_C TIntLastColumn()
IMPORT_C CAknLayoutData *LayoutData()
IMPORT_C TBoolLayoutInit()
IMPORT_C TBoolMakeColumnRect(TInt, TRect &)
IMPORT_C CColumnListBoxData *NewL()
voidResetMarquee()
IMPORT_C voidResetSLSubCellArray()
IMPORT_C const CFont *RowAndColumnFont(TInt, TInt)
IMPORT_C TAknSeparatorLinePositionSeparatorLinePosition()
IMPORT_C voidSetColumnAlignmentL(TInt, CGraphicsContext::TTextAlign)
IMPORT_C voidSetColumnBaselinePosL(TInt, TInt)
IMPORT_C voidSetColumnFontForRowL(TInt, TInt, const CFont *)
IMPORT_C voidSetColumnFontL(TInt, const CFont *)
IMPORT_C voidSetColumnHorizontalGapL(TInt, TInt)
IMPORT_C voidSetColumnMarginsL(TInt, TMargins)
IMPORT_C voidSetColumnSeparatorStyleL(TInt, CGraphicsContext::TPenStyle)
IMPORT_C voidSetColumnTextClipGapL(TInt, TInt)
IMPORT_C voidSetColumnUnderlined(TBitFlags32)
IMPORT_C voidSetColumnWidthPixelL(TInt, TInt)
IMPORT_C voidSetConditionalSubCellL(TInt, const TAknTextLineLayout &, TInt)
IMPORT_C voidSetControl(CCoeControl *)
voidSetCurrentItemIndex(TInt)
voidSetCurrentMarqueeItemIndex(TInt)
voidSetESSHighlightedTextColor(TRgb)
voidSetESSTextColor(TRgb)
IMPORT_C voidSetGraphicSubCellL(TInt, const TAknWindowLineLayout &)
IMPORT_C voidSetGraphicsColumnL(TInt, TBool)
IMPORT_C voidSetHighlightAnimBackgroundDrawer(MColumnListBoxAnimBackgroundDrawer *)
IMPORT_C voidSetIconArray(CArrayPtr< CGulIcon > *)
IMPORT_C voidSetItemCellSize(const TSize &)
IMPORT_C voidSetLayoutInit(TBool)
IMPORT_C voidSetListEndSkinStyle(const TAknsItemID *, const TRect &)
IMPORT_C voidSetMarqueeParams(const TInt, const TInt, const TInt)
IMPORT_C voidSetMarqueeParams(const TInt, const TInt, const TInt, const TInt)
IMPORT_C voidSetNumberColumnL(TInt, TBool)
IMPORT_C voidSetOptionalColumnL(TInt, TBool)
IMPORT_C voidSetSeparatorLinePosition(TAknSeparatorLinePosition)
voidSetSkinBackgroundContext(CAknsListBoxBackgroundControlContext *)
IMPORT_C voidSetSkinEnabledL(TBool)
IMPORT_C voidSetSkinHighlightFrame(const TAknsItemID *, const TAknsItemID *)
IMPORT_C voidSetSkinStyle(const TAknsItemID *, const TRect &)
IMPORT_C voidSetStretchableConditionalSubCellL(TInt, const TAknTextComponentLayout &, const TAknTextComponentLayout &, TInt, TInt)
IMPORT_C voidSetStretchableGraphicSubCellL(TInt, const TAknWindowComponentLayout &, const TAknWindowComponentLayout &)
IMPORT_C voidSetStretchableTextSubCellL(TInt, const TAknTextComponentLayout &, const TAknTextComponentLayout &)
IMPORT_C voidSetSubCellIconSize(TInt, TSize)
IMPORT_C voidSetTextSubCellL(TInt, const TAknTextLineLayout &)
voidSetupSkinContextL()
IMPORT_C MAknsControlContext *SkinBackgroundContext()
IMPORT_C TBoolStretchingEnabled()
IMPORT_C voidSubCellsMightIntersect(const TBool)
TBool UsesScalableLayoutData()
Protected Member Functions
CColumnListBoxData()
IMPORT_C voidConstructLD()
IMPORT_C voidConstructLD(const TAknsItemID &)
IMPORT_C voidDrawText(CWindowGc &, const TRect &, const TDesC &, const TDesC &, const TInt, const CGraphicsContext::TTextAlign, const CFont &, const TBool, const TBool)
Private Member Functions
TInt AddActualFontL(const CFont *)
voidAddColumnL(TInt)
SColumn &At(TInt)
const SColumn &At(TInt)
voidBitBltColored(CWindowGc &, TBool, const CGulIcon *, TInt, TBool, const TRect &)
voidCheckIfSubCellsIntersect(TAknTextLineLayout *, TBool *, const TDesC &, const TRect &)
IMPORT_C TIntColumnEndX(TInt)
IMPORT_C TIntColumnX(TInt)
voidDoConstructL(const TAknsItemID &)
voidDrawHighLight(CWindowGc &, const TRect &, TBool, MAknsSkinInstance *)
voidDrawMarkingModeIcons(const TListItemProperties &, CWindowGc &, TRect &)
TBool FindColumnIndex(TInt &, TInt)
voidFindColumnIndexOrAddL(TInt &, TInt)
IMPORT_C voidSetColumnEndXL(TInt, TInt)
IMPORT_C voidSetColumnXL(TInt, TInt)
voidSetUnderlineStyle(TListItemProperties, CWindowGc &, TInt)
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()
Private Attributes
CArrayFix< SColumn > *iColumnArray
CColumnListBoxDataExtension *iExtension
Inherited Attributes
CListBoxData::iBoldFont
CListBoxData::iBoldItalicFont
CListBoxData::iItalicFont
CListBoxData::iNormalFont
CListBoxData::iSearchString

Constructor & Destructor Documentation

CColumnListBoxData()

IMPORT_CCColumnListBoxData()[protected]

C++ default constructor.

~CColumnListBoxData()

IMPORT_C~CColumnListBoxData()

Destructor.

Member Functions Documentation

AboutToDrawHighlightAnim()

IMPORT_C voidAboutToDrawHighlightAnim()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

AddActualFontL(const CFont *)

TInt AddActualFontL(const CFont *aBaseFont)[private]

Parameters

const CFont * aBaseFont

AddColumnL(TInt)

voidAddColumnL(TIntaColumn)[private]

Parameters

TInt aColumn

At(TInt)

SColumn &At(TIntaArrayIndex)[private]

Parameters

TInt aArrayIndex

At(TInt)

const SColumn &At(TIntaArrayIndex)const [private]

Parameters

TInt aArrayIndex

BitBltColored(CWindowGc &, TBool, const CGulIcon *, TInt, TBool, const TRect &)

voidBitBltColored(CWindowGc &aGc,
TBoolaHighlight,
const CGulIcon *aIcon,
TIntaSubcell,
TBoolaColorIcon,
const TRect &aGraphicRect
)const [private]

Parameters

CWindowGc & aGc
TBool aHighlight
const CGulIcon * aIcon
TInt aSubcell
TBool aColorIcon
const TRect & aGraphicRect

CheckIfSubCellsIntersect(TAknTextLineLayout *, TBool *, const TDesC &, const TRect &)

voidCheckIfSubCellsIntersect(TAknTextLineLayout *aLayouts,
TBool *aResults,
const TDesC &aText,
const TRect &aItemRect
)const [private]

Parameters

TAknTextLineLayout * aLayouts
TBool * aResults
const TDesC & aText
const TRect & aItemRect

ColumnAlignment(TInt)

IMPORT_C CGraphicsContext::TTextAlignColumnAlignment(TIntaColumn)const

Gets the text alignment for the specified column.

Parameters

TInt aColumnThe index of the column for which the alignment is obtained.

ColumnBaselinePos(TInt)

IMPORT_C TIntColumnBaselinePos(TIntaColumn)const

Gets column's baseline.

Parameters

TInt aColumntarget column.

ColumnEndX(TInt)

IMPORT_C TIntColumnEndX(TIntaColumn)const [private]

Parameters

TInt aColumn

ColumnFont(TInt)

IMPORT_C const CFont *ColumnFont(TIntaColumn)const

Gets font used by the column.

Parameters

TInt aColumnTarget column.

ColumnHorizontalGap(TInt)

IMPORT_C TIntColumnHorizontalGap(TIntaColumn)const

Not used in S60.

Parameters

TInt aColumn

ColumnIsGraphics(TInt)

IMPORT_C TBoolColumnIsGraphics(TIntaColumn)const

Checks whether the column contains graphics.

Parameters

TInt aColumnTarget column.

ColumnIsNumber(TInt)

IMPORT_C TBoolColumnIsNumber(TIntaColumn)const

Checks if the column is a number.

Parameters

TInt aColumnTarget column.

ColumnIsOptional(TInt)

IMPORT_C TBoolColumnIsOptional(TIntaColumn)const

Checks whether the column is optional.

Parameters

TInt aColumnTarget column.

ColumnMargins(TInt)

IMPORT_C TMarginsColumnMargins(TIntaColumn)const

Gets column's margins.

Parameters

TInt aColumnTarget column.

ColumnSeparatorStyle(TInt)

IMPORT_C CGraphicsContext::TPenStyleColumnSeparatorStyle(TIntaColumn)const

Not used in S60.

Parameters

TInt aColumn

ColumnTextClipGap(TInt)

IMPORT_C TIntColumnTextClipGap(TIntaSubCellIndex)const

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

Parameters

TInt aSubCellIndexIndex to target column.

ColumnWidthPixel(TInt)

IMPORT_C TIntColumnWidthPixel(TIntaColumn)const

Gets the specified column s width in pixels.

Parameters

TInt aColumnThe index of the column for which the width is obtained.

ColumnX(TInt)

IMPORT_C TIntColumnX(TIntaColumn)const [private]

Parameters

TInt aColumn

ConstructLD()

IMPORT_C voidConstructLD()[protected]

A second phase constructor.

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

ConstructLD(const TAknsItemID &)

IMPORT_C voidConstructLD(const TAknsItemID &aAnimationIID)[protected]

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

Since
3.0

Parameters

const TAknsItemID & aAnimationIIDSkin item identifier of the constructed animation. Passing KAknsIIDNone will disable highlight animation.

Control()

IMPORT_C CCoeControl *Control()const

Gets CCoeControl for component.

CreateMarqueeControlL()

voidCreateMarqueeControlL()

Creates a marquee control for the CColumnListBoxData and redraw.

CreatePictographInterfaceL()

voidCreatePictographInterfaceL()

Creates a pictograph interface for the CColumnListBoxData.

CurrentItemTextWasClipped()

IMPORT_C TUint32CurrentItemTextWasClipped()const
Tells whether current item has clipped text cells
Since
S60 3.2

CurrentMarqueeItemIndex()

TInt CurrentMarqueeItemIndex()

Gets current marquee item index.

DoConstructL(const TAknsItemID &)

voidDoConstructL(const TAknsItemID &aAnimationIID)[private]

Parameters

const TAknsItemID & aAnimationIID

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

IMPORT_C voidDraw(const TListItemProperties &aItemProperties,
CWindowGc &aGc,
const TDesC *aText,
const TRect &aRect,
TBoolaHighlight,
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

const TListItemProperties & aItemPropertiesThe properties of each column in the row.
CWindowGc & aGcThe graphics context to draw into.
const TDesC * aTextThe text to parse and draw.
const TRect & aRectBounding rectangle for the entire row.
TBool aHighlightETrue to draw the item highlighted. EFalse otherwise.
const TColors & aColorsThe colours to use if the item is highlighted.

DrawHighLight(CWindowGc &, const TRect &, TBool, MAknsSkinInstance *)

voidDrawHighLight(CWindowGc &aGc,
const TRect &aRect,
TBoolaHighlight,
MAknsSkinInstance *aSkin
)const [private]

Parameters

CWindowGc & aGc
const TRect & aRect
TBool aHighlight
MAknsSkinInstance * aSkin

DrawHighlightAnim(CBitmapContext &, const TRect &)

IMPORT_C TBoolDrawHighlightAnim(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

Parameters

CBitmapContext & aGcGraphics context for blitting animation frame
const TRect & aRectTarget rect for blitting animation frame

DrawMarkingModeIcons(const TListItemProperties &, CWindowGc &, TRect &)

voidDrawMarkingModeIcons(const TListItemProperties &aProperties,
CWindowGc &aGc,
TRect &aItemRect
)const [private]

Draws check boxes in marking mode

Parameters

const TListItemProperties & aPropertiesItem properties
CWindowGc & aGcGraphics context
TRect & aItemRectItem area

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

voidDrawSimple(const TListItemProperties &aItemProperties,
CWindowGc &aGc,
const TDesC *aText,
const TRect &aRect,
TBoolaHighlight,
const TColors &aColors
)const

internal

Parameters

const TListItemProperties & aItemProperties
CWindowGc & aGc
const TDesC * aText
const TRect & aRect
TBool aHighlight
const TColors & aColors

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

IMPORT_C voidDrawText(CWindowGc &aGc,
const TRect &aTextRect,
const TDesC &aText,
const TDesC &aClippedText,
const TIntaBaselineOffset,
const CGraphicsContext::TTextAlignaAlign,
const CFont &aFont,
const TBoolaHighlight,
const TBoolaIsTextClipped
)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

Parameters

CWindowGc & aGcWindow graphics context controller.
const TRect & aTextRectThe area where the text is drawn.
const TDesC & aTextThe whole text. Not clipped.
const TDesC & aClippedTextClipped / truncated text.
const TInt aBaselineOffsetAn offset from the top of the box to the text baseline.
const CGraphicsContext::TTextAlign aAlignThe text alignment mode (default is left, rather than centre or right).
const CFont & aFontWanted font.
const TBool aHighlightDoes the current item have highlight.
const TBool aIsTextClippedIs the current item clipped.

EnableMarqueeL(TBool)

IMPORT_C voidEnableMarqueeL(TBoolaEnable)

Enables or disables the marquee.

Parameters

TBool aEnableETrue = On. EFalse = Off.

EnableStretching(const TBool)

voidEnableStretching(const TBoolaEnabled)

Parameters

const TBool aEnabled

FindColumnIndex(TInt &, TInt)

TBool FindColumnIndex(TInt &aArrayIndex,
TIntaColumn
)const [private]

Parameters

TInt & aArrayIndex
TInt aColumn

FindColumnIndexOrAddL(TInt &, TInt)

voidFindColumnIndexOrAddL(TInt &aArrayIndex,
TIntaColumn
)[private]

Parameters

TInt & aArrayIndex
TInt aColumn

FocusGained()

voidFocusGained()

FocusLost()

voidFocusLost()

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,
TIntaColumn
)const

Gets the specified font for the specified column.

Parameters

const TListItemProperties & aItemPropertiesWhether the required font is: bold, italic, bold and italic or normal.
TInt aColumnThe index of the column for which the font is obtained.

GetSubCellIconSize(TInt)

TSize GetSubCellIconSize(TIntaIndex)

Gets subcell icon size.

Parameters

TInt aIndexIndex of the wanted subcell.

HandleResourceChange(TInt)

voidHandleResourceChange(TIntaType)

Handles changing of an resource. Only supports skin change.

Parameters

TInt aTypeDefines the resource that has changed.

HasHighlightAnim()

IMPORT_C TBoolHasHighlightAnim()const
Since
3.1

HighlightAnim()

IMPORT_C const CAknsEffectAnim *HighlightAnim()const

Gets the highlight animation .

Since
S60 3.0

IconArray()

IMPORT_C CArrayPtr< CGulIcon > *IconArray()const

Gets the icon array.

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

KineticScrollingEnabled()

TBool KineticScrollingEnabled()const

Returns ETrue if kinetic scrolling is enabled.

LastColumn()

IMPORT_C TIntLastColumn()const

Gets the index of the last defined column.

LayoutData()

IMPORT_C CAknLayoutData *LayoutData()const

Gives out layout data for separator line drawing.

LayoutInit()

IMPORT_C TBoolLayoutInit()const

Checks if the layout has been initialized.

MakeColumnRect(TInt, TRect &)

IMPORT_C TBoolMakeColumnRect(TIntaColumn,
TRect &aRect
)

Gets the specified column s surrounding rectangle.

Parameters

TInt aColumnThe index of the column for which the rectangle is obtained.
TRect & aRectOn return contains the specified column s rectangle.

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.

ResetMarquee()

voidResetMarquee()

Resets marquee control.

ResetSLSubCellArray()

IMPORT_C voidResetSLSubCellArray()

RowAndColumnFont(TInt, TInt)

IMPORT_C const CFont *RowAndColumnFont(TIntaRow,
TIntaColumn
)const

Gets the font attached to the row and cell.

Parameters

TInt aRowIndex number of the row.
TInt aColumnIndex number of the column.

SeparatorLinePosition()

IMPORT_C TAknSeparatorLinePositionSeparatorLinePosition()const

Gives out separator line position.

SetColumnAlignmentL(TInt, CGraphicsContext::TTextAlign)

IMPORT_C voidSetColumnAlignmentL(TIntaColumn,
CGraphicsContext::TTextAlignaAlign
)

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

TInt aColumnThe index of the column for which alignment is set.
CGraphicsContext::TTextAlign aAlignThe text alignment to use. The default is ELeft.

SetColumnBaselinePosL(TInt, TInt)

IMPORT_C voidSetColumnBaselinePosL(TIntaColumn,
TIntaPos
)

Sets columns baseline position.

Parameters

TInt aColumnTarget column.
TInt aPosWanted position.

SetColumnEndXL(TInt, TInt)

IMPORT_C voidSetColumnEndXL(TIntaColumn,
TIntaEndX
)const [private]

Parameters

TInt aColumn
TInt aEndX

SetColumnFontForRowL(TInt, TInt, const CFont *)

IMPORT_C voidSetColumnFontForRowL(TIntaRow,
TIntaColumn,
const CFont *aFont
)

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

Parameters

TInt aRowIndex number of the row.
TInt aColumnIndex number of the column.
const CFont * aFontFont to be used.

SetColumnFontL(TInt, const CFont *)

IMPORT_C voidSetColumnFontL(TIntaColumn,
const CFont *aFont
)

Sets column's font.

Parameters

TInt aColumnTarget column.
const CFont * aFontWanted font.

SetColumnHorizontalGapL(TInt, TInt)

IMPORT_C voidSetColumnHorizontalGapL(TIntaColumn,
TIntaGap
)

Not used in S60.

Parameters

TInt aColumn
TInt aGap

SetColumnMarginsL(TInt, TMargins)

IMPORT_C voidSetColumnMarginsL(TIntaColumn,
TMarginsaMargins
)

Sets column's margins.

Parameters

TInt aColumnTarget column.
TMargins aMarginsWanted margins.

SetColumnSeparatorStyleL(TInt, CGraphicsContext::TPenStyle)

IMPORT_C voidSetColumnSeparatorStyleL(TIntaColumn,
CGraphicsContext::TPenStyleaStyle
)

Not used in S60.

Parameters

TInt aColumn
CGraphicsContext::TPenStyle aStyle

SetColumnTextClipGapL(TInt, TInt)

IMPORT_C voidSetColumnTextClipGapL(TIntaSubCellIndex,
TIntaSize
)

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

Parameters

TInt aSubCellIndexIndex of the target column.
TInt aSizeWanted TextClipGap size.

SetColumnUnderlined(TBitFlags32)

IMPORT_C voidSetColumnUnderlined(TBitFlags32aUnderlinedColumns)

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

Parameters

TBitFlags32 aUnderlinedColumnsBitmask of columns to be underlined.

SetColumnWidthPixelL(TInt, TInt)

IMPORT_C voidSetColumnWidthPixelL(TIntaColumn,
TIntaWidth
)

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

TInt aColumnThe index of the column for which the width is to be set.
TInt aWidthThe width in pixels.

SetColumnXL(TInt, TInt)

IMPORT_C voidSetColumnXL(TIntaColumn,
TIntaX
)const [private]

Parameters

TInt aColumn
TInt aX

SetConditionalSubCellL(TInt, const TAknTextLineLayout &, TInt)

IMPORT_C voidSetConditionalSubCellL(TIntaSubCell,
const TAknTextLineLayout &aTextLayout,
TIntaAffectedSubCell
)

Parameters

TInt aSubCell
const TAknTextLineLayout & aTextLayout
TInt aAffectedSubCell

SetControl(CCoeControl *)

IMPORT_C voidSetControl(CCoeControl *aControl)

Sets CCoeControl for current component.

Parameters

CCoeControl * aControlCurrent listbox control instance, cannot be any other control.

SetCurrentItemIndex(TInt)

voidSetCurrentItemIndex(TIntaIndex)

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

Parameters

TInt aIndexThe new index for the current item.

SetCurrentMarqueeItemIndex(TInt)

voidSetCurrentMarqueeItemIndex(TIntaIndex)

Sets the index for current marquee item.

Parameters

TInt aIndexItem index.

SetESSHighlightedTextColor(TRgb)

voidSetESSHighlightedTextColor(TRgbaHighlightedTextColor)

Sets text colour for highlighted text.

Parameters

TRgb aHighlightedTextColorWanted colour.

SetESSTextColor(TRgb)

voidSetESSTextColor(TRgbaTextColor)

Sets text colour.

Parameters

TRgb aTextColorWanted colour.

SetGraphicSubCellL(TInt, const TAknWindowLineLayout &)

IMPORT_C voidSetGraphicSubCellL(TIntaSubCell,
const TAknWindowLineLayout &aGraphicLayout
)

Parameters

TInt aSubCell
const TAknWindowLineLayout & aGraphicLayout

SetGraphicsColumnL(TInt, TBool)

IMPORT_C voidSetGraphicsColumnL(TIntaColumn,
TBoolaIsGraphics
)

Sets whether the column shows graphics.

Parameters

TInt aColumnTarget column.
TBool aIsGraphicsWanted setting.

SetHighlightAnimBackgroundDrawer(MColumnListBoxAnimBackgroundDrawer *)

IMPORT_C voidSetHighlightAnimBackgroundDrawer(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

Parameters

MColumnListBoxAnimBackgroundDrawer * aDrawerNew background drawer.

SetIconArray(CArrayPtr< CGulIcon > *)

IMPORT_C voidSetIconArray(CArrayPtr< CGulIcon > *aArray)

Sets icon array.

Parameters

CArrayPtr< CGulIcon > * aArrayWanted icon collection .

SetItemCellSize(const TSize &)

IMPORT_C voidSetItemCellSize(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

Parameters

const TSize & aSizeInPixelsNew size in pixels for the Item cell.

SetLayoutInit(TBool)

IMPORT_C voidSetLayoutInit(TBoolaValue)const

Sets the initialization .

Parameters

TBool aValueWanted value (ETrue = initialized).

SetListEndSkinStyle(const TAknsItemID *, const TRect &)

IMPORT_C voidSetListEndSkinStyle(const TAknsItemID *aId,
const TRect &aRect
)

Sets skin style for the end of the list.

Parameters

const TAknsItemID * aIdWanted skins item ID.
const TRect & aRectSkin tile size.

SetMarqueeParams(const TInt, const TInt, const TInt)

IMPORT_C voidSetMarqueeParams(const TIntaLoops,
const TIntaScrollAmount,
const TIntaScrollDelay
)

Customizes marquee default behaviour.

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

Since
S60 2.8

Parameters

const TInt aLoopsMax number of loops to be executed.
const TInt aScrollAmountThe amount of pixels scrolled per iteration.
const TInt aScrollDelayThe interval between iterations.

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

IMPORT_C voidSetMarqueeParams(const TIntaLoops,
const TIntaScrollAmount,
const TIntaScrollDelay,
const TIntaInterval
)

Customizes marquee default behaviour.

Since
S60 2.8

Parameters

const TInt aLoopsMax number of loops to be executed.
const TInt aScrollAmountThe amount of pixels scrolled per iteration.
const TInt aScrollDelayThe interval between iterations.
const TInt aIntervalThe interval between frame updates.

SetNumberColumnL(TInt, TBool)

IMPORT_C voidSetNumberColumnL(TIntaColumn,
TBoolaIsNumber
)

Sets whether the column is a number.

Parameters

TInt aColumnTarget columun.
TBool aIsNumberWanted setting. ETrue if it is a number.

SetOptionalColumnL(TInt, TBool)

IMPORT_C voidSetOptionalColumnL(TIntaColumn,
TBoolaIsOptional
)

Sets whether the column is optional.

Parameters

TInt aColumnTarget column.
TBool aIsOptionalWanted setting, ETrue if column is optional.

SetSeparatorLinePosition(TAknSeparatorLinePosition)

IMPORT_C voidSetSeparatorLinePosition(TAknSeparatorLinePositionaPosition)

Sets position of listbox line.

Parameters

TAknSeparatorLinePosition aPositionWanted position.

SetSkinBackgroundContext(CAknsListBoxBackgroundControlContext *)

voidSetSkinBackgroundContext(CAknsListBoxBackgroundControlContext *aContext)

Sets background skin context. Changes ownership as well.

Parameters

CAknsListBoxBackgroundControlContext * aContextWanted background skin control context.

SetSkinEnabledL(TBool)

IMPORT_C voidSetSkinEnabledL(TBoolaEnabled)

Enables/Disables skin.

Parameters

TBool aEnabledSets whether the skins are enable or disabled ETrue for enabling skins.

SetSkinHighlightFrame(const TAknsItemID *, const TAknsItemID *)

IMPORT_C voidSetSkinHighlightFrame(const TAknsItemID *aFrameId,
const TAknsItemID *aFrameCenterId
)

Sets skin for the highlighted frame.

Parameters

const TAknsItemID * aFrameIdWanted skin's item ID for the frame.
const TAknsItemID * aFrameCenterIdWanted skin's item ID for the center of the frame.

SetSkinStyle(const TAknsItemID *, const TRect &)

IMPORT_C voidSetSkinStyle(const TAknsItemID *aId,
const TRect &aTileRect
)

Sets style for the skin fot list tiles.

Parameters

const TAknsItemID * aIdWanted skins item ID.
const TRect & aTileRectSkin tile size.

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

IMPORT_C voidSetStretchableConditionalSubCellL(TIntaSubCell,
const TAknTextComponentLayout &aNormalLayout,
const TAknTextComponentLayout &aStretchedLayout,
TIntaNormalSubCell,
TIntaStretchedSubCell
)

Parameters

TInt aSubCell
const TAknTextComponentLayout & aNormalLayout
const TAknTextComponentLayout & aStretchedLayout
TInt aNormalSubCell
TInt aStretchedSubCell

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

IMPORT_C voidSetStretchableGraphicSubCellL(TIntaSubCell,
const TAknWindowComponentLayout &aNormalLayout,
const TAknWindowComponentLayout &aStretchedLayout
)

Parameters

TInt aSubCell
const TAknWindowComponentLayout & aNormalLayout
const TAknWindowComponentLayout & aStretchedLayout

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

IMPORT_C voidSetStretchableTextSubCellL(TIntaSubCell,
const TAknTextComponentLayout &aNormalLayout,
const TAknTextComponentLayout &aStretchedLayout
)

Parameters

TInt aSubCell
const TAknTextComponentLayout & aNormalLayout
const TAknTextComponentLayout & aStretchedLayout

SetSubCellIconSize(TInt, TSize)

IMPORT_C voidSetSubCellIconSize(TIntaIndex,
TSizeaSize
)

Sets the subcell icon size.

Since
S60 2.8

Parameters

TInt aIndexIndex of the sub cell.
TSize aSizeSize of the sub cell icon.

SetTextSubCellL(TInt, const TAknTextLineLayout &)

IMPORT_C voidSetTextSubCellL(TIntaSubCell,
const TAknTextLineLayout &aTextLayout
)

Parameters

TInt aSubCell
const TAknTextLineLayout & aTextLayout

SetUnderlineStyle(TListItemProperties, CWindowGc &, TInt)

voidSetUnderlineStyle(TListItemPropertiesaProperties,
CWindowGc &aGc,
TIntaColumn
)const [private]

Parameters

TListItemProperties aProperties
CWindowGc & aGc
TInt aColumn

SetupSkinContextL()

voidSetupSkinContextL()

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.

StretchingEnabled()

IMPORT_C TBoolStretchingEnabled()const

SubCellsMightIntersect(const TBool)

IMPORT_C voidSubCellsMightIntersect(const TBoolaMightIntersect)

Parameters

const TBool aMightIntersect

UsesScalableLayoutData()

TBool UsesScalableLayoutData()const

Member Data Documentation

CArrayFix< SColumn > * iColumnArray

CArrayFix< SColumn > *iColumnArray[private]

CColumnListBoxDataExtension * iExtension

CColumnListBoxDataExtension *iExtension[private]