Symbian^3 Application Developer Library >

RSSSettings Class Reference

class RSSSettings
It is class that can be used to fetch phone related settings.
Since
1.0 sssettings.lib

Nested Classes and Structures

Public Member Functions
RSSSettings ()
IMPORT_C void Cancel ( TSSSettingsSetting , MSSSettingsObserver &)
IMPORT_C void CancelAll ( MSSSettingsObserver &)
IMPORT_C void Close ()
IMPORT_C TInt Get ( TSSSettingsSetting , TInt &)
IMPORT_C TInt HandleRefresh ()
IMPORT_C TInt HandleSIMChanged ()
IMPORT_C TBool IsValueValidCugIndex (const TInt &)
IMPORT_C TInt Open ()
IMPORT_C TInt Open ( RTelServer *)
IMPORT_C TInt PreviousCugValue ( TInt &)
IMPORT_C TInt Register ( TSSSettingsSetting , MSSSettingsObserver &)
IMPORT_C TInt RegisterAll ( MSSSettingsObserver &)
IMPORT_C TInt ResetPreviousCugValue ()
IMPORT_C TInt Set ( TSSSettingsSetting , TInt )
Private Member Functions
RSSSettings (const RSSSettings &)
void DeleteSettingsData ()
TBool ExistsObserver ( TSSSettingsSetting , MSSSettingsObserver &)
MSSSettingsObserver * FindOneObserver ()
TInt GetALSSettingValue ( TInt &, const TInt )
TInt GetCug ( TInt &)
TInt GetDefaultCugL ( TInt &)
TInt InformCallBack ( TAny *)
void InformChange ( TSSSettingsSetting , TInt )
TInt IsALSSupported ( TInt , TInt , TBool , TInt )
void OpenL ( RTelServer *)
TInt SetCug (const TInt , const TInt )
RSSSettings & operator= (const RSSSettings &)
Private Member Type Definitions
typedef RPointerArray < MSSSettingsObserver > RSSSettingsObserverArray
Private Attributes
TSSSettingsData * iData

Constructor & Destructor Documentation

RSSSettings()

IMPORT_C RSSSettings ( )

C++ default constructor.

RSSSettings(const RSSSettings &)

RSSSettings ( const RSSSettings & ) [private]

Parameters

const RSSSettings &

Member Functions Documentation

Cancel(TSSSettingsSetting, MSSSettingsObserver &)

IMPORT_C void Cancel ( TSSSettingsSetting aSetting,
MSSSettingsObserver & aObserver
)

Cancel specific setting.

Parameters

TSSSettingsSetting aSetting setting.
MSSSettingsObserver & aObserver observer.

CancelAll(MSSSettingsObserver &)

IMPORT_C void CancelAll ( MSSSettingsObserver & aObserver )

Cancels all registrations of the observer.

Parameters

MSSSettingsObserver & aObserver observer.

Close()

IMPORT_C void Close ( )

Closes SsSettings.

After the use of the class, the method must be called.

DeleteSettingsData()

void DeleteSettingsData ( ) [private]

ExistsObserver(TSSSettingsSetting, MSSSettingsObserver &)

TBool ExistsObserver ( TSSSettingsSetting aSetting,
MSSSettingsObserver & aObserver
) [private]

Parameters

TSSSettingsSetting aSetting
MSSSettingsObserver & aObserver

FindOneObserver()

MSSSettingsObserver * FindOneObserver ( ) const [private]

Get(TSSSettingsSetting, TInt &)

IMPORT_C TInt Get ( TSSSettingsSetting aSetting,
TInt & aValue
)

Fetch value of a setting.

Parameters

TSSSettingsSetting aSetting setting.
TInt & aValue result will be stored here (if success).

GetALSSettingValue(TInt &, const TInt)

TInt GetALSSettingValue ( TInt & aValue,
const TInt aSimState
) [private]

Parameters

TInt & aValue
const TInt aSimState

