summaryrefslogtreecommitdiff
path: root/legacy/elementary/src/lib/elm_panes.eo
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-07-31 16:16:13 +0100
committerTom Hacohen <tom@stosb.com>2015-07-31 16:16:13 +0100
commita9b60ec1241826caac4fb87a0b9c61fd89ca9752 (patch)
tree2841db8954dfaa1a085272203ac1c51721d9040d /legacy/elementary/src/lib/elm_panes.eo
parent077339bce1b191a3d0a4e5d0617fa71233a83151 (diff)
panes: Migrate docs to new Eolian format.
Diffstat (limited to 'legacy/elementary/src/lib/elm_panes.eo')
-rw-r--r--legacy/elementary/src/lib/elm_panes.eo246
1 files changed, 55 insertions, 191 deletions
diff --git a/legacy/elementary/src/lib/elm_panes.eo b/legacy/elementary/src/lib/elm_panes.eo
index 3a9b8333f1..881eb7efdd 100644
--- a/legacy/elementary/src/lib/elm_panes.eo
+++ b/legacy/elementary/src/lib/elm_panes.eo
@@ -3,266 +3,130 @@ class Elm.Panes (Elm.Layout, Evas.Clickable_Interface)
3 eo_prefix: elm_obj_panes; 3 eo_prefix: elm_obj_panes;
4 methods { 4 methods {
5 @property content_left_size { 5 @property content_left_size {
6 set { 6 [[Set the size proportion of panes widget's left side.
7 /*@
8 Set the size proportion of panes widget's left side.
9
10 By default it's homogeneous, i.e., both sides have the same size.
11 7
12 If something different is required, it can be set with this function. 8 By default it's homogeneous, i.e., both sides have the same size.
13 For example, if the left content should be displayed over
14 75% of the panes size, @p size should be passed as @c 0.75.
15 This way, right content will be resized to 25% of panes size.
16 9
17 If displayed vertically, left content is displayed at top, and 10 If something different is required, it can be set with this function.
18 right content at bottom. 11 For example, if the left content should be displayed over
12 75% of the panes size, $size should be passed as 0.75.
13 This way, right content will be resized to 25% of panes size.
19 14
20 @note This proportion will change when user drags the panes bar. 15 If displayed vertically, left content is displayed at top, and
16 right content at bottom.
21 17
22 @see elm_panes_content_left_size_get() 18 Note: This proportion will change when user drags the panes bar.]]
23 19 set {
24 @ingroup Panes */
25 } 20 }
26 get { 21 get {
27 /*@
28 Get the size proportion of panes widget's left side.
29
30 @return float value between 0.0 and 1.0 representing size proportion
31 of left side.
32
33 @see elm_panes_content_left_size_set() for more details.
34
35 @ingroup Panes */
36 } 22 }
37 values { 23 values {
38 size: double; /*@ Value between 0.0 and 1.0 representing size proportion 24 size: double; [[Value between 0.0 and 1.0 representing size proportion of left side.]]
39 of left side. */
40 } 25 }
41 } 26 }
42 @property horizontal { 27 @property horizontal {
43 set { 28 [[Set how to split and dispose each content.
44 /*@
45 Set how to split and dispose each content.
46 29
47 Use this function to change how your panes is to be disposed: 30 Use this function to change how your panes is to be disposed:
48 vertically or horizontally. 31 vertically or horizontally.
49 Horizontal panes have "top" and "bottom" contents, vertical panes have 32 Horizontal panes have "top" and "bottom" contents, vertical panes have
50 "left" and "right" contents. 33 "left" and "right" contents.
51 34
52 By default panes is in a vertical mode. 35 By default panes is in a vertical mode.]]
53 36 set {
54 @see elm_panes_horizontal_get()
55
56 @ingroup Panes */
57 } 37 }
58 get { 38 get {
59 /*@
60 Get the split direction of a given panes widget.
61
62 @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
63 @c EINA_FALSE if it's @b vertical (and on errors).
64
65 @see elm_panes_horizontal_set() for more details.
66
67 @ingroup Panes */
68 } 39 }
69 values { 40 values {
70 horizontal: bool; /*@ Use @c EINA_TRUE to make @p obj to split panes 41 horizontal: bool; [[Use $true to make $obj to split panes
71 horizontally ("top" and "bottom" contents). @c EINA_FALSE to make it 42 horizontally ("top" and "bottom" contents). $false to make it
72 vertically ("left" and "right" contents) */ 43 vertically ("left" and "right" contents).]]
73 } 44 }
74 } 45 }
75 @property fixed { 46 @property fixed {
76 set { 47 [[Set whether the left and right panes can be resized by user interaction.
77 /*@
78 Set whether the left and right panes can be resized by user interaction.
79 48
80 By default panes' contents are resizable by user interaction. 49 By default panes' contents are resizable by user interaction.]]
81 50 set {
82 @see elm_panes_fixed_get()
83 @see elm_panes_content_left_size_set()
84 @see elm_panes_content_right_size_set()
85
86 @ingroup Panes */
87 } 51 }
88 get { 52 get {
89 /*@
90 Get the resize mode for the panes of a given panes widget.
91
92 @return @c EINA_TRUE, if @p obj is set to be resizable by user interaction.
93
94 @see elm_panes_fixed_set() for more details.
95 @see elm_panes_content_left_size_get()
96 @see elm_panes_content_right_size_get()
97
98 @ingroup Panes */
99 } 53 }
100 values { 54 values {
101 fixed: bool; /*@ Use @c EINA_TRUE to fix the left and right panes sizes and make 55 fixed: bool; [[Use $true to fix the left and right panes sizes and make
102 them not to be resized by user interaction. Use @c EINA_FALSE to make them 56 them not to be resized by user interaction. Use $false to make them
103 resizable. */ 57 resizable.]]
104 } 58 }
105 } 59 }
106 @property content_right_size { 60 @property content_right_size {
107 set { 61 [[Set the size proportion of panes widget's right side.
108 /*@
109 Set the size proportion of panes widget's right side.
110
111 By default it's homogeneous, i.e., both sides have the same size.
112 62
113 If something different is required, it can be set with this function. 63 By default it's homogeneous, i.e., both sides have the same size.
114 For example, if the right content should be displayed over
115 75% of the panes size, @p size should be passed as @c 0.75.
116 This way, left content will be resized to 25% of panes size.
117 64
118 If displayed vertically, left content is displayed at top, and 65 If something different is required, it can be set with this function.
119 right content at bottom. 66 For example, if the right content should be displayed over
67 75% of the panes size, $size should be passed as 0.75.
68 This way, left content will be resized to 25% of panes size.
120 69
121 @note This proportion will change when user drags the panes bar. 70 If displayed vertically, left content is displayed at top, and
71 right content at bottom.
122 72
123 @see elm_panes_content_right_size_get() 73 Note: This proportion will change when user drags the panes bar.]]
124 74 set {
125 @ingroup Panes */
126 } 75 }
127 get { 76 get {
128 /*@
129 Get the size proportion of panes widget's right side.
130
131 @return float value between 0.0 and 1.0 representing size proportion
132 of right side.
133
134 @see elm_panes_content_right_size_set() for more details.
135
136 @ingroup Panes */
137 } 77 }
138 values { 78 values {
139 size: double; /*@ Value between 0.0 and 1.0 representing size proportion 79 size: double; [[Value between 0.0 and 1.0 representing size proportion of right side.]]
140 of right side. */
141 } 80 }
142 } 81 }
143 @property content_left_min_relative_size { 82 @property content_left_min_relative_size {
144 set { 83 [[Controls the relative minimum size of panes widget's left side.
145 /*@
146 Set the relative minimum size of panes widget's left side.
147
148 @param obj The panes object.
149 @param size double value between 0.0 and 1.0 representing size
150 proportion of minimum size of left side.
151 84
152 @note If displayed vertically, left content is displayed at top. 85 proportion of minimum size of left side.
153 86
154 87 Note: If displayed vertically, left content is displayed at top.]]
155 @see elm_panes_content_left_min_size_relative_get() 88 set {
156
157 @ingroup Panes */
158 } 89 }
159 get { 90 get {
160 /*@
161 Get the relative minimum size of panes widget's left side.
162
163 @param obj The panes object.
164 @return double value between 0.0 and 1.0 representing size proportion
165 of minimum size of left side.
166
167 @see elm_panes_content_left_min_relative_size_set() for more details.
168
169 @ingroup Panes */
170 } 91 }
171 values { 92 values {
172 size: double; /*@ value between 0.0 and 1.0 representing size proportion 93 size: double; [[value between 0.0 and 1.0 representing size proportion of minimum size of left side.]]
173 of minimum size of left side. */
174 } 94 }
175 } 95 }
176 @property content_right_min_relative_size { 96 @property content_right_min_relative_size {
177 set { 97 [[Set the relative minimum size of panes widget's right side.
178 /*@
179 Set the relative minimum size of panes widget's right side.
180
181 @param obj The panes object.
182 @param size double value between 0.0 and 1.0 representing size proportion
183 of minimum size of right side.
184 98
185 @note If displayed vertically, right content is displayed at bottom. 99 Note: If displayed vertically, right content is displayed at bottom.]]
186 100 set {
187 @see elm_panes_content_right_min_relative_size_get()
188
189 @ingroup Panes */
190 } 101 }
191 get { 102 get {
192 /*@
193 Get the relative minimum size of panes widget's right side.
194
195 @param obj The panes object.
196 @return double value between 0.0 and 1.0 representing size proportion
197 of minimum size of right side.
198
199 @see elm_panes_content_right_min_size_set() for more details.
200
201 @ingroup Panes */
202 } 103 }
203 values { 104 values {
204 size: double; /*@ value between 0.0 and 1.0 representing size proportion 105 size: double; [[value between 0.0 and 1.0 representing size proportion of minimum size of right side.]]
205 of minimum size of right side. */
206 } 106 }
207 } 107 }
208 @property content_left_min_size { 108 @property content_left_min_size {
209 set { 109 [[Set the absolute minimum size of panes widget's left side.
210 /*@
211 Set the absolute minimum size of panes widget's left side.
212 110
213 @param obj The panes object. 111 Note: If displayed vertically, left content is displayed at top.]]
214 @param size int value representing minimum size of left side in pixels. 112 set {
215
216 @note If displayed vertically, left content is displayed at top.
217
218 @see elm_panes_content_left_min_size_get()
219
220 @ingroup Panes */
221 } 113 }
222 get { 114 get {
223 /*@
224 Get the absolute minimum size of panes widget's left side.
225
226 @param obj The panes object.
227 @retur int value representing minimum size of left side in pixels.
228
229 @see elm_panes_content_left_min_size_set() for more details.
230
231 @ingroup Panes */
232 } 115 }
233 values { 116 values {
234 size: Evas.Coord; /*@ value representing minimum size of left side 117 size: Evas.Coord; [[value representing minimum size of left side in pixels.]]
235 in pixels. */
236 } 118 }
237 } 119 }
238 @property content_right_min_size { 120 @property content_right_min_size {
239 set { 121 [[Control the absolute minimum size of panes widget's right side.
240 /*@
241 Set the absolute minimum size of panes widget's right side.
242 122
243 @param obj The panes object. 123 Note: If displayed vertically, right content is displayed at bottom.]]
244 @param size int value representing minimum size of right side in pixels. 124 set {
245
246 @note If displayed vertically, right content is displayed at bottom.
247
248 @see elm_panes_content_right_min_size_get()
249
250 @ingroup Panes */
251 } 125 }
252 get { 126 get {
253 /*@
254 Get the absolute minimum size of panes widget's right side.
255
256 @param obj The panes object.
257 @retur int value representing minimum size of right side in pixels.
258
259 @see elm_panes_content_right_min_size_set() for more details.
260
261 @ingroup Panes */
262 } 127 }
263 values { 128 values {
264 size: Evas.Coord; /*@ value representing minimum size of right side 129 size: Evas.Coord; [[value representing minimum size of right side in pixels.]]
265 in pixels. */
266 } 130 }
267 } 131 }
268 } 132 }