Symbian^3 Application Developer Library >

CPbk2StoreManager Class Reference

class CPbk2StoreManager : public CBase

Phonebook 2 store manager. The responsibilities of this class are to retrieve and observer the device contact store configuration and to open these stores through the Virtual Phonebook contact manager. It also manages the compression of the contact stores.

Inherits from

Public Member Functions
~CPbk2StoreManager ()
CVPbkContactStoreUriArray * CurrentlyValidShownStoresL ()
CVPbkContactStoreUriArray * CurrentlyValidStoresL ()
void DeregisterStoreEvents (const MVPbkContactStoreObserver &)
IMPORT_C void EnableCompression ( TBool )
IMPORT_C void EnsureCurrentConfigurationStoresIncludedL ()
IMPORT_C void EnsureDefaultSavingStoreIncludedL ()
IMPORT_C CPbk2StoreManager * NewL ( CVPbkContactManager &, CPbk2StoreConfiguration &, TBool )
IMPORT_C void OpenStoresL ()
void RegisterStoreEventsL (const MVPbkContactStoreObserver &)
Private Member Functions
CPbk2StoreManager ( CVPbkContactManager &, CPbk2StoreConfiguration &, TBool )
void CloseUnnecessaryStoresL ()
void ConfigurationChanged ()
void ConfigurationChangedComplete ()
void ConstructL ()
void EnsureCurrentConfigurationLoadedAndOpenL ()
void HandleConfigurationChangedL ()
void HandleSavingStoreChangedL ()
void HandleStoreEventL ( MVPbkContactStore &, TVPbkContactStoreEvent )
TBool IsStoreOpen ( MVPbkContactStore &)
void OpenComplete ()
void ReplaceStoreL ( MVPbkContactStore &)
void SavingStoreChanged ()
void StoreReady ( MVPbkContactStore &)
void StoreUnavailable ( MVPbkContactStore &, TInt )
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
TBool iActOnConfigurationEvents
MPbk2CompressPolicyManager * iCompressPolicy
CVPbkContactManager & iContactManager
MVPbkContactStoreList * iContactStores
RPointerArray < MVPbkContactStore > iFailedStores
RPointerArray < MVPbkContactStore > iOpenedStores
CPbk2StoreConfiguration & iStoreConfiguration
RPointerArray < MVPbkContactStoreObserver > iStoreObservers

Constructor & Destructor Documentation

CPbk2StoreManager(CVPbkContactManager &, CPbk2StoreConfiguration &, TBool)

CPbk2StoreManager ( CVPbkContactManager & aContactManager,
CPbk2StoreConfiguration & aStoreConfiguration,
TBool aActOnConfigurationEvents
) [private, inline]

Parameters

CVPbkContactManager & aContactManager
CPbk2StoreConfiguration & aStoreConfiguration
TBool aActOnConfigurationEvents

~CPbk2StoreManager()

~CPbk2StoreManager ( )

Destructor.

Member Functions Documentation

CloseUnnecessaryStoresL()

void CloseUnnecessaryStoresL ( ) [private]

ConfigurationChanged()

void ConfigurationChanged ( ) [private]

ConfigurationChangedComplete()

void ConfigurationChangedComplete ( ) [private]

ConstructL()

void ConstructL ( ) [private, inline]

CurrentlyValidShownStoresL()

CVPbkContactStoreUriArray * CurrentlyValidShownStoresL ( ) const

CurrentlyValidStoresL()

CVPbkContactStoreUriArray * CurrentlyValidStoresL ( ) const

DeregisterStoreEvents(const MVPbkContactStoreObserver &)

void DeregisterStoreEvents ( const MVPbkContactStoreObserver & aObserver )

Parameters

const MVPbkContactStoreObserver & aObserver

EnableCompression(TBool)

IMPORT_C void EnableCompression ( TBool aEnable )

Enables and disables compression.

Parameters

TBool aEnable Indicates whether to enable or disable compression.

EnsureCurrentConfigurationLoadedAndOpenL()

void EnsureCurrentConfigurationLoadedAndOpenL ( ) [private]

EnsureCurrentConfigurationStoresIncludedL()

IMPORT_C void EnsureCurrentConfigurationStoresIncludedL ( )

Ensures current configuation stores are loaded

EnsureDefaultSavingStoreIncludedL()

IMPORT_C void EnsureDefaultSavingStoreIncludedL ( )

Ensures default saving store is loaded

HandleConfigurationChangedL()

void HandleConfigurationChangedL ( ) [private]

HandleSavingStoreChangedL()

void HandleSavingStoreChangedL ( ) [private]

HandleStoreEventL(MVPbkContactStore &, TVPbkContactStoreEvent)

void HandleStoreEventL ( MVPbkContactStore & aContactStore,
TVPbkContactStoreEvent aEvent
) [private]

Parameters

MVPbkContactStore & aContactStore
TVPbkContactStoreEvent aEvent

IsStoreOpen(MVPbkContactStore &)

TBool IsStoreOpen ( MVPbkContactStore & aContactStore ) const [private]

Parameters

MVPbkContactStore & aContactStore

NewL(CVPbkContactManager &, CPbk2StoreConfiguration &, TBool)

IMPORT_C CPbk2StoreManager * NewL ( CVPbkContactManager & aContactManager,
CPbk2StoreConfiguration & aStoreConfiguration,
TBool aActOnConfigurationEvents
) [static]

Creates a new instance of this class.

Parameters

CVPbkContactManager & aContactManager Virtual Phonebook contact manager.
CPbk2StoreConfiguration & aStoreConfiguration Contact store configuration.
TBool aActOnConfigurationEvents Indicates whether to act on configuration events.

OpenComplete()

void OpenComplete ( ) [private]

OpenStoresL()

IMPORT_C void OpenStoresL ( )

Opens all the contact stores that are loaded by Virtual Phonebook contact manager.

RegisterStoreEventsL(const MVPbkContactStoreObserver &)

void RegisterStoreEventsL ( const MVPbkContactStoreObserver & aObserver )

Parameters

const MVPbkContactStoreObserver & aObserver

ReplaceStoreL(MVPbkContactStore &)

void ReplaceStoreL ( MVPbkContactStore & aContactStore ) [private]

Parameters

MVPbkContactStore & aContactStore

SavingStoreChanged()

void SavingStoreChanged ( ) [private]

StoreReady(MVPbkContactStore &)

void StoreReady ( MVPbkContactStore & aContactStore ) [private]

Parameters

MVPbkContactStore & aContactStore

StoreUnavailable(MVPbkContactStore &, TInt)

void StoreUnavailable ( MVPbkContactStore & aContactStore,
TInt aReason
) [private]

Parameters

MVPbkContactStore & aContactStore
TInt aReason

Member Data Documentation

TBool iActOnConfigurationEvents

TBool iActOnConfigurationEvents [private]

MPbk2CompressPolicyManager * iCompressPolicy

MPbk2CompressPolicyManager * iCompressPolicy [private]

CVPbkContactManager & iContactManager

CVPbkContactManager & iContactManager [private]

MVPbkContactStoreList * iContactStores

MVPbkContactStoreList * iContactStores [private]

RPointerArray< MVPbkContactStore > iFailedStores

RPointerArray < MVPbkContactStore > iFailedStores [private]

RPointerArray< MVPbkContactStore > iOpenedStores

RPointerArray < MVPbkContactStore > iOpenedStores [private]

CPbk2StoreConfiguration & iStoreConfiguration

CPbk2StoreConfiguration & iStoreConfiguration [private]

RPointerArray< MVPbkContactStoreObserver > iStoreObservers

RPointerArray < MVPbkContactStoreObserver > iStoreObservers [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.