#include <mw/EPos_TPosLmDatabaseSettings.h>
| class TPosLmDatabaseSettings |
| Public Member Enumerations | |
|---|---|
| enum | TAttribute { EName } |
| Public Member Functions | |
|---|---|
| TPosLmDatabaseSettings() | |
| IMPORT_C TPtrC | DatabaseName() |
| IMPORT_C TBool | IsAttributeSet(TAttribute) |
| IMPORT_C void | SetDatabaseName(const TPosLmDatabaseName &) |
| IMPORT_C void | UnsetAttribute(TAttribute) |
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.
| IMPORT_C TPtrC | 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 | IsAttributeSet | ( | TAttribute | aDbAttribute | ) | const |
Checks whether a database attribute is set in this instance.
| Parameter | Description |
|---|---|
| aDbAttribute | The database attribute to check. |
Returns: ETrue if the attribute is set, otherwise EFalse.
| IMPORT_C void | 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.
| Parameter | Description |
|---|---|
| aDatabaseName | The new name for the database. |
| IMPORT_C void | 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.
| Parameter | Description |
|---|---|
| aDbAttribute | The database attribute to unset. |