Enlightenment CVS committal

Author  : barbieri
Project : e17
Module  : proto/python-efl

Dir     : e17/proto/python-efl/python-ecore/ecore/evas


Modified Files:
        __init__.py ecore.evas.c_ecore_evas.pyx 
        ecore.evas.c_ecore_evas_base.pxi 
        ecore.evas.c_ecore_evas_base_x11.pxi 
        ecore.evas.c_ecore_evas_buffer.pxi 
        ecore.evas.c_ecore_evas_directfb.pxi 
        ecore.evas.c_ecore_evas_fb.pxi 
        ecore.evas.c_ecore_evas_gl_x11.pxi 
        ecore.evas.c_ecore_evas_software_x11.pxi 
        ecore.evas.c_ecore_evas_software_x11_16.pxi 
        ecore.evas.c_ecore_evas_xrender_x11.pxi 


Log Message:
Ecore_Evas docs.

===================================================================
RCS file: /cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/__init__.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- __init__.py 2 Sep 2007 15:11:54 -0000       1.4
+++ __init__.py 1 Oct 2007 05:09:43 -0000       1.5
@@ -4,6 +4,6 @@
 
 from c_ecore_evas import shutdown, engine_type_supported_get, \
      engine_type_from_name, engine_name_from_type, SoftwareX11, \
-     GLX11, XRenderX11, FB, DirectFB, Buffer, SoftwareX11_16
+     GLX11, XRenderX11, FB, Buffer, SoftwareX11_16
 
 c_ecore_evas.init()
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas.pyx,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- ecore.evas.c_ecore_evas.pyx 30 Sep 2007 22:18:52 -0000      1.5
+++ ecore.evas.c_ecore_evas.pyx 1 Oct 2007 05:09:43 -0000       1.6
@@ -1,6 +1,9 @@
 cimport evas.python as python
 import evas.c_evas
 
+__extra_epydoc_fields__ = (
+    ("parm", "Parameter", "Parameters"), # epydoc don't support pyrex properly
+    )
 
 def init():
     return ecore_evas_init()
@@ -22,6 +25,11 @@
 
 
 def engine_type_from_name(char *method):
+    """Retrive the type id for the engine given it's name.
+
+    @return: >= 0 on success or -1 on failure.
+    @rtype: int
+    """
     cdef int i
 
     for i from 0 <= i < engines_len:
@@ -31,12 +39,20 @@
 
 
 def engine_name_from_type(int type_id):
+    """Retrive the engine name given it's id.
+
+    @rtype: str
+    """
     if type_id >= 0 and type_id < engines_len:
         return engines[type_id]
     return None
 
 
 def engine_type_supported_get(method):
+    """Check if engine is supported.
+
+    @rtype: bool
+    """
     cdef Ecore_Evas_Engine_Type method_id
 
     if isinstance(method, (int, long)):
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas_base.pxi,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- ecore.evas.c_ecore_evas_base.pxi    1 Oct 2007 04:34:47 -0000       1.8
+++ ecore.evas.c_ecore_evas_base.pxi    1 Oct 2007 05:09:43 -0000       1.9
@@ -124,16 +124,78 @@
 
 
 cdef class EcoreEvas:
