This provides APIs related to operations, used in View Object.

Supported Object types are following:

Markers
Polygons
Polylines
Group Objects

Functions
int	maps_view_object_create_marker (maps_coordinates_h coordinates, const char image_file_path, maps_view_marker_type_e type, maps_view_object_h marker)
	Creates a marker visual object.
int	maps_view_object_create_polyline (maps_coordinates_list_h coordinates, unsigned char r, unsigned char g, unsigned char b, unsigned char a, int width, maps_view_object_h *polyline)
	Creates a polyline visual object.
int	maps_view_object_create_polygon (maps_coordinates_list_h coordinates, unsigned char r, unsigned char g, unsigned char b, unsigned char a, maps_view_object_h *polygon)
	Creates a polygon visual object.
int	maps_view_object_create_overlay (maps_coordinates_h coordinates, Evas_Object object, maps_view_overlay_type_e type, maps_view_object_h overlay)
	Creates an overlay object.
int	maps_view_object_destroy (maps_view_object_h object)
	Destroys the object.
int	maps_view_object_get_type (maps_view_object_h object, maps_view_object_type_e *type)
	Gets the object type.
int	maps_view_object_set_visible (maps_view_object_h object, bool visible)
	Shows the object.
int	maps_view_object_get_visible (const maps_view_object_h object, bool *visible)
	Gets the object visibility.
int	maps_view_object_polyline_set_polyline (maps_view_object_h polyline, maps_coordinates_list_h points)
	Sets points to the polyline.
int	maps_view_object_polyline_foreach_point (maps_view_object_h polyline, maps_coordinates_cb callback, void *user_data)
	Retrieves all points, added to the polyline.
int	maps_view_object_polyline_set_color (maps_view_object_h polyline, unsigned char r, unsigned char g, unsigned char b, unsigned char a)
	Sets the polyline color.
int	maps_view_object_polyline_get_color (const maps_view_object_h polyline, unsigned char r, unsigned char g, unsigned char b, unsigned char a)
	Gets the polyline color.
int	maps_view_object_polyline_set_width (maps_view_object_h polyline, int width)
	Sets the polyline width.
int	maps_view_object_polyline_get_width (const maps_view_object_h polyline, int *width)
	Gets the polyline width.
int	maps_view_object_polygon_set_polygon (maps_view_object_h polygon, maps_coordinates_list_h points)
	Sets points to the polygon.
int	maps_view_object_polygon_foreach_point (maps_view_object_h polygon, maps_coordinates_cb callback, void *user_data)
	Retrieves all points, added to the polygon.
int	maps_view_object_polygon_set_fill_color (maps_view_object_h polygon, unsigned char r, unsigned char g, unsigned char b, unsigned char a)
	Sets polygon fill color.
int	maps_view_object_polygon_get_fill_color (const maps_view_object_h polygon, unsigned char r, unsigned char g, unsigned char b, unsigned char a)
	Gets polygon fill color.
int	maps_view_object_marker_set_coordinates (maps_view_object_h marker, maps_coordinates_h coordinates)
	Sets the marker coordinates.
int	maps_view_object_marker_resize (maps_view_object_h marker, int width, int height)
	Sets the marker screen size.
int	maps_view_object_marker_set_image_file (maps_view_object_h marker, const char *file_path)
	Sets the marker image file path.
int	maps_view_object_marker_get_image_file (const maps_view_object_h marker, char **file_path)
	Gets the marker image file path.
int	maps_view_object_marker_get_coordinates (const maps_view_object_h marker, maps_coordinates_h *coordinates)
	Gets the marker coordinates.
int	maps_view_object_marker_get_size (const maps_view_object_h marker, int width, int height)
	Gets the marker screen size.
int	maps_view_object_marker_get_type (const maps_view_object_h marker, maps_view_marker_type_e *type)
	Gets the marker type.
int	maps_view_object_marker_set_z_order (maps_view_object_h marker, int z_order)
	Sets the marker z-order.
