Typedefs | Enumerations | Functions
Map

Typedefs

typedef struct _Elm_Map_Marker Elm_Map_Marker
 A marker to be shown in a specific point of the map. More...
 
typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class
 Each marker must be associated to a class. More...
 
typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class
 Each marker must be associated to a group class. More...
 
typedef struct _Elm_Map_Route Elm_Map_Route
 A route to be shown in the map. More...
 
typedef struct _Elm_Map_Name Elm_Map_Name
 A handle for specific coordinates. More...
 
typedef struct _Elm_Map_Overlay Elm_Map_Overlay
 A overlay to be shown in a specific point of the map. More...
 
typedef Evas_Object *(* Elm_Map_Marker_Get_Func) (Evas_Object *obj, Elm_Map_Marker *marker, void *data)
 Bubble content fetching class function for marker classes. More...
 
typedef void(* Elm_Map_Marker_Del_Func) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o)
 Function to delete bubble content for marker classes. More...
 
typedef Evas_Object *(* Elm_Map_Marker_Icon_Get_Func) (Evas_Object *obj, Elm_Map_Marker *marker, void *data)
 Icon fetching class function for marker classes. More...
 
typedef Evas_Object *(* Elm_Map_Group_Icon_Get_Func) (Evas_Object *obj, void *data)
 Icon fetching class function for markers group classes. More...
 
typedef void(* Elm_Map_Overlay_Get_Cb) (void *data, Evas_Object *map, Elm_Map_Overlay *overlay)
 Get callback function for the overlay. More...
 
typedef void(* Elm_Map_Overlay_Del_Cb) (void *data, Evas_Object *map, Elm_Map_Overlay *overlay)
 Det callback function for the overlay. More...
 
typedef void(* Elm_Map_Name_Cb) (void *data, Evas_Object *map, Elm_Map_Name *name)
 Async-callback function for the name request. More...
 
typedef void(* Elm_Map_Name_List_Cb) (void *data, Evas_Object *map, Eina_List *name_list)
 Async-callback function for the name list request. More...
 
typedef void(* Elm_Map_Route_Cb) (void *data, Evas_Object *map, Elm_Map_Route *route)
 Async-callback function for the route request. More...
 

Enumerations

enum  Elm_Map_Zoom_Mode {
  ELM_MAP_ZOOM_MODE_MANUAL,
  ELM_MAP_ZOOM_MODE_AUTO_FIT,
  ELM_MAP_ZOOM_MODE_AUTO_FILL
}
 Set map's zoom behavior. More...
 
enum  Elm_Map_Source_Type {
  ELM_MAP_SOURCE_TYPE_TILE,
  ELM_MAP_SOURCE_TYPE_ROUTE,
  ELM_MAP_SOURCE_TYPE_NAME
}
 Set type of a external source (provider). More...
 
enum  Elm_Map_Route_Type {
  ELM_MAP_ROUTE_TYPE_MOTOCAR,
  ELM_MAP_ROUTE_TYPE_BICYCLE,
  ELM_MAP_ROUTE_TYPE_FOOT
}
 Set type of transport used on route. More...
 
enum  Elm_Map_Route_Method {
  ELM_MAP_ROUTE_METHOD_FASTEST,
  ELM_MAP_ROUTE_METHOD_SHORTEST
}
 Set the routing method, what should be prioritized, time or distance. More...
 
enum  Elm_Map_Name_Method
 Set the name search method. More...
 
enum  Elm_Map_Overlay_Type
 Set overlay type to be used. More...
 

Functions

void elm_map_overlay_del (Elm_Map_Overlay *overlay)
 Delete a overlay from the map. More...
 
Elm_Map_Overlay_Type elm_map_overlay_type_get (const Elm_Map_Overlay *overlay)
 Get the overlay type. More...
 
void elm_map_overlay_data_set (Elm_Map_Overlay *overlay, void *data)
 Set a pointer of user data for a overlay. More...
 
void * elm_map_overlay_data_get (const Elm_Map_Overlay *overlay)
 Get the user data stored on a overlay. More...
 
void elm_map_overlay_hide_set (Elm_Map_Overlay *overlay, Eina_Bool hide)
 Set if the overlay is hidden or not. More...
 
Eina_Bool elm_map_overlay_hide_get (const Elm_Map_Overlay *overlay)
 Get a value whether the overlay is hidden or not. More...
 
