HS Settings APIChanges in HS Settings API documentation
PurposeThe HS Settings API is an interface that enables developers to fetch and update settings of the Home screen widget. API descriptionThe Home screen Settings API was introduced as an alternative interface to the Home screen Service API (SAPI). It provides means to access widget specific settings from non-Home screen processes, such as Control Panel. The Home screen application itself uses the Home screen Plug-in Service API to access the settings via a Language Interworking (LIW) interface. This solution requires that the inputs are both LIW wrapped and that the whole active application configuration is read from Home Screen Plug-in Service (HSPS). Due to the previous performance demanding requirements, the HS Settings API was implemented. It provides a simple and quick C++ interface for accessing the Home screen settings. When the Home screen Settings API is instantiated, it gets stored to a thread local storage (TLS). While the Home screen Service API is instantiated, a client - server session is established between the Service API and the HSPS server. As soon as the active application configuration has been fetched to the Service API, the settings can be manipulated via the Settings API. Use casesRelated use cases are as follows:
API class structureThe
Settings are defined by zero or more items, which are instantiated
from the
Related APIs
Using the Home screen Settings APIGet settingsThe following sequence diagram illustrates a typical use case where the end user personalizes the settings of a widget:
Example of the settingsEach widget on Home screen has its own XML-based plug-in configuration. A plug-in configuration can be retrieved from the active application configuration with a plug-in ID, which is reserved from a related pool after the widget has been added to a Home screen page. The below example illustrates a plug-in configuration that could be used by the Desktop widget. There is always the settings element, which has zero or more child elements with any number of "key" and "value" attributes. In the example, the Desktop widget defines four shortcut items, from which various applications can be started.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: EPL
|
