EFL migration revision 67547
[framework/uifw/elementary.git] / tests / debian / libelm-dev / usr / include / elementary-0 / elm_searchbar.h
1    /**
2     * @defgroup Searchbar Searchbar
3     * @addtogroup Searchbar
4     * @{
5     * @ingroup Elementary
6     *
7     * This is Searchbar.
8     * It can contain a simple entry and button object.
9     */
10
11    /**
12     * Add a new searchbar to the parent
13     * @param parent The parent object
14     * @return The new object or NULL if it cannot be created
15     */
16    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
17    /**
18     * set the text of entry
19     *
20     * @param obj The searchbar object
21     * @return void
22     */
23    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
24    /**
25     * get the text of entry
26     *
27     * @param obj The searchbar object
28     * @return string pointer of entry
29     */
30    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
31    /**
32     * get the pointer of entry
33     *
34     * @param obj The searchbar object
35     * @return the entry object
36     */
37    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
38    /**
39     * get the pointer of editfield
40     *
41     * @param obj The searchbar object
42     * @return the editfield object
43     */
44    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
45    /**
46     * set the cancel button animation flag
47     *
48     * @param obj The searchbar object
49     * @param cancel_btn_ani_flag The flag of animating cancen button or not
50     * @return void
51     */
52    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
53    /**
54     * set the cancel button show mode
55     *
56     * @param obj The searchbar object
57     * @param visible The flag of cancen button show or not
58     * @return void
59     */
60    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
61    /**
62     * clear searchbar status
63     *
64     * @param obj The searchbar object
65     * @return void
66     */
67    EAPI void         elm_searchbar_clear(Evas_Object *obj);
68    /**
69     * set the searchbar boundary rect mode(with bg rect) set
70     *
71     * @param obj The searchbar object
72     * @param boundary The present flag of boundary rect or not
73     * @return void
74     */
75    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
76    /**
77     * @}
78     */
79