Symbian^3 Application Developer Library >

CAknContextPane Class Reference

class CAknContextPane : public CAknControl

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

Inherits from

Public Member Functions
CAknContextPane ()
~CAknContextPane ()
IMPORT_C void ConstructFromResourceL ( TResourceReader &)
IMPORT_C void ConstructL ()
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C const CEikImage & Picture ()
IMPORT_C void SetFromResourceL ( TResourceReader &)
void SetNaviPaneBackgroundType ( TInt )
IMPORT_C void SetPicture (const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C void SetPicture ( CEikImage *)
IMPORT_C void SetPictureFromFileL (const TDesC &, TInt , TInt )
IMPORT_C void SetPictureToDefaultL ()
IMPORT_C CEikImage * SwapPicture ( CEikImage *)
Protected Member Functions
IMPORT_C CCoeControl * ComponentControl ( TInt )
IMPORT_C TInt CountComponentControls ()
IMPORT_C void HandleResourceChange ( TInt )
TTypeUid::Ptr MopSupplyObject ( TTypeUid )
IMPORT_C void SizeChanged ()
Private Member Functions
TUid AppUid ()
void CommonConstructL ()
IMPORT_C void Draw (const TRect &)
IMPORT_C void * ExtensionInterface ( TUid )
void InitL ()
void LoadNaviWipeBitmapL ()
void ReadFromResourceFileL ( TResourceReader &)
void SetPictureSize ( CFbsBitmap *, TSize )
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::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()
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
CAknContextPaneExtension * iExtension
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CAknContextPane()

IMPORT_C CAknContextPane ( )

Standard constructor

~CAknContextPane()

IMPORT_C ~CAknContextPane ( )

Destructor

Member Functions Documentation

AppUid()

TUid AppUid ( ) [private]

Returns application's Uid. In embedded applications, root application's Uid is returned.

CommonConstructL()

void CommonConstructL ( ) [private]

ComponentControl(TInt)

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

From CCoeControl . Returns a control determined by control id.

Parameters

TInt aIndex

ConstructFromResourceL(TResourceReader &)

IMPORT_C void ConstructFromResourceL ( TResourceReader & aReader ) [virtual]

Construct from resources.

Parameters

TResourceReader & aReader resource reader.

ConstructL()

IMPORT_C void ConstructL ( )

2nd phase construction

CountComponentControls()

IMPORT_C TInt CountComponentControls ( ) const [protected, virtual]

From CCoeControl . Returns number of controls inside the context 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]

From CAknControl

Parameters

TUid aInterface

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

From CCoeControl . Handles pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

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

Handles a change to the control's resources of type aType which are shared across the environment, e.g. color scheme change.

Parameters

TInt aType Event type.

InitL()

void InitL ( ) [private]

LoadNaviWipeBitmapL()

void LoadNaviWipeBitmapL ( ) [private]

MopSupplyObject(TTypeUid)

TTypeUid::Ptr MopSupplyObject ( TTypeUid aId ) [protected]

Parameters

TTypeUid aId

Picture()

IMPORT_C const CEikImage & Picture ( ) const

Returns a reference to the current context pane bitmap. The reference is lost when context pane bitmap is changed with any Set -method including SetPictureToDefaultL and SwapPicture)

ReadFromResourceFileL(TResourceReader &)

void ReadFromResourceFileL ( TResourceReader & aReader ) [private]

Parameters

TResourceReader & aReader

SetFromResourceL(TResourceReader &)

IMPORT_C void SetFromResourceL ( TResourceReader & aReader )

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

Parameters

TResourceReader & aReader

SetNaviPaneBackgroundType(TInt)

void SetNaviPaneBackgroundType ( TInt aType )

Set the background type. This method is used by the UI framework for for syncronizing this components background type with navipane background type.

Available backgroud types are: EAknNaviPaneBackgroundTypeNotDefined EAknNaviPaneBackgroundTypeWipe EAknNaviPaneBackgroundTypeSolid

Parameters

TInt aType Background type.

SetPicture(const CFbsBitmap *, const CFbsBitmap *)

IMPORT_C void SetPicture ( const CFbsBitmap * aBitmap,
const CFbsBitmap * aMaskBitmap = NULL
)

Sets bitmap with mask to the context pane and shows it in the status pane's context pane. Context pane object takes ownership of the bitmap.

Parameters

const CFbsBitmap * aBitmap new bitmap to the context pane.
const CFbsBitmap * aMaskBitmap = NULL mask of the bitmap.

SetPicture(CEikImage *)

IMPORT_C void SetPicture ( CEikImage * aImage )

Sets bitmap to the context pane and shows it in the status pane's context pane. Context pane object takes ownership of the bitmap.

Parameters

CEikImage * aImage new bitmap and its mask.

SetPictureFromFileL(const TDesC &, TInt, TInt)

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

Sets bitmap to the context pane from file and shows it in the status pane's context pane.

Parameters

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

SetPictureSize(CFbsBitmap *, TSize)

void SetPictureSize ( CFbsBitmap * aPicture,
TSize aSize
) [private]

Parameters

CFbsBitmap * aPicture
TSize aSize

SetPictureToDefaultL()

IMPORT_C void SetPictureToDefaultL ( )

Show context pane's default bitmap. Application's AIF file icon is used if it exists.

SizeChanged()

IMPORT_C void SizeChanged ( ) [protected, virtual]

From CCoeControl . Handle the size change events.

SwapPicture(CEikImage *)

IMPORT_C CEikImage * SwapPicture ( CEikImage * aNewImage )

Sets bitmap with mask to the context pane and shows it in the status pane's context pane. Context pane object takes ownership of the bitmap. Old bitmap is returned and the caller is responsible of deleting the returned object.

Parameters

CEikImage * aNewImage new bitmap to the context pane. This object takes ownership of aNewImage.

Member Data Documentation

CAknContextPaneExtension * iExtension

CAknContextPaneExtension * iExtension [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.