Landmarks UI Add/Edit APIChanges in Landmarks UI Add/Edit API documentation
Changes in Landmarks UI Add/Edit API PurposeLandmarks UI Add/Edit API provides ready-made UI components for landmark related operations, like viewing and editing of a existing landmark, creating a new landmark, etc. The UI components also allow sending of a landmark using "Landmark Messaging" and support map related operations involving landmarks. DependenciesLandmarks UI Add/Edit API internally utilizes:
API descriptionLandmarks UI Add/Edit API is typically used by applications that require landmarks related operations. The UI components, provided by this API, support different landmark related operations through the "Options" menu. Landmarks UI Add/Edit API provides two basic UI components: "Landmark Viewer" and "Landmark Editor". The client can launch the dialog in one of the two modes (Viewer or Editor). Once the dialog is launched, switching to other mode is not possible using the Landmarks UI Add/Edit API. However, the end-user of the application can switch from Viewer mode to Editor mode by choosing the "edit" item in the Options menu and can switch back to Viewer mode by pressing "done". If the dialog is launched in the Editor mode, then it is not possible to switch to the Viewer mode. The end-users of the applications making use of these UI components, can perform various operations provided as menu options.
Viewing a landmark:
The client application may give its user the
possibility to view the contents of a landmark by popping up a
The viewer dialog can display an already existing landmark in the database
using the landmark ID or the newly created
The main operations that can be performed once the Landmarks Viewer dialog is launched are shown below:
Editing a landmark:
The client application may give its user the
possibility to edit a landmark by popping up a
The main operations that can be performed once the Landmarks Editor dialog is launched are shown below:
Landmarks UI Add/Edit API loads the implementation at run-time and the implementation consists only of local objects. The logical type of the API is "Library API" and the technical type is Method call interface. Use casesThe main use cases of the Landmarks UI Add\Edit API are as follows:
API class structureThis section describes the Landmarks UI Add/Edit API class structure.
Landmarks UI Add/Edit API contains one class,
Related APIs
Related APIs
Using Landmarks UI Add Edit API
Before using this API, client applications need to open an existing landmark
database and obtain the database handle. This can be done using the
Launching the landmark Editor\Viewer dialog with an already existing landmark IDTo launch landmarks Editor/Viewer dialog with an existing landmark Id, at first, the client typically needs to obtain the landmark Id from an existing and opened database. Client applications can obtain existing landmark Ids in various ways, like using Landmarks API or Landmarks Search API (when the user interface is not involved) or using Landmarks UI Selector API (when a user interface is involved).
To launch the dialog, the client first needs to create an instance of
In the Editor mode, any landmark attribute can be edited by the end user. The end user can select a category or a set of categories for the landmark from the Options menu of the editor. The modified landmark is saved into the landmark database when the user presses "done" . In the Viewer mode, the user can only view the attributes of the landmark. The user can view the landmark categories to which the current landmark belongs from the dialog’s Options menu.
The client can set its view or AppUI as the parent object of the landmarks
Editor\Viewer dialog, thereby creating a network of object providers using
the
The client can set its own help context by using the
Although by default the Landmarks viewer dialog provides the Map and Navigation
related functionality, the client can choose to disable these menu items while
launching the dialog using the
The following diagram illustrates steps involved in launching the landmark dialog in Editor or Viewer mode with an already existing landmark ID.
The following example code depicts launching of editor dialog with an already existing landmark ID.
Related APIs
Launching the landmark Editor\Viewer dialog with a new landmark
To launch the landmark Editor/Viewer dialog for a new landmark (does not
exist in any landmark database), client applications need to create an instance
of
To launch the dialog, the client first needs to create an instance of
The following diagram illustrates steps involved in launching the landmark dialog in Editor or Viewer mode with a new landmark object.
The following example code depicts launching of editor dialog with a new landmark object.
Related APIs
Error handlingLandmark UI Add/Edit API uses the standard Symbian error reporting mechanism. Errors are reported through return codes or leaves. VariationLandmark attributes like Latitude, Longitude, Altitude, Position accuracy and Altitude accuracy visibility will be variated depending on the product configuration/regional variation. This overwrites the requested attributes to be shown through TLmkEditorParams. Limitations of the API
Related APIs
GlossaryAbbreviations
Definitions
|