summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-11-10 14:38:06 +0100
committerStefan Schmidt <stefan@osg.samsung.com>2016-11-10 15:14:42 +0100
commit8e88ff7487884b7b5aca50a1b32bb590e179334a (patch)
tree8927967142e365b96700780bc6705114cdf97dff /src
parent299338a55065c31f88d5ac87bbe1249f5255f3fa (diff)
docs: eo: finish up docs for eo
Add some mising docs, fix some typos and align with other docs.
Diffstat (limited to 'src')
-rw-r--r--src/lib/eo/efl_class.eo1
-rw-r--r--src/lib/eo/efl_object.eo79
2 files changed, 39 insertions, 41 deletions
diff --git a/src/lib/eo/efl_class.eo b/src/lib/eo/efl_class.eo
index 367848a..b40674d 100644
--- a/src/lib/eo/efl_class.eo
+++ b/src/lib/eo/efl_class.eo
@@ -1,4 +1,5 @@
1abstract Efl.Class () 1abstract Efl.Class ()
2{ 2{
3 [[Abstract Efl class]]
3 data: null; 4 data: null;
4} 5}
diff --git a/src/lib/eo/efl_object.eo b/src/lib/eo/efl_object.eo
index 3192061..5866cac 100644
--- a/src/lib/eo/efl_object.eo
+++ b/src/lib/eo/efl_object.eo
@@ -44,6 +44,7 @@ type Efl.Callback_Priority: short; [[Callback priority value. Range is -32k - 32
44 44
45abstract Efl.Object () 45abstract Efl.Object ()
46{ 46{
47 [[Abstract Efl object class]]
47 eo_prefix: efl; 48 eo_prefix: efl;
48 49
49 methods { 50 methods {
@@ -69,7 +70,7 @@ abstract Efl.Object ()
69 get { 70 get {
70 } 71 }
71 values { 72 values {
72 parent: Efl.Object @nullable; [[the new parent]] 73 parent: Efl.Object @nullable; [[The new parent]]
73 } 74 }
74 } 75 }
75 del @const { 76 del @const {
@@ -96,7 +97,7 @@ abstract Efl.Object ()
96 get { 97 get {
97 } 98 }
98 values { 99 values {
99 name: string @nullable; [[the name]] 100 name: string @nullable; [[The name]]
100 } 101 }
101 } 102 }
102 @property comment { 103 @property comment {
@@ -111,7 +112,7 @@ abstract Efl.Object ()
111 get { 112 get {
112 } 113 }
113 values { 114 values {
114 comment: string @nullable; [[the comment]] 115 comment: string @nullable; [[The comment]]
115 } 116 }
116 } 117 }
117 @property event_global_freeze_count @class { 118 @property event_global_freeze_count @class {
@@ -141,7 +142,7 @@ abstract Efl.Object ()
141 get { 142 get {
142 } 143 }
143 values { 144 values {
144 finalized: bool; 145 finalized: bool; [[$true if the object is finalized, $false otherwise]]
145 } 146 }
146 } 147 }
147 provider_find { 148 provider_find {
@@ -149,7 +150,7 @@ abstract Efl.Object ()
149 150
150 The object from the provider will then be returned. 151 The object from the provider will then be returned.
151 The base implementation calls the provider_find function on the object parent, 152 The base implementation calls the provider_find function on the object parent,
152 and returnes its result. If no parent is present NULL is returned. 153 and returns its result. If no parent is present NULL is returned.
153 Each implementation has to support this function by overriding 154 Each implementation has to support this function by overriding
154 it and returning itself if the interface matches the parameter. 155 it and returning itself if the interface matches the parameter.
155 If this is not done the class cannot be found up in the object tree. 156 If this is not done the class cannot be found up in the object tree.
@@ -157,7 +158,7 @@ abstract Efl.Object ()
157 params { 158 params {
158 klass : const(Efl.Object); [[The class identifier to search for]] 159 klass : const(Efl.Object); [[The class identifier to search for]]
159 } 160 }
160 return : Efl.Object; 161 return : Efl.Object; [[Object from the provider list]]
161 } 162 }
162 constructor { 163 constructor {
163 [[Call the object's constructor. 164 [[Call the object's constructor.
@@ -185,9 +186,9 @@ abstract Efl.Object ()
185 the search will match any object of that class. 186 the search will match any object of that class.
186 ]] 187 ]]
187 params { 188 params {
188 @in search: string; [[the name search string]] 189 @in search: string; [[The name search string]]
189 } 190 }
190 return: Efl.Object; [[the first object found]] 191 return: Efl.Object; [[The first object found]]
191 } 192 }
192 wref_add { 193 wref_add {
193 [[Add a new weak reference to obj. 194 [[Add a new weak reference to obj.
@@ -199,13 +200,13 @@ abstract Efl.Object ()
199 being freed. 200 being freed.
200 ]] 201 ]]
201 params { 202 params {
202 @in wref: ptr(Efl.Object); 203 @in wref: ptr(Efl.Object); [[The weak ref]]
203 } 204 }
204 } 205 }
205 wref_del { 206 wref_del {
206 [[Delete the weak reference passed.]] 207 [[Delete the weak reference passed.]]
207 params { 208 params {
208 @in wref: ptr(Efl.Object); 209 @in wref: ptr(Efl.Object); [[The weak ref]]
209 } 210 }
210 } 211 }
211 @property key_data { 212 @property key_data {
@@ -214,16 +215,16 @@ abstract Efl.Object ()
214 The user is in charge of freeing the data. 215 The user is in charge of freeing the data.
215 ]] 216 ]]
216 keys { 217 keys {
217 key: string; [[the key associated with the data]] 218 key: string; [[The key associated with the data]]
218 } 219 }
219 set { 220 set {
220 values { 221 values {
221 data: const(void_ptr); [[the data to set]] 222 data: const(void_ptr); [[The data to set]]
222 } 223 }
223 } 224 }
224 get { 225 get {
225 values { 226 values {
226 data: void_ptr; [[the data to set]] 227 data: void_ptr; [[The data to set]]
227 } 228 }
228 } 229 }
229 } 230 }
@@ -239,16 +240,16 @@ abstract Efl.Object ()
239 are shared and can store only one thing 240 are shared and can store only one thing
240 ]] 241 ]]
241 keys { 242 keys {
242 key: string; [[the key associated with the object ref]] 243 key: string; [[The key associated with the object ref]]
243 } 244 }
244 set { 245 set {
245 values { 246 values {
246 objdata: const(Efl.Object); [[the object to set]] 247 objdata: const(Efl.Object); [[The object to set]]
247 } 248 }
248 } 249 }
249 get { 250 get {
250 values { 251 values {
251 objdata: Efl.Object; [[the object to set]] 252 objdata: Efl.Object; [[The object to set]]
252 } 253 }
253 } 254 }
254 } 255 }
@@ -262,16 +263,16 @@ abstract Efl.Object ()
262 are shared and can store only one thing 263 are shared and can store only one thing
263 ]] 264 ]]
264 keys { 265 keys {
265 key: string; [[the key associated with the object ref]] 266 key: string; [[The key associated with the object ref]]
266 } 267 }
267 set { 268 set {
268 values { 269 values {
269 objdata: const(Efl.Object); [[the object to set]] 270 objdata: const(Efl.Object); [[The object to set]]
270 } 271 }
271 } 272 }
272 get { 273 get {
273 values { 274 values {
274 objdata: Efl.Object; [[the object to set]] 275 objdata: Efl.Object; [[The object to set]]
275 } 276 }
276 } 277 }
277 } 278 }
@@ -286,32 +287,32 @@ abstract Efl.Object ()
286 are shared and can store only one thing 287 are shared and can store only one thing
287 ]] 288 ]]
288 keys { 289 keys {
289 key: string; [[the key associated with the value]] 290 key: string; [[The key associated with the value]]
290 } 291 }
291 values { 292 values {
292 value: ptr(generic_value); [[the value to set]] 293 value: ptr(generic_value); [[The value to set]]
293 } 294 }
294 } 295 }
295 event_thaw { 296 event_thaw {
296 [[thaw events of object. 297 [[Thaw events of object.
297 298
298 Lets event callbacks be called for the object. 299 Lets event callbacks be called for the object.
299 ]] 300 ]]
300 } 301 }
301 event_freeze { 302 event_freeze {
302 [[freeze events of object. 303 [[Freeze events of object.
303 304
304 Prevents event callbacks from being called for the object. 305 Prevents event callbacks from being called for the object.
305 ]] 306 ]]
306 } 307 }
307 event_global_thaw @class { 308 event_global_thaw @class {
308 [[thaw events of object. 309 [[Thaw events of object.
309 310
310 Lets event callbacks be called for the object. 311 Lets event callbacks be called for the object.
311 ]] 312 ]]
312 } 313 }
313 event_global_freeze @class { 314 event_global_freeze @class {
314 [[freeze events of object. 315 [[Freeze events of object.
315 316
316 Prevents event callbacks from being called for the object. 317 Prevents event callbacks from being called for the object.
317 ]] 318 ]]
@@ -331,11 +332,11 @@ abstract Efl.Object ()
331 } 332 }
332 } 333 }
333 event_callback_del { 334 event_callback_del {
334 [[Del a callback with a specific data associated to it for an event.]] 335 [[Delete a callback with a specific data associated to it for an event.]]
335 return: bool; [[Return $true when the callback has been successfully removed.]] 336 return: bool; [[Return $true when the callback has been successfully removed.]]
336 params { 337 params {
337 @in desc: ptr(const(Efl.Event.Description)); [[The description of the event to listen to]] 338 @in desc: ptr(const(Efl.Event.Description)); [[The description of the event to listen to]]
338 @in func: Efl.Event_Cb; [[the callback to delete]] 339 @in func: Efl.Event_Cb; [[The callback to delete]]
339 @in user_data: const(void_ptr); [[The data to compare]] 340 @in user_data: const(void_ptr); [[The data to compare]]
340 } 341 }
341 } 342 }
@@ -349,9 +350,9 @@ abstract Efl.Object ()
349 ]] 350 ]]
350 return: bool; [[Return $true when the callback has been successfully added.]] 351 return: bool; [[Return $true when the callback has been successfully added.]]
351 params { 352 params {
352 @in array: ptr(const(Efl.Callback_Array_Item)); [[an #Efl_Callback_Array_Item of events to listen to]] 353 @in array: ptr(const(Efl.Callback_Array_Item)); [[An #Efl_Callback_Array_Item of events to listen to]]
353 @in priority: Efl.Callback_Priority; [[The priority of the callback]] 354 @in priority: Efl.Callback_Priority; [[The priority of the callback]]
354 @in data: const(void_ptr); [[additional data to pass to the callback]] 355 @in data: const(void_ptr); [[Additional data to pass to the callback]]
355 } 356 }
356 } 357 }
357 event_callback_array_del { 358 event_callback_array_del {
@@ -360,7 +361,7 @@ abstract Efl.Object ()
360 ]] 361 ]]
361 return: bool; [[Return $true when the callback has been successfully removed.]] 362 return: bool; [[Return $true when the callback has been successfully removed.]]
362 params { 363 params {
363 @in array: ptr(const(Efl.Callback_Array_Item)); [[an #Efl_Callback_Array_Item of events to listen to]] 364 @in array: ptr(const(Efl.Callback_Array_Item)); [[An #Efl_Callback_Array_Item of events to listen to]]
364 @in user_data: const(void_ptr); [[The data to compare]] 365 @in user_data: const(void_ptr); [[The data to compare]]
365 } 366 }
366 } 367 }
@@ -370,9 +371,7 @@ abstract Efl.Object ()
370 @in desc: ptr(const(Efl.Event.Description)); [[The description of the event to call]] 371 @in desc: ptr(const(Efl.Event.Description)); [[The description of the event to call]]
371 @in event_info: void_ptr; [[Extra event info to pass to the callbacks]] 372 @in event_info: void_ptr; [[Extra event info to pass to the callbacks]]
372 } 373 }
373 return: bool; [[$false if one of the callbacks aborted the call, 374 return: bool; [[$false if one of the callbacks aborted the call, $true otherwise]]
374 $true otherwise
375 ]]
376 } 375 }
377 event_callback_legacy_call { 376 event_callback_legacy_call {
378 [[Call the callbacks for an event of an object. 377 [[Call the callbacks for an event of an object.
@@ -386,9 +385,7 @@ abstract Efl.Object ()
386 @in desc: ptr(const(Efl.Event.Description)); [[The description of the event to call]] 385 @in desc: ptr(const(Efl.Event.Description)); [[The description of the event to call]]
387 @in event_info: void_ptr; [[Extra event info to pass to the callbacks]] 386 @in event_info: void_ptr; [[Extra event info to pass to the callbacks]]
388 } 387 }
389 return: bool; [[$false if one of the callbacks aborted the call, 388 return: bool; [[$false if one of the callbacks aborted the call, $true otherwise]]
390 $true otherwise
391 ]]
392 } 389 }
393 event_callback_stop { 390 event_callback_stop {
394 [[Stop the current callback call. 391 [[Stop the current callback call.
@@ -414,14 +411,14 @@ abstract Efl.Object ()
414 } 411 }
415 } 412 }
416 dbg_info_get { 413 dbg_info_get {
417 [[Get dbg information from the object.]] 414 [[Get debug information from the object.]]
418 params { 415 params {
419 @in root_node: ptr(Efl.Dbg_Info); [[node of the tree]] 416 @in root_node: ptr(Efl.Dbg_Info); [[Node of the tree]]
420 } 417 }
421 } 418 }
422 children_iterator_new { 419 children_iterator_new {
423 [[Get an iterator on all childrens]] 420 [[Get an iterator on all childrens]]
424 return: free(own(iterator<Efl.Object>), eina_iterator_free) @warn_unused; 421 return: free(own(iterator<Efl.Object>), eina_iterator_free) @warn_unused; [[Children iterator]]
425 } 422 }
426 composite_attach { 423 composite_attach {
427 [[Make an object a composite object of another. 424 [[Make an object a composite object of another.
@@ -445,7 +442,7 @@ abstract Efl.Object ()
445 See @.composite_attach, @.composite_part_is. 442 See @.composite_attach, @.composite_part_is.
446 ]] 443 ]]
447 params { 444 params {
448 @in comp_obj: Efl.Object; [[the object that will be removed from the parent.]] 445 @in comp_obj: Efl.Object; [[The object that will be removed from the parent.]]
449 } 446 }
450 return: bool; [[$true if successful. $false otherwise.]] 447 return: bool; [[$true if successful. $false otherwise.]]
451 } 448 }
@@ -471,6 +468,6 @@ abstract Efl.Object ()
471 events { 468 events {
472 callback,add @hot; [[A callback was added.]] 469 callback,add @hot; [[A callback was added.]]
473 callback,del @hot; [[A callback was deleted.]] 470 callback,del @hot; [[A callback was deleted.]]
474 del @hot; [[Obj is being deleted.]] 471 del @hot; [[Object is being deleted.]]
475 } 472 }
476} 473}