Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/evas
Dir : e17/libs/evas/src/lib/canvas
Modified Files:
evas_object_gradient.c evas_object_image.c evas_object_text.c
Log Message:
Some new docs, some cleanup, some more groups.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_object_gradient.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- evas_object_gradient.c 18 Oct 2003 03:34:00 -0000 1.4
+++ evas_object_gradient.c 12 Aug 2004 12:13:59 -0000 1.5
@@ -56,10 +56,18 @@
/* it has no other api calls as all properties are standard */
/**
- * To be documented.
+ * @defgroup Evas_Object_Gradient_Group Evas Gradient Object Functions
*
- * FIXME: To be fixed.
- *
+ * Functions that work on evas gradient objects.
+ *
+ * The following example shows how
+ */
+
+/**
+ * Adds a gradient object to the given evas.
+ * @param e The given evas.
+ * @return A new evas gradient object if successful. Otherwise, @c NULL.
+ * @ingroup Evas_Object_Gradient_Group
*/
Evas_Object *
evas_object_gradient_add(Evas *e)
@@ -76,10 +84,23 @@
}
/**
- * To be documented.
+ * Adds a colour to the given evas gradient object.
+ *
+ * The @p distance parameter determines the proportion of the gradient
+ * object that is to be set to this colour. For instance, if red is
+ * added with @p distance set to 2, and green is added with @p
+ * distance set to 1, two-thirds will be red or reddish and one-third
+ * will be green or greenish.
*
- * FIXME: To be fixed.
- *
+ * Colours are added from the top downwards.
+ *
+ * @param obj The given evas gradient object.
+ * @param r Red component of the given colour.
+ * @param g Green component of the given colour.
+ * @param b Blue component of the given colour.
+ * @param a Alpha component of the given colour.
+ * @param distance Proportion of the gradient object that is this colour.
+ * @ingroup Evas_Object_Gradient_Group
*/
void
evas_object_gradient_color_add(Evas_Object *obj, int r, int g, int b, int a, int
distance)
@@ -104,10 +125,8 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Deletes all colours set for the given evas gradient object.
+ * @param obj The given evas gradient object.
*/
void
evas_object_gradient_colors_clear(Evas_Object *obj)
@@ -130,10 +149,11 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Sets the angle at which the given evas gradient object sits clockwise
+ * from vertical.
+ * @param obj The given evas gradient object.
+ * @param angle Angle in degrees. Can be negative.
+ * @ingroup Evas_Object_Gradient
*/
void
evas_object_gradient_angle_set(Evas_Object *obj, Evas_Angle angle)
@@ -154,10 +174,11 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Retrieves the angle at which the given evas gradient object sits
+ * clockwise from the vertical.
+ * @param obj The given evas gradient object.
+ * @return The current angle if successful. @c 0.0 otherwise.
+ * @ingroup Evas_Object_Gradient
*/
Evas_Angle
evas_object_gradient_angle_get(Evas_Object *obj)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_object_image.c,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -3 -r1.15 -r1.16
--- evas_object_image.c 1 Aug 2004 12:34:19 -0000 1.15
+++ evas_object_image.c 12 Aug 2004 12:14:00 -0000 1.16
@@ -106,11 +106,17 @@
}
/**
+ * @defgroup Evas_Object_Image_File_Group Image Object File Functions
+ *
+ * Functions that write to or retrieve images from files.
+ */
+
+/**
* Sets the image displayed by the given image object.
* @param obj The given image object.
* @param file Name of the file that the image exists in.
* @param key Can be NULL.
- * @ingroup Evas_Object_Image
+ * @ingroup Evas_Object_Image_File_Group
*/
void
evas_object_image_file_set(Evas_Object *obj, const char *file, const char *key)
@@ -176,7 +182,7 @@
* name in.
* @param key Pointer to a character pointer to store the pointer to the key
* string in.
- * @ingroup Evas_Object_Image
+ * @ingroup Evas_Object_Image_File_Group
*/
void
evas_object_image_file_get(Evas_Object *obj, char **file, char **key)
@@ -199,6 +205,12 @@
}
/**
+ * @defgroup Evas_Object_Image_Border_Group Image Object Border Functions
+ *
+ * Functions that adjust the unscaled image border of image objects.
+ */
+
+/**
* Sets how much of each border of the given evas image object is not
* to be scaled.
*
@@ -215,7 +227,7 @@
* @param r Distance of the right border that is not to be stretched.
* @param t Distance of the top border that is not to be stretched.
* @param b Distance of the bottom border that is not to be stretched.
- * @ingroup Evas_Object_Image
+ * @ingroup Evas_Object_Image_Border_Group
*/
void
evas_object_image_border_set(Evas_Object *obj, int l, int r, int t, int b)
@@ -259,7 +271,7 @@
* @param r Pointer to an integer to store the right border width in.
* @param t Pointer to an integer to store the top border width in.
* @param b Pointer to an integer to store the bottom border width in.
- * @ingroup Evas_Object_Image
+ * @ingroup Evas_Object_Image_Border_Group
*/
void
evas_object_image_border_get(Evas_Object *obj, int *l, int *r, int *t, int *b)
@@ -288,6 +300,13 @@
}
/**
+ * @defgroup Evas_Object_Image_Fill_Group Image Object Fill Rectangle Functions
+ *
+ * Functions that deal with what areas of the image object are to be
+ * tiled with the given image.
+ */
+
+/**
* Sets the rectangle on the image object that the image will be drawn
* to.
*
@@ -299,11 +318,12 @@
* The default values for the fill parameters is @p x = 0, @p y = 0,
* @p w = 32 and @p h = 32.
*
- * @param obj The given evas image object.
- * @param x The X coordinate for the top left corner of the image.
- * @param y The Y coordinate for the top left corner of the image.
- * @param w The width of the image.
- * @param h The height of the image.
+ * @param obj The given evas image object.
+ * @param x The X coordinate for the top left corner of the image.
+ * @param y The Y coordinate for the top left corner of the image.
+ * @param w The width of the image.
+ * @param h The height of the image.
+ * @ingroup Evas_Object_Image_Fill_Group
*/
void
evas_object_image_fill_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord
w, Evas_Coord h)
@@ -339,11 +359,12 @@
*
* See @ref evas_object_image_fill_set for more details.
*
- * @param obj The given evas image object.
- * @param x Pointer to an integer to store the X coordinate in.
- * @param y Pointer to an integer to store the Y coordinate in.
- * @param w Pointer to an integer to store the width in.
- * @param h Pointer to an integer to store the height in.
+ * @param obj The given evas image object.
+ * @param x Pointer to an integer to store the X coordinate in.
+ * @param y Pointer to an integer to store the Y coordinate in.
+ * @param w Pointer to an integer to store the width in.
+ * @param h Pointer to an integer to store the height in.
+ * @ingroup Evas_Object_Image_Fill_Group
*/
void
evas_object_image_fill_get(Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord
*w, Evas_Coord *h)
@@ -372,10 +393,24 @@
}
/**
- * To be documented.
+ * @defgroup Evas_Object_Image_Size Image Object Image Size Functions
*
- * FIXME: To be fixed.
- *
+ * Functions that change the size of the image used by an image object.
+ */
+
+/**
+ * Sets the size of the image to be display by the given image object.
+ *
+ * This function will scale down or crop the image so that it is
+ * treated as if it were at the given size. If the size given is
+ * smaller than the image, it will be cropped. If the size given is
+ * larger, then the image will be treated as if it were in the upper
+ * left hand corner of a larger image that is otherwise transparent.
+ *
+ * @param obj The given image object.
+ * @param w The new width.
+ * @param h The new height.
+ * @ingroup Evas_Object_Image_Size
*/
void
evas_object_image_size_set(Evas_Object *obj, int w, int h)
@@ -415,11 +450,12 @@
/**
* Retrieves the size of the image displayed by the given image object.
- * @param obj The given image object.
- * @param w A pointer to an integer in which to store the width. Can be
- * @c NULL.
- * @param h A pointer to an integer in which to store the height. Can be
- * @c NULL.
+ * @param obj The given image object.
+ * @param w A pointer to an integer in which to store the width. Can be
+ * @c NULL.
+ * @param h A pointer to an integer in which to store the height. Can be
+ * @c NULL.
+ * @ingroup Evas_Object_Image_Size
*/
void
evas_object_image_size_get(Evas_Object *obj, int *w, int *h)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/evas/src/lib/canvas/evas_object_text.c,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -3 -r1.25 -r1.26
--- evas_object_text.c 14 Jun 2004 06:04:22 -0000 1.25
+++ evas_object_text.c 12 Aug 2004 12:14:00 -0000 1.26
@@ -745,10 +745,9 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Sets the text to be displayed by the given evas text object.
+ * @param obj Evas text object.
+ * @param text Text to display.
*/
void
evas_object_text_text_set(Evas_Object *obj, const char *text)
@@ -805,10 +804,9 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Retrieves the text currently being displayed by the given evas text object.
+ * @param obj The given evas text object.
+ * @return The text currently being displayed. Do not free it.
*/
const char *
evas_object_text_text_get(Evas_Object *obj)
@@ -1096,13 +1094,16 @@
}
-
-
/**
- * To be documented.
+ * @defgroup Evas_Font_Path_Group Font Path Functions
*
- * FIXME: To be fixed.
- *
+ * Functions that edit the paths being used to load fonts.
+ */
+
+/**
+ * Removes all font paths loaded into memory for the given evas.
+ * @param e The given evas.
+ * @ingroup Evas_Font_Path_Group
*/
void
evas_font_path_clear(Evas *e)
@@ -1118,10 +1119,10 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Appends a font path to the list of font paths used by the given evas.
+ * @param e The given evas.
+ * @param path The new font path.
+ * @ingroup Evas_Font_Path_Group
*/
void
evas_font_path_append(Evas *e, const char *path)
@@ -1134,10 +1135,10 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Prepends a font path to the list of font paths used by the given evas.
+ * @param e The given evas.
+ * @param path The new font path.
+ * @ingroup Evas_Font_Path_Group
*/
void
evas_font_path_prepend(Evas *e, const char *path)
@@ -1150,10 +1151,10 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
- *
+ * Retrieves the list of font paths used by the given evas.
+ * @param e The given evas.
+ * @return The list of font paths used.
+ * @ingroup Evas_Font_Path_Group
*/
const Evas_List *
evas_font_path_list(Evas *e)
-------------------------------------------------------
SF.Net email is sponsored by Shop4tech.com-Lowest price on Blank Media
100pk Sonic DVD-R 4x for only $29 -100pk Sonic DVD+R for only $33
Save 50% off Retail on Ink & Toner - Free Shipping and Free Gift.
http://www.shop4tech.com/z/Inkjet_Cartridges/9_108_r285
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs