CAknVolumeControl Class Reference

#include <mw/Aknvolumecontrol.h>

class CAknVolumeControl : public CAknControl

Inherits from

Public Member Functions
CAknVolumeControl()
~CAknVolumeControl()
virtual IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C CFbsBitmap *CreateBitmapL(TInt)
IMPORT_C CGulIcon *CreateSetDynRangeStyleListBoxIconL(TInt, TInt, TInt)
IMPORT_C CGulIcon *CreateSetStyleListBoxIconL(TInt)
IMPORT_C voidGetRange(TInt &, TInt &)
IMPORT_C voidHandleNaviDecoratorEventL(TInt)
voidHandleNaviStackChange(TBool)
virtual IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
virtual IMPORT_C voidHandleResourceChange(TInt)
virtual TSize MinimumSize()
virtual TKeyResponse OfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C voidSetRange(TInt, TInt)
IMPORT_C voidSetValue(TInt)
voidSuppressDrawing(TBool)
IMPORT_C TIntValue()
Protected Member Functions
virtual voidDraw(const TRect &)
virtual 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::ComponentControl(TInt)const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CountComponentControls()const
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::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
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

Used for controlling the volume setting on the phone.

Constructor & Destructor Documentation

CAknVolumeControl ( )

IMPORT_CCAknVolumeControl()

C++ default constructor.

~CAknVolumeControl ( )

IMPORT_C~CAknVolumeControl()

Destructor.

Member Function Documentation

ConstructFromResourceL ( TResourceReader & )

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[virtual]

Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &)

From CCoeControl.

Construct item from given resource.

ParameterDescription
aReaderResource reader reading the wanted resource set.

CreateBitmapL ( TInt )

IMPORT_C CFbsBitmap *CreateBitmapL(TIntaValue)[static]

Creates volume bitmap to "list pane for setting item" (setting option item volume graphic). Ownership of the returned bitmap is transfered to the caller.

ParameterDescription
aValueCurrent value (1-10)

Returns: Volume bitmap. Ownership of the bitmap is transfered to the caller.

CreateSetDynRangeStyleListBoxIconL ( TInt, TInt, TInt )

IMPORT_C CGulIcon *CreateSetDynRangeStyleListBoxIconL(TIntaValue,
TIntaMinimum,
TIntaMaximum
)[static]

Creates Hi-res volume icon to "list pane for setting item" (setting option item volume graphic). Ownership of the returned icon is transfered to the caller.

Since
3.2
ParameterDescription
aValueCurrent value (1-10)
aMinimumMinimum for Hi-res volume control
aMaximumMaximum for Hi-res volume control

Returns: Volume icon. Ownership of the icon is transfered to the caller.

CreateSetStyleListBoxIconL ( TInt )

IMPORT_C CGulIcon *CreateSetStyleListBoxIconL(TIntaValue)[static]

Creates general volume icon to "list pane for setting item" (setting option item volume graphic). Ownership of the returned icon is transfered to the caller.

ParameterDescription
aValueCurrent value (1-10)

Returns: Volume icon. Ownership of the icon is transfered to the caller.

Draw ( const TRect & )

voidDraw(const TRect &aRect)const [protected, virtual]

Reimplemented from CCoeControl::Draw(const TRect &)const

From CCoeControl.

Draws every visible item into the specified rectangle.

ParameterDescription
aRectthe specified rectangle.

GetRange ( TInt &, TInt & )

IMPORT_C voidGetRange(TInt &aMinimumValue,
TInt &aMaximumValue
)
Gets the range of the volume control.
Since
3.2
ParameterDescription
aMinimumValueThe minimum value of the volume control
aMaximumValueThe maximum value of the volume control

HandleNaviDecoratorEventL ( TInt )

IMPORT_C voidHandleNaviDecoratorEventL(TIntaEventID)

From MAknNaviDecoratorObserver

Handles Navidecorator events (Arrow left and arrow right)

ParameterDescription
aEventIDID of event to be handled

HandleNaviStackChange ( TBool )

voidHandleNaviStackChange(TBoolaIsOnNaviStack)

Informs the volume control about whether or not it's placed on the navi pane's control stack

ParameterDescription
aIsOnNaviStackETrue if the control is on the navi stack, EFalse otherwise.

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

Reimplemented from CCoeControl::HandlePointerEventL(const TPointerEvent &)

From CCoeControl.

Handles pointer events.

ParameterDescription
aPointerEventPointer event to be handled

HandleResourceChange ( TInt )

IMPORT_C voidHandleResourceChange(TIntaType)[virtual]

Reimplemented from CCoeControl::HandleResourceChange(TInt)

From CCoeControl.

Handles the change of CAknVolumeControl's resources.

ParameterDescription
aTypeType of resource to change

MinimumSize ( )

TSize MinimumSize()[virtual]

Reimplemented from CCoeControl::MinimumSize()

From CCoeControl.

Gets minimun size of layout rectangle.

Returns: Minimum layout rectangle size.

OfferKeyEventL ( const TKeyEvent &, TEventCode )

TKeyResponse OfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

Reimplemented from CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)

From CCoeControl

Handles key events.

ParameterDescription
aKeyEventKey event to be handled.
aTypeType of the event.

Returns: Returns EKeyConsumed if key event was handled.

SetRange ( TInt, TInt )

IMPORT_C voidSetRange(TIntaMinimumValue,
TIntaMaximumValue
)

Sets the range of the volume control. Maximum value must be greater than the minimum value, or the method will Panic.

Since
3.2
Exceptions:
Will panic with EAknPanicInvalidValue if the minimum value is greater or equal than maximum value.
ParameterDescription
aMinimumValueThe minimum value of the volume control
aMaximumValueThe maximum value of the volume control

SetValue ( TInt )

IMPORT_C voidSetValue(TIntaValue)

Sets volume.

ParameterDescription
aValueThe new volume.

SizeChanged ( )

voidSizeChanged()[protected, virtual]

Reimplemented from CCoeControl::SizeChanged()

From CCoeControl.

Handles layout change.

SuppressDrawing ( TBool )

voidSuppressDrawing(TBoolaSuppress)

Value ( )

IMPORT_C TIntValue()const

Gets volume.

Returns: The volume setting.