summaryrefslogtreecommitdiff
path: root/src/lib/elm_route.h
blob: e5e0454557f5487ea17c257cf1cd9fc539341e3d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/**
 * @internal
 * @defgroup Route Route
 * @ingroup Elementary
 *
 * @image html route_inheritance_tree.png
 * @image latex route_inheritance_tree.eps
 *
 * @brief For displaying a route on the map widget.
 *
 * @{
 */

/**
 * @internal
 *
 * @brief Adds a new route object to the parent's canvas.
 *
 * @param parent The parent object
 * @return The new object, otherwise @c NULL if it cannot be created
 *
 * @ingroup Route
 */
EAPI Evas_Object *elm_route_add(Evas_Object *parent);

#ifdef ELM_EMAP
EAPI void         elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
#endif

/**
 * @internal
 *
 * @brief Gets the minimum and maximum values along the longitude.
 *
 * @remarks If only one value is needed, the other pointer can be passed
 *          as @c NULL.
 *
 * @param obj The route object
 * @param min A pointer to store the minimum value
 * @param max A pointer to store the maximum value
 *
 * @ingroup Route
 */
EAPI void        elm_route_longitude_min_max_get(const Evas_Object *obj, double *min, double *max);

/**
 * @internal
 *
 * @brief Gets the minimum and maximum values along the latitude.
 *
 * @remarks If only one value is needed, the other pointer can be passed
 *          as @c NULL.
 *
 * @param obj The route object
 * @param min A pointer to store the minimum value
 * @param max A pointer to store the maximum value
 *
 * @ingroup Route
 */
EAPI void        elm_route_latitude_min_max_get(const Evas_Object *obj, double *min, double *max);

/**
 * @}
 */