+    """Integration of Ecore and Evas providing a Window.
+
+    This class does the integration of ecore and evas, setups the correct
+    evas engine and handle events, redraws and other requeriments for a
+    properly working system.
+
+    @ivar evas: associated Evas canvas.
+    @ivar alpha: if using alpha channel or not.
+    @ivar shaped: if window is shaped or not.
+    @ivar avoid_damage: if avoiding damage or not.
+    @ivar focus: if window have focus or not.
+    @ivar pos: window position.
+    @ivar size: window size.
+    @ivar size_base: window base size.
+    @ivar size_max: maximum size.
+    @ivar size_min: minimum size.
+    @ivar size_step: size must be multiple of these values.
+    @ivar geometry: position and size.
+    @ivar ignore_events: if window ignores events or not.
+    @ivar layer: which layer this window is.
+    @ivar borderless: if window have border or not.
+    @ivar fullscreen: if window is fullscreen.
+    @ivar iconified: if window is minimized (iconified).
+    @ivar maximized: if window is maximized or not.
+    @ivar sticky: if window is sticky or not.
+    @ivar override: if the WM should ignore or not this window.
+    @ivar rotation: if window contents should be rotated or not.
+    @ivar name_class: (name, class) that identifies this window (WM_CLASS)
+    @ivar title: window title.
+    @ivar visibility: if window is visible or not.
+    @ivar withdrawn: if window is withdrawn or not.
+    @ivar callback_delete_request: callback used to handle delete events.
+    @ivar callback_destroy: callback used to handle destroy events.
+    @ivar callback_focus_in: callback used to handle focus in events.
+    @ivar callback_focus_out: callback used to handle focus out events.
+    @ivar callback_mouse_in: callback used to handle mouse in events.
+    @ivar callback_mouse_out: callback used to handle mouse out events.
+    @ivar callback_post_render: callback used after render.
+    @ivar callback_pre_render: callback used before render.
+    @ivar callback_move: callback used to handle move events.
+    @ivar callback_resize: callback used to handle resize events.
+    @ivar callback_hide: callback used to handle hide events.
+    @ivar callback_show: callback used to handle show events.
+    @ivar callback_sticky: callback used to handle sticky events.
+    @ivar callback_unsticky: callback used to handle unsticky events.
+
+    @group Callbacks: callback_delete_request_set, callback_delete_request_get,
+     callback_destroy_get, callback_destroy_set, callback_focus_in_get,
+     callback_focus_in_set, callback_focus_out_get, callback_focus_out_set,
+     callback_hide_get, callback_hide_set, callback_mouse_in_get,
+     callback_mouse_in_set, callback_mouse_out_get, callback_mouse_out_set,
+     callback_move_get, callback_move_set, callback_post_render_get,
+     callback_post_render_set, callback_pre_render_get,
+     callback_pre_render_set, callback_resize_get, callback_resize_set,
+     callback_show_get, callback_show_set, callback_sticky_get,
+     callback_sticky_set, callback_unsticky_get, callback_unsticky_set,
+     callback_delete_request, callback_destroy, callback_focus_in,
+     callback_focus_out, callback_hide, callback_mouse_in,
+     callback_mouse_out, callback_move, callback_post_render,
+     callback_pre_render, callback_resize, callback_show, callback_sticky,
+     callback_unsticky
+    """
     def __new__(self, *args, **kargs):
         self.obj = NULL
-        self._data = dict()
+        self.data = dict()
 
     def __dealloc__(self):
-        self._data = None
+        self.data = None
         if self.obj:
-            if self._evas:
-                self._evas._unset_obj()
-                self._evas = None
+            if self.evas:
+                self.evas._unset_obj()
+                self.evas = None
             ecore_evas_data_set(self.obj, "python-ecore-evas", NULL)
             ecore_evas_free(self.obj)
             self.obj = NULL
@@ -147,31 +209,25 @@
 
         evas_ptr = <long>ecore_evas_get(obj)
         if evas_ptr:
-            self._evas = evas.c_evas._Canvas_from_instance(evas_ptr)
+            self.evas = evas.c_evas._Canvas_from_instance(evas_ptr)
 
         return 1
 
     def __str__(self):
-        return "%s(Evas=%s)" % (self.__class__.__name__, self._evas)
+        return "%s(Evas=%s)" % (self.__class__.__name__, self.evas)
 
     def __repr__(self):
         return "%s(0x%x, refcount=%d, Ecore_Evas=0x%x, Evas=%r)" % \
                (self.__class__.__name__, <unsigned long>self,
                 PY_REFCOUNT(self), <unsigned long>self.obj,
-                self._evas)
+                self.evas)
 
     def evas_get(self):
-        return self._evas
-
-    property evas:
-        def __get__(self):
-            return self._evas
-
-    property data:
-        def __get__(self):
-            return self._data
+        "@rtype: L{evas.c_evas.Canvas}"
+        return self.evas
 
     def cursor_get(self):
+        "@rtype: (object, int, int, int)"
         cdef evas.c_evas.Evas_Object *eobj
         cdef int layer, hotx, hoty
         eobj = NULL
@@ -183,6 +239,13 @@
         return (eo, layer, hotx, hoty)
 
     def cursor_set(self, cursor, int layer=0, int hotx=0, int hoty=0):
+        """Set window cursor to some file (image) or any Evas Object.
+
+        @parm: B{cursor} either filename or L{evas.c_evas.Object}
+        @parm: B{layer}
+        @parm: B{hotx} horizontal hotspot
+        @parm: B{hoty} vertical hotspot
+        """
         if cursor is None:
             ecore_evas_cursor_set(self.obj, NULL, layer, hotx, hoty)
         elif isinstance(cursor, str):
@@ -195,15 +258,25 @@
 
     def object_cursor_set(self, c_evas.Object cursor, int layer=0,
                           int hotx=0, int hoty=0):
+        """Set window cursor to any Evas Object.
+
+        @parm: B{cursor} an L{evas.c_evas.Object} to use as cursor.
+        @parm: B{layer}
+        @parm: B{hotx}
+        @parm: B{hoty}
+        """
         ecore_evas_object_cursor_set(self.obj, cursor.obj, layer, hotx, hoty)
 
     def move(self, int x, int y):
+        "Move window to given position."
         ecore_evas_move(self.obj, x, y)
 
     def pos_set(self, int x, int y):
+        "Same as L{move()}"
         ecore_evas_move(self.obj, x, y)
 
     def pos_get(self):
+        "@rtype: tuple of int"
         cdef int x, y
         ecore_evas_geometry_get(self.obj, &x, &y, NULL, NULL)
         return (x, y)
@@ -216,15 +289,19 @@
             return self.pos_get()
 
     def managed_move(self, int x, int y):
+        "This sets the managed geometry position of the window."
         ecore_evas_managed_move(self.obj, x, y)
 
     def resize(self, int w, int h):
+        "Resize window to given size."
         ecore_evas_resize(self.obj, w, h)
 
     def size_set(self, int w, int h):
+        "Same as L{resize()}"
         ecore_evas_resize(self.obj, w, h)
 
     def size_get(self):
+        "@rtype: tuple of int"
         cdef int w, h
         ecore_evas_geometry_get(self.obj, NULL, NULL, &w, &h)
         return (w, h)
@@ -237,12 +314,15 @@
             return self.size_get()
 
     def move_resize(self, int x, int y, int w, int h):
+        "Move and resize the window."
         ecore_evas_move_resize(self.obj, x, y, w, h)
 
     def geometry_set(self, int x, int y, int w, int h):
+        "Same as L{move_resize()}."
         ecore_evas_move_resize(self.obj, x, y, w, h)
 
     def geometry_get(self):
+        "@rtype: tuple of int"
         cdef int x, y, w, h
         ecore_evas_geometry_get(self.obj, &x, &y, &w, &h)
         return (x, y, w, h)
@@ -263,7 +343,10 @@
         ecore_evas_rotation_set(self.obj, rot)
 
     def rotation_get(self):
-        "Get rotation angle, in degrees."
+        """Get rotation angle, in degrees.
+
+        @rtype: int
+        """
         return ecore_evas_rotation_get(self.obj)
 
     property rotation:
@@ -278,7 +361,7 @@
         """Set whether the object is shaped or not.
 
         If true, EcoreEvas will be transparent in areas without any
-        evas.Object.
+        L{evas.c_evas.Object}.
         """
         ecore_evas_shaped_set(self.obj, shaped)
 
@@ -286,7 +369,9 @@
         """Get whether the object is shaped or not.
 
         A shaped EcoreEvas will be transparent in areas without any
-        evas.Object
+        L{evas.c_evas.Object}.
+
+        @rtype: bool
         """
         return bool(ecore_evas_shaped_get(self.obj))
 
@@ -311,7 +396,10 @@
         ecore_evas_alpha_set(self.obj, alpha)
 
     def alpha_get(self):
-        "Get whether the object has an alpha channel or not."
+        """Get whether the object has an alpha channel or not.
+
+        @rtype: bool
+        """
         return bool(ecore_evas_alpha_get(self.obj))
 
     property alpha:
@@ -334,6 +422,7 @@
             self.hide()
 
     def visibility_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_visibility_get(self.obj))
 
     property visibility:
@@ -353,6 +442,7 @@
         ecore_evas_title_set(self.obj, t)
 
     def title_get(self):
+        "@rtype: str"
         cdef char *s
         s = ecore_evas_title_get(self.obj)
         if s != NULL:
@@ -366,9 +456,11 @@
             self.title_set(value)
 
     def name_class_set(self, char *n, char *c):
+        "Set name and class for this window (WM_CLASS)"
         ecore_evas_name_class_set(self.obj, n, c)
 
     def name_class_get(self):
+        "@rtype: tuple of str"
         cdef char *n, *c
         ecore_evas_name_class_get(self.obj, &n, &c)
         if n == NULL:
@@ -392,6 +484,7 @@
         ecore_evas_size_min_set(self.obj, w, h)
 
     def size_min_get(self):
+        "@rtype: tuple of int"
         cdef int w, h
         ecore_evas_size_min_get(self.obj, &w, &h)
         return (w, h)
@@ -407,6 +500,7 @@
         ecore_evas_size_max_set(self.obj, w, h)
 
     def size_max_get(self):
+        "@rtype: tuple of int"
         cdef int w, h
         ecore_evas_size_max_get(self.obj, &w, &h)
         return (w, h)
@@ -422,6 +516,7 @@
         ecore_evas_size_base_set(self.obj, w, h)
 
     def size_base_get(self):
+        "@rtype: tuple of int"
         cdef int w, h
         ecore_evas_size_base_get(self.obj, &w, &h)
         return (w, h)
@@ -434,9 +529,13 @@
             self.size_base_set(*spec)
 
     def size_step_set(self, int w, int h):
+        """This limits the size of window to always being an integer
+        multiple of the step size.
+        """
         ecore_evas_size_step_set(self.obj, w, h)
 
     def size_step_get(self):
+        "@rtype: tuple of int"
         cdef int w, h
         ecore_evas_size_step_get(self.obj, &w, &h)
         return (w, h)
@@ -452,7 +551,8 @@
         ecore_evas_layer_set(self.obj, layer)
 
     def layer_get(self):
-        return bool(ecore_evas_layer_get(self.obj))
+        "@rtype: int"
+        return ecore_evas_layer_get(self.obj)
 
     property layer:
         def __get__(self):
@@ -465,6 +565,7 @@
         ecore_evas_focus_set(self.obj, on)
 
     def focus_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_focus_get(self.obj))
 
     property focus:
@@ -478,6 +579,7 @@
         ecore_evas_iconified_set(self.obj, on)
 
     def iconified_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_iconified_get(self.obj))
 
     property iconified:
@@ -491,6 +593,7 @@
         ecore_evas_borderless_set(self.obj, on)
 
     def borderless_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_borderless_get(self.obj))
 
     property borderless:
@@ -504,6 +607,7 @@
         ecore_evas_override_set(self.obj, on)
 
     def override_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_override_get(self.obj))
 
     property override:
@@ -518,6 +622,7 @@
         ecore_evas_maximized_set(self.obj, on)
 
     def maximized_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_maximized_get(self.obj))
 
     property maximized:
@@ -531,6 +636,7 @@
         return bool(ecore_evas_fullscreen_get(self.obj))
 
     def fullscreen_set(self, int spec):
+        "@rtype: bool"
         ecore_evas_fullscreen_set(self.obj, spec)
 
     property fullscreen:
@@ -544,6 +650,7 @@
         ecore_evas_avoid_damage_set(self.obj, on)
 
     def avoid_damage_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_avoid_damage_get(self.obj))
 
     property avoid_damage:
@@ -557,6 +664,7 @@
         ecore_evas_withdrawn_set(self.obj, on)
 
     def withdrawn_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_withdrawn_get(self.obj))
 
     property withdrawn:
@@ -570,6 +678,7 @@
         ecore_evas_sticky_set(self.obj, on)
 
     def sticky_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_sticky_get(self.obj))
 
     property sticky:
@@ -583,6 +692,7 @@
         ecore_evas_ignore_events_set(self.obj, on)
 
     def ignore_events_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_ignore_events_get(self.obj))
 
     property ignore_events:
@@ -597,6 +707,12 @@
     # Callbacks
     #
     def callback_resize_set(self, func):
+        """Set function to be called when window is resized.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._resize_cb = func
         if func is None:
             ecore_evas_callback_resize_set(self.obj, NULL)
@@ -604,6 +720,7 @@
             ecore_evas_callback_resize_set(self.obj, resize_cb)
 
     def callback_resize_get(self):
+        "@rtype: callable"
         return self._resize_cb
 
     property callback_resize:
@@ -617,6 +734,12 @@
             self.callback_resize_set(None)
 
     def callback_move_set(self, func):
+        """Set function to be called when window is moved.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._move_cb = func
         if func is None:
             ecore_evas_callback_move_set(self.obj, NULL)
@@ -624,6 +747,7 @@
             ecore_evas_callback_move_set(self.obj, move_cb)
 
     def callback_move_get(self):
+        "@rtype: callable"
         return self._move_cb
 
     property callback_move:
@@ -637,6 +761,12 @@
             self.callback_move_set(None)
 
     def callback_show_set(self, func):
+        """Set function to be called when window is shown.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._show_cb = func
         if func is None:
             ecore_evas_callback_show_set(self.obj, NULL)
@@ -644,6 +774,7 @@
             ecore_evas_callback_show_set(self.obj, show_cb)
 
     def callback_show_get(self):
+        "@rtype: callable"
         return self._show_cb
 
     property callback_show:
@@ -657,6 +788,12 @@
             self.callback_show_set(None)
 
     def callback_hide_set(self, func):
+        """Set function to be called when window is hidden.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._hide_cb = func
         if func is None:
             ecore_evas_callback_hide_set(self.obj, NULL)
@@ -664,6 +801,7 @@
             ecore_evas_callback_hide_set(self.obj, hide_cb)
 
     def callback_hide_get(self):
+        "@rtype: callable"
         return self._hide_cb
 
     property callback_hide:
@@ -677,6 +815,12 @@
             self.callback_hide_set(None)
 
     def callback_delete_request_set(self, func):
+        """Set function to be called when window gets a delete request.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._delete_request_cb = func
         if func is None:
             ecore_evas_callback_delete_request_set(self.obj, NULL)
@@ -684,6 +828,7 @@
             ecore_evas_callback_delete_request_set(self.obj, delete_request_cb)
 
     def callback_delete_request_get(self):
+        "@rtype: callable"
         return self._delete_request_cb
 
     property callback_delete_request:
@@ -697,6 +842,12 @@
             self.callback_delete_request_set(None)
 
     def callback_destroy_set(self, func):
+        """Set function to be called when window is destroyed.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._destroy_cb = func
         if func is None:
             ecore_evas_callback_destroy_set(self.obj, NULL)
@@ -704,6 +855,7 @@
             ecore_evas_callback_destroy_set(self.obj, destroy_cb)
 
     def callback_destroy_get(self):
+        "@rtype: callable"
         return self._destroy_cb
 
     property callback_destroy:
@@ -717,6 +869,12 @@
             self.callback_destroy_set(None)
 
     def callback_focus_in_set(self, func):
+        """Set function to be called when window gets focus.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._focus_in_cb = func
         if func is None:
             ecore_evas_callback_focus_in_set(self.obj, NULL)
@@ -724,6 +882,7 @@
             ecore_evas_callback_focus_in_set(self.obj, focus_in_cb)
 
     def callback_focus_in_get(self):
+        "@rtype: callable"
         return self._focus_in_cb
 
     property callback_focus_in:
@@ -737,6 +896,12 @@
             self.callback_focus_in_set(None)
 
     def callback_focus_out_set(self, func):
+        """Set function to be called when window is loses focus.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._focus_out_cb = func
         if func is None:
             ecore_evas_callback_focus_out_set(self.obj, NULL)
@@ -744,6 +909,7 @@
             ecore_evas_callback_focus_out_set(self.obj, focus_out_cb)
 
     def callback_focus_out_get(self):
