summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 14:24:37 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 14:24:45 +0100
commitc026c7aafe7ed2a8cb538cdd4a65b385be670ea1 (patch)
treeca99e4c7964e112a199d92c3f0061fd4d1dcc20e
parent6dfee8b0772abab4e522907ec0d90fa859b8daa3 (diff)
popup: convert docs
-rw-r--r--src/lib/elm_popup.eo155
1 files changed, 56 insertions, 99 deletions
diff --git a/src/lib/elm_popup.eo b/src/lib/elm_popup.eo
index df866e124..9ce41e5a0 100644
--- a/src/lib/elm_popup.eo
+++ b/src/lib/elm_popup.eo
@@ -29,153 +29,110 @@ class Elm.Popup (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
29 methods { 29 methods {
30 @property align { 30 @property align {
31 set { 31 set {
32 /*@ 32 [[Set the alignment of the popup object.
33 @brief Set the alignment of the popup object
34 Sets the alignment in which the popup will appear in its parent.
35 33
36 @see elm_popup_align_get() 34 Sets the alignment in which the popup will appear in its parent.
37 35
38 @since 1.9 36 @since 1.9
39 @ingroup Popup */ 37 ]]
40 } 38 }
41 get { 39 get {
42 /*@ 40 [[Get the alignment of the popup object.
43 @brief Get the alignment of the popup object
44 @see elm_popup_align_set()
45 41
46 @since 1.9 42 @since 1.9
47 @ingroup Popup */ 43 ]]
48 } 44 }
49 values { 45 values {
50 horizontal: double; /*@ The horizontal alignment of the popup */ 46 horizontal: double; [[The horizontal alignment of the popup.]]
51 vertical: double; /*@ The vertical alignment of the popup */ 47 vertical: double; [[The vertical alignment of the popup.]]
52 } 48 }
53 } 49 }
54 @property allow_events { 50 @property allow_events {
55 set { 51 set {
56 /*@ 52 [[Sets whether events should be passed to by a click outside.
57 @brief Sets whether events should be passed to by a click outside.
58 53
59 Enabling allow event will remove the Blocked event area and events will 54 Enabling allow event will remove the Blocked event area and
60 pass to the lower layer objects otherwise they are blocked. 55 events will pass to the lower layer objects otherwise they
56 are blocked.
61 57
62 @ingroup Popup 58 Note: The default value is $false.
63 @see elm_popup_allow_events_get() 59 ]]
64 @note The default value is false. */
65 } 60 }
66 get { 61 get {
67 /*@ 62 [[Returns value indicating whether allow event is enabled or not.]]
68 @brief Returns value indicating whether allow event is enabled or not
69
70 @return $false if Blocked event area is present else $true
71
72 @ingroup Popup
73 @see elm_popup_allow_events_set()
74 @note By default the Blocked event area is present */
75 } 63 }
76 values { 64 values {
77 allow: bool; /*@ $true Events are passed to lower objects, else not */ 65 allow: bool; [[If $true, events are passed to lower objects.]]
78 } 66 }
79 } 67 }
80 @property content_text_wrap_type { 68 @property content_text_wrap_type {
81 set { 69 [[Control the wrapping type of content text packed in content
82 /*@
83 @brief Sets the wrapping type of content text packed in content
84 area of popup object. 70 area of popup object.
85 71 ]]
86 @ingroup Popup 72 set {}
87 @see elm_popup_content_text_wrap_type_get() */ 73 get {}
88 }
89 get {
90 /*@
91 @brief Returns the wrapping type of content text packed in content area of
92 popup object.
93
94 @return wrap type of the content text
95
96 @ingroup Popup
97 @see elm_popup_content_text_wrap_type_set */
98 }
99 values { 74 values {
100 wrap: Elm.Wrap.Type; /*@ wrapping type of type Elm_Wrap_Type */ 75 wrap: Elm.Wrap.Type; [[Wrapping type of type Elm_Wrap_Type.]]
101 } 76 }
102 } 77 }
103 @property orient { 78 @property orient {
104 set { 79 set {
105 /*@ 80 [[Sets the orientation of the popup in the parent region.
106 @brief Sets the orientation of the popup in the parent region
107
108 Sets the position in which popup will appear in its parent. By default,
109 #ELM_POPUP_ORIENT_CENTER is set.
110 81
111 @ingroup Popup 82 Sets the position in which popup will appear in its parent.
112 @see @ref Elm_Popup_Orient for possible values. */ 83 By default, #ELM_POPUP_ORIENT_CENTER is set.
84 ]]
113 } 85 }
114 get { 86 get {
115 /*@ 87 [[Returns the orientation of the popup.]]
116 @brief Returns the orientation of Popup
117
118 @return the orientation of the popup
119
120 @ingroup Popup
121 @see elm_popup_orient_set()
122 @see Elm_Popup_Orient */
123 } 88 }
124 values { 89 values {
125 orient: Elm.Popup.Orient; /*@ the orientation of the popup */ 90 orient: Elm.Popup.Orient; [[The orientation of the popup.]]
126 } 91 }
127 } 92 }
128 @property timeout { 93 @property timeout {
129 set { 94 set {
130 /*@ 95 [[Sets a timeout to hide popup automatically
131 @brief Sets a timeout to hide popup automatically
132 96
133 This function sets a timeout and starts the timer controlling when the 97 This function sets a timeout and starts the timer controlling
134 popup is hidden. Since calling evas_object_show() on a popup restarts 98 when the popup is hidden. Since calling \@ref evas_object_show
135 the timer controlling when it is hidden, setting this before the 99 on a popup restarts the timer controlling when it is hidden,
136 popup is shown will in effect mean starting the timer when the popup is 100 setting this before the popup is shown will in effect mean
137 shown. Smart signal "timeout" is called afterwards which can be handled 101 starting the timer when the popup is shown. Smart signal
138 if needed. 102 "timeout" is called afterwards which can be handled
103 if needed.
139 104
140 @note Set a value <= 0.0 to disable a running timer. 105 Note: Set a value <= 0.0 to disable a running timer.
141 106
142 @note If the value > 0.0 and the popup is previously visible, the 107 Note: If the value > 0.0 and the popup is previously visible,
143 timer will be started with this value, canceling any running timer. 108 the timer will be started with this value, canceling any
144 @ingroup Popup */ 109 running timer.
110 ]]
145 } 111 }
146 get { 112 get {
147 /*@ 113 [[Returns the timeout value set to the popup (in seconds).]]
148 @brief Returns the timeout value set to the popup (in seconds)
149
150 @return the timeout value
151
152 @ingroup Popup
153 @see elm_popup_timeout_set() */
154 } 114 }
155 values { 115 values {
156 timeout: double; /*@ The timeout in seconds */ 116 timeout: double; [[The timeout in seconds.]]
157 } 117 }
158 } 118 }
159 item_append { 119 item_append {
160 /*@ 120 [[Add a new item to a Popup object
161 @brief Add a new item to a Popup object
162
163 Both an item list and a content could not be set at the same time!
164 once you add an item, the previous content will be removed.
165
166 @return A handle to the item added or $NULL, on errors
167 121
168 @ingroup Popup 122 Both an item list and a content could not be set at the same time!
169 @warning When the first item is appended to popup object, any previous content 123 once you add an item, the previous content will be removed.
170 of the content area is deleted. At a time, only one of content, content-text
171 and item(s) can be there in a popup content area. */
172 124
173 return: Elm.Widget_Item *; 125 Warning: When the first item is appended to popup object, any
126 previous content of the content area is deleted. At a time,
127 only one of content, content-text and item(s) can be there
128 in a popup content area.
129 ]]
130 return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
174 params { 131 params {
175 @in label: const(char)*; /*@ The Label of the new item */ 132 @in label: const(char)*; [[The Label of the new item.]]
176 @in icon: Evas.Object * @optional; /*@ Icon to be set on new item */ 133 @in icon: Evas.Object * @optional; [[Icon to be set on new item.]]
177 @in func: Evas_Smart_Cb @optional; /*@ Convenience function called when item selected */ 134 @in func: Evas_Smart_Cb @optional; [[Convenience function called when item selected.]]
178 @in data: const(void)* @optional; /*@ Data passed to $func above */ 135 @in data: const(void)* @optional; [[Data passed to $func above.]]
179 } 136 }
180 } 137 }
181 } 138 }