GetCug(TInt &)

TInt GetCug ( TInt & aValue ) const [private]

Parameters

TInt & aValue

GetDefaultCugL(TInt &)

TInt GetDefaultCugL ( TInt & aValue ) const [private]

Parameters

TInt & aValue

HandleRefresh()

IMPORT_C TInt HandleRefresh ( )

Handle refresh

HandleSIMChanged()

IMPORT_C TInt HandleSIMChanged ( )

It is called when SIM changes.

InformCallBack(TAny *)

TInt InformCallBack ( TAny * aPtr ) [private, static]

Parameters

TAny * aPtr

InformChange(TSSSettingsSetting, TInt)

void InformChange ( TSSSettingsSetting aSetting,
TInt aNewValue
) [private]

Parameters

TSSSettingsSetting aSetting
TInt aNewValue

IsALSSupported(TInt, TInt, TBool, TInt)

TInt IsALSSupported ( TInt aPpAlsValue,
TInt aSimAlsValue,
TBool aAlsCspSupport,
TInt aAlsCspError
) const [private]

Checks if Alternate Line is to be supported.

Parameters

TInt aPpAlsValue parameter to be checked.
TInt aSimAlsValue parameter to be checked.
TBool aAlsCspSupport parameter to be checked.
TInt aAlsCspError parameter to be checked.

IsValueValidCugIndex(const TInt &)

IMPORT_C TBool IsValueValidCugIndex ( const TInt & aValue ) const

Check whether or not the given CUG index is valid.

Parameters

const TInt & aValue CUG index

Open()

IMPORT_C TInt Open ( )

Opens SsSettings.

Before using the class, one of Open methods must be called.

Open(RTelServer *)

IMPORT_C TInt Open ( RTelServer * aTelServer )

Opens SsSettings.

Ownership of parameters is NOT transferred. If parameter is NULL, then the instance creates its own sessions.

Before using the class, one of Open methods must be called.

Parameters

RTelServer * aTelServer ETel server session.

OpenL(RTelServer *)

void OpenL ( RTelServer * aTelServer ) [private]

Parameters

RTelServer * aTelServer

PreviousCugValue(TInt &)

IMPORT_C TInt PreviousCugValue ( TInt & aPreviousValue )

Get previous CUG value

Parameters

TInt & aPreviousValue Old value is saved here. 0 if not set

Register(TSSSettingsSetting, MSSSettingsObserver &)

IMPORT_C TInt Register ( TSSSettingsSetting aSetting,
MSSSettingsObserver & aObserver
)

Registers an observer to receive changes of a setting.

Parameters

TSSSettingsSetting aSetting setting.
MSSSettingsObserver & aObserver observer.

RegisterAll(MSSSettingsObserver &)

IMPORT_C TInt RegisterAll ( MSSSettingsObserver & aObserver )

Registers an observer to receive all changes.

Parameters

MSSSettingsObserver & aObserver observer.

ResetPreviousCugValue()

IMPORT_C TInt ResetPreviousCugValue ( )

Reset previous CUG value

Set(TSSSettingsSetting, TInt)

IMPORT_C TInt Set ( TSSSettingsSetting aSetting,
TInt aValue
)

Changes value of a setting. Successfull function call generates notify call to each observer in this object even if the value is the same. From other objects of this class the observers will get only change notifications.

Parameters

TSSSettingsSetting aSetting setting.
TInt aValue new value for setting.

SetCug(const TInt, const TInt)

TInt SetCug ( const TInt aValue,
const TInt aCugDefault
) const [private]

Parameters

const TInt aValue
const TInt aCugDefault

operator=(const RSSSettings &)

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

Parameters

const RSSSettings &

Member Type Definitions Documentation

Typedef RSSSettingsObserverArray

typedef RPointerArray < MSSSettingsObserver > RSSSettingsObserverArray [private]

Member Data Documentation

TSSSettingsData * iData

TSSSettingsData * iData [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.