int	maps_view_object_marker_get_z_order (const maps_view_object_h marker, int *z_order)
	Gets the marker z-order.
int	maps_view_object_overlay_get_object (maps_view_object_h overlay, Evas_Object **object)
	Gets the Evas object.
int	maps_view_object_overlay_set_coordinates (maps_view_object_h overlay, maps_coordinates_h coordinates)
	Sets the overlay coordinates.
int	maps_view_object_overlay_get_coordinates (const maps_view_object_h overlay, maps_coordinates_h *coordinates)
	Gets the overlay coordinates.
int	maps_view_object_overlay_set_min_zoom_level (maps_view_object_h overlay, int zoom)
	Sets the minimal zoom level for overlay.
int	maps_view_object_overlay_get_min_zoom_level (const maps_view_object_h overlay, int *zoom)
	Gets the minimal zoom level for overlay.
int	maps_view_object_overlay_set_max_zoom_level (maps_view_object_h overlay, int zoom)
	Sets the minimal zoom level for overlay.
int	maps_view_object_overlay_get_max_zoom_level (const maps_view_object_h overlay, int *zoom)
	Gets the minimal zoom level for overlay.
Typedefs
typedef void *	maps_view_object_h
	The View Object handle.
typedef enum _maps_view_object_type_e	maps_view_object_type_e
	Enumeration for visual object types.
typedef enum _maps_view_marker_type_e	maps_view_marker_type_e
	Enumeration for map marker types.
typedef enum _maps_view_overlay_type_e	maps_view_overlay_type_e
	Enumeration for overlay types.
typedef bool(*	maps_view_object_polyline_point_cb )(int index, int total, maps_coordinates_h point, void *user_data)
	Called when requesting the list of points of the polyline.
typedef bool(*	maps_view_object_polygon_point_cb )(int index, int total, maps_coordinates_h point, void *user_data)
	Called when requesting the list of points of the polygon.

Typedef Documentation

typedef enum _maps_view_marker_type_e maps_view_marker_type_e

Enumeration for map marker types.

Since :: 2.3.2

typedef void* maps_view_object_h

The View Object handle.

The handle of an arbitrary visual object instance.

Since :: 2.3.2

Remarks:: The handle may be issued with one of following functions: * maps_view_object_create_marker() * maps_view_object_create_polygon() * maps_view_object_create_polyline()
To release the handle, use maps_view_object_destroy().
Note that when the object is added to View, it will be released automatically when the View is destroyed.

See also:: maps_view_object_destroy(); maps_view_add_object()

typedef bool(* maps_view_object_polygon_point_cb)(int index, int total, maps_coordinates_h point, void *user_data)

Called when requesting the list of points of the polygon.

This callback is invoked while iterating through the list of points, added to the polygon.

Since :: 2.3.2

Remarks:: point must be released using maps_coordinates_destroy().
To use point outside this function, clone it with maps_coordinates_clone().

Parameters:

[in]	index	The current index of path point
[in]	total	The total amount of path points
[in]	point	The point
[in]	user_data	The user data pointer passed from maps_view_object_polygon_foreach_point()

Returns:: true to continue with the next iteration of the loop,
false to break out of the loop

Precondition:: maps_view_object_polygon_foreach_point() will invoke this callback.

See also:: maps_view_object_polygon_foreach_point(); maps_coordinates_h

typedef bool(* maps_view_object_polyline_point_cb)(int index, int total, maps_coordinates_h point, void *user_data)

Called when requesting the list of points of the polyline.

This callback is invoked while iterating through the list of points, added to the polyline.

Since :: 2.3.2

Remarks:: point must be released using maps_coordinates_destroy().
To use point outside this function, clone it with maps_coordinates_clone().

Parameters:

[in]	index	The current index of path point
[in]	total	The total amount of path points
[in]	point	The point
[in]	user_data	The user data pointer passed from maps_view_object_polyline_foreach_point()

Returns:: true to continue with the next iteration of the loop,
false to break out of the loop

Precondition:: maps_view_object_polyline_foreach_point() will invoke this callback.

See also:: maps_view_object_polyline_foreach_point(); maps_coordinates_h

typedef enum _maps_view_object_type_e maps_view_object_type_e

Enumeration for visual object types.

Since :: 2.3.2

typedef enum _maps_view_overlay_type_e maps_view_overlay_type_e

Enumeration for overlay types.

Since :: 2.3.2

Enumeration Type Documentation

enum _maps_view_marker_type_e

Enumeration for map marker types.

Since :: 2.3.2

Enumerator:

MAPS_VIEW_MARKER_PIN	Indicates the pin marker type
MAPS_VIEW_MARKER_STICKER	Indicates the sticker marker type

enum _maps_view_object_type_e

Enumeration for visual object types.

Since :: 2.3.2

Enumerator:

MAPS_VIEW_OBJECT_POLYLINE	Indicates the polyline
MAPS_VIEW_OBJECT_POLYGON	Indicates the polygon
MAPS_VIEW_OBJECT_MARKER	Indicates the marker
MAPS_VIEW_OBJECT_OVERLAY	Indicates the overlay

enum _maps_view_overlay_type_e

Enumeration for overlay types.

Since :: 2.3.2

Enumerator:

MAPS_VIEW_OVERLAY_NORMAL	Indicates the normal type
MAPS_VIEW_OVERLAY_BUBBLE	Indicates the bubble type
MAPS_VIEW_OVERLAY_BOX	Indicates the box type

Function Documentation

int maps_view_object_create_marker	(	maps_coordinates_h	coordinates,
		const char *	image_file_path,
		maps_view_marker_type_e	type,
		maps_view_object_h *	marker
	)

Creates a marker visual object.

This function creates a marker on a given geographical coordinates. The marker is specified with a given image file and a type.

Since :: 2.3.2

Remarks:: marker can be released by using maps_view_object_destroy().
If added to the View using maps_view_add_object(), marker will be released automatically when the View is destroyed.
http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.
http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.

Parameters:

[in]	coordinates	The geographical coordinates to add marker on
[in]	image_file_path	The file name with the image for the marker
[in]	type	The type of the marker, one of listed in maps_view_marker_type_e
[out]	marker	The handle of newly created marker

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_PERMISSION_DENIED	Permission Denied
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: coordinates are created using map_coordinates_create().

See also:: maps_view_object_h; maps_view_marker_type_e; maps_view_object_create_polygon(); maps_view_object_create_polyline(); maps_view_add_object(); maps_view_object_destroy(); maps_coordinates_h

int maps_view_object_create_overlay	(	maps_coordinates_h	coordinates,
		Evas_Object *	object,
		maps_view_overlay_type_e	type,
		maps_view_object_h *	overlay
	)

Creates an overlay object.

This function creates an overlay object to contain Evas objects.

Since :: 2.3.2

Remarks:: overlay can be released by using maps_view_object_destroy().
If added to the View using maps_view_add_object(), overlay will be released automatically when the View is destroyed.

Parameters:

[in]	coordinates	The list of geographical coordinates
[in]	object	The Evas object to be contained
[in]	type	The type of boxing the object
[out]	overlay	The handle of newly created polygon

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: coordinates is created using maps_coordinates_list_create().

See also:: maps_view_object_h; maps_view_object_create_marker(); maps_view_object_create_polyline(); maps_view_object_create_polygon(); maps_view_add_object(); maps_view_object_destroy(); maps_coordinates_h; maps_coordinates_create()

int maps_view_object_create_polygon	(	maps_coordinates_list_h	coordinates,
		unsigned char	r,
		unsigned char	g,
		unsigned char	b,
		unsigned char	a,
		maps_view_object_h *	polygon
	)

Creates a polygon visual object.

This function creates a polygon visual object, specified with a list of geographical coordinates and fill color.

Since :: 2.3.2

Remarks:: polygon can be released by using maps_view_object_destroy().
If added to the View using maps_view_add_object(), polygon will be released automatically when the View is destroyed.

Parameters:

[in]	coordinates	The list of geographical coordinates
[in]	r	The red component of polygon background color [0 ~ 255]
[in]	g	The green component of polygon background color [0 ~ 255]
[in]	b	The blue component of polygon background color [0 ~ 255]
[in]	a	The alpha component of polygon background color [0 ~ 255]
[out]	polygon	The handle of newly created polygon

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: coordinates is created using maps_coordinates_list_create().

See also:: maps_view_object_h; maps_view_object_create_marker(); maps_view_object_create_polyline(); maps_view_add_object(); maps_view_object_destroy(); maps_coordinates_list_h; maps_coordinates_list_create()

int maps_view_object_create_polyline	(	maps_coordinates_list_h	coordinates,
		unsigned char	r,
		unsigned char	g,
		unsigned char	b,
		unsigned char	a,
		int	width,
		maps_view_object_h *	polyline
	)

Creates a polyline visual object.

This function creates a polyline visual object, specified with a list of geographical coordinates, line width and color.

Since :: 2.3.2

Remarks:: polyline can be released by using maps_view_object_destroy().
If added to the View using maps_view_add_object(), polyline will be released automatically when the View is destroyed.

Parameters:

[in]	coordinates	The list of geographical coordinates
[in]	r	The red component of polyline color [0 ~ 255]
[in]	g	The green component of polyline color [0 ~ 255]
[in]	b	The blue component of polyline color [0 ~ 255]
[in]	a	The alpha component of polyline color [0 ~ 255]
[in]	width	The width of line [1 ~ 100] (pixels)
[out]	polyline	The handle of newly added polyline

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: coordinates is created using maps_coordinates_list_create().

See also:: maps_view_object_h; maps_view_object_create_marker(); maps_view_object_create_polygon(); maps_view_add_object(); maps_view_object_destroy(); maps_coordinates_list_h; maps_coordinates_list_create()

int maps_view_object_destroy ( maps_view_object_h object )

Destroys the object.

This function destroys the object handle and releases all its resources.

Since :: 2.3.2

Parameters:

[in] object The object handle to destroy

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

See also:: maps_view_object_h; maps_view_object_create_marker(); maps_view_object_create_polygon(); maps_view_object_create_polyline()

int maps_view_object_get_type	(	maps_view_object_h	object,
		maps_view_object_type_e *	type
	)

Gets the object type.

This function gets the object type.

Since :: 2.3.2

Parameters:

[in]	object	The object handle
[out]	type	The pointer to maps_view_object_type_e in which to store the object type

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: object is created using maps_view_object_create_marker(), maps_view_object_create_polyline() or maps_view_object_create_polygon().

See also:: maps_view_object_h; maps_view_object_create_marker(); maps_view_object_create_polyline(); maps_view_object_create_polygon()

int maps_view_object_get_visible	(	const maps_view_object_h	object,
		bool *	visible
	)

Gets the object visibility.

This function retrieves whether or not the given object is visible.

Since :: 2.3.2

Parameters:

[in]	object	The object handle
[out]	visible	The pointer to a boolean in which to store the object visibility

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: object is created using maps_view_object_create_marker(), maps_view_object_create_polyline(), maps_view_object_create_polygon().

See also:: maps_view_object_h; maps_view_object_set_visible()

int maps_view_object_marker_get_coordinates	(	const maps_view_object_h	marker,
		maps_coordinates_h *	coordinates
	)

Gets the marker coordinates.

This function gets the marker geographical coordinates.

Since :: 2.3.2

Remarks:: The coordinates should be freed using maps_coordinates_destroy().

Parameters:

[in]	marker	The marker object handle
[out]	coordinates	The pointer to maps_coordinates_h in which to store the marker geographical coordinates

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_marker().; coordinates may be set previously using maps_view_object_marker_set_coordinates().

See also:: maps_view_object_marker_set_coordinates(); maps_coordinates_h; maps_view_object_create_marker()

int maps_view_object_marker_get_image_file	(	const maps_view_object_h	marker,
		char **	file_path
	)

