aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/elementary/elm_naviframe.eo
blob: 039cb0320bbb977d1ea78e57fe4cf3d0248c9169 (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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
class Elm.Naviframe (Efl.Ui.Layout, Efl.Access.Widget.Action, Efl.Ui.Legacy)
{
   [[Elementary naviframe class]]
   legacy_prefix: elm_naviframe;
   eo_prefix: elm_obj_naviframe;
   event_prefix: elm_naviframe;
   methods {
      @property event_enabled {
         [[Control the event enabled when pushing/popping items

           If $enabled is $true, the contents of the naviframe item will
           receives events from mouse and keyboard during view changing such as
           item push/pop.

           Warning: Events will be blocked by calling evas_object_freeze_events_set()
           internally. So don't call the API whiling pushing/popping items.]]
         set {
         }
         get {
         }
         values {
            enabled: bool; [[Events are received when enabled is $true, and ignored otherwise.]]
         }
      }
      @property content_preserve_on_pop {
         [[Preserve the content objects when items are popped.]]
         set {
         }
         get {
         }
         values {
            preserve: bool; [[Enable the preserve mode if $true, disable otherwise]]
         }
      }
      @property prev_btn_auto_pushed {
         [[Control if creating prev button automatically or not]]
         set {
         }
         get {
         }
         values {
            auto_pushed: bool; [[If $true, the previous button(back button) will be created internally when you pass the $NULL to the prev_btn parameter in elm_naviframe_item_push]]
         }
      }
      @property items {
         get {
            [[Get a list of all the naviframe items.]]

            return: list<Elm.Widget.Item> @owned @warn_unused; [[A list of naviframe items, @Elm.Widget.Item, or $NULL on failure. Note: The returned list MUST be freed.]]
         }
      }
      @property top_item {
         get {
            [[Get a top item on the naviframe stack]]

            return: Elm.Widget.Item; [[The top item on the naviframe stack or $NULL, if the stack is empty]]
         }
      }
      @property bottom_item {
         get {
            [[Get a bottom item on the naviframe stack]]

            return: Elm.Widget.Item; [[The bottom item on the naviframe stack or $NULL, if the stack is empty]]
         }
      }
      item_pop {
         [[Pop an item that is on top of the stack

           This pops an item that is on the top(visible) of the naviframe, makes it
           disappear, then deletes the item. The item that was underneath it on the
           stack will become visible.

           When pop transition animation is in progress, new pop operation is blocked until current pop operation
           is complete.
          ]]

         return: Efl.Canvas.Object; [[$NULL or the content object(if the elm_naviframe_content_preserve_on_pop_get is true).]]
      }
      item_insert_before {
         [[Insert a new item into the naviframe before item $before.

           The item is inserted into the naviframe straight away without any
           transition operations. This item will be deleted when it is popped.]]

         return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
         params {
            @in before: Elm.Widget.Item; [[The naviframe item to insert before.]]
            @in title_label: string @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
            @in prev_btn: Efl.Canvas.Object @nullable; [[The button to go to the previous item. If it is NULL, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn"]]
            @in next_btn: Efl.Canvas.Object @nullable; [[The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn"]]
            @in content: Efl.Canvas.Object; [[The main content object. The name of content part is "elm.swallow.content"]]
            @in item_style: string @nullable; [[The current item style name. $NULL would be default.]]
         }
      }
      item_push {
         [[Push a new item to the top of the naviframe stack (and show it).


           The item pushed becomes one page of the naviframe, this item will be
           deleted when it is popped.

           When push transition animation is in progress, pop operation is blocked until push is complete.

           The following styles are available for this item:
           "default"]]

         return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
         params {
            @in title_label: string @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
            @in prev_btn: Efl.Canvas.Object @nullable; [[The button to go to the previous item. If it is NULL, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn"]]
            @in next_btn: Efl.Canvas.Object @nullable; [[The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn"]]
            @in content: Efl.Canvas.Object; [[The main content object. The name of content part is "elm.swallow.content"]]
            @in item_style: string @nullable; [[The current item style name. $NULL would be default.]]
         }
      }
      item_simple_promote {
         [[Simple version of item_promote.]]

         params {
            @in content: Efl.Canvas.Object; [[Item to promote]]
         }
      }
      item_insert_after {
         [[Insert a new item into the naviframe after item $after.

           The item is inserted into the naviframe straight away without any
           transition operations. This item will be deleted when it is popped.

           The following styles are available for this item:
           "default"]]

         return: Elm.Widget.Item; [[The created item or $NULL upon failure.]]
         params {
            @in after: Elm.Widget.Item; [[The naviframe item to insert after.]]
            @in title_label: string @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
            @in prev_btn: Efl.Canvas.Object @nullable; [[The button to go to the previous item. If it is NULL, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn"]]
            @in next_btn: Efl.Canvas.Object @nullable; [[The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn"]]
            @in content: Efl.Canvas.Object; [[The main content object. The name of content part is "elm.swallow.content"]]
            @in item_style: string @nullable; [[The current item style name. $NULL would be default.]]
         }
      }
   }
   implements {
      class.constructor;
      Efl.Object.constructor;
      Efl.Gfx.Entity.visible { set; }
      Efl.Ui.Widget.on_access_update;
      Efl.Ui.Translatable.translation_update;
      Efl.Ui.Widget.theme_apply;
      Efl.Ui.Widget.widget_event;
      Efl.Layout.Signal.signal_emit;
      Efl.Access.Widget.Action.elm_actions { get; }
      Efl.Ui.Widget.resize_object { set; }
      Efl.Part.part_get;
   }
   events {
      transition,finished: Efl.Object; [[Called when naviframe transition finished]]
      title,transition,finished: Efl.Object; [[Called when naviframe title transaction finished]]
      title,clicked: Efl.Object; [[Called when naviframe title was clicked]]
      item,activated: Efl.Object; [[Called when naviframe item was activated]]
   }
}