RCbsSettings Class Reference

class RCbsSettings : public RSubSessionBase

This represents the client-side subsession to modify and retrieve settings.

Inherits from

Constructor & Destructor Documentation

RCbsSettings()

RCbsSettings ( )

Constructor.

RCbsSettings(const RCbsSettings &)

RCbsSettings ( const RCbsSettings & ) [private]

Parameters

const RCbsSettings &

Member Functions Documentation

Close()

TInt Close ( )

Closes the subsession.

GetLanguages(TCbsSettingsLanguages &)

void GetLanguages ( TCbsSettingsLanguages & aLanguages )

Returns the preferred languages in aLanguages.

Parameters

TCbsSettingsLanguages & aLanguages The method returns the languages in this parameter.

GetReceptionStatus(TBool &)

void GetReceptionStatus ( TBool & aStatus )

Returns the reception status in aStatus, which is ETrue if the reception is on. Otherwise it is EFalse.

Parameters

TBool & aStatus The method returns the reception status in this parameter.

GetTopicDetectionStatus(TBool &)

void GetTopicDetectionStatus ( TBool & aStatus )

Returns the topic detection status in aStatus, which is ETrue if the detection is on. Otherwise it is EFalse.

Parameters

TBool & aStatus The method returns the topic detection status in this parameter.

NotifySettingsChanged(TRequestStatus &, TCbsSettingsEvent &)

void NotifySettingsChanged ( TRequestStatus & aStatus,
TCbsSettingsEvent & aEvent
)

Requests the server to notify the client whenever any settings will be changed.

Note that for each subsession only one this kind of request can be pending. Each client is responsible of assuring this.

Parameters

TRequestStatus & aStatus It is the variable that the server will modify whenever an event occurs.
TCbsSettingsEvent & aEvent The server will store the type of occurred event to this variable.

NotifySettingsChangedCancel()

void NotifySettingsChangedCancel ( )

Cancels the request to notify the client.

Open(RCbs &)

TInt Open ( RCbs & aServer )

Creates a subsession to the server.

Note that this method must be called before using any other method.

Parameters

RCbs & aServer It is the session.

SetLanguages(const TCbsSettingsLanguages &)

TInt SetLanguages ( const TCbsSettingsLanguages & aLanguages )

Changes the preferred languages to aLanguages.

Parameters

const TCbsSettingsLanguages & aLanguages It contains the new preferred languages.

SetReceptionStatus(TBool)

TInt SetReceptionStatus ( TBool aStatus )

Changes the reception status to aStatus.

Parameters

TBool aStatus It contains the new reception status.

SetTopicDetectionStatus(TBool)

TInt SetTopicDetectionStatus ( TBool aStatus )

Changes the topic detection status to aStatus.

Parameters

TBool aStatus It contains the new topic detection status.

operator=(const RCbsSettings &)

RCbsSettings & operator= ( const RCbsSettings & ) [private]

Parameters

const RCbsSettings &

Member Data Documentation

TPtr8 iNotifyEventPtr

TPtr8 iNotifyEventPtr [private]