aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/elementary/elm_popup.eo
blob: 9d4aa06d38929ca23984d41aafe535d87133edbf (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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
import elm_general;

enum Elm.Popup.Orient
{
   [[Possible orient values for popup.

     These values should be used in conjunction to elm_popup_orient_set() to
     set the position in which the popup should appear(relative to its parent)
     and in conjunction with elm_popup_orient_get() to know where the popup
     is appearing.
   ]]

   top = 0, [[Popup should appear in the top of parent, default.]]
   center, [[Popup should appear in the center of parent.]]
   bottom, [[Popup should appear in the bottom of parent.]]
   left, [[Popup should appear in the left of parent.]]
   right, [[Popup should appear in the right of parent.]]
   top_left, [[Popup should appear in the top left of parent.]]
   top_right, [[Popup should appear in the top right of parent.]]
   bottom_left, [[Popup should appear in the bottom left of parent.]]
   bottom_right, [[Notify should appear in the bottom right of parent.]]
   last [[Sentinel value, don't use.]]
}


class Elm.Popup (Elm.Layout, Elm.Interface.Atspi_Widget_Action)
{
   legacy_prefix: elm_popup;
   eo_prefix: elm_obj_popup;
   event_prefix: elm_popup;
   methods {
      @property align {
         set {
            [[Set the alignment of the popup object.

              Sets the alignment in which the popup will appear in its parent.

              @since 1.9
            ]]
         }
         get {
            [[Get the alignment of the popup object.

              @since 1.9
            ]]
         }
         values {
            horizontal: double; [[The horizontal alignment of the popup.]]
            vertical: double; [[The vertical alignment of the popup.]]
         }
      }
      @property allow_events {
         set {
            [[Sets whether events should be passed to by a click outside.

              Enabling allow event will remove the Blocked event area and
              events will pass to the lower layer objects otherwise they
              are blocked.

              Note: The default value is $false.
            ]]
         }
         get {
            [[Returns value indicating whether allow event is enabled or not.]]
         }
         values {
            allow: bool; [[If $true, events are passed to lower objects.]]
         }
      }
      @property content_text_wrap_type {
         [[Control the wrapping type of content text packed in content
            area of popup object.
         ]]
         set {}
         get {}
         values {
            wrap: Elm.Wrap.Type; [[Wrapping type of type Elm_Wrap_Type.]]
         }
      }
      @property orient {
         set {
            [[Sets the orientation of the popup in the parent region.

              Sets the position in which popup will appear in its parent.
              By default, #ELM_POPUP_ORIENT_CENTER is set.
            ]]
         }
         get {
            [[Returns the orientation of the popup.]]
         }
         values {
            orient: Elm.Popup.Orient; [[The orientation of the popup.]]
         }
      }
      @property timeout {
         set {
            [[Sets a timeout to hide popup automatically

              This function sets a timeout and starts the timer controlling
              when the popup is hidden. Since calling \@ref evas_object_show
              on a popup restarts the timer controlling when it is hidden,
              setting this before the  popup is shown will in effect mean
              starting the timer when the popup is shown. Smart signal
              "timeout" is called afterwards which can be handled
              if needed.

              Note: Set a value <= 0.0 to disable a running timer.

              Note: If the value > 0.0 and the popup is previously visible,
              the timer will be started with this value, canceling any
              running timer.
            ]]
         }
         get {
            [[Returns the timeout value set to the popup (in seconds).]]
         }
         values {
            timeout: double; [[The timeout in seconds.]]
         }
      }
      @property scrollable {
         set {
            [[Enable or disable scroller in popup content area

              Normally content area does not contain scroller.

              @since 1.15.1
            ]]
         }
         get {
            [[Get the scrollable state of popup content area

              Normally content area does not contain scroller.

              @since 1.15.1
            ]]
         }
         values {
            scroll: bool; [[$true if it is to be scrollable, $false otherwise.]]
         }
      }
      item_append {
         [[Add a new item to a Popup object

           Both an item list and a content could not be set at the same time!
           once you add an item, the previous content will be removed.

           Warning: When the first item is appended to popup object, any
           previous content of the content area is deleted. At a time,
           only one of content, content-text and item(s) can be there
           in a popup content area.
         ]]
         return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]]
         params {
            @in label: string; [[The Label of the new item.]]
            @in icon: Evas.Object @optional; [[Icon to be set on new item.]]
            @in func: Evas_Smart_Cb @optional; [[Convenience function called when item selected.]]
            @in data: const(void_ptr) @optional; [[Data passed to $func above.]]
         }
      }
      dismiss {
         [[Dismiss a Popup object.
           @since 1.17
         ]]
      }
   }
   implements {
      class.constructor;
      Eo.Base.constructor;
      Efl.Canvas.Group.group_del;
      Efl.Canvas.Group.group_add;
      Elm.Widget.focus_direction;
      Elm.Widget.focus_next_manager_is;
      Elm.Widget.theme_apply;
      Elm.Widget.focus_direction_manager_is;
      Elm.Widget.access;
      Elm.Widget.focus_next;
      Elm.Widget.widget_parent.set;
      Elm.Widget.translate;
      Elm.Widget.sub_object_del;
      Elm.Widget.event;
      Elm.Layout.text.set;
      Elm.Layout.text.get;
      Elm.Layout.sizing_eval;
      Elm.Layout.signal_emit;
      Elm.Interface.Atspi_Widget_Action.elm_actions.get;
      Elm.Interface.Atspi_Accessible.state_set.get;
      Efl.Part.part;
   }
   events {
      block,clicked;
      timeout;
      item,focused;
      item,unfocused;
      dismissed;
   }

}