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