Class CEikLabel

CEikLabel

Support

Supported from 6.0

Description

This class enables you to display one or more lines of text. It is usually used for buttons and file name labels.

Derivation

CBase Base class for all classes to be instantiated on the heap CCoeControl Control base class from which all other controls are derived CEikAlignedControl This class extends the CCoeControl class in order to support extra functionality such as control alignment and margins CEikLabel This class enables you to display one or more lines of text MCoeControlContext Interface to allow sharing of graphics settings between controls

Defined in CEikLabel:
BufferReserveLength(), CEikLabel(), CalcMinimumSize(), ConstructFromResourceL(), Draw(), EFullEmphasis, ENoEmphasis, EPartialEmphasis, EStrikethrough, EUnderlining, Font(), GetColorUseListL(), HandleResourceChange(), IsStrikethrough(), IsUnderlined(), MinimumSize(), NumberOfLines(), PixelGapBetweenLines(), SetBufferReserveLengthL(), SetEmphasis(), SetFont(), SetPixelGapBetweenLines(), SetStrikethrough(), SetTextL(), SetUnderlining(), TLabelFlags, TTextEmphasis, Text(), iFont, iGapBetweenLines, iLabFlags, iNumberOfLines, iText, ~CEikLabel()

Inherited from CBase:
operator new()

Inherited from CCoeControl:
ActivateGc(), ActivateL(), BackedUpWindow(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentControl(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CountComponentControls(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawDeferred(), DrawNow(), DrawableWindow(), EnableDragEvents(), FocusChanged(), GetColor(), GetHelpContext(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleRedrawEvent(), HasBorder(), IgnoreEventsUntilNextPointerUp(), Index(), InputCapabilities(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), MakeVisible(), Observer(), OfferKeyEventL(), OverrideColorL(), OwnsWindow(), Position(), PositionChanged(), PositionRelativeToScreen(), PrepareForFocusGainL(), PrepareForFocusLossL(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), ResetGc(), SetAdjacent(), SetAllowStrayPointers(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetContainerWindow(), SetContainerWindowL(), SetControlContext(), SetCornerAndSize(), SetCornerAndSizeL(), SetDimmed(), SetExtent(), SetExtentL(), SetExtentToWholeScreen(), SetExtentToWholeScreenL(), SetFocus(), SetFocusing(), SetGloballyCapturing(), SetNeighbor(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetRectL(), SetSize(), SetSizeL(), SetSizeWithoutNotification(), SetSizeWithoutNotificationL(), Size(), SizeChanged(), SizeChangedL(), SystemGc(), Window()

Inherited from CEikAlignedControl:
SetAlignment(), SetAllMarginsTo(), iAlignment, iMargin

Inherited from MCoeControlContext:
ActivateContext(), PrepareContext(), ResetContext()

CEikLabel();

Description

Default constructor.

void ConstructFromResourceL(TResourceReader& aReader);

Description

Constructs a label from resource using the specified resource reader.

Parameters

TResourceReader& aReader The resource reader to use.

~CEikLabel();

Description

Destructor.

void SetTextL(const TDesC& aText);

Description

Sets the label’s text.

Parameters

const TDesC& aText The label’s text.

const TDesC* Text() const;

Description

Gets the label’s text.

Return value

TDesC* The label’s text.

TUint8 NumberOfLines();

Description

Gets the number of lines of text in the label.

Return value

TUint8 The number of lines of text.

void SetFont(const CFont* aFont);

Description

Sets the label’s font.

Parameters

const CFont* aFont The label’s font.

const CFont* Font() const;

Description

Gets the label’s font.

Return value

CFont* The label’s font.

void SetEmphasis(TTextEmphasis aEmphasis);

Description

Sets the label's text emphasis.

Parameters

TTextEmphasis aEmphasis The label's text emphasis.

void SetPixelGapBetweenLines(TInt aGap);

Description

Sets the gap between the label’s text lines in pixels.

Parameters

TInt aGap The number of pixels between two lines of text.

TInt PixelGapBetweenLines() const;

Description

Gets the number of pixels between two lines of text.

Return value

TInt The number of pixels between two lines of text.

TBool IsUnderlined() const;

Description

Tests whether the label is underlined.

Return value

TBool ETrue if the label is set as underlined, EFalse if the label is not set as underlined.

void SetUnderlining(TBool aUnderLining);

Description

Sets label underlining.

Parameters

TBool aUnderLining ETrue to set the label as underlined, EFalse to set the label as not underlined.

TBool IsStrikethrough() const;

Description

Tests label strike-through.

Return value

TBool ETrue if the label is set to be drawn with a line through it, EFalse if the label is not set to be drawn with a line through it.

void SetStrikethrough(TBool aStrikethrough);

Description

Sets label strike-through.

Parameters

TBool aStrikethrough ETrue to set the label to be drawn with a line through it, EFalse to set the label to not be drawn with a line through it.

TInt BufferReserveLength() const;

Description

Gets the buffer reserve length.

Return value

TInt The buffer reserve length.

void SetBufferReserveLengthL(TInt aLength);

Description

Sets the buffer reserve length.

Parameters

TInt aLength The buffer reserve length.

TSize MinimumSize();

Description

Gets the minimum size required to draw the label.

Return value

TSize The minimum size required to draw the label.

TSize CalcMinimumSize(TPtrC& aText) const;

Description

Gets the minimum size required to draw the specified text.

Parameters

TPtrC& aText The text to be drawn.

Return value

TSize The minimum size required to draw the text.

void GetColorUseListL(CArrayFix<TCoeColorUse>& aColorUseList) const;

Description

Gets the list of logical colours used to draw the control. The list is appended to aColorUseList and paired with an explanation of how the colours are used.

Parameters

CArrayFix<TCoeColorUse>& aColorUseList List of logical colours.

void HandleResourceChange(TInt aType);

Description

Handles a change in the control's resources which are shared across the environment. Colours or fonts for example.

Parameters

TInt aType The type of resource that has changed.

void Draw(const TRect& aRect) const;

Description

Draws the control.

Parameters

const TRect& aRect Optional. If supplied, the rectangle in which the control is drawn.

TTextEmphasis

Description

Determines text emphasis.

ENoEmphasis Text is drawn with no emphasis. EPartialEmphasis Text is drawn partially emphasised. EFullEmphasis Text is drawn with full emphasis.

TLabelFlags

Description

Determines whether text is drawn with underlining and strike-through.

EUnderlining Text is drawn with underlining. EStrikethrough Text is drawn with strike-through.

Description

Specifies various label attributes.

protected: HBufC* iText

Description

The label’s text.

protected: const CFont* iFont

Description

The label’s font.

protected: TUint8 iNumberOfLines

Description

The label’s number of lines of text.

protected: TUint8 iLabFlags

Description

The label’s flags. These are used to set text emphasis and characteristics, such as underlining, and strikethrough.

protected: TInt iGapBetweenLines

Description

The number of pixels between lines of text.