include/maps_place_image_plugin.h

   1 /*
   2  * Copyright (c) 2014 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 #ifndef __MAPS_PLACE_IMAGE_PLUGIN_H__
  18 #define __MAPS_PLACE_IMAGE_PLUGIN_H__
  19
  20 #include <maps_place_image.h>
  21
  22 /**
  23  * @ingroup CAPI_MAPS_PLUGIN_PLACE_MODULE
  24  * @defgroup CAPI_MAPS_PLUGIN_PLACE_IMAGE_MODULE Image
  25  *
  26  * @file maps_place_image_plugin.h
  27  * @brief This file contains the functions related to Place Image
  28  * information, needed in plug-in development.
  29  *
  30  * @addtogroup CAPI_MAPS_PLUGIN_PLACE_IMAGE_MODULE
  31  * @{
  32  * @brief This provides APIs related to Place Image, used in Place
  33  * Discovery and Search, needed in plug-in development.
  34  */
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /**
  41  * @deprecated Deprecated since 8.0.
  42  * @brief Creates a new place image handle.
  43  * @details This function creates a new place image handle and allocates all
  44  * needed resources.
  45  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  46  * @remarks @a image must be released using maps_place_image_destroy().
  47  * \n @a image may be cloned using maps_place_image_clone().
  48  *
  49  * @param[out] image A handle of a new place image on success
  50  * @return 0 on success, otherwise a negative error value
  51  * @retval #MAPS_ERROR_NONE Successful
  52  * @retval #MAPS_ERROR_OUT_OF_MEMORY Out of memory
  53  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
  54  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  55  *
  56  * @see maps_place_image_destroy()
  57  * @see maps_place_image_clone()
  58  */
  59 int maps_place_image_create(maps_place_image_h *image) TIZEN_DEPRECATED_API;
  60
  61 /**
  62  * @deprecated Deprecated since 8.0.
  63  * @brief Sets the place image ID.
  64  * @details This function sets the place image ID.
  65  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  66  *
  67  * @param[in] image The handle of place image
  68  * @param[in] id The place image Id
  69  * @return 0 on success, otherwise a negative error value
  70  * @retval #MAPS_ERROR_NONE Successful
  71  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
  72  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  73  *
  74  * @pre @a image is created using maps_place_image_create().
  75  *
  76  * @see maps_place_image_create()
  77  * @see maps_place_image_get_id()
  78  */
  79 int maps_place_image_set_id(maps_place_image_h image, const char *id) TIZEN_DEPRECATED_API;
  80
  81 /**
  82  * @deprecated Deprecated since 8.0.
  83  * @brief Sets the place image URL.
  84  * @details This function sets the place image URL.
  85  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
  86  *
  87  * @param[in] image The handle of place image
  88  * @param[in] url The place image url
  89  * @return 0 on success, otherwise a negative error value
  90  * @retval #MAPS_ERROR_NONE Successful
  91  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
  92  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
  93  *
  94  * @pre @a image is created using maps_place_image_create().
  95  *
  96  * @see maps_place_image_create()
  97  * @see maps_place_image_get_url()
  98  */
  99 int maps_place_image_set_url(maps_place_image_h image, const char *url) TIZEN_DEPRECATED_API;
 100
 101 /**
 102  * @deprecated Deprecated since 8.0.
 103  * @brief Sets the place image width.
 104  * @details This function sets the place image width.
 105  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
 106  *
 107  * @param[in] image The handle of place image
 108  * @param[in] width The place image width
 109  * @return 0 on success, otherwise a negative error value
 110  * @retval #MAPS_ERROR_NONE Successful
 111  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
 112  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
 113  *
 114  * @pre @a image is created using maps_place_image_create().
 115  *
 116  * @see maps_place_image_create()
 117  * @see maps_place_image_get_width()
 118  */
 119 int maps_place_image_set_width(maps_place_image_h image, const int width) TIZEN_DEPRECATED_API;
 120
 121 /**
 122  * @deprecated Deprecated since 8.0.
 123  * @brief Sets the place image height.
 124  * @details This function sets the place image height.
 125  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
 126  *
 127  * @param[in] image The handle of place image
 128  * @param[in] height The place image height
 129  * @return 0 on success, otherwise a negative error value
 130  * @retval #MAPS_ERROR_NONE Successful
 131  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
 132  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
 133  *
 134  * @pre @a image is created using maps_place_image_create().
 135  *
 136  * @see maps_place_image_create()
 137  * @see maps_place_image_get_height()
 138  */
 139 int maps_place_image_set_height(maps_place_image_h image, const int height) TIZEN_DEPRECATED_API;
 140
 141 /**
 142  * @deprecated Deprecated since 8.0.
 143  * @brief Sets the place image user link.
 144  * @details This function sets the place image user link.
 145  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
 146  *
 147  * @param[in] image The handle of place image
 148  * @param[in] user The place image user link
 149  * @return 0 on success, otherwise a negative error value
 150  * @retval #MAPS_ERROR_NONE Successful
 151  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
 152  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
 153  *
 154  * @pre @a image is created using maps_place_image_create().
 155  *
 156  * @see maps_place_image_create()
 157  * @see maps_place_image_get_user_link()
 158  * @see #maps_place_link_object_h
 159  */
 160 int maps_place_image_set_user_link(maps_place_image_h image, const maps_place_link_object_h user) TIZEN_DEPRECATED_API;
 161
 162 /**
 163  * @deprecated Deprecated since 8.0.
 164  * @brief Sets the place image media.
 165  * @details This function sets the place image media.
 166  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
 167  *
 168  * @param[in] image The handle of place image
 169  * @param[in] media The place image media
 170  * @return 0 on success, otherwise a negative error value
 171  * @retval #MAPS_ERROR_NONE Successful
 172  * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter
 173  * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported
 174  *
 175  * @pre @a image is created using maps_place_image_create().
 176  *
 177  * @see maps_place_image_create()
 178  * @see maps_place_image_get_media()
 179  * @see #maps_place_media_h
 180  */
 181 int maps_place_image_set_media(maps_place_image_h image, const maps_place_media_h media) TIZEN_DEPRECATED_API;
 182
 183 #ifdef __cplusplus
 184 }
 185 #endif
 186 /**
 187  * @}
 188  */
 189 #endif /* __MAPS_PLACE_IMAGE_PLUGIN_H__ */