location/map-service/location-map-pref.h

   1 /*
   2  * libslp-location
   3  *
   4  * Copyright (c) 2010-2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: Youngae Kang <youngae.kang@samsung.com>, Yunhan Kim <yhan.kim@samsung.com>,
   7  *          Genie Kim <daejins.kim@samsung.com>, Minjune Kim <sena06.kim@samsung.com>
   8  *
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  * http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  */
  21
  22 #ifndef __LOCATION_MAP_PREF_H__
  23 #define __LOCATION_MAP_PREF_H__
  24
  25 #include <location-map-types.h>
  26
  27 G_BEGIN_DECLS
  28
  29 /**
  30  * @file location-map-pref.h
  31  * @brief This file contains the internal definitions and structures related to a service provider.
  32  * @addtogroup LocationMapService
  33  * @{
  34  * @defgroup LocationMapServiceProvider Service Provider
  35  * @brief This represents preference and capability of Service providers
  36  * @addtogroup LocationMapServiceProvider
  37  * @{
  38  */
  39
  40 /**
  41  * @brief Get provider name to be used in the service request
  42  */
  43 gchar *location_map_pref_get_provider_name (const LocationMapPref *pref);
  44
  45 /**
  46  * @brief Get language to be used in the service request.
  47  */
  48 gchar *location_map_pref_get_language (const LocationMapPref *pref);
  49
  50 /**
  51  * @brief Get country to be used in the service request.
  52  */
  53 gchar *location_map_pref_get_country (const LocationMapPref *pref);
  54
  55 /**
  56  * @brief Get the preferred length unit to be used in the service request.
  57  */
  58 gchar *location_map_pref_get_distance_unit (const LocationMapPref *pref);
  59
  60 /**
  61  * @brief Get available service of the service provider.
  62  */
  63 GList *location_map_pref_get_property_key (const LocationMapPref *pref);
  64
  65 /**
  66  * @brief Get property to be used in the service request.
  67  */
  68 gconstpointer location_map_pref_get_property (const LocationMapPref *pref, gconstpointer key);
  69
  70 /**
  71  * @brief Set provider's name to be used in the service request.
  72  */
  73 gboolean location_map_pref_set_provider_name (LocationMapPref *pref, const gchar *name);
  74
  75 /**
  76  * @brief Set language to be used in the service request.
  77  */
  78 gboolean location_map_pref_set_language (LocationMapPref *pref, const gchar *language);
  79
  80 /**
  81  * @brief Set country to be used in the service request.
  82  */
  83 gboolean location_map_pref_set_country (LocationMapPref *pref, const gchar *country);
  84
  85 /**
  86  * @brief Get the preferred length unit to be used in the service request.
  87  */
  88 gboolean location_map_pref_set_distance_unit (LocationMapPref *pref, const gchar * unit);
  89
  90 /**
  91  * @brief Set property to be used in the service request.
  92  */
  93 gboolean location_map_pref_set_property (LocationMapPref *pref, gconstpointer key, gconstpointer value);
  94
  95 /**
  96  * @brief Create a new LocationMapPref.
  97  */
  98 LocationMapPref * location_map_pref_new (void);
  99
 100 /**
 101  * @brief Copy a new LocationMapPref.
 102  */
 103 LocationMapPref * location_map_pref_copy (LocationMapPref *pref);
 104
 105 /**
 106  * @brief Free a LocationMapPref.
 107  */
 108 void location_map_pref_free (LocationMapPref *pref);
 109
 110 /**
 111  * @} @}
 112  */
 113
 114 G_END_DECLS
 115
 116 #endif /* __LOCATION_MAP_PREF_H__ */