Collapse all Symbian^3 Product Developer Library

MDiscovererObserver Class Reference

class MDiscovererObserver

Since: 7.0 Responsible for managing the registry (adding and removing entries).

Public Member Functions
void	DiscoveriesBegin()
void	DiscoveriesComplete(TBool, TPluginProcessingTypeIdentifier)
void	DriveReinstatedL(TDriveUnit)
void	DriveRemovedL(TDriveUnit)
TBool	IsAnyDllRegisteredWithDriveL(const TDriveUnit)
void	LanguageChangedL(TBool &)
TBool	NotifiedWithErrorCode(TInt)
void	RegisterDiscoveryL(const TDriveName &, CPluginBase *&, TBool)
void	SetDiscoveryFlagL(const TDriveUnit &)

Member Functions Documentation

DiscoveriesBegin()

void

DiscoveriesBegin

(

)

[pure virtual]

Intended Usage : Pure virtual method used by the CDiscoverer class to signal that a discovery session is starting. Error Condition : None.

Since: 7.0

Pre-condition: The MDiscovererObserver must be fully constructed, and capable of accepting discoveries for registration.

Post-condition: Discovery start is noted, and any appropriate action for the observer is completed.

DiscoveriesComplete(TBool, TPluginProcessingTypeIdentifier)

void	DiscoveriesComplete	(	TBool	aSuccessful,
			TPluginProcessingTypeIdentifier	aProcessingType
		)	[pure virtual]

Intended Usage : Pure virtual method used by the CDiscoverer class to signal that a discovery session is complete. Error Condition : None.

Since: 7.0

Pre-condition: The MDiscovererObserver must be fully constructed, and capable of accepting discoveries for registration.

Post-condition: Discovery completion is noted, and any appropriate action for the observer is completed.

Parameters

TBool aSuccessful	ETrue indicates the scan completed successfully, EFalse, that the scan was only partial.
TPluginProcessingTypeIdentifier aProcessingType	indicates the type of processing for plugins for ensuring that plugins are not processed multiple times during start-up phase

DriveReinstatedL(TDriveUnit)

void

DriveReinstatedL

(

TDriveUnit

aDrive

)

[pure virtual]

Intended Usage :Pure virtual method used by the CDiscoverer class to notify the observer that a drive letter has become available for use. Error Condition : None.

Since: 7.0 :

Pre-condition: The MDiscovererObserver must be fully constructed, and capable of accepting discoveries for registration.

Post-condition: Drive removal is noted, and any appropriate action for the observer is completed. E.g. The registered Interface Implementation Collections stored upon the specified drive are again made available for use.

Parameters

TDriveUnit aDrive

The drive identifier.

DriveRemovedL(TDriveUnit)

void

DriveRemovedL

(

TDriveUnit

aDrive

)

[pure virtual]

Intended Usage :Pure virtual method used by the CDiscoverer class to notify the observer that a drive letter is no longer available for use. Error Condition : Leaves with an error code.

leave: Depends on implementation

Since: 7.0 :

Pre-condition: The MDiscovererObserver must be fully constructed, and capable of accepting discoveries for registration.

Post-condition: Drive removal is noted, and any appropriate action for the observer is completed. E.g. The registered Interface Implementation Collectionss stored upon the specified drive are no longer available for use.

Parameters

TDriveUnit aDrive

The drive identifier.

IsAnyDllRegisteredWithDriveL(const TDriveUnit)

TBool

IsAnyDllRegisteredWithDriveL

(

const TDriveUnit

aDrive

)

const [pure virtual]

Parameters

const TDriveUnit aDrive

LanguageChangedL(TBool &)

void

LanguageChangedL

(

TBool &

aLanguageChanged

)

[pure virtual]

Intended Usage :Pure virtual method used by the CDiscoverer class to notify the observer that the language switch notifier has been activated. The observer should instruct the notification object how to proceed. Error Condition : Leaves with an error code.

leave: Depends on implementation

Since: 9.3 :

Pre-condition: The MDiscovererObserver must be fully constructed, and capable of accepting discoveries for registration.

Post-condition: The CRegistryData will have its iLanguageChanged flag set to True when language switch happens.

Parameters

TBool & aLanguageChanged

the flag returned to indicate whether language downgrade path is changed.

NotifiedWithErrorCode(TInt)

TBool

NotifiedWithErrorCode

(

TInt

aError

)

[pure virtual]

Intended Usage :Pure virtual method used by the CDiscoverer class to notify the observer that the notifier has been activated with an error status code. The observer should instruct the notification object how to proceed. Error Condition : None.

Since: 7.0 :

Pre-condition: The MDiscovererObserver must be fully constructed, and capable of accepting discoveries for registration.

Post-condition: The status code should be used by the observer to instruct the notifier to cease recieving notifications or not.

Parameters

TInt aError

The error value recieved by the notifier.

RegisterDiscoveryL(const TDriveName &, CPluginBase *&, TBool)

void	RegisterDiscoveryL	(	const TDriveName &	aDrive,
			CPluginBase *&	aDirEntry,
			TBool	aAnyDllDiscovered
		)	[pure virtual]

Intended Usage : Pure virtual method used by the CDiscoverer class to register a discovery. Error Condition : Depends upon the implementation class.

leave: Implementation class dependent.

CRegistrar.

Since: 9.1

Pre-condition: The MDiscovererObserver must be fully constructed, and capable of accepting discoveries for registration.

Post-condition: Discovery is registered.

Parameters

const TDriveName & aDrive	the drive containing this entry
CPluginBase *& aDirEntry	A reference to the Discovered directory entry.
TBool aAnyDllDiscovered	A flag to tell if any Dll is discovered in the drive.

SetDiscoveryFlagL(const TDriveUnit &)

void

SetDiscoveryFlagL

(

const TDriveUnit &

aDrive

)

[pure virtual]

Parameters

const TDriveUnit & aDrive