void elm_map_overlay_displayed_zoom_min_set (Elm_Map_Overlay *overlay, int zoom)
 Set the minimum zoom from where the overlay is displayed. More...
 
int elm_map_overlay_displayed_zoom_min_get (const Elm_Map_Overlay *overlay)
 Get the minimum zoom from where the overlay is displayed. More...
 
void elm_map_overlay_paused_set (Elm_Map_Overlay *overlay, Eina_Bool paused)
 Pause or unpause the overlay. More...
 
Eina_Bool elm_map_overlay_paused_get (const Elm_Map_Overlay *overlay)
 Get a value whether the overlay is paused or not. More...
 
Eina_Bool elm_map_overlay_visible_get (const Elm_Map_Overlay *overlay)
 Get a value whether the overlay is visible or not. More...
 
void elm_map_overlay_content_set (Elm_Map_Overlay *overlay, Evas_Object *obj)
 Set the content object of the overlay. More...
 
const Evas_Object * elm_map_overlay_content_get (const Elm_Map_Overlay *overlay)
 Get the content object. More...
 
void elm_map_overlay_icon_set (Elm_Map_Overlay *overlay, Evas_Object *icon)
 Set a icon of the overlay. More...
 
const Evas_Object * elm_map_overlay_icon_get (const Elm_Map_Overlay *overlay)
 Get the icon object. More...
 
void elm_map_overlay_region_set (Elm_Map_Overlay *overlay, double lon, double lat)
 Set the geographic coordinates of the overlay. More...
 
void elm_map_overlay_region_get (const Elm_Map_Overlay *overlay, double *lon, double *lat)
 Get the geographic coordinates of the overlay. More...
 
void elm_map_overlay_color_set (Elm_Map_Overlay *overlay, int r, int g, int b, int a)
 Set the object color of the overlay. More...
 
void elm_map_overlay_color_get (const Elm_Map_Overlay *overlay, int *r, int *g, int *b, int *a)
 Get the object color of the overlay. More...
 
void elm_map_overlay_show (Elm_Map_Overlay *overlay)
 Show the given overlay at the center of the map, immediately. More...
 
void elm_map_overlays_show (Eina_List *overlays)
 Move and zoom the map to display a list of overlays. More...
 
void elm_map_overlay_get_cb_set (Elm_Map_Overlay *overlay, Elm_Map_Overlay_Get_Cb get_cb, void *data)
 Set the get callback function of the overlay. More...
 
void elm_map_overlay_del_cb_set (Elm_Map_Overlay *overlay, Elm_Map_Overlay_Del_Cb del_cb, void *data)
 Set the del callback function to call when the overlay is deleted. More...
 
void elm_map_overlay_class_append (Elm_Map_Overlay *clas, Elm_Map_Overlay *overlay)
 Add a new overlay member to the class overlay. More...
 
void elm_map_overlay_class_remove (Elm_Map_Overlay *clas, Elm_Map_Overlay *overlay)
 Remove a overlay from the class. More...
 
void elm_map_overlay_class_zoom_max_set (Elm_Map_Overlay *clas, int zoom)
 Set the maximum zoom from where the overlay members in the class can be grouped. More...
 
int elm_map_overlay_class_zoom_max_get (const Elm_Map_Overlay *clas)
 Get the maximum zoom from where the overlay members in the class can be grouped. More...
 
Eina_List * elm_map_overlay_group_members_get (const Elm_Map_Overlay *grp)
 Get the overlay members of the group overlay. More...
 
void elm_map_overlay_bubble_follow (Elm_Map_Overlay *bubble, const Elm_Map_Overlay *parent)
 Follow a other overlay. More...
 
void elm_map_overlay_bubble_content_append (Elm_Map_Overlay *bubble, Evas_Object *content)
 Add a content object to the bubble overlay. More...
 
void elm_map_overlay_bubble_content_clear (Elm_Map_Overlay *bubble)
 Clear all contents inside the bubble overlay. More...
 
void elm_map_overlay_polygon_region_add (Elm_Map_Overlay *overlay, double lon, double lat)
 Add a geographic coordinates to the polygon overlay. More...
 
void elm_map_route_del (Elm_Map_Route *route)
 Remove a route from the map. More...
 
double elm_map_route_distance_get (const Elm_Map_Route *route)
 Get the route distance in kilometers. More...
 
const char * elm_map_route_node_get (const Elm_Map_Route *route)
 Get the information of route nodes. More...
 
const char * elm_map_route_waypoint_get (const Elm_Map_Route *route)
 Get the information of route waypoint. More...
 
const char * elm_map_name_address_get (const Elm_Map_Name *name)
 Get the address of the name. More...
 
void elm_map_name_region_get (const Elm_Map_Name *name, double *lon, double *lat)
 Get the current coordinates of the name. More...
 
void elm_map_name_del (Elm_Map_Name *name)
 Remove a name from the map. More...
 
Evas_Object * elm_map_add (Evas_Object *parent)
 Add a new map widget to the given parent Elementary (container) object. More...
 

Detailed Description

map_inheritance_tree.png
preview-00.png

This is a widget specifically for displaying a map. It uses basically OpenStreetMap provider http://www.openstreetmap.org/, but custom providers can be added.

It supports some basic but yet nice features:

This widget implements the elm-scrollable-interface interface, so that all (non-deprecated) functions for the base Scroller widget also work for map objects.

Smart callbacks one can listen to:

Available style for map widget:

Available style for markers:

Available style for marker bubble:

List of examples:

Typedef Documentation

typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class

Each marker must be associated to a group class.

It's required to add a mark. The group class defines the style of the marker when a marker is grouped to other markers. Markers with the same group are grouped if they are close. A new group class can be created with elm_map_marker_group_class_new().

typedef Evas_Object*(* Elm_Map_Group_Icon_Get_Func) (Evas_Object *obj, void *data)

Icon fetching class function for markers group classes.

typedef struct _Elm_Map_Marker Elm_Map_Marker

A marker to be shown in a specific point of the map.

Can be created with elm_map_marker_add() and deleted with elm_map_marker_remove().

typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class

Each marker must be associated to a class.

It's required to add a mark. The class defines the style of the marker when a marker is displayed alone (not grouped). A new class can be created with elm_map_marker_class_new().

typedef void(* Elm_Map_Marker_Del_Func) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o)

Function to delete bubble content for marker classes.

typedef Evas_Object*(* Elm_Map_Marker_Get_Func) (Evas_Object *obj, Elm_Map_Marker *marker, void *data)

Bubble content fetching class function for marker classes.

When the user click on a marker, a bubble is displayed with a content.

typedef Evas_Object*(* Elm_Map_Marker_Icon_Get_Func) (Evas_Object *obj, Elm_Map_Marker *marker, void *data)

Icon fetching class function for marker classes.

typedef struct _Elm_Map_Name Elm_Map_Name

A handle for specific coordinates.

typedef void(* Elm_Map_Name_Cb) (void *data, Evas_Object *map, Elm_Map_Name *name)

Async-callback function for the name request.

typedef void(* Elm_Map_Name_List_Cb) (void *data, Evas_Object *map, Eina_List *name_list)

Async-callback function for the name list request.

typedef struct _Elm_Map_Overlay Elm_Map_Overlay

A overlay to be shown in a specific point of the map.

This can be created by elm_map_overlay_add() and similar functions and deleted by elm_map_overlay_del().

typedef void(* Elm_Map_Overlay_Del_Cb) (void *data, Evas_Object *map, Elm_Map_Overlay *overlay)

Det callback function for the overlay.

Since
1.7
typedef void(* Elm_Map_Overlay_Get_Cb) (void *data, Evas_Object *map, Elm_Map_Overlay *overlay)

Get callback function for the overlay.

typedef struct _Elm_Map_Route Elm_Map_Route

A route to be shown in the map.

Can be created with elm_map_route_add() and deleted with elm_map_route_del().

typedef void(* Elm_Map_Route_Cb) (void *data, Evas_Object *map, Elm_Map_Route *route)

Async-callback function for the route request.

Enumeration Type Documentation

Set the name search method.

This is for name module interface.

Set overlay type to be used.

This type is resolved when the overlay is created. You can get this value by elm_map_overlay_type_get().

See also
elm_map_overlay_type_get()
elm_map_overlay_add()
elm_map_overlay_class_add()
elm_map_overlay_bubble_add()

Set the routing method, what should be prioritized, time or distance.

See also
elm_map_route_add()
Enumerator
ELM_MAP_ROUTE_METHOD_FASTEST 

Route should prioritize time.

ELM_MAP_ROUTE_METHOD_SHORTEST 

Route should prioritize distance.

Set type of transport used on route.

See also
elm_map_route_add()
Enumerator
ELM_MAP_ROUTE_TYPE_MOTOCAR 

Route should consider an automobile will be used.

ELM_MAP_ROUTE_TYPE_BICYCLE 

Route should consider a bicycle will be used by the user.

ELM_MAP_ROUTE_TYPE_FOOT 

Route should consider user will be walking.

Set type of a external source (provider).

See also
elm_map_sources_get()
elm_map_source_get()
elm_map_source_set()
Enumerator
ELM_MAP_SOURCE_TYPE_TILE 

Map tile provider.

ELM_MAP_SOURCE_TYPE_ROUTE 

Route service provider.

ELM_MAP_SOURCE_TYPE_NAME 

Name service provider.

Set map's zoom behavior.

It can be set to manual or automatic.

Default value is ELM_MAP_ZOOM_MODE_MANUAL.

Values don't work as bitmask, only one can be chosen.

Note
Valid sizes are 2^zoom, consequently the map may be smaller than the scroller view.
See also
elm_map_zoom_mode_set()
elm_map_zoom_mode_get()
Enumerator
ELM_MAP_ZOOM_MODE_MANUAL 

Zoom controlled manually by elm_map_zoom_set().

It's set by default.

ELM_MAP_ZOOM_MODE_AUTO_FIT 

Zoom until map fits inside the scroll frame with no pixels outside this area.

ELM_MAP_ZOOM_MODE_AUTO_FILL 

Zoom until map fills scroll, ensuring no pixels are left unfilled.

Function Documentation

Evas_Object* elm_map_add ( Evas_Object *  parent)

Add a new map widget to the given parent Elementary (container) object.

Parameters
parentThe parent object.
Returns
a new map widget handle or NULL, on errors.

This function inserts a new map widget on the canvas.

const char* elm_map_name_address_get ( const Elm_Map_Name name)

Get the address of the name.

Parameters
nameThe name handle.
Returns
Returns the address string of name.

This gets the coordinates of the name, created with one of the conversion functions.

See also
elm_map_name_add()
void elm_map_name_del ( Elm_Map_Name name)

Remove a name from the map.

Parameters
nameThe name to remove.

Basically the struct handled by name will be freed, so conversions between address and coordinates will be lost.

See also
elm_map_name_add()
void elm_map_name_region_get ( const Elm_Map_Name name,
double *  lon,
double *  lat 
)

Get the current coordinates of the name.

Parameters
nameThe name handle.
latPointer to store the latitude.
lonPointer to store The longitude.

This gets the coordinates of the name, created with one of the conversion functions.

See also
elm_map_name_add()
void elm_map_overlay_bubble_content_append ( Elm_Map_Overlay bubble,
Evas_Object *  content 
)

Add a content object to the bubble overlay.

Parameters
bubbleThe bubble overlay to add a content.
contentThe content to be added to the bubble overlay.

Added contents will be displayed inside the bubble overlay.

See also
elm_map_overlay_bubble_content_clear()
void elm_map_overlay_bubble_content_clear ( Elm_Map_Overlay bubble)

Clear all contents inside the bubble overlay.

Parameters
bubbleThe bubble overlay to clear the contents.

This will delete all contents inside the bubble overlay.

See also
elm_map_overlay_bubble_content_append()
void elm_map_overlay_bubble_follow ( Elm_Map_Overlay bubble,
const Elm_Map_Overlay parent 
)

Follow a other overlay.

Parameters
bubbleThe bubble overlay to follow a parent overlay.
parentThe parent overlay to be followed by the bubble overlay.

Bubble overlay will follow the parent overlay's movement (hide, show, move).

See also
elm_map_overlay_bubble_add()
void elm_map_overlay_class_append ( Elm_Map_Overlay clas,
Elm_Map_Overlay overlay 
)

Add a new overlay member to the class overlay.

Parameters
clasThe class overlay to add a new overlay.
overlayThe overlay to be added to the class overlay.
See also
elm_map_overlay_class_remove()
void elm_map_overlay_class_remove ( Elm_Map_Overlay clas,
Elm_Map_Overlay overlay 
)

Remove a overlay from the class.

Parameters
clasThe class overlay to delete the overlay.
overlayThe overlay to be deleted from the class overlay.
See also
elm_map_overlay_class_append()

Referenced by elm_map_overlay_del().

int elm_map_overlay_class_zoom_max_get ( const Elm_Map_Overlay clas)

Get the maximum zoom from where the overlay members in the class can be grouped.

Parameters
clasThe overlay class has overlay members.
Returns
The maximum zoom.
See also
elm_map_overlay_class_zoom_max_set()
void elm_map_overlay_class_zoom_max_set ( Elm_Map_Overlay clas,
int  zoom 
)

Set the maximum zoom from where the overlay members in the class can be grouped.

Parameters
clasThe overlay class has overlay members.
zoomThe maximum zoom.

Overlay members in the class only will be grouped when the map is displayed at less than zoom.

See also
elm_map_overlay_class_zoom_max_get()
void elm_map_overlay_color_get ( const Elm_Map_Overlay overlay,
int *  r,
int *  g,
int *  b,
int *  a 
)

Get the object color of the overlay.

Parameters
overlayThe overlay to return color.
rPointer to store the red channel value.
gPointer to store the green channel value.
bPointer to store the blue channel value.
aPointer to store the alpha channel value.
See also
elm_map_overlay_color_set()
void elm_map_overlay_color_set ( Elm_Map_Overlay overlay,
int  r,
int  g,
int  b,
int  a 
)

Set the object color of the overlay.

Parameters
overlayThe overlay to be set color.
rRed channel value, from 0 to 255.
gGreen channel value, from 0 to 255.
bBlue channel value, from 0 to 255.
aAlpha channel value, from 0 to 255.

It uses an additive color model, so each color channel represents how much of each primary colors must to be used. 0 represents absence of this color, so if all of the three are set to 0, the color will be black.

These component values should be integers in the range 0 to 255, (single 8-bit byte).

This sets the color used for the overlay. By default, it is set to solid red (r = 255, g = 0, b = 0, a = 255).

For alpha channel, 0 represents completely transparent, and 255, opaque.

Function supports only ELM_MAP_OVERLAY_TYPE_CLASS, ELM_MAP_OVERLAY_TYPE_DEFAULT and ELM_MAP_OVERLAY_TYPE_ROUTE Elm_Map_Overlay_Type types.

See also
elm_map_overlay_color_get()
const Evas_Object* elm_map_overlay_content_get ( const Elm_Map_Overlay overlay)

Get the content object.

Parameters
overlayThe overlay to return the content.
Returns
Return the evas object if it exists, else NULL.

Only default and class type overlay support this function.

Returned content is what being inside the overlay that being displayed.

Do not modify this object (move, show, hide, del, etc.). You can only resize this.

The content can be set by elm_map_overlay_content_set().

See also
elm_map_overlay_content_set()
void elm_map_overlay_content_set ( Elm_Map_Overlay overlay,
Evas_Object *  obj 
)

Set the content object of the overlay.

Parameters
overlayThe overlay to be set the content.
objThe evas object will be used to display the overlay.

Only default and class type overlay support this function.

The content should be resized or set size hints before set to the overlay. Do not modify this object (move, show, hide, del, etc.), after set. You can only resize this.

This content is what will be inside the overlay that will be displayed. If a content is set, icon and default style layout are no more used before the content is deleted.

If obj is NULL, content inside the overlay is deleted.

See also
elm_map_overlay_content_get()
void* elm_map_overlay_data_get ( const Elm_Map_Overlay overlay)

Get the user data stored on a overlay.

Parameters
overlayThe overlay to return the user data.
Returns
A pointer to data stored using elm_map_overlay_data_set(), or NULL, if none has been set.
See also
elm_map_overlay_data_set()
void elm_map_overlay_data_set ( Elm_Map_Overlay overlay,
void *  data 
)

Set a pointer of user data for a overlay.

Parameters
overlayThe overlay to own the user data.
dataA pointer of user data
See also
elm_map_overlay_data_get()
void elm_map_overlay_del ( Elm_Map_Overlay overlay)

Delete a overlay from the map.

This function can delete all types of overlays.

Parameters
overlayThe overlay to be deleted.
See also
elm_map_overlay_add()
elm_map_overlay_class_add()
elm_map_overlay_bubble_add()

References elm_map_overlay_class_remove().

void elm_map_overlay_del_cb_set ( Elm_Map_Overlay overlay,
Elm_Map_Overlay_Del_Cb  del_cb,
void *  data 
)

Set the del callback function to call when the overlay is deleted.

Parameters
overlayThe overlay to own the del callback function.
del_cbThe callback function.
dataThe user callback data.

If the overlay is deleted, the callback wll be called. The deleted overlay is returned by callback.

You can delete this callback function by setting NULL.

Since
1.7
int elm_map_overlay_displayed_zoom_min_get ( const Elm_Map_Overlay overlay)

Get the minimum zoom from where the overlay is displayed.

Parameters
overlayThe overlay to return the minimum zoom.
Returns
zoom The minimum zoom.
See also
elm_map_overlay_displayed_zoom_min_set()
void elm_map_overlay_displayed_zoom_min_set ( Elm_Map_Overlay overlay,
int  zoom 
)

Set the minimum zoom from where the overlay is displayed.

Parameters
overlayThe overlay to be set the minimum zoom.
zoomThe minimum zoom.

The overlay only will be displayed when the map is displayed at zoom or bigger.

See also
elm_map_overlay_displayed_zoom_min_get()
void elm_map_overlay_get_cb_set ( Elm_Map_Overlay overlay,
Elm_Map_Overlay_Get_Cb  get_cb,
void *  data 
)

Set the get callback function of the overlay.

Parameters
overlayThe overlay to own the get callback function.
get_cbThe callback function.
dataThe user callback data.

If the overlay is clicked, the callback wll be called. The clicked overlay is returned by callback.

You can add callback to the class overlay. If one of the group overlays in this class is clicked, callback will be called and return a virtual group overlays.

You can delete this callback function by setting NULL.

Eina_List* elm_map_overlay_group_members_get ( const Elm_Map_Overlay grp)

Get the overlay members of the group overlay.

Parameters
grpThe group overlay has overlay members.
Returns
The list of group overlay members.

The group overlays are virtual overlays. Those are shown and hidden dynamically. You can add callback to the class overlay. If one of the group overlays in this class is clicked, callback will be called and return a virtual group overlays.

You can change the state (hidden, paused, etc.) or set the content or icon of the group overlays by chaning the state of the class overlay. Do not modifty the group overlay itself.

See also
elm_map_overlay_class_add()
Eina_Bool elm_map_overlay_hide_get ( const Elm_Map_Overlay overlay)

Get a value whether the overlay is hidden or not.

Parameters
overlayThe overlay to return the hidden state.
Returns
EINA_TRUE means the overlay is hidden. EINA_FALSE indicates it is not.

This gets the current hidden state for the overlay.

See also
elm_map_overlay_hide_set()
void elm_map_overlay_hide_set ( Elm_Map_Overlay overlay,
Eina_Bool  hide 
)

Set if the overlay is hidden or not.

Parameters
overlayThe overlay to be hidden.
hideUse EINA_TRUE to hide the overlay or EINA_FALSE to show.
See also
elm_map_overlay_hide_get()
const Evas_Object* elm_map_overlay_icon_get ( const Elm_Map_Overlay overlay)

Get the icon object.

Parameters
overlayThe overlay to return the icon.
Returns
Return the icon object if it exists, else NULL.

Only default and class type overlay support this function.

Returned icon is what being inside the overlay that being displayed.

Do not modify this icon (move, show, hide, resize, del, etc.).

The icon can be set by elm_map_overlay_icon_set().

See also
elm_map_overlay_icon_set()
void elm_map_overlay_icon_set ( Elm_Map_Overlay overlay,
Evas_Object *  icon 
)

Set a icon of the overlay.

Parameters
overlayThe overlay to be set the icon.
iconThe icon will be used to display the overlay.

Only default and class type overlay support this function.

Do not modify this object (move, show, hide, resize, del, etc.), after set.

If icon is set, default style layout will not be used.

If icon is NULL, icon inside the overlay will be deleted.

See also
elm_map_overlay_icon_get()
Eina_Bool elm_map_overlay_paused_get ( const Elm_Map_Overlay overlay)

Get a value whether the overlay is paused or not.

