Collapse all Symbian^3 Product Developer Library

CAknNaviLabel Class Reference

class CAknNaviLabel : public CAknControl

Label control to the status pane's navigation pane.

Inherits from

CAknNaviLabel
- CAknControl
  - CCoeControl
    - CBase

Public Member Functions
	CAknNaviLabel()
	~CAknNaviLabel()
IMPORT_C void	HandlePointerEventL(const TPointerEvent &)
IMPORT_C TNaviLabelType	NaviLabelType()
IMPORT_C void	SetNaviLabelType(TNaviLabelType)
IMPORT_C void	SetTextL(const TDesC &)
const TDesC *	Text()

Protected Member Functions
IMPORT_C void	Draw(const TRect &)
IMPORT_C void	SizeChanged()

Private Member Functions
IMPORT_C void *	ExtensionInterface(TUid)
TAknLayoutText	LayoutText()
TInt	WidthInsideMargins()

Inherited Functions
	CAknControl::CAknControl()
	CAknControl::~CAknControl()
	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()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::ActivateL()
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::ComponentControl(TInt)const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ConstructFromResourceL(TResourceReader &)
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CountComponentControls()const
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::FocusChanged(TDrawNow)
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HandleResourceChange(TInt)
	CCoeControl::HasBorder()const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::InputCapabilities()const
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MakeVisible(TBool)
	CCoeControl::MaximumWidth()const
	CCoeControl::MinimumSize()
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionChanged()
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::PrepareForFocusLossL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAdjacent(TInt)
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetContainerWindowL(const CCoeControl &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetDimmed(TBool)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateL(RWriteStream &)const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()

Public Member Enumerations
enum	TNaviLabelType { ENavigationLabel, EAdditionalInfoLabel, EHintText }

Inherited Enumerations
	CCoeControl:TZoomType

Private Attributes
TRgb	iColor
CAknNaviLabelExtension *	iExtension
const CFont *	iFont
TNaviLabelType	iLabelType
TInt	iLeftMargin
TInt	iRightMargin
TInt	iRightOffset
TInt	iSpare
HBufC *	iText

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize

Constructor & Destructor Documentation

CAknNaviLabel()

IMPORT_C

CAknNaviLabel

(

)

Constructor.

~CAknNaviLabel()

IMPORT_C

~CAknNaviLabel

(

)

Destructor.

Member Functions Documentation

Draw(const TRect &)

IMPORT_C void

Draw

(

const TRect &

aRect

)

const [protected, virtual]

From CCoeControl. Draw a control.

Parameters

const TRect & aRect

The region of the control to be redrawn.

ExtensionInterface(TUid)

IMPORT_C void *

ExtensionInterface

(

TUid

aInterface

)

[private, virtual]

From CAknControl

Parameters

TUid aInterface

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

From CCoeControl. Handles pointer event.

Parameters

const TPointerEvent & aPointerEvent

Pointer event to be handled.

LayoutText()

TAknLayoutText

LayoutText

(

)

const [private]

Reads the text layout from Aknlayout system.

NaviLabelType()

IMPORT_C TNaviLabelType

NaviLabelType

(

)

Returns type of the label.

SetNaviLabelType(TNaviLabelType)

IMPORT_C void

SetNaviLabelType

(

TNaviLabelType

aNaviLabelType

)

Set type of the label.

Parameters

TNaviLabelType aNaviLabelType

navigation label type.

SetTextL(const TDesC &)

IMPORT_C void

SetTextL

(

const TDesC &

aText

)

Sets navigation label text.

Parameters

const TDesC & aText

reference to the navigation text.

SizeChanged()

IMPORT_C void

SizeChanged

(

)

[protected, virtual]

From CCoeControl. Handle the size change events.

Text()

const TDesC *

Text

(

)

const [inline]

Returns the current label text.

WidthInsideMargins()

TInt

WidthInsideMargins

(

)

const [private]

Calculates width using margins.

Member Enumerations Documentation

Enum TNaviLabelType

Enumerators

ENavigationLabel
EAdditionalInfoLabel
EHintText

Member Data Documentation

TRgb iColor

TRgb

iColor

[private]

CAknNaviLabelExtension * iExtension

CAknNaviLabelExtension *

iExtension

[private]

const CFont * iFont

const CFont *

iFont

[private]

TNaviLabelType iLabelType

TNaviLabelType

iLabelType

[private]

TInt iLeftMargin

TInt

iLeftMargin

[private]

TInt iRightMargin

TInt

iRightMargin

[private]

TInt iRightOffset

TInt

iRightOffset

[private]

TInt iSpare

TInt

iSpare

[private]

HBufC * iText

HBufC *

iText

[private]