Tizen Native API  5.0
View Object

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

Supported Object types are following:

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

Enumeration for map marker types.

Since :
3.0
typedef void* maps_view_object_h

The View Object handle.

The handle of an arbitrary visual object instance.

Since :
3.0
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 :
3.0
Remarks:
point must be released using maps_coordinates_destroy().
To use point outside this function, clone it with maps_coordinates_clone().
Parameters:
[in]indexThe current index of path point
[in]totalThe total amount of path points
[in]pointThe point
[in]user_dataThe 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 :
3.0
Remarks:
point must be released using maps_coordinates_destroy().
To use point outside this function, clone it with maps_coordinates_clone().
Parameters:
[in]indexThe current index of path point
[in]totalThe total amount of path points
[in]pointThe point
[in]user_dataThe 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

Enumeration for visual object types.

Since :
3.0

Enumeration for overlay types.

Since :
3.0

Enumeration Type Documentation

Enumeration for map marker types.

Since :
3.0
Enumerator:
MAPS_VIEW_MARKER_PIN 

Indicates the pin marker type

MAPS_VIEW_MARKER_STICKER 

Indicates the sticker marker type

Enumeration for visual object types.

Since :
3.0
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

Enumeration for overlay types.

Since :
3.0
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 :
3.0
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]coordinatesThe geographical coordinates to add marker on
[in]image_file_pathThe file name with the image for the marker
[in]typeThe type of the marker, one of listed in maps_view_marker_type_e
[out]markerThe handle of newly created marker
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_OUT_OF_MEMORYOut of memory
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_PERMISSION_DENIEDPermission Denied
MAPS_ERROR_NOT_SUPPORTEDNot 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

Creates an overlay object.

This function creates an overlay object to contain Evas objects.

Since :
3.0
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]coordinatesThe list of geographical coordinates
[in]objectThe Evas object to be contained
[in]typeThe type of boxing the object
[out]overlayThe handle of newly created polygon
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_OUT_OF_MEMORYOut of memory
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
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]coordinatesThe list of geographical coordinates
[in]rThe red component of polygon background color [0 ~ 255]
[in]gThe green component of polygon background color [0 ~ 255]
[in]bThe blue component of polygon background color [0 ~ 255]
[in]aThe alpha component of polygon background color [0 ~ 255]
[out]polygonThe handle of newly created polygon
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_OUT_OF_MEMORYOut of memory
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
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]coordinatesThe list of geographical coordinates
[in]rThe red component of polyline color [0 ~ 255]
[in]gThe green component of polyline color [0 ~ 255]
[in]bThe blue component of polyline color [0 ~ 255]
[in]aThe alpha component of polyline color [0 ~ 255]
[in]widthThe width of line [1 ~ 100] (pixels)
[out]polylineThe handle of newly added polyline
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_OUT_OF_MEMORYOut of memory
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()

Destroys the object.

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

Since :
3.0
Parameters:
[in]objectThe object handle to destroy
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
See also:
maps_view_object_h
maps_view_object_create_marker()
maps_view_object_create_polygon()
maps_view_object_create_polyline()

Gets the object type.

This function gets the object type.

Since :
3.0
Parameters:
[in]objectThe object handle
[out]typeThe 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_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]objectThe object handle
[out]visibleThe pointer to a boolean in which to store the object visibility
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()

Gets the marker coordinates.

This function gets the marker geographical coordinates.

Since :
3.0
Remarks:
The coordinates should be freed using maps_coordinates_destroy().
Parameters:
[in]markerThe marker object handle
[out]coordinatesThe 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_NONESuccessful
MAPS_ERROR_OUT_OF_MEMORYOut of memory
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Remarks:
The file_path should be freed using free().
Parameters:
[in]markerThe marker object handle
[out]file_pathThe marker image file path
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_OUT_OF_MEMORYOut of memory
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]markerThe marker object handle
[out]widthThe pointer to an integer in which to store the marker width on the screen in pixels
[out]heightThe 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_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()

Gets the marker type.

This function gets the marker type.

Since :
3.0
Parameters:
[in]markerThe marker object handle
[out]typeThe 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_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]markerThe marker object handle
[out]z_orderThe z-order
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Remarks:
To make the marker size proportionally, use 0 as the value for the width or height paramter. 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]markerThe marker object handle
[in]widthThe resized marker pixels in width on the screen
[in]heightThe resized marker pixels in height on the screen
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
Precondition:
marker is created using maps_view_object_create_marker().
See also:
maps_view_object_create_marker()
maps_view_object_marker_get_size()