Parameters
overlayThe overlay to return paused state.
Returns
EINA_TRUE means overlay is paused. EINA_FALSE indicates it is not.

This gets the current paused state for the overlay.

See also
elm_map_overlay_paused_set()
void elm_map_overlay_paused_set ( Elm_Map_Overlay overlay,
Eina_Bool  paused 
)

Pause or unpause the overlay.

Parameters
overlayThe overlay to be paused.
pausedUse EINA_TRUE to pause the overlay or EINA_FALSE to unpause it.

This sets the paused state to on (EINA_TRUE) or off (EINA_FALSE) for the overlay.

The default is off.

This will stop moving the overlay coordinates instantly. even if map being scrolled or zoomed.

See also
elm_map_overlay_paused_get()
void elm_map_overlay_polygon_region_add ( Elm_Map_Overlay overlay,
double  lon,
double  lat 
)

Add a geographic coordinates to the polygon overlay.

Parameters
overlayThe polygon overlay to get a region.
lonThe longitude.
latThe latitude.

At least 3 regions should be added to show the polygon overlay.

Overlay created with this method can be deleted with elm_map_overlay_del().

See also
elm_map_overlay_polygon_add()
elm_map_overlay_del()
void elm_map_overlay_region_get ( const Elm_Map_Overlay overlay,
double *  lon,
double *  lat 
)

Get the geographic coordinates of the overlay.

Parameters
overlayThe overlay to return geographic coordinates.
lonPointer to store longitude.
latPointer to store latitude.

Only default and bubble type overlay support this function.

This returns the center coordinates of the overlay. It can be set by elm_map_overlay_region_set().

See also
elm_map_overlay_region_set()
void elm_map_overlay_region_set ( Elm_Map_Overlay overlay,
double  lon,
double  lat 
)

Set the geographic coordinates of the overlay.

Parameters
overlayThe overlay to be set geographic coordinates.
lonLongitude to be set.
latLatitude to be set.

Only default and bubble type overlay support this function.

This sets the center coordinates of the overlay. It can be get by elm_map_overlay_region_get().

See also
elm_map_overlay_region_get()
void elm_map_overlay_show ( Elm_Map_Overlay overlay)

Show the given overlay at the center of the map, immediately.

Parameters
overlayThe overlay to be center at.

This causes map to redraw its viewport's contents to the region containing the given overlay's coordinates, that will be moved to the center of the map.

See also
elm_map_overlays_show() if more than one overlay need to be displayed.
Elm_Map_Overlay_Type elm_map_overlay_type_get ( const Elm_Map_Overlay overlay)

Get the overlay type.

Parameters
overlayThe overlay to return type.
Returns
Return the overlay type.

This type is resolved when the overlay is created.

See also
elm_map_overlay_add()
elm_map_overlay_class_add()
elm_map_overlay_bubble_add()
Eina_Bool elm_map_overlay_visible_get ( const Elm_Map_Overlay overlay)

Get a value whether the overlay is visible or not.

Parameters
overlayThe overlay to return visible state.
Returns
EINA_TRUE means overlay is visible. EINA_FALSE indicates it is not.

The visible of the overlay can not be set. This value can be changed dynamically while zooming and panning

Since
1.7
void elm_map_overlays_show ( Eina_List *  overlays)

Move and zoom the map to display a list of overlays.

Parameters
overlaysA list of Elm_Map_Overlay handles.

The map will be centered on the center point of the overlays in the list. Then the map will be zoomed in order to fit the overlays using the maximum zoom which allows display of all the overlays.

Warning
All the overlays should belong to the same map object.
See also
elm_map_overlay_show() to show a single overlay.
void elm_map_route_del ( Elm_Map_Route route)

Remove a route from the map.

Parameters
routeThe route to remove.
See also
elm_map_route_add()
double elm_map_route_distance_get ( const Elm_Map_Route route)

Get the route distance in kilometers.

Parameters
routeThe route object.
Returns
The distance of route (unit : km).
const char* elm_map_route_node_get ( const Elm_Map_Route route)

Get the information of route nodes.

Parameters
routeThe route object.
Returns
Returns a string with the nodes of route.
const char* elm_map_route_waypoint_get ( const Elm_Map_Route route)

Get the information of route waypoint.

Parameters
routethe route object.
Returns
Returns a string with information about waypoint of route.