location/map-service/location-landmark.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_LANDMARK_H__
  23 #define __LOCATION_LANDMARK_H__
  24
  25 #include <location-types.h>
  26
  27 G_BEGIN_DECLS
  28
  29 /**
  30  * @file location-landmark.h
  31  * @brief This file contains the internal definitions and structures related to Landmark.
  32  */
  33
  34 /**
  35  * @addtogroup LocationMapServicePOI
  36  * @{
  37  * @defgroup LocationMapServiceLandmark Location Landmark
  38  * @brief This provides structure, enumeration and APIs for Landmark
  39  * @addtogroup LocationMapServiceLandmark
  40  * @{
  41  */
  42
  43 /**
  44  * @brief Create a new Landmark
  45  */
  46 LocationLandmark *location_landmark_new (void);
  47
  48 /**
  49  * @brief Copy the given Landmark
  50  */
  51 LocationLandmark *location_landmark_copy (const LocationLandmark *landmark);
  52
  53 /**
  54  * @brief Free the given Landmark
  55  */
  56 void location_landmark_free (LocationLandmark *landmark);
  57
  58 /**
  59  * @brief Get the ID of the given landmark
  60  */
  61 guint location_landmark_get_id (const LocationLandmark *landmark);
  62
  63 /**
  64  * @brief Get the name of the given landmark
  65  */
  66 gchar *location_landmark_get_name (const LocationLandmark *landmark);
  67 /**
  68  * @brief Get the position in the given landmark
  69  */
  70 LocationPosition *location_landmark_get_position (const LocationLandmark *landmark);
  71 /**
  72  * @brief Get the address of the given landmark
  73  */
  74 LocationAddress *location_landmark_get_address (const LocationLandmark *landmark);
  75 /**
  76  * @brief Get the description of the given landmark
  77  */
  78 gchar *location_landmark_get_description (const LocationLandmark *landmark);
  79 /**
  80  * @brief Get the timestamp of the given landmark
  81  */
  82 guint location_landmark_get_timestamp (const LocationLandmark *landmark);
  83 /**
  84  * @brief Get the priority of the given landmark
  85  */
  86 guint location_landmark_get_priority (const LocationLandmark *landmark);
  87 /**
  88  * @brief Get the bounding box of the given landmark
  89  */
  90 LocationBoundary *location_landmark_get_bounding_box (const LocationLandmark *landmark);
  91 /**
  92  * @brief Get the author of the given landmark
  93  */
  94 gchar *location_landmark_get_author (const LocationLandmark *landmark);
  95 /**
  96  * @brief Get the list of urls of the given landmark
  97  */
  98 GList *location_landmark_get_url (const LocationLandmark *landmark);
  99 /**
 100  * @brief Get the categories of the given landmark
 101  */
 102 GList *location_landmark_get_category (const LocationLandmark *landmark);
 103 /**
 104  * @brief Get the phone number of the given landmark
 105  */
 106 gchar *location_landmark_get_phone_number (const LocationLandmark *landmark);
 107 /**
 108  * @brief Get the property keys of the given landmark
 109  */
 110 GList *location_landmark_get_property_key (const LocationLandmark *landmark);
 111
 112 /**
 113  * @brief Get the property data of the given landmark
 114  */
 115 gconstpointer location_landmark_get_property (const LocationLandmark *landmark, gconstpointer key);
 116
 117 /**
 118  * @brief Create a new #LocationLandmarkUrl
 119  */
 120 LocationLandmarkUrl * location_landmark_url_new (void);
 121
 122 /**
 123  * @brief Free a #LocationLandmarkUrl
 124  */
 125 void location_landmark_url_free (LocationLandmarkUrl *url);
 126
 127 /**
 128  * @brief Copy a #LocationLandmarkUrl
 129  */
 130 LocationLandmarkUrl *location_landmark_url_copy (const LocationLandmarkUrl *url);
 131
 132 /**
 133  * @brief Get the url path of the given #LocationLandmarkUrl
 134  */
 135 gchar *location_landmark_url_get_url_path (const LocationLandmarkUrl *url);
 136 /**
 137  * @brief Get the url's description of the given #LocationLandmarkUrl
 138  */
 139 gchar *location_landmark_url_get_description (const LocationLandmarkUrl *url);
 140
 141 /**
 142   * @} @}
 143   */
 144
 145 G_END_DECLS
 146
 147 #endif