summaryrefslogtreecommitdiff
path: root/efl/eo
diff options
context:
space:
mode:
authordavemds <dave@gurumeditation.it>2014-04-06 23:35:53 +0200
committerdavemds <dave@gurumeditation.it>2014-04-06 23:36:05 +0200
commitbeff74c28aa33b7295900a20dda4f00d61147cff (patch)
tree22bcf680dd3105c67120f7686c1d4987523e7eea /efl/eo
parentd6dc3a2045b756e3a633fcfdac9312dc234fa00d (diff)
added docs for Eo
Diffstat (limited to 'efl/eo')
-rw-r--r--efl/eo/efl.eo.pyx37
1 files changed, 34 insertions, 3 deletions
diff --git a/efl/eo/efl.eo.pyx b/efl/eo/efl.eo.pyx
index 33557d2..42817ab 100644
--- a/efl/eo/efl.eo.pyx
+++ b/efl/eo/efl.eo.pyx
@@ -200,8 +200,7 @@ cdef Eina_Bool _eo_event_del_cb(void *data, cEo *obj,
200cdef class Eo(object): 200cdef class Eo(object):
201 """ 201 """
202 202
203 Base class used by all the Eo object in the bindings, its not meant to be 203 Base class used by all the object in the EFL.
204 used by users, but only by internal classes.
205 204
206 """ 205 """
207 206
@@ -250,27 +249,59 @@ cdef class Eo(object):
250 return 1 249 return 1
251 250
252 def delete(self): 251 def delete(self):
252 """Delete the object and free internal resources.
253
254 .. note:: This will not delete the python object, but only the internal
255 C one. The python object will be automatically deleted by the
256 garbage collector when there are no more reference to it.
257
258 """
253 eo_del(self.obj) 259 eo_del(self.obj)
254 260
255 def is_deleted(self): 261 def is_deleted(self):
256 "Check if the object has been deleted thus leaving the object shallow" 262 """Check if the object has been deleted thus leaving the object shallow.
263
264 :return: True if the object has been deleted yet, False otherwise.
265 :rtype: bool
266
267 """
257 return bool(self.obj == NULL) 268 return bool(self.obj == NULL)
258 269
259 def parent_set(self, Eo parent): 270 def parent_set(self, Eo parent):
271 """Set the parent object.
272
273 :param parent: The object to set as parent.
274 :type parent: :class:`Eo`
275
276 """
260 eo_do(self.obj, eo_parent_set(parent.obj)) 277 eo_do(self.obj, eo_parent_set(parent.obj))
261 278
262 def parent_get(self): 279 def parent_get(self):
280 """Get the parent object.
281
282 :return: The parent object
283 :rtype: :class:`Eo`
284
285 """
263 cdef cEo *parent = NULL 286 cdef cEo *parent = NULL
264 eo_do(self.obj, eo_parent_get(&parent)) 287 eo_do(self.obj, eo_parent_get(&parent))
265 return object_from_instance(parent) 288 return object_from_instance(parent)
266 289
267 def event_freeze(self): 290 def event_freeze(self):
291 """Pause event propagation for this object."""
268 eo_do(self.obj, eo_event_freeze()) 292 eo_do(self.obj, eo_event_freeze())
269 293
270 def event_thaw(self): 294 def event_thaw(self):
295 """Restart event propagation for this object."""
271 eo_do(self.obj, eo_event_thaw()) 296 eo_do(self.obj, eo_event_thaw())
272 297
273 def event_freeze_get(self): 298 def event_freeze_get(self):
299 """Get the event freeze count for this object.
300
301 :return: the freeze count
302 :rtype: int
303
304 """
274 cdef int fcount 305 cdef int fcount
275 eo_do(self.obj, eo_event_freeze_get(&fcount)) 306 eo_do(self.obj, eo_event_freeze_get(&fcount))
276 return fcount 307 return fcount