Collapse all Symbian^3 Application Developer Library

CAknBatteryPane Class Reference

class CAknBatteryPane : public CCoeControl

A default control in the status pane's battery pane. The control draws battery strength indicator graphics.

Inherits from

CAknBatteryPane
- CCoeControl
  - CBase

Public Member Functions
	CAknBatteryPane ()
	~CAknBatteryPane ()
TInt	BatteryLevel ()
TInt	BatteryState ()
IMPORT_C void	ConstructFromResourceL ( TResourceReader &)
void	HandlePointerEventL (const TPointerEvent &)
TBool	Recharging ()
IMPORT_C void	SetBatteryLevel ( TInt )
void	SetBatteryStateL ( TInt )
void	SetRecharge ( TBool )

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
IMPORT_C void	ConstructL ()
TInt	DoTick ()
IMPORT_C void	Draw (const TRect &)
void	DrawInFlatStatusPane (const TRect &)
void	DrawInNormalStatusPane (const TRect &)
void	DrawInStaconPane (const TRect &)
IMPORT_C void *	ExtensionInterface ( TUid )
void	SetContainerWindowNonFading ( TBool )
TInt	TickerCallback ( TAny *)

Inherited Functions
	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

Private Attributes
CAknBatteryIcon *	iBatteryIconControl
TInt	iBatteryLevel
CAknBatteryStrength *	iBatteryStrengthControl
CAknBatteryDataObserver *	iDataObserver
TBool	iIsActiveIdle
TInt	iPrivateFlags
CEikStatusPaneBase *	iStatusPane
CPeriodic *	iTicker

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

Constructor & Destructor Documentation

CAknBatteryPane()

IMPORT_C

CAknBatteryPane

(

)

Constructor.

~CAknBatteryPane()

IMPORT_C

~CAknBatteryPane

(

)

Destructor.

Member Functions Documentation

BatteryLevel()

TInt

BatteryLevel

(

)

Gets battery strength value from the battery indicator.

BatteryState()

TInt

BatteryState

(

)

Gets the battery state value from the battery indicator.

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]

Resource constructor.

Parameters

TResourceReader & aReader

Resource reader.

ConstructL()

IMPORT_C void

ConstructL

(

)

[private]

CountComponentControls()

IMPORT_C TInt

CountComponentControls

(

)

const [protected, virtual]

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

DoTick()

TInt

DoTick

(

)

[private]

Draw(const TRect &)

IMPORT_C void

Draw

(

const TRect &

aRect

)

const [private, virtual]

Parameters

const TRect & aRect

DrawInFlatStatusPane(const TRect &)

void

DrawInFlatStatusPane

(

const TRect &

aRect

)

const [private]

Parameters

const TRect & aRect

DrawInNormalStatusPane(const TRect &)

void

DrawInNormalStatusPane

(

const TRect &

aRect

)

const [private]

Parameters

const TRect & aRect

DrawInStaconPane(const TRect &)

void

DrawInStaconPane

(

const TRect &

aRect

)

const [private]

Parameters

const TRect & aRect

ExtensionInterface(TUid)

IMPORT_C void *

ExtensionInterface

(

TUid

aInterface

)

[private]

From CAknControl

Parameters

TUid aInterface

HandlePointerEventL(const TPointerEvent &)

void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

From CCoeControl . Handles pointer event

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 of type aType which are shared across the environment.

Parameters

TInt aType

Event type.

PositionChanged()

IMPORT_C void

PositionChanged

(

)

[protected, virtual]

From CCoeControl . Handle the position change events.

Recharging()

TBool

Recharging

(

)

Tells if battery recharging animation is on/off.

SetBatteryLevel(TInt)

IMPORT_C void

SetBatteryLevel

(

TInt

aLevel

)

Sets battery strength value to the battery indicator.

Parameters

TInt aLevel

Battery strength value ( 0 - 7 ).

SetBatteryStateL(TInt)

void

SetBatteryStateL

(

TInt

aState

)

Sets the battery state value for the battery indicator.

Parameters

TInt aState

Battery state value.

SetContainerWindowNonFading(TBool)

void

SetContainerWindowNonFading

(

TBool

aNonFading

)

[private]

Parameters

TBool aNonFading

SetRecharge(TBool)

void

SetRecharge

(

TBool

aRecharging

)

Sets battery recharging animation on/off.

Parameters

TBool aRecharging

ETrue if animation is to be shown.

SizeChanged()

IMPORT_C void

SizeChanged

(

)

[protected, virtual]

From CCoeControl . Handle the size change events.

TickerCallback(TAny *)

TInt

TickerCallback

(

TAny *

aThis

)

[private, static]

Parameters

TAny * aThis

Member Data Documentation

CAknBatteryIcon * iBatteryIconControl

CAknBatteryIcon *

iBatteryIconControl

[private]

TInt iBatteryLevel

TInt

iBatteryLevel

[private]

CAknBatteryStrength * iBatteryStrengthControl

CAknBatteryStrength *

iBatteryStrengthControl

[private]

CAknBatteryDataObserver * iDataObserver

CAknBatteryDataObserver *

iDataObserver

[private]

TBool iIsActiveIdle

TBool

iIsActiveIdle

[private]

TInt iPrivateFlags

TInt

iPrivateFlags

[private]

CEikStatusPaneBase * iStatusPane

CEikStatusPaneBase *

iStatusPane

[private]

CPeriodic * iTicker

CPeriodic *

iTicker

[private]