+        "@rtype: callable"
         return self._focus_out_cb
 
     property callback_focus_out:
@@ -757,6 +923,12 @@
             self.callback_focus_out_set(None)
 
     def callback_sticky_set(self, func):
+        """Set function to be called when window becomes sticky.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._sticky_cb = func
         if func is None:
             ecore_evas_callback_sticky_set(self.obj, NULL)
@@ -764,6 +936,7 @@
             ecore_evas_callback_sticky_set(self.obj, sticky_cb)
 
     def callback_sticky_get(self):
+        "@rtype: callable"
         return self._sticky_cb
 
     property callback_sticky:
@@ -777,6 +950,12 @@
             self.callback_sticky_set(None)
 
     def callback_unsticky_set(self, func):
+        """Set function to be called when window becomes un-sticky.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._unsticky_cb = func
         if func is None:
             ecore_evas_callback_unsticky_set(self.obj, NULL)
@@ -784,6 +963,7 @@
             ecore_evas_callback_unsticky_set(self.obj, unsticky_cb)
 
     def callback_unsticky_get(self):
+        "@rtype: callable"
         return self._unsticky_cb
 
     property callback_unsticky:
@@ -797,6 +977,12 @@
             self.callback_unsticky_set(None)
 
     def callback_mouse_in_set(self, func):
+        """Set function to be called when mouse enters window.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._mouse_in_cb = func
         if func is None:
             ecore_evas_callback_mouse_in_set(self.obj, NULL)
@@ -804,6 +990,7 @@
             ecore_evas_callback_mouse_in_set(self.obj, mouse_in_cb)
 
     def callback_mouse_in_get(self):
+        "@rtype: callable"
         return self._mouse_in_cb
 
     property callback_mouse_in:
@@ -817,6 +1004,12 @@
             self.callback_mouse_in_set(None)
 
     def callback_mouse_out_set(self, func):
+        """Set function to be called when mouse leaves window.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._mouse_out_cb = func
         if func is None:
             ecore_evas_callback_mouse_out_set(self.obj, NULL)
@@ -824,6 +1017,7 @@
             ecore_evas_callback_mouse_out_set(self.obj, mouse_out_cb)
 
     def callback_mouse_out_get(self):
+        "@rtype: callable"
         return self._mouse_out_cb
 
     property callback_mouse_out:
@@ -837,6 +1031,12 @@
             self.callback_mouse_out_set(None)
 
     def callback_pre_render_set(self, func):
+        """Set function to be called before evas is rendered.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._pre_render_cb = func
         if func is None:
             ecore_evas_callback_pre_render_set(self.obj, NULL)
@@ -844,6 +1044,7 @@
             ecore_evas_callback_pre_render_set(self.obj, pre_render_cb)
 
     def callback_pre_render_get(self):
+        "@rtype: callable"
         return self._pre_render_cb
 
     property callback_pre_render:
@@ -857,6 +1058,12 @@
             self.callback_pre_render_set(None)
 
     def callback_post_render_set(self, func):
+        """Set function to be called after evas is rendered.
+
+        Signature: C{function(object)}
+        """
+        if func is not None and not callable(func):
+            raise TypeError("func must be callable or None.")
         self._post_render_cb = func
         if func is None:
             ecore_evas_callback_post_render_set(self.obj, NULL)
@@ -864,6 +1071,7 @@
             ecore_evas_callback_post_render_set(self.obj, post_render_cb)
 
     def callback_post_render_get(self):
+        "@rtype: callable"
         return self._post_render_cb
 
     property callback_post_render:
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas_base_x11.pxi,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore.evas.c_ecore_evas_base_x11.pxi        6 Sep 2007 04:17:49 -0000       
1.1
+++ ecore.evas.c_ecore_evas_base_x11.pxi        1 Oct 2007 05:09:43 -0000       
1.2
@@ -5,9 +5,9 @@
         """Set cursor to one pre-defined shape.
 
         Default value is ECORE_X_CURSOR_X, usual values are:
