summaryrefslogtreecommitdiff
path: root/location/map-service/location-landmark-ext.h
blob: 69e0c5f1b3ccd1e434fbf21cfc4eaaa04689aabb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
/*
 * libslp-location
 *
 * Copyright (c) 2010-2013 Samsung Electronics Co., Ltd. All rights reserved.
 *
 * Contact: Youngae Kang <youngae.kang@samsung.com>, Minjune Kim <sena06.kim@samsung.com>
 *          Genie Kim <daejins.kim@samsung.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __LOCATION_LANDMARK_EXT_H__
#define __LOCATION_LANDMARK_EXT_H__

#include <location-map-types.h>

G_BEGIN_DECLS

/**
 * @file location-landmark-ext.h
 * @brief This file contains the extensional definitions and structures related to Landmark.
 */

/**
 * @addtogroup LocationMapServicePOI
 * @{
 * @defgroup LocationMapServiceLandmarkExt Location Landmark Ext
 * @brief This provides Location Landmark Ext APIs
 * @addtogroup LocationMapServiceLandmarkExt
 * @{
 */

/**
 * @brief Set the ID of the given #LocationLandmark
 * @remarks None.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] id - a guint
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_id
 */
gboolean location_landmark_set_id (LocationLandmark *landmark, guint id);

/**
 * @brief Set the name of the given #LocationLandmark
 * @remarks The previous name of the #LocationLandmark will be removed if a name is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] name - a gchar
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_name
 */
gboolean location_landmark_set_name (LocationLandmark *landmark, const gchar *name);

/**
 * @brief Set the position in the given #LocationLandmark
 * @remarks The previous position of the #LocationLandmark will be removed if a position is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] position - a #LocationPosition
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_position
 */
gboolean location_landmark_set_position (LocationLandmark *landmark, const LocationPosition *position);

/**
 * @brief Set the address of the given #LocationLandmark
 * @remarks The previous address of the #LocationLandmark will be removed if an addr is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] addr - a #LocationAddress
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_address
 */
gboolean location_landmark_set_address (LocationLandmark *landmark, const LocationAddress *addr);

/**
 * @brief Set the description of the given #LocationLandmark
 * @remarks The previous description of the #LocationLandmark will be removed if a desc is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] desc - a gchar
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_description
 */
gboolean location_landmark_set_description (LocationLandmark *landmark, const gchar *desc);

/**
 * @brief Set the timestamp of the given #LocationLandmark
 * @remarks None.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] timestamp - a guint
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_timestamp
 */
gboolean location_landmark_set_timestamp (LocationLandmark *landmark, guint timestamp);

/**
 * @brief Set the priority of the given #LocationLandmark
 * @remarks None.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] priority - a guint
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_priority
 */
gboolean location_landmark_set_priority (LocationLandmark *landmark, guint priority);

/**
 * @brief Set the boundary of the given #LocationLandmark
 * @remarks The previous bounding box of the #LocationLandmark will be removed if a bbox is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] bbox - a #LocationBoundary
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_bounding_box
 */
gboolean location_landmark_set_bounding_box (LocationLandmark *landmark, const LocationBoundary *bbox);

/**
 * @brief Set the author of the given #LocationLandmark
 * @remarks The previous author of the #LocationLandmark will be removed if a author is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] author - a gchar
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_author
 */
gboolean location_landmark_set_author (LocationLandmark *landmark, const gchar *author);

/**
 * @brief Set the urls of the given #LocationLandmark
 * @remarks The previous url of the #LocationLandmark will be removed if an url is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] url - a GList
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_url
 */
gboolean location_landmark_set_url (LocationLandmark *landmark, GList *url);

/**
 * @brief Set the categories of the given #LocationLandmark
 * @remarks The previous categories of the #LocationLandmark will be removed if a category is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] category - a GList
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_category
 */
gboolean location_landmark_set_category (const LocationLandmark *landmark, GList *category);

/**
 * @brief Set the phone number of the given #LocationLandmark
 * @remarks The previous phone number of the #LocationLandmark will be removed if a number is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] number - a gchar
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_phone_number
 */
gboolean location_landmark_set_phone_number (const LocationLandmark *landmark, const gchar *number);

/**
 * @brief Set the property data of the given #LocationLandmark
 * @remarks The previous value of the #LocationLandmark matching to key will be removed if a value is NULL.
 * @pre None.
 * @post None.
 * @param [in] landmark - a #LocationLandmark
 * @param [in] key - a gconstpointer
 * @param [in] value - a gconstpointer
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_get_property
 */
gboolean location_landmark_set_property (const LocationLandmark *landmark, gconstpointer key, gconstpointer value);

/**
 * @brief Set url of the given #LocationLandmarkUrl
 * @remarks The previous url path of the #LocationLandmarkUrl will be removed if a path is NULL.
 * @pre None.
 * @post None.
 * @param [in] url - a #LocationLandmarkUrl
 * @param [in] path - a gchar
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_url_get_url_path
 */
gboolean location_landmark_url_set_url_path (LocationLandmarkUrl *url, const gchar *path);

/**
 * @brief Set the description of the given #LocationLandmarkUrl
 * @remarks The previous description of the #LocationLandmarkUrl will be removed if a desc is NULL.
 * @pre None.
 * @post None.
 * @param [in] url - a #LocationLandmarkUrl
 * @param [in] desc - a gchar
 * @return gboolean
 * @retval  TRUE if success
 * @see location_landmark_url_get_description
 */
gboolean location_landmark_url_set_description (LocationLandmarkUrl *url, const gchar *desc);

/**
 * @} @}
 */

G_END_DECLS

#endif