Gets the marker image file path.

This function gets the marker image file path.

Since :: 2.3.2

Remarks:: The file_path should be freed using free().

Parameters:

[in]	marker	The marker object handle
[out]	file_path	The marker image file path

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_marker().; file_path may be set previously using maps_view_object_marker_set_image_file().

See also:: maps_view_object_marker_set_image_file(); maps_view_object_create_marker()

int maps_view_object_marker_get_size	(	const maps_view_object_h	marker,
		int *	width,
		int *	height
	)

Gets the marker screen size.

This function gets the marker size on the screen.

Since :: 2.3.2

Parameters:

[in]	marker	The marker object handle
[out]	width	The pointer to an integer in which to store the marker width on the screen in pixels
[out]	height	The pointer to an integer in which to store the marker height on the screen in pixels

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_marker().; width and height may be set previously using maps_view_object_marker_resize().

See also:: maps_view_object_marker_resize(); maps_view_object_create_marker()

int maps_view_object_marker_get_type	(	const maps_view_object_h	marker,
		maps_view_marker_type_e *	type
	)

Gets the marker type.

This function gets the marker type.

Since :: 2.3.2

Parameters:

[in]	marker	The marker object handle
[out]	type	The pointer to a maps_view_marker_type_e in which to store the marker type

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_marker().

See also:: maps_view_marker_type_e; maps_view_object_create_marker()

int maps_view_object_marker_get_z_order	(	const maps_view_object_h	marker,
		int *	z_order
	)

Gets the marker z-order.

This function gets the z-order.

Since :: 2.3.2

Parameters:

[in]	marker	The marker object handle
[out]	z_order	The z-order

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_marker().

See also:: maps_view_object_create_marker(); maps_view_object_marker_set_z_order()

int maps_view_object_marker_resize	(	maps_view_object_h	marker,
		int	width,
		int	height
	)

Sets the marker screen size.

This function sets the marker screen size.

Since :: 2.3.2

Remarks:: To make the marker size proportionally, use 0 as the value for the width or height parameter. For instance, to make the width of an marker 150 pixels, and change the height using the same proportion, use maps_view_object_marker_resize(marker, 150, 0).

Parameters:

[in]	marker	The marker object handle
[in]	width	The resized marker pixels in width on the screen
[in]	height	The resized marker pixels in height on the screen

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_marker().

See also:: maps_view_object_create_marker(); maps_view_object_marker_get_size()

int maps_view_object_marker_set_coordinates	(	maps_view_object_h	marker,
		maps_coordinates_h	coordinates
	)

Sets the marker coordinates.

This function sets the marker geographical coordinates.

Since :: 2.3.2

Parameters:

[in]	marker	The marker object handle
[in]	coordinates	The marker geographical coordinates handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_marker().; coordinates are created using maps_coordinates_create().

See also:: maps_view_object_create_marker(); maps_view_object_marker_get_coordinates(); maps_coordinates_h; maps_coordinates_create()

int maps_view_object_marker_set_image_file	(	maps_view_object_h	marker,
		const char *	file_path
	)

Sets the marker image file path.

This function sets the marker image file path.

Since :: 2.3.2

Remarks:: http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.
http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.

Parameters:

[in]	marker	The marker object handle
[in]	file_path	The marker image file path

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_PERMISSION_DENIED	Permission Denied
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_marker().

See also:: maps_view_object_marker_get_image_file(); maps_view_object_create_marker()

int maps_view_object_marker_set_z_order	(	maps_view_object_h	marker,
		int	z_order
	)

Sets the marker z-order.

This function sets the z-order.

Since :: 2.3.2

Remarks:: The z_order must be in range of [-100, 100].

Parameters:

[in]	marker	The marker object handle
[in]	z_order	The z-order

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_marker().

See also:: maps_view_object_create_marker(); maps_view_object_marker_get_z_order()

int maps_view_object_overlay_get_coordinates	(	const maps_view_object_h	overlay,
		maps_coordinates_h *	coordinates
	)