-         * ECORE_X_CURSOR_ARROW
-         * ECORE_X_CURSOR_CLOCK
-         * ECORE_X_CURSOR_CROSS
+         - ECORE_X_CURSOR_ARROW
+         - ECORE_X_CURSOR_CLOCK
+         - ECORE_X_CURSOR_CROSS
 
         See ecore.x for available symbols.
         """
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas_buffer.pxi,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore.evas.c_ecore_evas_buffer.pxi  3 May 2007 16:13:19 -0000       1.1
+++ ecore.evas.c_ecore_evas_buffer.pxi  1 Oct 2007 05:09:43 -0000       1.2
@@ -1,6 +1,7 @@
 # This file is included verbatim by c_ecore_evas.pyx
 
 cdef class Buffer(EcoreEvas):
+    "Buffer render."
     def __init__(self, int w=320, int h=240):
         cdef Ecore_Evas *obj
 
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas_directfb.pxi,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore.evas.c_ecore_evas_directfb.pxi        3 May 2007 16:13:19 -0000       
1.1
+++ ecore.evas.c_ecore_evas_directfb.pxi        1 Oct 2007 05:09:43 -0000       
1.2
@@ -42,6 +42,7 @@
 
 
 cdef class DirectFB(EcoreEvas):
+    "DirectFB render."
     def __init__(self, char *display=NULL, int windowed=1, int x=0, int y=0,
                  int w=320, int h=240):
         cdef Ecore_Evas *obj
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas_fb.pxi,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- ecore.evas.c_ecore_evas_fb.pxi      3 May 2007 16:13:19 -0000       1.1
+++ ecore.evas.c_ecore_evas_fb.pxi      1 Oct 2007 05:09:43 -0000       1.2
@@ -1,6 +1,7 @@
 # This file is included verbatim by c_ecore_evas.pyx
 
 cdef class FB(EcoreEvas):
+    "Framebuffer window."
     def __init__(self, char *display=NULL, int rotation=0, int w=320,
                  int h=240):
         cdef Ecore_Evas *obj
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas_gl_x11.pxi,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore.evas.c_ecore_evas_gl_x11.pxi  6 Sep 2007 04:17:49 -0000       1.2
+++ ecore.evas.c_ecore_evas_gl_x11.pxi  1 Oct 2007 05:09:43 -0000       1.3
@@ -1,6 +1,12 @@
 # This file is included verbatim by c_ecore_evas.pyx
 
 cdef class GLX11(BaseX11):
+    """X11 window using OpenGL render.
+
+    @ivar window: X11 window id.
+    @ivar subwindow: X11 sub-window id.
+    @ivar direct_resize: if direct resize is enabled or not.
+    """
     def __init__(self, char *display=NULL, long parent_xid=0, int x=0, int y=0,
                  int w=320, int h=240):
         cdef Ecore_Evas *obj
@@ -10,6 +16,10 @@
             self._set_obj(obj)
 
     def window_get(self):
+        """Get X11 window id.
+
+           @rtype: int
+        """
         return ecore_evas_gl_x11_window_get(self.obj)
 
     property window:
@@ -17,6 +27,7 @@
             return self.window_get()
 
     def subwindow_get(self):
+        "@rtype: int"
         return ecore_evas_gl_x11_subwindow_get(self.obj)
 
     property subwindow:
@@ -27,6 +38,7 @@
         ecore_evas_gl_x11_direct_resize_set(self.obj, on)
 
     def direct_resize_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_gl_x11_direct_resize_get(self.obj))
 
     property direct_resize:
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas_software_x11.pxi,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore.evas.c_ecore_evas_software_x11.pxi    6 Sep 2007 04:17:49 -0000       
1.2
+++ ecore.evas.c_ecore_evas_software_x11.pxi    1 Oct 2007 05:09:43 -0000       
1.3
@@ -1,6 +1,12 @@
 # This file is included verbatim by c_ecore_evas.pyx
 
 cdef class SoftwareX11(BaseX11):
+    """X11 window using software render.
+
+    @ivar window: X11 window id.
+    @ivar subwindow: X11 sub-window id.
+    @ivar direct_resize: if direct resize is enabled or not.
+    """
     def __init__(self, char *display=NULL, long parent_xid=0, int x=0, int y=0,
                  int w=320, int h=240):
         cdef Ecore_Evas *obj
@@ -10,6 +16,10 @@
             self._set_obj(obj)
 
     def window_get(self):
+        """Get X11 window id.
+
+           @rtype: int
+        """
         return ecore_evas_software_x11_window_get(self.obj)
 
     property window:
@@ -17,6 +27,7 @@
             return self.window_get()
 
     def subwindow_get(self):
+        "@rtype: int"
         return ecore_evas_software_x11_subwindow_get(self.obj)
 
     property subwindow:
@@ -27,6 +38,7 @@
         ecore_evas_software_x11_direct_resize_set(self.obj, on)
 
     def direct_resize_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_software_x11_direct_resize_get(self.obj))
 
     property direct_resize:
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas_software_x11_16.pxi,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore.evas.c_ecore_evas_software_x11_16.pxi 6 Sep 2007 04:17:49 -0000       
1.2
+++ ecore.evas.c_ecore_evas_software_x11_16.pxi 1 Oct 2007 05:09:43 -0000       
1.3
@@ -1,6 +1,12 @@
 # This file is included verbatim by c_ecore_evas.pyx
 
 cdef class SoftwareX11_16(BaseX11):
+    """X11 window using software render optimized for 16 bits-per-pixel.
+
+    @ivar window: X11 window id.
+    @ivar subwindow: X11 sub-window id.
+    @ivar direct_resize: if direct resize is enabled or not.
+    """
     def __init__(self, char *display=NULL, long parent_xid=0, int x=0, int y=0,
                  int w=320, int h=240):
         cdef Ecore_Evas *obj
@@ -11,6 +17,10 @@
             self._set_obj(obj)
 
     def window_get(self):
+        """Get X11 window id.
+
+           @rtype: int
+        """
         return ecore_evas_software_x11_16_window_get(self.obj)
 
     property window:
@@ -18,6 +28,7 @@
             return self.window_get()
 
     def subwindow_get(self):
+        "@rtype: int"
         return ecore_evas_software_x11_16_subwindow_get(self.obj)
 
     property subwindow:
@@ -28,6 +39,7 @@
         ecore_evas_software_x11_16_direct_resize_set(self.obj, on)
 
     def direct_resize_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_software_x11_16_direct_resize_get(self.obj))
 
     property direct_resize:
===================================================================
RCS file: 
/cvs/e/e17/proto/python-efl/python-ecore/ecore/evas/ecore.evas.c_ecore_evas_xrender_x11.pxi,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ecore.evas.c_ecore_evas_xrender_x11.pxi     6 Sep 2007 04:17:49 -0000       
1.2
+++ ecore.evas.c_ecore_evas_xrender_x11.pxi     1 Oct 2007 05:09:43 -0000       
1.3
@@ -1,6 +1,12 @@
 # This file is included verbatim by c_ecore_evas.pyx
 
 cdef class XRenderX11(BaseX11):
+    """X11 window using XRender.
+
+    @ivar window: X11 window id.
+    @ivar subwindow: X11 sub-window id.
+    @ivar direct_resize: if direct resize is enabled or not.
+    """
     def __init__(self, char *display=NULL, long parent_xid=0, int x=0, int y=0,
                  int w=320, int h=240):
         cdef Ecore_Evas *obj
@@ -10,6 +16,10 @@
             self._set_obj(obj)
 
     def window_get(self):
+        """Get X11 window id.
+
+           @rtype: int
+        """
         return ecore_evas_xrender_x11_window_get(self.obj)
 
     property window:
@@ -17,6 +27,7 @@
             return self.window_get()
 
     def subwindow_get(self):
+        "@rtype: int"
         return ecore_evas_xrender_x11_subwindow_get(self.obj)
 
     property subwindow:
@@ -27,6 +38,7 @@
         ecore_evas_xrender_x11_direct_resize_set(self.obj, on)
 
     def direct_resize_get(self):
+        "@rtype: bool"
         return bool(ecore_evas_xrender_x11_direct_resize_get(self.obj))
 
     property direct_resize:



-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs

Reply via email to