From: chanywa Date: Tue, 7 Jun 2016 12:37:50 +0000 (+0900) Subject: modified intermediate APIs for maps-widget between maps-service and plug-in #2 X-Git-Tag: submit/tizen/20160607.123939^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=fce91dd61aa29e194be80636b69a65f2f1201367;p=platform%2Fcore%2Fapi%2Fmaps-service.git modified intermediate APIs for maps-widget between maps-service and plug-in #2 Change-Id: I7e0a561c877f8b82e425702197764c504e8af58e --- diff --git a/include/maps_plugin.h b/include/maps_plugin.h index 528c66a..8502b09 100755 --- a/include/maps_plugin.h +++ b/include/maps_plugin.h @@ -847,35 +847,6 @@ int maps_plugin_create_map_view(maps_view_h view, maps_plugin_map_view_ready_cb */ int maps_plugin_destroy_map_view(maps_view_h view); -/** - * @brief Called when the map rendering is finished. - * @details The Plugin invokes this callback when the rendering of the requested - * part of map is finished. - * @since_tizen 3.0 - * @remarks The parameter @a center must be released using - * maps_coordinates_destroy(). - * \n To use the @a center outside of this function, copy the handle using - * maps_coordinates_clone() function. - * \n The parameter @a area must be released using maps_area_destroy() - * \n To use the @a area outside of this function, copy the handle using - * maps_area_clone() function. - * - * @param[in] result The result of request - * @param[in] request_id The id of request, start from 0 - * @param[in] centes The coordinates of the center of requested map - * area - * @param[in] area The requested map area - * @param[in] user_data The user data passed from - * maps_plugin_render_map() - * - * @pre maps_plugin_render_map() will invoke this callback. - * - * @see maps_plugin_render_map() - */ -typedef void(*maps_plugin_render_map_cb) (maps_error_e result, int request_id, - maps_coordinates_h center, - maps_area_h area, void* user_data); - /** * @brief Request a map rendering. * @details This function request a draw routine of the map location with a @@ -901,9 +872,7 @@ typedef void(*maps_plugin_render_map_cb) (maps_error_e result, int request_id, * @see maps_plugin_draw_map() */ int maps_plugin_render_map(maps_view_h view, const maps_coordinates_h coordinates, - double zoom_factor, double rotation_angle, - maps_plugin_render_map_cb callback, - void* user_data, int* request_id); + double zoom_factor, double rotation_angle); /** * @brief Request the Plugin to move a map on a given delta. @@ -930,33 +899,39 @@ int maps_plugin_render_map(maps_view_h view, const maps_coordinates_h coordinate * @see maps_plugin_render_map() * @see maps_plugin_draw_map() */ -int maps_plugin_move_center(maps_view_h view, int delta_x, int delta_y, - maps_plugin_render_map_cb callback, - void* user_data, int* request_id); +int maps_plugin_move_center(maps_view_h view, int delta_x, int delta_y); /** - * @brief Draw a map on the maps view panel. - * @details This function draws the map, requested previously on the maps view - * panel in accordance with the current maps settings. + * @brief Enables or disables the scalebar. + * @details This function enables or disables the scalebar. * @since_tizen 3.0 + * @remarks This function requires network access. * * @param[in] view The handle of maps_view - * @param[in] canvas The canvas to draw on - * @param[in] x The x coordinate on the canvas top left - * @param[in] y The y coordinate on the canvas top left - * @param[in] width The width of the cancas - * @param[in] height The height of the cancas + * @param[in] enabled The enable status * @return 0 on success, otherwise a negative error value * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied + * + * @see maps_plugin_get_scalebar() + */ +int maps_plugin_set_scalebar(maps_view_h view, bool enable); + +/** + * @brief Checks whether the scalebar is enabled or not. + * @details This function checks whether the scalebar is enabled or not. + * @since_tizen 3.0 * - * @pre the draing routine is requested with preliminary call of - * maps_plugin_render_map(). + * @param[in] view The handle of maps_view + * @param[out]enabled The pointer to a boolean in which to store the enable status + * @return 0 on success, otherwise a negative error value + * @retval #MAPS_ERROR_NONE Successful + * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * - * @see maps_plugin_set_view() - * @see maps_plugin_render_map() + * @see maps_plugin_set_scalebar() */ -int maps_plugin_draw_map(maps_view_h view, Evas* canvas, int x, int y, int width, int height); +int maps_plugin_get_scalebar(maps_view_h view, bool *enabled); /** * @brief Notifyes that the visual object is changed. @@ -1064,38 +1039,6 @@ int maps_plugin_get_max_zoom_level(maps_view_h view, int *max_zoom_level); */ int maps_plugin_get_center(maps_view_h view, maps_coordinates_h *coordinates); -/** - * @brief Enables or disables the scalebar. - * @details This function enables or disables the scalebar. - * @since_tizen 3.0 - * @remarks This function requires network access. - * - * @param[in] view The handle of maps_view - * @param[in] enabled The enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied - * - * @see maps_plugin_get_scalebar() - */ -int maps_plugin_set_scalebar(maps_view_h view, bool enable); - -/** - * @brief Checks whether the scalebar is enabled or not. - * @details This function checks whether the scalebar is enabled or not. - * @since_tizen 3.0 - * - * @param[in] view The handle of maps_view - * @param[out]enabled The pointer to a boolean in which to store the enable status - * @return 0 on success, otherwise a negative error value - * @retval #MAPS_ERROR_NONE Successful - * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter - * - * @see maps_plugin_set_scalebar() - */ -int maps_plugin_get_scalebar(maps_view_h view, bool *enabled); - #ifdef __cplusplus } #endif diff --git a/include/maps_preference.h b/include/maps_preference.h index aedc937..e6092d2 100644 --- a/include/maps_preference.h +++ b/include/maps_preference.h @@ -146,7 +146,6 @@ extern "C" { * @brief The Maps Preference handle. * @details The Maps Preference handle can be obtained via call of * maps_preference_create(). - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * \n To release the handle use maps_preference_destroy(). * \n To clone the handle use maps_preference_clone(). * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif diff --git a/include/maps_service.h b/include/maps_service.h index f7b5d7f..7145594 100644 --- a/include/maps_service.h +++ b/include/maps_service.h @@ -79,24 +79,24 @@ typedef enum _maps_service_e { * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum _maps_service_data_e { - MAPS_PLACE_ADDRESS, /**< Indicates the availability of address value in the Place data */ - MAPS_PLACE_RATING, /**< Indicates the availability of rating value in the Place data */ - MAPS_PLACE_CATEGORIES, /**< Indicates the availability of place category list in the Place data */ - MAPS_PLACE_ATTRIBUTES, /**< Indicates the availability of place attribute list in the Place data */ - MAPS_PLACE_CONTACTS, /**< Indicates the availability of place contact list in the Place data */ - MAPS_PLACE_EDITORIALS, /**< Indicates the availability of place editorial list in the Place data */ - MAPS_PLACE_REVIEWS, /**< Indicates the availability of place review list in the Place data */ - MAPS_PLACE_IMAGE, /**< Indicates the availability of place image in Place the data */ - MAPS_PLACE_SUPPLIER, /**< Indicates the availability of place supplier link value in the Place data */ - MAPS_PLACE_RELATED, /**< Indicates the availability of related place link in the Place data */ - MAPS_ROUTE_PATH, /**< Indicates that the Route Data Structure is defined as a Path (a list of geographical coordinates) */ + MAPS_PLACE_ADDRESS, /**< Indicates the availability of address value in the Place data */ + MAPS_PLACE_RATING, /**< Indicates the availability of rating value in the Place data */ + MAPS_PLACE_CATEGORIES, /**< Indicates the availability of place category list in the Place data */ + MAPS_PLACE_ATTRIBUTES, /**< Indicates the availability of place attribute list in the Place data */ + MAPS_PLACE_CONTACTS, /**< Indicates the availability of place contact list in the Place data */ + MAPS_PLACE_EDITORIALS, /**< Indicates the availability of place editorial list in the Place data */ + MAPS_PLACE_REVIEWS, /**< Indicates the availability of place review list in the Place data */ + MAPS_PLACE_IMAGE, /**< Indicates the availability of place image in Place the data */ + MAPS_PLACE_SUPPLIER, /**< Indicates the availability of place supplier link value in the Place data */ + MAPS_PLACE_RELATED, /**< Indicates the availability of related place link in the Place data */ + MAPS_ROUTE_PATH, /**< Indicates that the Route Data Structure is defined as a Path (a list of geographical coordinates) */ MAPS_ROUTE_SEGMENTS_PATH, /**< Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a Path */ MAPS_ROUTE_SEGMENTS_MANEUVERS, /**< Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a list of Maneuvers*/ - MAPS_VIEW_TRAFFIC = 0x100, /**< Indicates the availability of traffic information on the Map @if MOBILE (Since 3.0) @endif */ - MAPS_VIEW_PUBLIC_TRANSIT, /**< Indicates the availability of public transit information on the Map @if MOBILE (Since 3.0) @endif */ - MAPS_VIEW_BUILDING, /**< Indicates the availability of 3D building drawable on the Map @if MOBILE (Since 3.0) @endif */ - MAPS_VIEW_SCALEBAR /**< Indicates the availability of scale bar on the Map @if MOBILE (Since 3.0) @endif */ + MAPS_VIEW_TRAFFIC = 0x100, /**< Indicates the availability of traffic information on the Map @if MOBILE (Since 3.0) @endif */ + MAPS_VIEW_PUBLIC_TRANSIT, /**< Indicates the availability of public transit information on the Map @if MOBILE (Since 3.0) @endif */ + MAPS_VIEW_BUILDING, /**< Indicates the availability of 3D building drawable on the Map @if MOBILE (Since 3.0) @endif */ + MAPS_VIEW_SCALEBAR /**< Indicates the availability of scale bar on the Map @if MOBILE (Since 3.0) @endif */ } maps_service_data_e; /** @@ -214,6 +214,7 @@ int maps_service_create(const char *maps_provider, maps_service_h *maps); * @retval #MAPS_ERROR_NONE Successful * @retval #MAPS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MAPS_ERROR_NOT_SUPPORTED Not supported + * @retval #MAPS_ERROR_PERMISSION_DENIED Permission Denied * * @pre Call maps_service_create() to create Maps Service and get its handle. *