Collapse all Symbian^3 Product Developer Library

MFormLabelApi Class Reference

class MFormLabelApi

Class used to provide label functionality within Form as an extended interface (via the GetExtendedInterface mechanism supplied in MTmSource). This class is entirely internal to Form. MTmSource::GetExtendedInterface

Since: Sirocco

Public Member Functions
IMPORT_C void	LabelMetrics(MTmSource::TLabelType, TSize &, TInt &)
IMPORT_C void	LabelModeCancel()
IMPORT_C TBool	LabelModeSelect(MTmSource::TLabelType, TInt)

Member Functions Documentation

LabelMetrics(MTmSource::TLabelType, TSize &, TInt &)

IMPORT_C void	LabelMetrics	(	MTmSource::TLabelType	aType,
			TSize &	aLabelSize,
			TInt &	aMarginSize
		)	const [virtual]

Get the size and margin size for a label. The maximum width and height for the label text are placed in aLabelSize and the width or height of the margin containing the label in aMarginSize. Whether the label is placed left, right, above or below the text and whether the label is centred in the margin or placed flush with one of its edges depends on the label type.

Parameters

MTmSource::TLabelType aType
TSize & aLabelSize
TInt & aMarginSize

LabelModeCancel()

IMPORT_C void

LabelModeCancel

(

)

[virtual]

Cancel any label mode that has been selected.

LabelModeSelect(MTmSource::TLabelType, TInt)

IMPORT_C TBool	LabelModeSelect	(	MTmSource::TLabelType	aType,
			TInt	aPos
		)	[virtual]

The default function to select label mode for a paragraph containing a particular position. If a label of the selected type exists for the paragraph, the mode is selected and the source returns the text of the label, not the main text, until the mode is cancelled. The return value is ETrue if a label exists, EFalse otherwise. This means that FALSE must be returned if label mode has already been selected.

Parameters

MTmSource::TLabelType aType
TInt aPos