Elementary migration revision 69026
[framework/uifw/elementary.git] / src / lib / elm_route.h
1 /**
2  * @defgroup Route Route
3  *
4  * For displaying a route on the map widget.
5  *
6  * @{
7  */
8
9 /**
10  * Add a new route object to the parent's canvas
11  *
12  * @param parent The parent object
13  * @return The new object or NULL if it cannot be created
14  *
15  */
16 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
17
18 #ifdef ELM_EMAP
19 EAPI void         elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
20 #endif
21
22
23 EINA_DEPRECATED EAPI double       elm_route_lon_min_get(Evas_Object *obj);
24 EINA_DEPRECATED EAPI double       elm_route_lat_min_get(Evas_Object *obj);
25 EINA_DEPRECATED EAPI double       elm_route_lon_max_get(Evas_Object *obj);
26 EINA_DEPRECATED EAPI double       elm_route_lat_max_get(Evas_Object *obj);
27
28 /**
29  * Get the minimum and maximum values along the longitude.
30  *
31  * @param obj The route object.
32  * @param min Pointer to store the minimum value.
33  * @param max Pointer to store the maximum value.
34  *
35  * @note If only one value is needed, the other pointer can be passed
36  * as @c NULL.
37  *
38  * @ingroup Route
39  */
40 EAPI void        elm_route_longitude_min_max_get(const Evas_Object *obj, double *min, double *max);
41
42 /**
43  * Get the minimum and maximum values along the latitude.
44  *
45  * @param obj The route object.
46  * @param min Pointer to store the minimum value.
47  * @param max Pointer to store the maximum value.
48  *
49  * @note If only one value is needed, the other pointer can be passed
50  * as @c NULL.
51  *
52  * @ingroup Route
53  */
54 EAPI void        elm_route_latitude_min_max_get(const Evas_Object *obj, double *min, double *max);