Symbian^3 Application Developer Library >

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 void ConstructFromResourceL ( TResourceReader &)
IMPORT_C void ConstructL ()
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C TInt MaxNumberOfVisibleTextRows ()
IMPORT_C void PrepareContext ( CWindowGc &)
IMPORT_C void SetFromResourceL ( TResourceReader &)
IMPORT_C void SetNumberOfVisibleTextRows ( TInt )
IMPORT_C void SetPicture (const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C void SetPictureFromFileL (const TDesC &, TInt , TInt )
IMPORT_C void SetSmallPicture (const CFbsBitmap *, const CFbsBitmap *, TBool )
IMPORT_C void SetText ( HBufC *)
IMPORT_C void SetText ( HBufC *, TBool )
IMPORT_C void SetTextL (const TDesC &)
IMPORT_C void SetTextL (const TDesC &, TBool )
IMPORT_C void SetTextToDefaultL ()
IMPORT_C void SetTitlePaneObserver (MAknTitlePaneObserver *)
const TDesC * Text ()
CEikLabel * TextLabel ()
CEikImage * TitleImage ()
Protected Member Functions
IMPORT_C CCoeControl * ComponentControl ( TInt )
IMPORT_C TInt CountComponentControls ()
IMPORT_C void HandleResourceChange ( TInt )
IMPORT_C void PositionChanged ()
IMPORT_C void SizeChanged ()
Private Member Functions
TUid AppUid ()
void CommonConstructL ()
IMPORT_C void Draw (const TRect &)
IMPORT_C void * ExtensionInterface ( TUid )
TInt FormatTitlePaneLabelL (const TInt , const TInt , const CFont *, const CFont *)
void ReadFromResourceFileL ( TResourceReader &)
void SetContainerWindowNonFading ( TBool )
void SetSmallPictureFromFileL (const TDesC &, TInt , TInt )
void SetupExtendedStatusPaneScrollEffectL ()
void SetupFlatStatusPaneFadeEffectL ()
void SetupFlatStatusPaneScrollEffectL ()
void SetupNoEffectL ()
void SetupNormalStatusPaneScrollEffectL ()
void SetupStaconPaneScrollEffectL ()
void SetupTitleLabelEffectL ()
void SizeChangedInExtendedStatusPane ()
void SizeChangedInFlatStatusPane ()
void SizeChangedInNormalStatusPane ()
void SizeChangedInStaconPane ()
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_C CAknTitlePane ( )

Constructor.

~CAknTitlePane()

IMPORT_C ~CAknTitlePane ( )

Destructor.

Member Functions Documentation

AppUid()

TUid AppUid ( ) const [private]

CommonConstructL()

void CommonConstructL ( ) [private]

ComponentControl(TInt)

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

Returns a control determined by control index.

Parameters

TInt aIndex Index of a control to be returned.

ConstructFromResourceL(TResourceReader &)

IMPORT_C void ConstructFromResourceL ( 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 void ConstructL ( )

2nd phase constructor.

CountComponentControls()

IMPORT_C TInt CountComponentControls ( ) const [protected, virtual]

Returns number of controls inside the title pane control.

Draw(const TRect &)

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

Parameters

const TRect & aRect

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [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 TInt aOneLineLayoutWidth,
const TInt aTwoLineLayoutWidth,
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 void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

Handles pointer events.

Parameters

const TPointerEvent & aPointerEvent Pointer event to be handled.

HandleResourceChange(TInt)

IMPORT_C void HandleResourceChange ( TInt aType ) [protected, virtual]

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

Parameters

TInt aType Event type.

MaxNumberOfVisibleTextRows()

IMPORT_C TInt MaxNumberOfVisibleTextRows ( ) 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.

Since
3.1

PositionChanged()

IMPORT_C void PositionChanged ( ) [protected, virtual]

Handles the position change events.

PrepareContext(CWindowGc &)

IMPORT_C void PrepareContext ( CWindowGc & aGc ) const [virtual]

Allows to modify graphics context before Draw .

Parameters

CWindowGc & aGc Graphics context to be modified.

ReadFromResourceFileL(TResourceReader &)

void ReadFromResourceFileL ( TResourceReader & aReader ) [private]

Parameters

TResourceReader & aReader

SetContainerWindowNonFading(TBool)

void SetContainerWindowNonFading ( TBool aNonFading ) [private]

Parameters

TBool aNonFading

SetFromResourceL(TResourceReader &)

IMPORT_C void SetFromResourceL ( TResourceReader & aReader )

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

Parameters

TResourceReader & aReader Resource reader of the title pane data.

SetNumberOfVisibleTextRows(TInt)

IMPORT_C void SetNumberOfVisibleTextRows ( TInt aRows )

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.

Since
3.1

Parameters

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

SetPicture(const CFbsBitmap *, const CFbsBitmap *)

IMPORT_C void SetPicture ( 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 * aBitmap Bitmap to be set on the title pane.
const CFbsBitmap * aMaskBitmap = NULL Mask of the bitmap.

SetPictureFromFileL(const TDesC &, TInt, TInt)

IMPORT_C void SetPictureFromFileL ( const TDesC & aFileName,
TInt aMainId,
TInt aMaskId = -1
)

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

Parameters

const TDesC & aFileName Name of the bitmap file.
TInt aMainId Index of the bitmap in the bitmap file.
TInt aMaskId = -1 Index of the bitmap's mask in the bitmap file.

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

IMPORT_C void SetSmallPicture ( const CFbsBitmap * aBitmap,
const CFbsBitmap * aMaskBitmap,
TBool aVisible
)

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.

Since
3.0

Parameters

const CFbsBitmap * aBitmap Bitmap to be set on the title pane.
const CFbsBitmap * aMaskBitmap Mask of the bitmap.
TBool aVisible If ETrue, picture is set visible. Otherwise only text is shown.

SetSmallPictureFromFileL(const TDesC &, TInt, TInt)

void SetSmallPictureFromFileL ( const TDesC & aFileName,
TInt aMainId,
TInt aMaskId = -1
) [private]

Parameters

const TDesC & aFileName
TInt aMainId
TInt aMaskId = -1

SetText(HBufC *)

IMPORT_C void SetText ( HBufC * aText )

Sets text to the title pane.

Parameters

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

SetText(HBufC *, TBool)

IMPORT_C void SetText ( HBufC * aText,
TBool aScroll
)

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.

Since
3.0

Parameters

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

SetTextL(const TDesC &)

IMPORT_C void SetTextL ( 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 & aText Text to be shown on the title pane.

SetTextL(const TDesC &, TBool)

IMPORT_C void SetTextL ( const TDesC & aText,
TBool aScroll
)

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.

Since
3.0

Parameters

const TDesC & aText Text to be shown on the title pane.
TBool aScroll If ETrue text is scrolled when needed, otherwise not.

SetTextToDefaultL()

IMPORT_C void SetTextToDefaultL ( )

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

SetTitlePaneObserver(MAknTitlePaneObserver *)

IMPORT_C void SetTitlePaneObserver ( MAknTitlePaneObserver * aObserver )

Sets observer for title pane events.

Parameters

MAknTitlePaneObserver * aObserver Pointer to title pane observer.

SetupExtendedStatusPaneScrollEffectL()

void SetupExtendedStatusPaneScrollEffectL ( ) [private]

SetupFlatStatusPaneFadeEffectL()

void SetupFlatStatusPaneFadeEffectL ( ) [private]

SetupFlatStatusPaneScrollEffectL()

void SetupFlatStatusPaneScrollEffectL ( ) [private]

SetupNoEffectL()

void SetupNoEffectL ( ) [private]

SetupNormalStatusPaneScrollEffectL()

void SetupNormalStatusPaneScrollEffectL ( ) [private]

SetupStaconPaneScrollEffectL()

void SetupStaconPaneScrollEffectL ( ) [private]

SetupTitleLabelEffectL()

void SetupTitleLabelEffectL ( ) [private]

SizeChanged()

IMPORT_C void SizeChanged ( ) [protected, virtual]

Handles the size change events.

SizeChangedInExtendedStatusPane()

void SizeChangedInExtendedStatusPane ( ) [private]

SizeChangedInFlatStatusPane()

void SizeChangedInFlatStatusPane ( ) [private]

SizeChangedInNormalStatusPane()

void SizeChangedInNormalStatusPane ( ) [private]

SizeChangedInStaconPane()

void SizeChangedInStaconPane ( ) [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.

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]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.