summaryrefslogtreecommitdiff
path: root/src/lib/elm_naviframe_item.eo
blob: 6b0fec5ca9ca1652e709971e0dce86cd36403afb (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
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
class Elm_Naviframe_Item(Elm_Widget_Item)
{
   legacy_prefix: null;
   eo_prefix: elm_obj_naviframe_item;
   properties {
        style {
             get {
                 /*@
                  Get an item style

                  @see also elm_naviframe_item_style_set()

                  @ingroup Naviframe
                  */
             }
             set {
                 /*@
                  Set an item style

                  The following styles are available for this item:
                  @li @c "default"

                  @see also elm_naviframe_item_style_get()

                  @ingroup Naviframe
                 */
             }
             values {
                 const char *style; /*@ The current item style name. @c NULL would be default */
             }
        }
   }
   methods {
      pop_to {
            /*@
             Pop the items between the top and the above one on the given item.

             The items between the top and the given item will be deleted first,
             and then the top item will be popped at last.

             @ingroup Naviframe
            */
        }
      title_enabled_get {
            /*@
             Get a value whether title area is enabled or not.

             @see also elm_naviframe_item_title_enabled_set()

             @ingroup Naviframe
            */
            return Eina_Bool; /*@ If @c EINA_TRUE, title area will be enabled, disabled otherwise */
        }
      title_enabled_set {
            /*@
             Enable/Disable the title area with transition effect

             When the title area is disabled, then the controls would be hidden so as
             to expand the content area to full-size.

             @see also elm_naviframe_item_title_enabled_get()
             @see also elm_naviframe_item_title_visible_set()

             @ingroup Naviframe
            */
            params {
                @in Eina_Bool enable; /*@ If @c EINA_TRUE, title area will be enabled, disabled otherwise */
                @in Eina_Bool transition; /*@ If @c EINA_TRUE, transition effect of the title will be visible, invisible otherwise */
             }
        }
      promote {
            /*@
             Promote an item already in the naviframe stack to the top of the stack

             This will take the indicated item and promote it to the top of the stack
             as if it had been pushed there. The item must already be inside the
             naviframe stack to work.
             */
        }

      pop_cb_set {
            /*@
             Set a function to be called when @c it of the naviframe is going to be
             popped.

             @param func the callback function.

             @warning Don't set "clicked" callback to the prev button additionally if the
             function does an exact same logic with this @c func. When hardware back key
             is pressed then both callbacks will be called.

             @since 1.8
             @ingroup Naviframe
             */
             params {
                  @in Elm_Naviframe_Item_Pop_Cb func; /*@ The callback function */
                  @in void *data; /*@ Data to be passed to func */
             }
        }
   }
   implements {
        Eo_Base::constructor;
        Elm_Widget_Item::del_pre;
        Elm_Widget_Item::signal_emit;
        Elm_Widget_Item::part_text::set;
        Elm_Widget_Item::part_text::get;
        Elm_Widget_Item::part_content::get;
        Elm_Widget_Item::part_content::set;
        Elm_Widget_Item::part_content_unset;
   }
}