Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: eiklbi.h
Link against: eikcoctl.lib

Class TListItemProperties

TListItemProperties

Support

Supported from 6.0

Description

Colour and style properties which can be applied when drawing the contents of list box items.

Defined in TListItemProperties:
Color(), IsBold(), IsDimmed(), IsItalics(), IsUnderlined(), SetBold(), SetColor(), SetDimmed(), SetItalics(), SetUnderlined(), TListItemProperties()


Construction


TListItemProperties()

TListItemProperties();

Description

Constructor.

[Top]


Getting and setting list item properties


Color()

TRgb Color() const;

Description

Gets the list item’s colour.

Return value

TRgb

The list item’s colour.


SetColor()

void SetColor(TRgb aColor);

Description

Sets the list item’s colour.

Parameters

TRgb aColor

The list item’s colour.


IsBold()

TBool IsBold() const;

Description

Tests whether the list item is drawn bold.

Return value

TBool

ETrue if the list item is drawn bold. EFalse otherwise.


SetBold()

void SetBold(TBool aBold);

Description

Sets whether the list item is drawn bold or not bold.

Parameters

TBool aBold

ETrue to draw the list item bold. EFalse otherwise.


IsDimmed()

TBool IsDimmed() const;

Description

Tests list item dim state.

An item is usually drawn dimmed to indicate that it cannot accept user input.

Return value

TBool

ETrue if the list item is dimmed. EFalse otherwise.


SetDimmed()

void SetDimmed(TBool aDimmed);

Description

Sets list item dim state.

An item is usually drawn dimmed to indicate that it cannot accept user input.

Parameters

TBool aDimmed

ETrue to draw the list item dimmed. EFalse otherwise.


IsItalics()

TBool IsItalics() const;

Description

Tests whether the list item is italicised.

Return value

TBool

ETrue if the list item is drawn in italics. EFalse otherwise.


SetItalics()

void SetItalics(TBool aItalics);

Description

Sets whether or not the list item is drawn in italics.

Parameters

TBool aItalics

ETrue to draw the list item in italics. EFalse otherwise.


IsUnderlined()

TBool IsUnderlined() const;

Description

Test whether the list item is drawn with an underline.

Return value

TBool

ETrue if the list item is drawn with an underline. EFalse otherwise.


SetUnderlined()

void SetUnderlined(TBool aUnderlined);

Description

Sets whether or not the list item is drawn with an underline.

Parameters

TBool aUnderlined

ETrue to draw the list item with an underline. EFalse otherwise.