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