Collapse all Symbian^3 Application Developer Library

CPbk2StoreConfiguration Class Reference

class CPbk2StoreConfiguration : public CBase

Phonebook 2 contact store configuration. The responsability of this class is to provide a centrally managed location where clients can retrieve the current store configuration of the device and to register as an observer to any store configuration events.

Inherits from

CPbk2StoreConfiguration
- CBase

Public Member Functions
	~CPbk2StoreConfiguration ()
IMPORT_C void	AddContactStoreURIL ( TVPbkContactStoreUriPtr )
IMPORT_C void	AddDefaultSavingStoreObserverL ( MPbk2DefaultSavingStoreObserver &)
IMPORT_C void	AddObserverL ( MPbk2StoreConfigurationObserver &)
IMPORT_C void	AddSupportedContactStoreURIL ( TVPbkContactStoreUriPtr )
IMPORT_C CVPbkContactStoreUriArray *	CurrentConfigurationL ()
IMPORT_C TVPbkContactStoreUriPtr	DefaultSavingStoreL ()
IMPORT_C CPbk2StoreConfiguration *	NewL ()
IMPORT_C void	RemoveContactStoreURIL ( TVPbkContactStoreUriPtr )
IMPORT_C void	RemoveDefaultSavingStoreObserver ( MPbk2DefaultSavingStoreObserver &)
IMPORT_C void	RemoveObserver ( MPbk2StoreConfigurationObserver &)
IMPORT_C void	RemoveSupportedContactStoreURIL ( TVPbkContactStoreUriPtr )
IMPORT_C CVPbkContactStoreUriArray *	SearchStoreConfigurationL ()
IMPORT_C CVPbkContactStoreUriArray *	SupportedStoreConfigurationL ()

Private Member Functions
	CPbk2StoreConfiguration ()
void	ConstructL ()

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
CPbk2StoreConfigurationImpl *	iImplementation

Constructor & Destructor Documentation

CPbk2StoreConfiguration()

CPbk2StoreConfiguration

(

)

[private]

~CPbk2StoreConfiguration()

~CPbk2StoreConfiguration

(

)

Destructor.

Member Functions Documentation

AddContactStoreURIL(TVPbkContactStoreUriPtr)

IMPORT_C void

AddContactStoreURIL

(

TVPbkContactStoreUriPtr

aURI

)

Adds a new contact store URI to current configuration. Then use AddSupportedContactStoreUriL to add the store to supported configuration if desired.

Parameters

TVPbkContactStoreUriPtr aURI

The URI to add.

AddDefaultSavingStoreObserverL(MPbk2DefaultSavingStoreObserver &)

IMPORT_C void

AddDefaultSavingStoreObserverL

(

MPbk2DefaultSavingStoreObserver &

aObserver

)

Adds a default saving store observer.

Parameters

MPbk2DefaultSavingStoreObserver & aObserver

The observer to add.

AddObserverL(MPbk2StoreConfigurationObserver &)

IMPORT_C void

AddObserverL

(

MPbk2StoreConfigurationObserver &

aObserver

)

Adds a new configuration observer.

Parameters

MPbk2StoreConfigurationObserver & aObserver

The observer to add.

AddSupportedContactStoreURIL(TVPbkContactStoreUriPtr)

IMPORT_C void

AddSupportedContactStoreURIL

(

TVPbkContactStoreUriPtr

aURI

)

Adds a new contact store URI to supported configuration. Use AddContactStoreURIL to add the store to current configuration if desired.

Parameters

TVPbkContactStoreUriPtr aURI

The URI to add.

ConstructL()

void

ConstructL

(

)

[private]

CurrentConfigurationL()

IMPORT_C CVPbkContactStoreUriArray *

CurrentConfigurationL

(

)

const

Fetches an array of configured contact store URIs.

DefaultSavingStoreL()

IMPORT_C TVPbkContactStoreUriPtr

DefaultSavingStoreL

(

)

const

Returns the URI of the default store for saving contacts.

NewL()

IMPORT_C CPbk2StoreConfiguration *

NewL

(

)

[static]

Creates a new instance of this class.

RemoveContactStoreURIL(TVPbkContactStoreUriPtr)

IMPORT_C void

RemoveContactStoreURIL

(

TVPbkContactStoreUriPtr

aURI

)

Removes a contact store URI from current configuration. Then use RemoveSupportedContactStoreUriL to remove the store from supported configuration if desired.

Parameters

TVPbkContactStoreUriPtr aURI

The URI to remove.

RemoveDefaultSavingStoreObserver(MPbk2DefaultSavingStoreObserver &)

IMPORT_C void

RemoveDefaultSavingStoreObserver

(

MPbk2DefaultSavingStoreObserver &

aObserver

)

Removes a default saving store observer.

Parameters

MPbk2DefaultSavingStoreObserver & aObserver

The observer to remove.

RemoveObserver(MPbk2StoreConfigurationObserver &)

IMPORT_C void

RemoveObserver

(

MPbk2StoreConfigurationObserver &

aObserver

)

Removes a configuration observer.

Parameters

MPbk2StoreConfigurationObserver & aObserver

The observer to remove.

RemoveSupportedContactStoreURIL(TVPbkContactStoreUriPtr)

IMPORT_C void

RemoveSupportedContactStoreURIL

(

TVPbkContactStoreUriPtr

aURI

)

Removes a contact store URI from supported configuration. Use RemoveContactStoreUriL to remove the store from current configuration if desired.

Parameters

TVPbkContactStoreUriPtr aURI

The URI to remove.

SearchStoreConfigurationL()

IMPORT_C CVPbkContactStoreUriArray *

SearchStoreConfigurationL

(

)

Fetches an array of contact store URIs to be used in searching, for example in phone number matching.

SupportedStoreConfigurationL()

IMPORT_C CVPbkContactStoreUriArray *

SupportedStoreConfigurationL

(

)

const

Fetches an array of supported contact stores URIs. NOTE: All returned stores are not necessarily supported by the current HW / SW configuration of the phone.

Member Data Documentation

CPbk2StoreConfigurationImpl * iImplementation

CPbk2StoreConfigurationImpl *

iImplementation

[private]