TListItemProperties Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eiklbi.h>

Detailed Description

The TListItemProperties class packages together the color and style properties which can be applied when drawing the contents of list box items.


Public Member Functions
IMPORT_C	TListItemProperties ()
	C++ default constructor.
void	SetBold (TBool aBold)
	Sets whether the list item is drawn bold or not bold.
TBool	IsBold () const
	Tests whether the list item is drawn bold.
void	SetItalics (TBool aItalics)
	Sets whether or not the list item is drawn in italics.
TBool	IsItalics () const
	Tests whether the list item is italicised.
void	SetUnderlined (TBool aUnderlined)
	Sets whether or not the list item is drawn with an underline.
TBool	IsUnderlined () const
	Test whether the list item is drawn with an underline.
void	SetDimmed (TBool aDimmed)
	Sets list item dim state.
TBool	IsDimmed () const
	Tests list item dim state.
void	SetColor (TRgb aColor)
	Sets the list item’s colour.
TRgb	Color () const
	Gets the list item’s colour.
void	SetSeparatorAfter (TBool aSeparator)
	Activate/deactivate separator after item.
TBool	IsSeparatorAfter () const
	Check if separator after item is active.
void	SetHiddenSelection (TBool aHidden)
	Select to hide the item .
TBool	IsSelectionHidden () const
	Check if the item is hidden.

Constructor & Destructor Documentation

IMPORT_C TListItemProperties::TListItemProperties

(

)

C++ default constructor.

Member Function Documentation

TRgb TListItemProperties::Color ( ) const [inline]

Gets the list item’s colour.

Returns:: The list item’s colour.

TBool TListItemProperties::IsBold ( ) const [inline]

Tests whether the list item is drawn bold.

Deprecated:

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

TBool TListItemProperties::IsDimmed ( ) const [inline]

Tests list item dim state.

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

Returns:: ETrue if the list item is dimmed. EFalse otherwise.

TBool TListItemProperties::IsItalics ( ) const [inline]

Tests whether the list item is italicised.

Deprecated:

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

TBool TListItemProperties::IsSelectionHidden ( ) const [inline]

Check if the item is hidden.

Returns:: ETrue if item is hidden.

TBool TListItemProperties::IsSeparatorAfter ( ) const [inline]

Check if separator after item is active.

Deprecated:

Returns:: ETrue if Active. EFalse if Deactivated.

TBool TListItemProperties::IsUnderlined ( ) const [inline]

Test whether the list item is drawn with an underline.

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

void TListItemProperties::SetBold ( TBool aBold ) [inline]

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

Deprecated:

Parameters:

aBold ETrue to draw the list item bold. EFalse otherwise.

void TListItemProperties::SetColor ( TRgb aColor ) [inline]

Sets the list item’s colour.

Parameters:

aColor

The list item’s colour.

void TListItemProperties::SetDimmed ( TBool aDimmed ) [inline]

Sets list item dim state.

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

Parameters:

aDimmed ETrue to draw the list item dimmed. EFalse otherwise.

void TListItemProperties::SetHiddenSelection ( TBool aHidden ) [inline]

Select to hide the item .

Parameters:

aHidden Defines whether the item is hidden. ETrue = Hidden

void TListItemProperties::SetItalics ( TBool aItalics ) [inline]

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

Deprecated:

Parameters:

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

void TListItemProperties::SetSeparatorAfter ( TBool aSeparator ) [inline]

Activate/deactivate separator after item.

Deprecated:

Parameters:

aSeparator Active/deactive selector. ETrue = Active. EFalse = Deactivated.

void TListItemProperties::SetUnderlined ( TBool aUnderlined ) [inline]

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

Parameters:

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

The documentation for this class was generated from the following file:

eiklbi.h

TListItemProperties Class Reference

Capability Information

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation