Elm: second doc patch
[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  * Get the minimum and maximum values along the longitude.
24  *
25  * @param obj The route object.
26  * @param min Pointer to store the minimum value.
27  * @param max Pointer to store the maximum value.
28  *
29  * @note If only one value is needed, the other pointer can be passed
30  * as @c NULL.
31  *
32  * @ingroup Route
33  */
34 EAPI void        elm_route_longitude_min_max_get(const Evas_Object *obj, double *min, double *max);
35
36 /**
37  * Get the minimum and maximum values along the latitude.
38  *
39  * @param obj The route object.
40  * @param min Pointer to store the minimum value.
41  * @param max Pointer to store the maximum value.
42  *
43  * @note If only one value is needed, the other pointer can be passed
44  * as @c NULL.
45  *
46  * @ingroup Route
47  */
48 EAPI void        elm_route_latitude_min_max_get(const Evas_Object *obj, double *min, double *max);
49
50 /**
51  * @}
52  */