Gets the overlay coordinates.

This function gets the overlay geographical coordinates.

Since :: 2.3.2

Remarks:: The coordinates should be freed using maps_coordinates_destroy().

Parameters:

[in]	overlay	The overlay object handle
[out]	coordinates	The pointer to maps_coordinates_h in which to store the overlay geographical coordinates

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_OUT_OF_MEMORY	Out of memory
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: overlay is created using maps_view_object_create_overlay().; coordinates may be set previously using maps_view_object_overlay_set_coordinates().

See also:: maps_view_object_create_overlay(); maps_view_object_overlay_set_coordinates(); maps_coordinates_h; maps_coordinates_destroy()

int maps_view_object_overlay_get_max_zoom_level	(	const maps_view_object_h	overlay,
		int *	zoom
	)

Gets the minimal zoom level for overlay.

This function gets the minimally allowed zoom level of the map to show the overlay.

Since :: 2.3.2

Parameters:

[in]	overlay	The overlay object handle
[out]	zoom	The pointer to an integer in which to store the minimally allowed zoom level

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: overlay is created using maps_view_object_create_overlay().

See also:: maps_view_object_create_overlay(); maps_view_object_overlay_get_min_zoom_level(); maps_view_object_overlay_set_min_zoom_level(); maps_view_object_overlay_set_max_zoom_level()

int maps_view_object_overlay_get_min_zoom_level	(	const maps_view_object_h	overlay,
		int *	zoom
	)

Gets the minimal zoom level for overlay.

This function gets the minimally allowed zoom level of the map to show the overlay.

Since :: 2.3.2

Parameters:

[in]	overlay	The overlay object handle
[out]	zoom	The pointer to an integer in which to store the minimally allowed zoom level.

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: overlay is created using maps_view_object_create_overlay().

See also:: maps_view_object_create_overlay(); maps_view_object_overlay_set_min_zoom_level(); maps_view_object_overlay_set_max_zoom_level(); maps_view_object_overlay_get_max_zoom_level()

int maps_view_object_overlay_get_object	(	maps_view_object_h	overlay,
		Evas_Object **	object
	)

Gets the Evas object.

This function gets the Evas object.

Since :: 2.3.2

Remarks:: The object must not be released.

Parameters:

[in]	overlay	The overlay object handle
[out]	object	The Evas object handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: marker is created using maps_view_object_create_overlay().

See also:: maps_view_object_create_overlay()

int maps_view_object_overlay_set_coordinates	(	maps_view_object_h	overlay,
		maps_coordinates_h	coordinates
	)

Sets the overlay coordinates.

This function sets the overlay geographical coordinates.

Since :: 2.3.2

Parameters:

[in]	overlay	The overlay object handle
[in]	coordinates	The overlay geographical coordinates handle

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: overlay is created using maps_view_object_create_overlay().; coordinates are created using maps_coordinates_create().

See also:: maps_view_object_create_overlay(); maps_view_object_overlay_get_coordinates(); maps_coordinates_h; maps_coordinates_create()

int maps_view_object_overlay_set_max_zoom_level	(	maps_view_object_h	overlay,
		int	zoom
	)

Sets the minimal zoom level for overlay.

This function sets the minimally allowed zoom level of the map to show the overlay.

Since :: 2.3.2

Parameters:

[in]	overlay	The overlay object handle
[in]	zoom	The new minimal zoom level

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: overlay is created using maps_view_object_create_overlay().

See also:: maps_view_object_create_overlay(); maps_view_object_overlay_get_min_zoom_level(); maps_view_object_overlay_set_min_zoom_level(); maps_view_object_overlay_get_max_zoom_level()

int maps_view_object_overlay_set_min_zoom_level	(	maps_view_object_h	overlay,
		int	zoom
	)

Sets the minimal zoom level for overlay.

This function sets the minimally allowed zoom level of the map to show the overlay.

Since :: 2.3.2

Parameters:

