Collapse all Symbian^3 Application Developer Library

MPhoneDialerController Class Reference

class MPhoneDialerController

Abstract dialer controller interface. Dialer controller provides data to be shown on dialer UI (e.g. prompt text and toolbar button contents), but is agnostic to implementation details and layout of the dialer UI components.

PhoneUiView.lib

Since: S60 v5.0

Nested Classes and Structures

MPhoneDialerController::CButtonData

Public Member Functions
TBool	ButtonDimmed ( TButtonIndex )
TInt	ButtonState ( TButtonIndex )
TInt	CbaResourceId ()
TBool	EasyDialingAllowed ()
TInt	GetButtonData ( TButtonIndex , RPointerArray < CButtonData > &)
TInt	MenuResourceId ()
const TDesC &	NumberEntryPromptTextL ()
void	SetNumberEntryIsEmpty ( TBool )

Public Member Enumerations
enum	TButtonIndex { EClearButton = 0, ECallButton , EPhonebookButton , ENumberOfButtons }

Member Functions Documentation

ButtonDimmed(TButtonIndex)

TBool

ButtonDimmed

(

TButtonIndex

aIndex

)

const [pure virtual]

Gets dimming status of the given button

Since: S60 v5.2

Parameters

TButtonIndex aIndex

Index of the button for which dimming status is queried.

ButtonState(TButtonIndex)

TInt

ButtonState

(

TButtonIndex

aIndex

)

const [pure virtual]

Gets current state of the given button.

Since: S60 v5.2

Parameters

TButtonIndex aIndex

Index of the button for which state is queried.

CbaResourceId()

TInt

CbaResourceId

(

)

const [pure virtual]

Returns Cba resource id

Since: S60 v5.1

EasyDialingAllowed()

TBool

EasyDialingAllowed

(

)

const [pure virtual]

Gets value indicating whether using Easy Dialing should be allowed in the current Dialer mode.

Since: S60 v5.2

GetButtonData(TButtonIndex, RPointerArray< CButtonData > &)

TInt	GetButtonData	(	TButtonIndex	aIndex,
			RPointerArray < CButtonData > &	aData
		)	const [pure virtual]

Get contents for given toolbar button. One button may have zero or more different functions. Which one is set active, depends on the return value of the member function ButtonState() .

Since: S60 v5.2

Parameters

TButtonIndex aIndex	Index of the button for which data is queried.
RPointerArray < CButtonData > & aData	On return, contains all the possible states for the button.

MenuResourceId()

TInt

MenuResourceId

(

)

const [pure virtual]

Returns Menu resource id

Since: S60 v5.1

NumberEntryPromptTextL()

const TDesC &

NumberEntryPromptTextL

(

)

[pure virtual]

Returns number entry prompt text

Since: S60 v5.1

SetNumberEntryIsEmpty(TBool)

void

SetNumberEntryIsEmpty

(

TBool

aEmpty

)

[pure virtual]

Function used to tell controller if number entry is empty or not. In many cases this has an influence on the status of some or all toolbar buttons.

Since: S60 v5.2

Parameters

TBool aEmpty

ETrue if number entry is empty, EFalse othwerwise.

Member Enumerations Documentation

Enum TButtonIndex

Indices to refer to visual button slots in the dialer toolbar. The index order in not necessarily the same as the visual order of the buttons. The index names correspond to the button functions in the normal dialer mode.

Since: S60 v5.2

Enumerators

EClearButton = 0
ECallButton
EPhonebookButton
ENumberOfButtons