Documentation arrived.
[ruby-evas.git] / src / rb_evas_object.c
index 98a05fbc839841df7f30d7537bdadcd53b68caf7..e465bfc4dc7520de75937680ad3e8310491ced2f 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * $Id: rb_evas_object.c 49 2004-08-01 10:17:39Z tilman $
+ * $Id: rb_evas_object.c 58 2004-08-10 14:10:02Z tilman $
  *
  * Copyright (C) 2004 Tilman Sauerbeck (tilman at code-monkey de)
  *
@@ -45,6 +45,7 @@ void c_evas_object_free (RbEvasObject *e, bool free_mem)
                free (e);
 }
 
+/* :nodoc: */
 static VALUE c_init (VALUE self, VALUE parent)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -56,11 +57,18 @@ static VALUE c_init (VALUE self, VALUE parent)
        return self;
 }
 
+/* :nodoc: */
 static VALUE c_inspect (VALUE self)
 {
        INSPECT (self, RbEvasObject);
 }
 
+/*
+ * call-seq:
+ *  e.delete => nil
+ *
+ * Deletes <i>e</i>.
+ */
 static VALUE c_delete (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -71,6 +79,14 @@ static VALUE c_delete (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.resize(width, height) => nil
+ *
+ * Resizes <i>e</i> to width x height.
+ *
+ *  e.resize(100, 200) #=> nil
+ */
 static VALUE c_resize (VALUE self, VALUE w, VALUE h)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -84,6 +100,15 @@ static VALUE c_resize (VALUE self, VALUE w, VALUE h)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.move(x, y) => nil
+ *
+ * Moves <i>e</i> to the coordinates specified in
+ * <i>x</i> and <i>y</i>.
+ *
+ *  e.move(100, 200) #=> nil
+ */
 static VALUE c_move (VALUE self, VALUE x, VALUE y)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -97,6 +122,16 @@ static VALUE c_move (VALUE self, VALUE x, VALUE y)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.geometry => array
+ *
+ * Returns an array containing the geometry of <i>e</i>.
+ *
+ *  e.move(150, 300)   #=> nil
+ *  e.resize(200, 200) #=> nil
+ *  e.geometry         #=> [150, 300, 200, 200]
+ */
 static VALUE c_geometry_get (VALUE self)
 {
        int x = 0, y = 0, w = 0, h = 0;
@@ -111,6 +146,12 @@ static VALUE c_geometry_get (VALUE self)
                            INT2FIX (h));
 }
 
+/*
+ * call-seq:
+ *  e.show => nil
+ *
+ * Shows <i>e</i>.
+ */
 static VALUE c_show (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -120,6 +161,12 @@ static VALUE c_show (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.hide => nil
+ *
+ * Hides <i>e</i>.
+ */
 static VALUE c_hide (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -129,6 +176,12 @@ static VALUE c_hide (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.visible? => true or false
+ *
+ * Returns true if <i>e</i> is visible, else false.
+ */
 static VALUE c_visible_get (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -136,6 +189,12 @@ static VALUE c_visible_get (VALUE self)
        return evas_object_visible_get (e->real) ? Qtrue : Qfalse;
 }
 
+/*
+ * call-seq:
+ *  e.evas => evas
+ *
+ * Returns the <code>Evas::Evas</code> for <i>e</i>.
+ */
 static VALUE c_evas_get (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -143,6 +202,12 @@ static VALUE c_evas_get (VALUE self)
        return e->parent;
 }
 
+/*
+ * call-seq:
+ *  e.name => string
+ *
+ * Returns the name of <i>e</i>.
+ */
 static VALUE c_name_get (VALUE self)
 {
        const char *name;
@@ -155,6 +220,12 @@ static VALUE c_name_get (VALUE self)
                return rb_str_new2 (name);
 }
 
+/*
+ * call-seq:
+ *  e.name(string)
+ *
+ * Sets the name of <i>e</i>.
+ */
 static VALUE c_name_set (VALUE self, VALUE val)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -166,6 +237,12 @@ static VALUE c_name_set (VALUE self, VALUE val)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.layer => fixnum
+ *
+ * Returns the layer <i>e</i> is in.
+ */
 static VALUE c_layer_get (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -173,6 +250,12 @@ static VALUE c_layer_get (VALUE self)
        return INT2FIX (evas_object_layer_get (e->real));
 }
 
+/*
+ * call-seq:
+ *  e.layer(fixnum)
+ *
+ * Sets the layer <i>e</i> is in.
+ */
 static VALUE c_layer_set (VALUE self, VALUE val)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -184,6 +267,15 @@ static VALUE c_layer_set (VALUE self, VALUE val)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.get_color => array
+ *
+ * Returns the color of <i>e</i>.
+ *
+ *  e.set_color(128, 128, 128, 0) #=> nil
+ *  e.get_color                   #=> [128, 128, 128, 0]
+ */
 static VALUE c_get_color (VALUE self)
 {
        int r = 0, g = 0, b = 0, a = 0;
@@ -196,6 +288,14 @@ static VALUE c_get_color (VALUE self)
                            INT2FIX (a));
 }
 
+/*
+ * call-seq:
+ *  e.set_color(r, g, b, a) => nil
+ *
+ * Sets the color of <i>e</i>.
+ *
+ *  e.set_color(128, 128, 128, 0) #=> nil
+ */
 static VALUE c_set_color (VALUE self, VALUE r, VALUE g, VALUE b,
                           VALUE a)
 {
@@ -212,6 +312,13 @@ static VALUE c_set_color (VALUE self, VALUE r, VALUE g, VALUE b,
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.pass_events? => true or false
+ *
+ * Returns true if <i>e</i> passes events on to EvasObjects that are
+ * below itself, else false.
+ */
 static VALUE c_pass_events_get (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -219,6 +326,13 @@ static VALUE c_pass_events_get (VALUE self)
        return evas_object_pass_events_get (e->real) ? Qtrue : Qfalse;
 }
 
+/*
+ * call-seq:
+ *  e.pass_events(true or false)
+ *
+ * Sets whether <i>e</i> passes events on to EvasObjects that are
+ * below itself.
+ */
 static VALUE c_pass_events_set (VALUE self, VALUE val)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -230,6 +344,12 @@ static VALUE c_pass_events_set (VALUE self, VALUE val)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *   e.raise => nil
+ *
+ * Raises <i>e</i>.
+ */
 static VALUE c_raise (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -239,6 +359,12 @@ static VALUE c_raise (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.lower => nil
+ *
+ * Lowers <i>e</i>.
+ */
 static VALUE c_lower (VALUE self)
 {
        GET_OBJ (self, RbEvasObject, e);
@@ -248,17 +374,17 @@ static VALUE c_lower (VALUE self)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.stack_above(evasobject) => nil
+ *
+ * Positions <i>e</i> above <i>evasobject</i>.
+ */
 static VALUE c_stack_above (VALUE self, VALUE target)
 {
        GET_OBJ (self, RbEvasObject, e);
 
-       if (!rb_obj_is_kind_of (target, cEvasObject)) {
-               rb_raise (rb_eTypeError,
-                         "wrong argument type %s (expected EvasObject)",
-                         rb_obj_classname (target));
-               return Qnil;
-       }
-
+       CHECK_CLASS (target, cEvasObject);
        GET_OBJ (target, RbEvasObject, t);
 
        evas_object_stack_above (e->real, t->real);
@@ -266,17 +392,17 @@ static VALUE c_stack_above (VALUE self, VALUE target)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.stack_below(evasobject) => nil
+ *
+ * Positions <i>e</i> below <i>evasobject</i>.
+ */
 static VALUE c_stack_below (VALUE self, VALUE target)
 {
        GET_OBJ (self, RbEvasObject, e);
 
-       if (!rb_obj_is_kind_of (target, cEvasObject)) {
-               rb_raise (rb_eTypeError,
-                         "wrong argument type %s (expected EvasObject)",
-                         rb_obj_classname (target));
-               return Qnil;
-       }
-
+       CHECK_CLASS (target, cEvasObject);
        GET_OBJ (target, RbEvasObject, t);
 
        evas_object_stack_below (e->real, t->real);
@@ -284,6 +410,13 @@ static VALUE c_stack_below (VALUE self, VALUE target)
        return Qnil;
 }
 
+/*
+ * call-seq:
+ *  e.above => evasobject
+ *
+ * Returns the <code>Evas::EvasObject</code> that's positioned above
+ * <i>e</i>.
+ */
 static VALUE c_above_get (VALUE self)
 {
        Evas_Object *o;
@@ -302,6 +435,13 @@ static VALUE c_above_get (VALUE self)
        return (VALUE) obj;
 }
 
+/*
+ * call-seq:
+ *  e.below => evasobject
+ *
+ * Returns the <code>Evas::EvasObject</code> that's positioned below
+ * <i>e</i>.
+ */
 static VALUE c_below_get (VALUE self)
 {
        Evas_Object *o;