2 * @defgroup Scrollhints Scrollhints
5 * Objects when inside a scroller can scroll, but this may not always be
6 * desirable in certain situations. This allows an object to hint to itself
7 * and parents to "not scroll" in one of 2 ways. If any child object of a
8 * scroller has pushed a scroll freeze or hold then it affects all parent
9 * scrollers until all children have released them.
11 * 1. To hold on scrolling. This means just flicking and dragging may no
12 * longer scroll, but pressing/dragging near an edge of the scroller will
13 * still scroll. This is automatically used by the entry object when
16 * 2. To totally freeze scrolling. This means it stops. until
23 * Push the scroll hold by 1
25 * This increments the scroll hold count by one. If it is more than 0 it will
26 * take effect on the parents of the indicated object.
28 * @param obj The object
29 * @ingroup Scrollhints
31 EAPI void elm_object_scroll_hold_push(Evas_Object *obj);
34 * Pop the scroll hold by 1
36 * This decrements the scroll hold count by one. If it is more than 0 it will
37 * take effect on the parents of the indicated object.
39 * @param obj The object
40 * @ingroup Scrollhints
42 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj);
45 * Push the scroll freeze by 1
47 * This increments the scroll freeze count by one. If it is more
48 * than 0 it will take effect on the parents of the indicated
51 * @param obj The object
52 * @ingroup Scrollhints
54 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj);
57 * Pop the scroll freeze by 1
59 * This decrements the scroll freeze count by one. If it is more
60 * than 0 it will take effect on the parents of the indicated
63 * @param obj The object
64 * @ingroup Scrollhints
66 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj);
69 * Lock the scrolling of the given widget (and thus all parents)
71 * This locks the given object from scrolling in the X axis (and implicitly
72 * also locks all parent scrollers too from doing the same).
74 * @param obj The object
75 * @param lock The lock state (1 == locked, 0 == unlocked)
76 * @ingroup Scrollhints
78 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock);
81 * Lock the scrolling of the given widget (and thus all parents)
83 * This locks the given object from scrolling in the Y axis (and implicitly
84 * also locks all parent scrollers too from doing the same).
86 * @param obj The object
87 * @param lock The lock state (1 == locked, 0 == unlocked)
88 * @ingroup Scrollhints
90 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock);
93 * Get the scrolling lock of the given widget
95 * This gets the lock for X axis scrolling.
97 * @param obj The object
98 * @ingroup Scrollhints
100 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj);
103 * Get the scrolling lock of the given widget
105 * This gets the lock for Y axis scrolling.
107 * @param obj The object
108 * @ingroup Scrollhints
110 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj);