CAknTitlePane Class Reference

class CAknTitlePane : public CAknControl

A default control in the status pane's title pane.

avkon.lib

Inherits from

Public Member Functions
CAknTitlePane()
~CAknTitlePane()
IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C voidConstructL()
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C TIntMaxNumberOfVisibleTextRows()
IMPORT_C voidPrepareContext(CWindowGc &)
IMPORT_C voidSetFromResourceL(TResourceReader &)
IMPORT_C voidSetNumberOfVisibleTextRows(TInt)
IMPORT_C voidSetPicture(const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C voidSetPictureFromFileL(const TDesC &, TInt, TInt)
IMPORT_C voidSetSmallPicture(const CFbsBitmap *, const CFbsBitmap *, TBool)
IMPORT_C voidSetText(HBufC *)
IMPORT_C voidSetText(HBufC *, TBool)
IMPORT_C voidSetTextL(const TDesC &)
IMPORT_C voidSetTextL(const TDesC &, TBool)
IMPORT_C voidSetTextToDefaultL()
IMPORT_C voidSetTitlePaneObserver(MAknTitlePaneObserver *)
const TDesC *Text()
CEikLabel *TextLabel()
CEikImage *TitleImage()
Protected Member Functions
IMPORT_C CCoeControl *ComponentControl(TInt)
IMPORT_C TIntCountComponentControls()
IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C voidPositionChanged()
IMPORT_C voidSizeChanged()
Private Member Functions
TUid AppUid()
voidCommonConstructL()
IMPORT_C voidDraw(const TRect &)
IMPORT_C void *ExtensionInterface(TUid)
TInt FormatTitlePaneLabelL(const TInt, const TInt, const CFont *, const CFont *)
voidReadFromResourceFileL(TResourceReader &)
voidSetContainerWindowNonFading(TBool)
voidSetSmallPictureFromFileL(const TDesC &, TInt, TInt)
voidSetupExtendedStatusPaneScrollEffectL()
voidSetupFlatStatusPaneFadeEffectL()
voidSetupFlatStatusPaneScrollEffectL()
voidSetupNoEffectL()
voidSetupNormalStatusPaneScrollEffectL()
voidSetupStaconPaneScrollEffectL()
voidSetupTitleLabelEffectL()
voidSizeChangedInExtendedStatusPane()
voidSizeChangedInFlatStatusPane()
voidSizeChangedInNormalStatusPane()
voidSizeChangedInStaconPane()
RWindow *StatuspaneContainerWindow()
TBool TextFits(TAknTextLineLayout &)
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::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
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::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::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()
Inherited Enumerations
CCoeControl:TZoomType
Protected Attributes
MAknTitlePaneObserver *iTitlePaneObserver
Private Attributes
HBufC *iDefaultTitleText
CAknTitlePaneExtension *iExtension
TBool iImageShown
CAknTitlePaneLabel *iTitleLabel
HBufC *iTitleText
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CAknTitlePane()

IMPORT_CCAknTitlePane()

Constructor.

~CAknTitlePane()

IMPORT_C~CAknTitlePane()

Destructor.

Member Functions Documentation

AppUid()

TUid AppUid()const [private]

CommonConstructL()

voidCommonConstructL()[private]

ComponentControl(TInt)

IMPORT_C CCoeControl *ComponentControl(TIntaIndex)const [protected, virtual]

Returns a control determined by control index.

Pointer to the control.

Parameters

TInt aIndexIndex of a control to be returned.

ConstructFromResourceL(TResourceReader &)

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[virtual]

Read title pane data from resource file and show it in the status pane's title pane.

Parameters

TResourceReader & aReader

ConstructL()

IMPORT_C voidConstructL()

2nd phase constructor.

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [protected, virtual]

Returns number of controls inside the title pane control.

Number of component controls.

Draw(const TRect &)

IMPORT_C voidDraw(const TRect &aRect)const [private, virtual]

Parameters

const TRect & aRect

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Virtual method provided to allow extensibility of virtual behaviour

Parameters

TUid aInterface

FormatTitlePaneLabelL(const TInt, const TInt, const CFont *, const CFont *)

TInt FormatTitlePaneLabelL(const TIntaOneLineLayoutWidth,
const TIntaTwoLineLayoutWidth,
const CFont *aOneLineFont,
const CFont *aTwoLineFont
)[private]

Parameters

const TInt aOneLineLayoutWidth
const TInt aTwoLineLayoutWidth
const CFont * aOneLineFont
const CFont * aTwoLineFont

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

Handles pointer events.

Parameters

const TPointerEvent & aPointerEventPointer event to be handled.

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[protected, virtual]

Handles a change to the control's resources which are shared across the environment, e.g. skin change.

Parameters

TInt aTypeEvent type.

MaxNumberOfVisibleTextRows()

IMPORT_C TIntMaxNumberOfVisibleTextRows()const

Gets the maximum amount of text rows that title pane is able to display simultaneously in the currently active status pane layout. Typically the return value is either 2 (default portrait mode layout) or 1 (landscape mode layouts). In the extended status pane layouts the maximum number of lines is always 1.

Since release 3.2, regardless of the status pane layout, the maximum number of lines is always 1.

3.1

Maximum number of visible text lines.

PositionChanged()

IMPORT_C voidPositionChanged()[protected, virtual]

Handles the position change events.

PrepareContext(CWindowGc &)

IMPORT_C voidPrepareContext(CWindowGc &aGc)const [virtual]

Allows to modify graphics context before Draw.

Parameters

CWindowGc & aGcGraphics context to be modified.

ReadFromResourceFileL(TResourceReader &)

voidReadFromResourceFileL(TResourceReader &aReader)[private]

Parameters

TResourceReader & aReader

SetContainerWindowNonFading(TBool)

voidSetContainerWindowNonFading(TBoolaNonFading)[private]

Parameters

TBool aNonFading

SetFromResourceL(TResourceReader &)

IMPORT_C voidSetFromResourceL(TResourceReader &aReader)

Set data from resource file and show it in the status pane's title pane.

Parameters

TResourceReader & aReaderResource reader of the title pane data.

SetNumberOfVisibleTextRows(TInt)

IMPORT_C voidSetNumberOfVisibleTextRows(TIntaRows)

Sets the number of text rows that can be used to display the text. The largest allowed value is the the value returned from MaxNumberOfVisibleTextRows() and the minimum value is always 1.

3.1

Parameters

TInt aRowsNumber of rows that can be used to display the text.

SetPicture(const CFbsBitmap *, const CFbsBitmap *)

IMPORT_C voidSetPicture(const CFbsBitmap *aBitmap,
const CFbsBitmap *aMaskBitmap = NULL
)

Set a picture to the title pane and show it in the status pane's title pane. Title pane object takes ownership of the picture. If NULL bitmap is passed, previously set image is shown.

Parameters

const CFbsBitmap * aBitmapBitmap to be set on the title pane.
const CFbsBitmap * aMaskBitmap = NULLMask of the bitmap.

SetPictureFromFileL(const TDesC &, TInt, TInt)

IMPORT_C voidSetPictureFromFileL(const TDesC &aFileName,
TIntaMainId,
TIntaMaskId = -1
)

Set a picture from file and show it in the status pane's title pane.

Parameters

const TDesC & aFileNameName of the bitmap file.
TInt aMainIdIndex of the bitmap in the bitmap file.
TInt aMaskId = -1Index of the bitmap's mask in the bitmap file.

SetSmallPicture(const CFbsBitmap *, const CFbsBitmap *, TBool)

IMPORT_C voidSetSmallPicture(const CFbsBitmap *aBitmap,
const CFbsBitmap *aMaskBitmap,
TBoolaVisible
)

Set a small picture to the title pane and show it in the status pane's title pane together with text.

Title pane object takes ownership of the picture.

If NULL bitmap is passed, previously set image is used.

3.0

Parameters

const CFbsBitmap * aBitmapBitmap to be set on the title pane.
const CFbsBitmap * aMaskBitmapMask of the bitmap.
TBool aVisibleIf ETrue, picture is set visible. Otherwise only text is shown.

SetSmallPictureFromFileL(const TDesC &, TInt, TInt)

voidSetSmallPictureFromFileL(const TDesC &aFileName,
TIntaMainId,
TIntaMaskId = -1
)[private]

Parameters

const TDesC & aFileName
TInt aMainId
TInt aMaskId = -1

SetText(HBufC *)

IMPORT_C voidSetText(HBufC *aText)

Sets text to the title pane.

Parameters

HBufC * aTextNew text. This object takes ownership of aText.

SetText(HBufC *, TBool)

IMPORT_C voidSetText(HBufC *aText,
TBoolaScroll
)

Sets text to the title pane. If whole text does not fit into titlepane, it will be scrolled once and then shown in truncated form.

3.0

Parameters

HBufC * aTextNew text. This object takes ownership of aText. If NULL is given then already existing text's scrollability will be changed according to aScroll.
TBool aScrollIf ETrue text is scrolled when needed, otherwise not.

SetTextL(const TDesC &)

IMPORT_C voidSetTextL(const TDesC &aText)

Set a text and show it in the status pane's title pane. Descriptor is copied to the title pane control and ownership of the original descriptor is left to the application.

Parameters

const TDesC & aTextText to be shown on the title pane.

SetTextL(const TDesC &, TBool)

IMPORT_C voidSetTextL(const TDesC &aText,
TBoolaScroll
)

Set a text and show it in the status pane's title pane. If whole text does not fit into titlepane, it will be scrolled once and then shown in truncated form.

Descriptor is copied to the title pane control and ownership of the original descriptor is left to the application.

3.0

Parameters

const TDesC & aTextText to be shown on the title pane.
TBool aScrollIf ETrue text is scrolled when needed, otherwise not.

SetTextToDefaultL()

IMPORT_C voidSetTextToDefaultL()

Set default value to the status pane's title pane. Default value is the name of currently active application.

SetTitlePaneObserver(MAknTitlePaneObserver *)

IMPORT_C voidSetTitlePaneObserver(MAknTitlePaneObserver *aObserver)

Sets observer for title pane events.

Parameters

MAknTitlePaneObserver * aObserverPointer to title pane observer.

SetupExtendedStatusPaneScrollEffectL()

voidSetupExtendedStatusPaneScrollEffectL()[private]

SetupFlatStatusPaneFadeEffectL()

voidSetupFlatStatusPaneFadeEffectL()[private]

SetupFlatStatusPaneScrollEffectL()

voidSetupFlatStatusPaneScrollEffectL()[private]

SetupNoEffectL()

voidSetupNoEffectL()[private]

SetupNormalStatusPaneScrollEffectL()

voidSetupNormalStatusPaneScrollEffectL()[private]

SetupStaconPaneScrollEffectL()

voidSetupStaconPaneScrollEffectL()[private]

SetupTitleLabelEffectL()

voidSetupTitleLabelEffectL()[private]

SizeChanged()

IMPORT_C voidSizeChanged()[protected, virtual]

Handles the size change events.

SizeChangedInExtendedStatusPane()

voidSizeChangedInExtendedStatusPane()[private]

SizeChangedInFlatStatusPane()

voidSizeChangedInFlatStatusPane()[private]

SizeChangedInNormalStatusPane()

voidSizeChangedInNormalStatusPane()[private]

SizeChangedInStaconPane()

voidSizeChangedInStaconPane()[private]

StatuspaneContainerWindow()

RWindow *StatuspaneContainerWindow()const [private]

Text()

const TDesC *Text()const [inline]

Returns text currently in the status pane's title pane. Ownership is not transferred.

Text currently shown in the title pane.

TextFits(TAknTextLineLayout &)

TBool TextFits(TAknTextLineLayout &aTextLayout)[private]

Parameters

TAknTextLineLayout & aTextLayout

TextLabel()

CEikLabel *TextLabel()

Gets title text label.

TitleImage()

CEikImage *TitleImage()

Gets the title image.

Member Data Documentation

HBufC * iDefaultTitleText

HBufC *iDefaultTitleText[private]

CAknTitlePaneExtension * iExtension

CAknTitlePaneExtension *iExtension[private]

TBool iImageShown

TBool iImageShown[private]

CAknTitlePaneLabel * iTitleLabel

CAknTitlePaneLabel *iTitleLabel[private]

MAknTitlePaneObserver * iTitlePaneObserver

MAknTitlePaneObserver *iTitlePaneObserver[protected]

HBufC * iTitleText

HBufC *iTitleText[private]