CAknVolumeControl Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknvolumecontrol.h>

Inherits CAknControl, and MAknNaviDecoratorObserver.

Detailed Description

Used for controlling the volume setting on the phone.


Public Member Functions
IMPORT_C�	CAknVolumeControl ()
�	C++ default constructor.
IMPORT_C�	~CAknVolumeControl ()
�	Destructor.
IMPORT_C void�	SetValue (TInt aValue)
�	Sets volume.
IMPORT_C TInt�	Value () const
�	Gets volume.
TSize�	MinimumSize ()
�	From `CCoeControl`.
TKeyResponse�	OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
�	From `CCoeControl`.
IMPORT_C void�	ConstructFromResourceL (TResourceReader &aReader)
�	From `CCoeControl`.
IMPORT_C void�	HandleResourceChange (TInt aType)
�	From `CCoeControl`.
IMPORT_C void�	HandlePointerEventL (const TPointerEvent &aPointerEvent)
�	From `CCoeControl`.
IMPORT_C void�	HandleNaviDecoratorEventL (TInt aEventID)
�	From `MAknNaviDecoratorObserver`.
Static Public Member Functions
static IMPORT_C CFbsBitmap *�	CreateBitmapL (TInt aValue)
�	Creates volume bitmap to "list pane for setting item" (setting option item volume graphic).
static IMPORT_C CGulIcon *�	CreateSetStyleListBoxIconL (TInt aValue)
�	Creates volume icon to "list pane for setting item" (setting option item volume graphic).
Protected Member Functions
void�	SizeChanged ()
�	From `CCoeControl`.
void�	Draw (const TRect &aRect) const
�	From `CCoeControl`.

Constructor & Destructor Documentation

IMPORT_C CAknVolumeControl::CAknVolumeControl

�	C++ default constructor.

IMPORT_C CAknVolumeControl::~CAknVolumeControl

�	Destructor.

Member Function Documentation

IMPORT_C void CAknVolumeControl::ConstructFromResourceL

TResourceReader &�

From CCoeControl.

Construct item from given resource.

Parameters:

Resource reader reading the wanted resource set.

static IMPORT_C CFbsBitmap* CAknVolumeControl::CreateBitmapL (� TInt� aValue �)� [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.

Parameters:

Current value (1-10)

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

static IMPORT_C CGulIcon* CAknVolumeControl::CreateSetStyleListBoxIconL (� TInt� aValue �)� [static]

Creates volume icon to "list pane for setting item" (setting option item volume graphic).

Ownership of the returned icon is transfered to the caller.

Parameters:

Current value (1-10)

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

void CAknVolumeControl::Draw (� const TRect &� aRect �)� const [protected]

From CCoeControl.

Draws every visible item into the specified rectangle.

Parameters:

the specified rectangle.

IMPORT_C void CAknVolumeControl::HandleNaviDecoratorEventL (� TInt� aEventID �)� [virtual]

From MAknNaviDecoratorObserver.

Handles Navidecorator events (Arrow left and arrow right)

Parameters:

ID of event to be handled

Implements MAknNaviDecoratorObserver.

IMPORT_C void CAknVolumeControl::HandlePointerEventL

const TPointerEvent &�

aPointerEvent

From CCoeControl.

Handles pointer events.

Parameters:

aPointerEvent�

Pointer event to be handled

IMPORT_C void CAknVolumeControl::HandleResourceChange

From CCoeControl.

Handles the change of CAknVolumeControl's resources.

Parameters:

Type of resource to change

TSize CAknVolumeControl::MinimumSize

�	From `CCoeControl`. Gets minimun size of layout rectangle. Returns: Minimum layout rectangle size.

TKeyResponse CAknVolumeControl::OfferKeyEventL	(�	const TKeyEvent &�	aKeyEvent,
		TEventCode�	aType
	)�

From CCoeControl.

Handles key events.

Parameters:

	aKeyEvent�	Key event to be handled.
	aType�	Type of the event.

Returns:: Returns EKeyConsumed if key event was handled.

IMPORT_C void CAknVolumeControl::SetValue

Sets volume.

Parameters:

The new volume.

void CAknVolumeControl::SizeChanged (� �)� [protected]

�	From `CCoeControl`. Handles layout change.

IMPORT_C TInt CAknVolumeControl::Value

�	Gets volume. Returns: The volume setting.

The documentation for this class was generated from the following file:

aknvolumecontrol.h

Copyright � Nokia Corporation 2001-2007