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 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 ()
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 )
Private Member Functions
TInt AddActualFontL (const CFont *)
void AddColumnL ( TInt )
SColumn & At ( TInt )
const SColumn & At ( TInt )
void BitBltColored ( CWindowGc &, TBool , const CGulIcon *, TInt , TBool , const TRect &)
void CheckIfSubCellsIntersect ( TAknTextLineLayout *, TBool *, const TDesC &, const TRect &)
IMPORT_C TInt ColumnEndX ( TInt )
IMPORT_C TInt ColumnX ( TInt )
void DoConstructL (const TAknsItemID &)
void DrawHighLight ( CWindowGc &, const TRect &, TBool , MAknsSkinInstance *)
void DrawMarkingModeIcons (const TListItemProperties &, CWindowGc &, TRect &)
TBool FindColumnIndex ( TInt &, TInt )
void FindColumnIndexOrAddL ( TInt &, TInt )
IMPORT_C void SetColumnEndXL ( TInt , TInt )
IMPORT_C void SetColumnXL ( TInt , TInt )
void SetUnderlineStyle ( 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_C CColumnListBoxData ( ) [protected]

C++ default constructor.

~CColumnListBoxData()

IMPORT_C ~CColumnListBoxData ( )

Destructor.

Member Functions 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

AddActualFontL(const CFont *)

TInt AddActualFontL ( const CFont * aBaseFont ) [private]

Parameters

const CFont * aBaseFont

AddColumnL(TInt)

void AddColumnL ( TInt aColumn ) [private]

Parameters

TInt aColumn

At(TInt)

SColumn & At ( TInt aArrayIndex ) [private]

Parameters

TInt aArrayIndex

At(TInt)

const SColumn & At ( TInt aArrayIndex ) const [private]

Parameters

TInt aArrayIndex

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

void BitBltColored ( CWindowGc & aGc,
TBool aHighlight,
const CGulIcon * aIcon,
TInt aSubcell,
TBool aColorIcon,
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 &)

void CheckIfSubCellsIntersect ( 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::TTextAlign ColumnAlignment ( TInt aColumn ) const

Gets the text alignment for the specified column.

Parameters

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

ColumnBaselinePos(TInt)

IMPORT_C TInt ColumnBaselinePos ( TInt aColumn ) const

Gets column's baseline.

Parameters

TInt aColumn target column.

ColumnEndX(TInt)

IMPORT_C TInt ColumnEndX ( TInt aColumn ) const [private]

Parameters

TInt aColumn

ColumnFont(TInt)

IMPORT_C const CFont * ColumnFont ( TInt aColumn ) const

Gets font used by the column.

Parameters

TInt aColumn Target column.

ColumnHorizontalGap(TInt)

IMPORT_C TInt ColumnHorizontalGap ( TInt aColumn ) const

Not used in S60.

Parameters

TInt aColumn

ColumnIsGraphics(TInt)

IMPORT_C TBool ColumnIsGraphics ( TInt aColumn ) const

Checks whether the column contains graphics.

Parameters

TInt aColumn Target column.

ColumnIsNumber(TInt)

IMPORT_C TBool ColumnIsNumber ( TInt aColumn ) const

Checks if the column is a number.

Parameters

TInt aColumn Target column.

ColumnIsOptional(TInt)

IMPORT_C TBool ColumnIsOptional ( TInt aColumn ) const

Checks whether the column is optional.

Parameters

TInt aColumn Target column.

ColumnMargins(TInt)

IMPORT_C TMargins ColumnMargins ( TInt aColumn ) const

Gets column's margins.

Parameters

TInt aColumn Target column.

ColumnSeparatorStyle(TInt)

IMPORT_C CGraphicsContext::TPenStyle ColumnSeparatorStyle ( TInt aColumn ) const

Not used in S60.

Parameters

TInt aColumn

ColumnTextClipGap(TInt)

IMPORT_C TInt ColumnTextClipGap ( TInt aSubCellIndex ) const

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

Parameters

TInt aSubCellIndex Index to target column.

ColumnWidthPixel(TInt)

IMPORT_C TInt ColumnWidthPixel ( TInt aColumn ) const

Gets the specified column s width in pixels.

Parameters

TInt aColumn The index of the column for which the width is obtained.

ColumnX(TInt)

IMPORT_C TInt ColumnX ( TInt aColumn ) const [private]

Parameters

TInt aColumn

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

Parameters

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

Control()

IMPORT_C CCoeControl * Control ( ) const

Gets CCoeControl for component.

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

CurrentMarqueeItemIndex()

TInt CurrentMarqueeItemIndex ( )

Gets current marquee item index.

DoConstructL(const TAknsItemID &)

void DoConstructL ( const TAknsItemID & aAnimationIID ) [private]

Parameters

const TAknsItemID & aAnimationIID

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.

Parameters

const TListItemProperties & aItemProperties The properties of each column in the row.
CWindowGc & aGc The graphics context to draw into.
const TDesC * aText The text to parse and draw.
const TRect & aRect Bounding rectangle for the entire row.
TBool aHighlight ETrue to draw the item highlighted. EFalse otherwise.
const TColors & aColors The colours to use if the item is highlighted.

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

void DrawHighLight ( CWindowGc & aGc,
const TRect & aRect,
TBool aHighlight,
MAknsSkinInstance * aSkin
) const [private]

Parameters

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

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

Parameters

CBitmapContext & aGc Graphics context for blitting animation frame
const TRect & aRect Target rect for blitting animation frame

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

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

Draws check boxes in marking mode

Parameters

const TListItemProperties & aProperties Item properties
CWindowGc & aGc Graphics context
TRect & aItemRect Item area

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

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

Parameters

CWindowGc & aGc Window graphics context controller.
const TRect & aTextRect The area where the text is drawn.
const TDesC & aText The whole text. Not clipped.
const TDesC & aClippedText Clipped / truncated text.
const TInt aBaselineOffset An offset from the top of the box to the text baseline.
const CGraphicsContext::TTextAlign aAlign The text alignment mode (default is left, rather than centre or right).
const CFont & aFont Wanted font.
const TBool aHighlight Does the current item have highlight.
const TBool aIsTextClipped Is the current item clipped.

EnableMarqueeL(TBool)

IMPORT_C void EnableMarqueeL ( TBool aEnable )

Enables or disables the marquee.

Parameters

TBool aEnable ETrue = On. EFalse = Off.

EnableStretching(const TBool)

void EnableStretching ( const TBool aEnabled )

Parameters

const TBool aEnabled

FindColumnIndex(TInt &, TInt)

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

Parameters

TInt & aArrayIndex
TInt aColumn

FindColumnIndexOrAddL(TInt &, TInt)

void FindColumnIndexOrAddL ( TInt & aArrayIndex,
TInt aColumn
) [private]

Parameters

TInt & aArrayIndex
TInt aColumn

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.

Parameters

const TListItemProperties & aItemProperties Whether the required font is: bold, italic, bold and italic or normal.
TInt aColumn The index of the column for which the font is obtained.

GetSubCellIconSize(TInt)

TSize GetSubCellIconSize ( TInt aIndex )

Gets subcell icon size.

Parameters

TInt aIndex Index of the wanted subcell.

HandleResourceChange(TInt)

void HandleResourceChange ( TInt aType )

Handles changing of an resource. Only supports skin change.

Parameters

TInt aType Defines the resource that has changed.

HasHighlightAnim()

IMPORT_C TBool HasHighlightAnim ( ) 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 TInt LastColumn ( ) 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 TBool LayoutInit ( ) const

Checks if the layout has been initialized.

MakeColumnRect(TInt, TRect &)

IMPORT_C TBool MakeColumnRect ( TInt aColumn,
TRect & aRect
)

Gets the specified column s surrounding rectangle.

Parameters

TInt aColumn The index of the column for which the rectangle is obtained.
TRect & aRect On 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()

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.

Parameters

TInt aRow Index number of the row.
TInt aColumn Index number of the column.

SeparatorLinePosition()

IMPORT_C TAknSeparatorLinePosition SeparatorLinePosition ( ) const

Gives out separator line 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.

Parameters

TInt aColumn The index of the column for which alignment is set.
CGraphicsContext::TTextAlign 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.

Parameters

TInt aColumn Target column.
TInt aPos Wanted position.

SetColumnEndXL(TInt, TInt)

IMPORT_C void SetColumnEndXL ( TInt aColumn,
TInt aEndX
) const [private]

Parameters

TInt aColumn
TInt aEndX

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.

Parameters

TInt aRow Index number of the row.
TInt aColumn Index number of the column.
const CFont * aFont Font to be used.

SetColumnFontL(TInt, const CFont *)

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

Sets column's font.

Parameters

TInt aColumn Target column.
const CFont * aFont Wanted font.

SetColumnHorizontalGapL(TInt, TInt)

IMPORT_C void SetColumnHorizontalGapL ( TInt aColumn,
TInt aGap
)

Not used in S60.

Parameters

TInt aColumn
TInt aGap

SetColumnMarginsL(TInt, TMargins)

IMPORT_C void SetColumnMarginsL ( TInt aColumn,
TMargins aMargins
)

Sets column's margins.

Parameters

TInt aColumn Target column.
TMargins aMargins Wanted margins.

SetColumnSeparatorStyleL(TInt, CGraphicsContext::TPenStyle)

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

Not used in S60.

Parameters

TInt aColumn
CGraphicsContext::TPenStyle aStyle

SetColumnTextClipGapL(TInt, TInt)

IMPORT_C void SetColumnTextClipGapL ( TInt aSubCellIndex,
TInt aSize
)

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

Parameters

TInt aSubCellIndex Index of the target column.
TInt 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

Parameters

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

Parameters

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

SetColumnXL(TInt, TInt)

IMPORT_C void SetColumnXL ( TInt aColumn,
TInt aX
) const [private]

Parameters

TInt aColumn
TInt aX

SetConditionalSubCellL(TInt, const TAknTextLineLayout &, TInt)

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

Parameters

TInt aSubCell
const TAknTextLineLayout & aTextLayout
TInt aAffectedSubCell

SetControl(CCoeControl *)

IMPORT_C void SetControl ( CCoeControl * aControl )

Sets CCoeControl for current component.

Parameters

CCoeControl * 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

Parameters

TInt aIndex The new index for the current item.

SetCurrentMarqueeItemIndex(TInt)

void SetCurrentMarqueeItemIndex ( TInt aIndex )

Sets the index for current marquee item.

Parameters

TInt aIndex Item index.

SetESSHighlightedTextColor(TRgb)

void SetESSHighlightedTextColor ( TRgb aHighlightedTextColor )

Sets text colour for highlighted text.

Parameters

TRgb aHighlightedTextColor Wanted colour.

SetESSTextColor(TRgb)

void SetESSTextColor ( TRgb aTextColor )

Sets text colour.

Parameters

TRgb aTextColor Wanted colour.

SetGraphicSubCellL(TInt, const TAknWindowLineLayout &)

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

Parameters

TInt aSubCell
const TAknWindowLineLayout & aGraphicLayout

SetGraphicsColumnL(TInt, TBool)

IMPORT_C void SetGraphicsColumnL ( TInt aColumn,
TBool aIsGraphics
)

Sets whether the column shows graphics.

Parameters

TInt aColumn Target column.
TBool 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

Parameters

MColumnListBoxAnimBackgroundDrawer * aDrawer New background drawer.

SetIconArray(CArrayPtr< CGulIcon > *)

IMPORT_C void SetIconArray ( CArrayPtr < CGulIcon > * aArray )

Sets icon array.

Parameters

CArrayPtr < CGulIcon > * 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

Parameters

const TSize & aSizeInPixels New size in pixels for the Item cell.

SetLayoutInit(TBool)

IMPORT_C void SetLayoutInit ( TBool aValue ) const

Sets the initialization .

Parameters

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

Parameters

const TAknsItemID * aId Wanted skins item ID.
const TRect & 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

Parameters

const TInt aLoops Max number of loops to be executed.
const TInt aScrollAmount The amount of pixels scrolled per iteration.
const TInt 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

Parameters

const TInt aLoops Max number of loops to be executed.
const TInt aScrollAmount The amount of pixels scrolled per iteration.
const TInt aScrollDelay The interval between iterations.
const TInt aInterval The interval between frame updates.

SetNumberColumnL(TInt, TBool)

IMPORT_C void SetNumberColumnL ( TInt aColumn,
TBool aIsNumber
)

Sets whether the column is a number.

Parameters

TInt aColumn Target columun.
TBool 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.

Parameters

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

SetSeparatorLinePosition(TAknSeparatorLinePosition)

IMPORT_C void SetSeparatorLinePosition ( TAknSeparatorLinePosition aPosition )

Sets position of listbox line.

Parameters

TAknSeparatorLinePosition aPosition Wanted position.

SetSkinBackgroundContext(CAknsListBoxBackgroundControlContext *)

void SetSkinBackgroundContext ( CAknsListBoxBackgroundControlContext * aContext )

Sets background skin context. Changes ownership as well.

Parameters

CAknsListBoxBackgroundControlContext * aContext Wanted background skin control context.

SetSkinEnabledL(TBool)

IMPORT_C void SetSkinEnabledL ( TBool aEnabled )

Enables/Disables skin.

Parameters

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

Parameters

const TAknsItemID * aFrameId Wanted skin's item ID for the frame.
const TAknsItemID * 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.

Parameters

const TAknsItemID * aId Wanted skins item ID.
const TRect & 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
)

Parameters

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
)

Parameters

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
)

Parameters

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

Parameters

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

SetTextSubCellL(TInt, const TAknTextLineLayout &)

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

Parameters

TInt aSubCell
const TAknTextLineLayout & aTextLayout

SetUnderlineStyle(TListItemProperties, CWindowGc &, TInt)

void SetUnderlineStyle ( TListItemProperties aProperties,
CWindowGc & aGc,
TInt aColumn
) const [private]

Parameters

TListItemProperties aProperties
CWindowGc & aGc
TInt aColumn

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.

StretchingEnabled()

IMPORT_C TBool StretchingEnabled ( ) const

SubCellsMightIntersect(const TBool)

IMPORT_C void SubCellsMightIntersect ( const TBool aMightIntersect )

Parameters

const TBool aMightIntersect

UsesScalableLayoutData()

TBool UsesScalableLayoutData ( ) const

Member Data Documentation

CArrayFix< SColumn > * iColumnArray

CArrayFix < SColumn > * iColumnArray [private]

CColumnListBoxDataExtension * iExtension

CColumnListBoxDataExtension * iExtension [private]