Collapse all Symbian^3 Application Developer Library

CCchUiPrivateApi Class Reference

class CCchUiPrivateApi : public CBase

CCH UI Private API - provides means to control CCH UI.

This API hides the actual implementation from clients. In essence this API provides internal access to connectivity UI logic.

cchui.lib

Since: S60 5.0

Inherits from

CCchUiPrivateApi
- CBase

Public Member Functions
	~CCchUiPrivateApi ()
void	AddObserverL ( MCchUiObserver &)
void	CancelNotes ()
void	ConfigureVisualizationL ( RArray < MCchUiObserver::TCchUiDialogType > &, RArray < TCCHSubserviceType > &)
void	ManualEnableResultL ( TUint32 , TInt )
CCchUiPrivateApi *	NewL ( CCch &)
void	RemoveObserver ( MCchUiObserver &)
void	Reserved1 ()
void	Reserved2 ()
void	ShowDialogL ( TUint32 , MCchUiObserver::TCchUiDialogType )

Private Member Functions
	CCchUiPrivateApi ()
void	ConstructL ( CCch &)

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()

Private Attributes
CCchUiApiImpl *	iImpl

Constructor & Destructor Documentation

CCchUiPrivateApi()

CCchUiPrivateApi

(

)

[private]

C++ default constructor.

~CCchUiPrivateApi()

~CCchUiPrivateApi

(

)

Destructor.

Member Functions Documentation

AddObserverL(MCchUiObserver &)

void

AddObserverL

(

MCchUiObserver &

aObserver

)

From MCchUi . Adds observer for listening cchui events.

Since: S60 5.0

Parameters

MCchUiObserver & aObserver

Event observing class

CancelNotes()

void

CancelNotes

(

)

From MCchUi . Cancels all notes shown by CCH UI. If there is nothing to dismiss, call to this method does nothing.

Since: S60 5.0

ConfigureVisualizationL(RArray< MCchUiObserver::TCchUiDialogType > &, RArray< TCCHSubserviceType > &)

void	ConfigureVisualizationL	(	RArray < MCchUiObserver::TCchUiDialogType > &	aAllowedNotes,
			RArray < TCCHSubserviceType > &	aAllowedSubServices
		)

From MCchUi . Allows client to configure visualization of connectivity events. This only effects the automatically shown connectivity notes. Client can still use separate methods in this API to show specific notes by itself.

By default all notes are allowed.

Since: S60 5.0

Parameters

RArray < MCchUiObserver::TCchUiDialogType > & aAllowedNotes	array of allowed notes
RArray < TCCHSubserviceType > & aAllowedSubServices	array of allowed subservices

ConstructL(CCch &)

void

ConstructL

(

CCch &

aCch

)

[private]

By default Symbian 2nd phase constructor is private.

Parameters

CCch & aCch

ManualEnableResultL(TUint32, TInt)

void	ManualEnableResultL	(	TUint32	aServiceId,
			TInt	aEnableResult
		)

Tells CCH UI that manual enable has proceeded and visualization should be handled according to events and provided result code.

Since: S60 5.0

Parameters

TUint32 aServiceId	service id of the service that the dialog is shown for. Service id is used to fetch service specific data.
TInt aEnableResult	result of the enable operation. If enable specific error, error is handled here instead of event listening

NewL(CCch &)

CCchUiPrivateApi *

NewL

(

CCch &

aCch

)

[static]

Two-phased constructor.

Parameters

CCch & aCch

RemoveObserver(MCchUiObserver &)

void

RemoveObserver

(

MCchUiObserver &

aObserver

)

From MCchUi . Removes the observer of cchui events.

Since: S60 5.0

Parameters

MCchUiObserver & aObserver

Event observing class

Reserved1()

void

Reserved1

(

)

Reserved for future use.

Since: S60 5.0

Reserved2()

void

Reserved2

(

)

Reserved for future use.

Since: S60 5.0

ShowDialogL(TUint32, MCchUiObserver::TCchUiDialogType)

void	ShowDialogL	(	TUint32	aServiceId,
			MCchUiObserver::TCchUiDialogType	aDialog
		)

From MCchUi . Shows global note/dialog. See observer definition for available notes.

Since: S60 5.0

leave: KErrAlreadyExists Failed to show dialog because another note already shown.

Parameters

TUint32 aServiceId	service id of the service that the dialog is shown for. Service id is used to fetch service specific data.
MCchUiObserver::TCchUiDialogType aDialog	defines which dialog is shown.

Member Data Documentation

CCchUiApiImpl * iImpl

CCchUiApiImpl *

iImpl

[private]

CCHUI API implementation. Own.