TPosLmDatabaseSettings Class Reference

API published in: S60 3rd Ed

Link against: eposlmdbmanlib.lib

Capability Information

Required Capabilities

None

Exceptions

The capability ReadUserData is required in:

CPosLmDatabaseManager::NewL();

CPosLmDatabaseManager::DefaultDatabaseUriLC();

CPosLmDatabaseManager::NotifyDatabaseEvent( TPosLmDatabaseEvent & aEvent, TRequestStatus & aStatus );

CPosLmDatabaseManager::DatabaseUriFromLastEventLC();

CPosLmDatabaseManager::ListDatabasesLC( const TDesC & aProtocol = KNullDesC );

CPosLmDatabaseManager::ListDatabasesL( RPointerArray< HPosLmDatabaseInfo > & aDatabaseInfoArray, const TDesC & aProtocol = KNullDesC );

CPosLmDatabaseManager::RegisterDatabaseL( HPosLmDatabaseInfo & aDatabaseInfo );

CPosLmDatabaseManager::UnregisterDatabaseL( const TDesC & aDatabaseUri );

CPosLmDatabaseManager::UnregisterAllDatabasesL( const TDesC & aProtocol );

CPosLmDatabaseManager::ModifyDatabaseSettingsL( const TDesC & aDatabaseUri, const TPosLmDatabaseSettings & aDatabaseSettings );

CPosLmDatabaseManager::GetDatabaseInfoL( HPosLmDatabaseInfo & aDatabaseInfo );

CPosLmDatabaseManager::DatabaseExistsL( const TDesC & aDatabaseUri );

CPosLmDatabaseManager::CreateDatabaseL( HPosLmDatabaseInfo & aDatabaseInfo );

CPosLmDatabaseManager::DeleteDatabaseL( const TDesC & aDatabaseUri );

CPosLmDatabaseManager::CopyDatabaseL( const TDesC & aSourceUri, const TDesC & aTargetUri );

The capability WriteUserData is required in:

CPosLmDatabaseManager::RegisterDatabaseL( HPosLmDatabaseInfo & aDatabaseInfo );

CPosLmDatabaseManager::UnregisterDatabaseL( const TDesC & aDatabaseUri );

CPosLmDatabaseManager::UnregisterAllDatabasesL( const TDesC & aProtocol );

CPosLmDatabaseManager::ModifyDatabaseSettingsL( const TDesC & aDatabaseUri, const TPosLmDatabaseSettings & aDatabaseSettings );

CPosLmDatabaseManager::CreateDatabaseL( HPosLmDatabaseInfo & aDatabaseInfo );

CPosLmDatabaseManager::DeleteDatabaseL( const TDesC & aDatabaseUri );

CPosLmDatabaseManager::CopyDatabaseL( const TDesC & aSourceUri, const TDesC & aTargetUri );

The capability WriteDeviceData is required in:

CPosLmDatabaseManager::SetDefaultDatabaseUriL( const TDesC & aDatabaseUri );

The capability NetworkServices is required in:

CPosLmDatabaseManager::DatabaseExistsL( const TDesC & aDatabaseUri ); When database URI refers to remote database.

CPosLmDatabaseManager::CreateDatabaseL( HPosLmDatabaseInfo & aDatabaseInfo ); When database URI refers to remote database.

CPosLmDatabaseManager::DeleteDatabaseL( const TDesC & aDatabaseUri ); When database URI refers to remote database.

CPosLmDatabaseManager::CopyDatabaseL( const TDesC & aSourceUri, const TDesC & aTargetUri ); When any of database URIs refers to remote database.

Other Information

The capability NetworkServices is required to work with remote databases.

#include <epos_tposlmdatabasesettings.h>

Detailed Description

TPosLmDatabaseSettings encapsulates the attributes that can be set for a landmark database.

The only available attribute is the displayable name.

To set a new display name, create a HPosLmDatabaseInfo object containing the URI of the database. Call SetDatabaseName on the TPosLmDatabaseSettings member in HPosLmDatabaseInfo and then pass the HPosLmDatabaseInfo to CPosLmDatabaseManager::ModifyDatabaseSettingsL.

When retrieving settings for a database, IsAttributeSet can be used to find out whether display name is set for the database or not.


Public Types
enum	TAttribute { EName = 0x01 }
	Enumeration of the attributes that can be set for a landmark database. More...
Public Member Functions
IMPORT_C	TPosLmDatabaseSettings ()
	Default constructor.
IMPORT_C TBool	IsAttributeSet (TAttribute aDbAttribute) const
	Checks whether a database attribute is set in this instance.
IMPORT_C void	UnsetAttribute (TAttribute aDbAttribute)
	Unset a database attribute.
IMPORT_C TPtrC	DatabaseName () const
	Retrieves the displayable name for the database.
IMPORT_C void	SetDatabaseName (const TPosLmDatabaseName &aDatabaseName)
	Set a displayable name for the database.

Member Enumeration Documentation

enum TPosLmDatabaseSettings::TAttribute

Enumeration of the attributes that can be set for a landmark database.

Enumerator:

EName

Displayable name for the landmark database.

Constructor & Destructor Documentation

IMPORT_C TPosLmDatabaseSettings::TPosLmDatabaseSettings

(

)

Default constructor.

Member Function Documentation

IMPORT_C TPtrC TPosLmDatabaseSettings::DatabaseName

(

)

const

Retrieves the displayable name for the database.

If the EName attribute is not set, an empty descriptor is returned.

Returns:: A pointer to the name descriptor. This pointer is valid until the TPosLmDatabaseSettings instance is destroyed.

IMPORT_C TBool TPosLmDatabaseSettings::IsAttributeSet

(

TAttribute

aDbAttribute

)

const

Checks whether a database attribute is set in this instance.

Parameters:

aDbAttribute

The database attribute to check.

Returns:: ETrue if the attribute is set, otherwise EFalse.

IMPORT_C void TPosLmDatabaseSettings::SetDatabaseName

(

const TPosLmDatabaseName &

aDatabaseName

)

Set a displayable name for the database.

If an empty descriptor is set, the database display name will be set to an empty string.

Parameters:

[in] aDatabaseName The new name for the database.

IMPORT_C void TPosLmDatabaseSettings::UnsetAttribute

(

TAttribute

aDbAttribute

)

Unset a database attribute.

If an attribute is not set in this instance and the instance is passed as input to a function for modifying the settings for a database, e.g. CPosLmDatabaseManager::ModifyDatabaseSettingsL, the attribute will be removed from the database.

Parameters:

aDbAttribute

The database attribute to unset.

The documentation for this class was generated from the following file:

epos_tposlmdatabasesettings.h

TPosLmDatabaseSettings Class Reference

Capability Information

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation