doc/appfw_preference_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_APPFW_PREFERENCE_DOC_H__
  19 #define __TIZEN_APPFW_PREFERENCE_DOC_H__
  20
  21  /**
  22  * @ingroup CAPI_APPLICATION_MODULE
  23  * @defgroup CAPI_PREFERENCE_MODULE Preference
  24  * @brief The @ref CAPI_PREFERENCE_MODULE API provides functions to store and retrieve small pieces of data, used for application preferences.
  25  *
  26  * @addtogroup CAPI_PREFERENCE_MODULE
  27  *
  28  * @section CAPI_PREFERENCE_MODULE_HEADER Required Header
  29  *   \#include <app_preference.h>
  30  *
  31  * @section CAPI_PREFERENCE_MODULE_OVERVIEW Overview
  32  *
  33  * The Preference API provides a mechanism that saves data items in the form of key/value pairs for this application, and later retrieves them.
  34  * A typical usecase would be for an application preference screen where the user can pick some values for some options. The Preference API
  35  * has pairs of functions, one to set such a pair, another to retrieve the stored value given in the key. Keys are always text strings, but
  36  * there are functions for each of the possible value types: integer, double, string, and boolean. There is also a function to clear all of the preferences.
  37  *
  38  * The @ref CAPI_PREFERENCE_MODULE API provides a way to register a callback to get notified when a value for a particular key changes. It is useful to know
  39  * when the display should be updated or some behavior is altered as a result.
  40  *
  41  * There is an iterator function which steps through all the data pairs, invoking a callback for each one.
  42  */
  43
  44 #endif /* __TIZEN_APPFW_PREFERENCE_DOC_H__ */