summaryrefslogtreecommitdiff
path: root/src/lib/elementary/efl_ui_widget_common.h
blob: 0e538cbed55d350cf091053eb4445ae125a9d982 (plain) (blame)
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
#ifndef EFL_UI_WIDGET_COMMON_H
#define EFL_UI_WIDGET_COMMON_H

/**
 * @brief Get an iterator over all subelements located at obj.
 *
 * This iterator contains also the canvas objects which are part of the widgets,
 * be aware that the construction of this tree is internal and might change heavily
 * inbetween versions.
 *
 * @param obj The widget which is the root of the subtree.
 *
 * @return A iterator that contains subelement widgets and canvas objects of the root widget. Every contained object is a Efl.Gfx.Entity.
 */
EAPI Eina_Iterator* efl_ui_widget_tree_iterator(Efl_Ui_Widget *obj);

/**
 * @brief Get an iterator over all subelements located at obj.
 *
 * @param obj The widget which is the root of the subtree.
 *
 * @return A iterator that contains subelement widgets of the root widget. Every contained object is a Efl.Ui.Widget.
 */
EAPI Eina_Iterator* efl_ui_widget_tree_widget_iterator(Efl_Ui_Widget *obj);

/**
 * @brief Get an iterator that contains all parents of the passed object.
 *
 * @param obj The object to fetch the parents from.
 *
 * @return A iterator that contains all parents of the object. Every contained object is a Efl.Ui.Widget.
 */
EAPI Eina_Iterator* efl_ui_widget_parent_iterator(Efl_Ui_Widget *obj);

#endif