[in]	overlay	The overlay object handle
[in]	zoom	The new minimal zoom level

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: overlay is created using maps_view_object_create_overlay().

See also:: maps_view_object_create_overlay(); maps_view_object_overlay_get_min_zoom_level(); maps_view_object_overlay_set_max_zoom_level(); maps_view_object_overlay_get_max_zoom_level()

int maps_view_object_polygon_foreach_point	(	maps_view_object_h	polygon,
		maps_coordinates_cb	callback,
		void *	user_data
	)

Retrieves all points, added to the polygon.

This function retrieves all points, added to the polygon.

Since :: 2.3.2

Remarks:: The objects will be delivered via maps_view_object_polygon_point_cb().

Parameters:

[in]	polygon	The polygon object handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_FOUND	Result not found
MAPS_ERROR_NOT_SUPPORTED	Not supported
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polygon is created using maps_view_object_create_polygon().

Postcondition:: This function invokes maps_view_object_polygon_point_cb() repeatedly to retrieve each point.

See also:: maps_view_object_polygon_point_cb(); maps_view_object_create_polygon(); maps_view_object_h; maps_view_object_polygon_set_polygon()

int maps_view_object_polygon_get_fill_color	(	const maps_view_object_h	polygon,
		unsigned char *	r,
		unsigned char *	g,
		unsigned char *	b,
		unsigned char *	a
	)

Gets polygon fill color.

This function gets the polygon fill color on canvas.

Since :: 2.3.2

Parameters:

[in]	polygon	The polygon data handle
[in]	r	The unsigned char pointer in which to store the red component of the background color
[in]	g	The unsigned char pointer in which to store the green component of the background color
[in]	b	The unsigned char pointer in which to store the blue component of the background color
[in]	a	The unsigned char pointer in which to store the alpha component of the background color

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polygon is created using maps_view_object_create_polygon().; Fill color components may be previously set using maps_view_object_polygon_set_fill_color().

See also:: maps_view_object_polygon_set_fill_color(); maps_view_object_create_polygon()

int maps_view_object_polygon_set_fill_color	(	maps_view_object_h	polygon,
		unsigned char	r,
		unsigned char	g,
		unsigned char	b,
		unsigned char	a
	)

Sets polygon fill color.

This function sets the polygon fill color on canvas.

Since :: 2.3.2

Parameters:

[in]	polygon	The polygon object handle
[in]	r	The red component of the fill color
[in]	g	The green component of the fill color
[in]	b	The blue component of the fill color
[in]	a	The alpha component of the fill color

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polygon is created using maps_view_object_create_polygon().

See also:: maps_view_object_polygon_get_fill_color(); maps_view_object_create_polygon()

int maps_view_object_polygon_set_polygon	(	maps_view_object_h	polygon,
		maps_coordinates_list_h	points
	)

Sets points to the polygon.

This function sets point list to the polygon.

Since :: 2.3.2

Parameters:

[in]	polygon	The polygon object handle
[in]	points	The points to set

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polygon is created using maps_view_object_create_polygon().; points are created using maps_coordinates_list_create().

See also:: maps_view_object_create_polygon(); maps_view_object_h; maps_coordinates_list_h; maps_coordinates_list_create(); maps_view_object_polygon_foreach_point()

int maps_view_object_polyline_foreach_point	(	maps_view_object_h	polyline,
		maps_coordinates_cb	callback,
		void *	user_data
	)

Retrieves all points, added to the polyline.

This function retrieves all points, added to the polyline.

Since :: 2.3.2

Remarks:: The points will be delivered via maps_view_object_polyline_point_cb().

Parameters:

[in]	polyline	The polyline object handle
[in]	callback	The callback function to invoke
[in]	user_data	The user data pointer to be passed to the callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polyline is created using maps_view_object_create_polyline().

Postcondition:: This function invokes maps_view_object_polyline_point_cb() repeatedly to retrieve each point.

See also:: maps_view_object_h; maps_view_object_create_polyline(); maps_view_object_polyline_set_polyline(); maps_view_object_polyline_point_cb()