Sets the marker coordinates.

This function sets the marker geographical coordinates.

Since :
3.0
Parameters:
[in]markerThe marker object handle
[in]coordinatesThe marker geographical coordinates handle
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
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]markerThe marker object handle
[in]file_pathThe marker image file path
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_PERMISSION_DENIEDPermission Denied
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Remarks:
The z_order must be in range of [-100, 100].
Parameters:
[in]markerThe marker object handle
[in]z_orderThe z-order
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()

Gets the overlay coordinates.

This function gets the overlay geographical coordinates.

Since :
3.0
Remarks:
The coordinates should be freed using maps_coordinates_destroy().
Parameters:
[in]overlayThe overlay object handle
[out]coordinatesThe 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_NONESuccessful
MAPS_ERROR_OUT_OF_MEMORYOut of memory
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]overlayThe overlay object handle
[out]zoomThe 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_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]overlayThe overlay object handle
[out]zoomThe 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_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()

Gets the Evas object.

This function gets the Evas object.

Since :
3.0
Remarks:
The object must not be released.
Parameters:
[in]overlayThe overlay object handle
[out]objectThe Evas object handle
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot supported
Precondition:
marker is created using maps_view_object_create_overlay().
See also:
maps_view_object_create_overlay()

Sets the overlay coordinates.

This function sets the overlay geographical coordinates.

Since :
3.0
Parameters:
[in]overlayThe overlay object handle
[in]coordinatesThe overlay geographical coordinates handle
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()

Sets the minimal zoom level for overlay.

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

Since :
3.0
Parameters:
[in]overlayThe overlay object handle
[in]zoomThe new minimal zoom level
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()

Sets the minimal zoom level for overlay.

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

Since :
3.0
Parameters:
[in]overlayThe overlay object handle
[in]zoomThe new minimal zoom level
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Remarks:
The objects will be delivered via maps_view_object_polygon_point_cb().
Parameters:
[in]polygonThe polygon object handle
[in]callbackThe callback function to invoke
[in]user_dataThe user data to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_FOUNDResult not found
MAPS_ERROR_NOT_SUPPORTEDNot supported
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]polygonThe polygon data handle
[in]rThe unsigned char pointer in which to store the red component of the background color
[in]gThe unsigned char pointer in which to store the green component of the background color
[in]bThe unsigned char pointer in which to store the blue component of the background color
[in]aThe 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_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]polygonThe polygon object handle
[in]rThe red component of the fill color
[in]gThe green component of the fill color
[in]bThe blue component of the fill color
[in]aThe alpha component of the fill color
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()

Sets points to the polygon.

This function sets point list to the polygon.

Since :
3.0
Parameters:
[in]polygonThe polygon object handle
[in]pointsThe points to set
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Remarks:
The points will be delivered via maps_view_object_polyline_point_cb().
Parameters:
[in]polylineThe polyline object handle
[in]callbackThe callback function to invoke
[in]user_dataThe user data pointer to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]polylineThe polyline object handle
[out]rThe unsigned char pointer in which to store the red component of the color, or NULL if not interested
[out]gThe unsigned char pointer in which to store the green component of the color, or NULL if not interested
[out]bThe unsigned char pointer in which to store the blue component of the color, or NULL if not interested
[out]aThe 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_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]polylineThe polyline object handle
[out]widthThe width of line [1 ~ 100] (pixels)
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]polylineThe polyline object handle
[in]rThe red component of the color
[in]gThe green component of the color
[in]bThe blue component of the color
[in]aThe alpha component of the color
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()

Sets points to the polyline.

This function sets point list to the polyline.

Since :
3.0
Parameters:
[in]polylineThe polyline object handle
[in]pointsThe points to set
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]polylineThe polyline object handle
[in]widthThe new width of line [1 ~ 100] (pixels)
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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 :
3.0
Parameters:
[in]objectThe object handle
[in]visibleThe new visibility of the object
Returns:
0 on success, otherwise a negative error value
Return values:
MAPS_ERROR_NONESuccessful
MAPS_ERROR_INVALID_PARAMETERInvalid parameter
MAPS_ERROR_NOT_SUPPORTEDNot 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()