CAknContextPane Class Reference

#include <mw/akncontext.h>

class CAknContextPane : public CAknControl

Inherits from

Public Member Enumerations
enumanonymous { ETypeId }
Public Member Functions
CAknContextPane()
~CAknContextPane()
virtual IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C voidConstructL()
virtual IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C const CEikImage &Picture()
IMPORT_C voidSetFromResourceL(TResourceReader &)
voidSetNaviPaneBackgroundType(TInt)
IMPORT_C voidSetPicture(const CFbsBitmap *, const CFbsBitmap *)
IMPORT_C voidSetPicture(CEikImage *)
IMPORT_C voidSetPictureFromFileL(const TDesC &, TInt, TInt)
IMPORT_C voidSetPictureToDefaultL()
IMPORT_C CEikImage *SwapPicture(CEikImage *)
Protected Member Functions
virtual IMPORT_C CCoeControl *ComponentControl(TInt)
virtual IMPORT_C TIntCountComponentControls()
virtual IMPORT_C voidHandleResourceChange(TInt)
TTypeUid::Ptr MopSupplyObject(TTypeUid)
virtual IMPORT_C voidSizeChanged()
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
Inherited Enumerations
CCoeControl:TZoomType
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::CCoeControlArray
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()

Detailed Description

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

Member Enumeration Documentation

Enum anonymous

EnumeratorValueDescription
ETypeId0x101F8741

Constructor & Destructor Documentation

CAknContextPane ( )

IMPORT_CCAknContextPane()

Standard constructor

~CAknContextPane ( )

IMPORT_C~CAknContextPane()

Destructor

Member Function Documentation

ComponentControl ( TInt )

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

From CCoeControl. Returns a control determined by control id.

Returns: Pointer to control

ConstructFromResourceL ( TResourceReader & )

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[virtual]

Construct from resources.

ParameterDescription
aReaderresource reader.

ConstructL ( )

IMPORT_C voidConstructL()

2nd phase construction

CountComponentControls ( )

IMPORT_C TIntCountComponentControls()const [protected, virtual]

From CCoeControl. Returns number of controls inside the context pane control.

Returns: Number of component controls.

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

From CCoeControl. Handles pointer events

HandleResourceChange ( TInt )

IMPORT_C voidHandleResourceChange(TIntaType)[protected, virtual]

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

ParameterDescription
aTypeEvent type.

MopSupplyObject ( TTypeUid )

TTypeUid::Ptr MopSupplyObject(TTypeUidaId)[protected]

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)

Returns: Reference to the current context pane bitmap.

SetFromResourceL ( TResourceReader & )

IMPORT_C voidSetFromResourceL(TResourceReader &aReader)

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

SetNaviPaneBackgroundType ( TInt )

voidSetNaviPaneBackgroundType(TIntaType)

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

ParameterDescription
aTypeBackground type.

SetPicture ( const CFbsBitmap *, const CFbsBitmap * )

IMPORT_C voidSetPicture(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.

ParameterDescription
aBitmapnew bitmap to the context pane.
aMaskBitmapmask of the bitmap.

SetPicture ( CEikImage * )

IMPORT_C voidSetPicture(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.

ParameterDescription
aImagenew bitmap and its mask.

SetPictureFromFileL ( const TDesC &, TInt, TInt )

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

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

ParameterDescription
aFileNamename of the bitmap file.
aMainIdid of the bitmap in the bitmap file.
aMaskIdid of the bitmap's mask in the bitmap file.

SetPictureToDefaultL ( )

IMPORT_C voidSetPictureToDefaultL()

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

SizeChanged ( )

IMPORT_C voidSizeChanged()[protected, virtual]

Reimplemented from CCoeControl::SizeChanged()

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.

ParameterDescription
aNewImagenew bitmap to the context pane. This object takes ownership of aNewImage.

Returns: Previous context pane bitmap. The caller is responsible of deleting the returned object.