int maps_view_object_polyline_get_color	(	const maps_view_object_h	polyline,
		unsigned char *	r,
		unsigned char *	g,
		unsigned char *	b,
		unsigned char *	a
	)

Gets the polyline color.

This function gets the polyline color on canvas.

Since :: 2.3.2

Parameters:

[in]	polyline	The polyline object handle
[out]	r	The unsigned char pointer in which to store the red component of the color, or NULL if not interested
[out]	g	The unsigned char pointer in which to store the green component of the color, or NULL if not interested
[out]	b	The unsigned char pointer in which to store the blue component of the color, or NULL if not interested
[out]	a	The unsigned char pointer in which to store the alpha component of the color, or NULL if not interested

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polyline is created using maps_view_object_create_polyline().; color components may be previously set using maps_view_object_polyline_set_color().

See also:: maps_view_object_polyline_set_color(); maps_view_object_polyline_get_width(); maps_view_object_create_polyline()

int maps_view_object_polyline_get_width	(	const maps_view_object_h	polyline,
		int *	width
	)

Gets the polyline width.

This function gets the polyline width on canvas.

Since :: 2.3.2

Parameters:

[in]	polyline	The polyline object handle
[out]	width	The width of line [1 ~ 100] (pixels)

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polyline is created using maps_view_object_create_polyline().; width may be previously set using maps_view_object_polyline_set_width().

See also:: maps_view_object_polyline_set_width(); maps_view_object_polyline_get_color(); maps_view_object_create_polyline()

int maps_view_object_polyline_set_color	(	maps_view_object_h	polyline,
		unsigned char	r,
		unsigned char	g,
		unsigned char	b,
		unsigned char	a
	)

Sets the polyline color.

This function sets the polyline color on canvas.

Since :: 2.3.2

Parameters:

[in]	polyline	The polyline object handle
[in]	r	The red component of the color
[in]	g	The green component of the color
[in]	b	The blue component of the color
[in]	a	The alpha component of the color

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polyline is created using maps_view_object_create_polyline().

See also:: maps_view_object_polyline_get_color(); maps_view_object_polyline_set_width(); maps_view_object_create_polyline()

int maps_view_object_polyline_set_polyline	(	maps_view_object_h	polyline,
		maps_coordinates_list_h	points
	)

Sets points to the polyline.

This function sets point list to the polyline.

Since :: 2.3.2

Parameters:

[in]	polyline	The polyline object handle
[in]	points	The points to set

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polyline is created using maps_view_object_create_polyline().; points are created using maps_coordinates_list_create().

Postcondition:: Previous points will be destroyed automatically.

See also:: maps_view_object_h; maps_coordinates_list_h; maps_coordinates_list_create(); maps_view_object_create_polyline(); maps_view_object_polyline_foreach_point()

int maps_view_object_polyline_set_width	(	maps_view_object_h	polyline,
		int	width
	)

Sets the polyline width.

This function sets the polyline width on canvas.

Since :: 2.3.2

Parameters:

[in]	polyline	The polyline object handle
[in]	width	The new width of line [1 ~ 100] (pixels)

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: polyline is created using maps_view_object_create_polyline().

See also:: maps_view_object_polyline_get_width(); maps_view_object_polyline_set_color(); maps_view_object_create_polyline()

int maps_view_object_set_visible	(	maps_view_object_h	object,
		bool	visible
	)

Shows the object.

This function changes the visibility of the given object on the View.

Since :: 2.3.2

Parameters:

[in]	object	The object handle
[in]	visible	The new visibility of the object

Returns:: 0 on success, otherwise a negative error value

Return values:

MAPS_ERROR_NONE	Successful
MAPS_ERROR_INVALID_PARAMETER	Invalid parameter
MAPS_ERROR_NOT_SUPPORTED	Not supported

Precondition:: object is created using maps_view_object_create_marker(), maps_view_object_create_polyline(), maps_view_object_create_polygon().

See also:: maps_view_object_h; maps_view_object_get_visible()

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation