Enlightenment CVS committal
Author : moom
Project : e17
Module : proto
Dir : e17/proto/etk/src/lib
Modified Files:
etk_image.c
Log Message:
* [Etk_Image] Update the docs of the properties
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_image.c,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -3 -r1.29 -r1.30
--- etk_image.c 30 Dec 2006 14:27:13 -0000 1.29
+++ etk_image.c 30 Dec 2006 14:42:00 -0000 1.30
@@ -985,43 +985,48 @@
* - Etk_Image
*
* \par Properties:
- * @prop_name "image_file": The image file (.png, .jpg, ...) which the image
is loaded from.
- * Set to NULL if the image is loaded from an edje file (.edj)
- * @prop_type String (char *)
- * @prop_rw
- * @prop_val NULL
+ * @prop_name "source": The source of the image (file, edje, stock, Evas
object or pixel data)
+ * @prop_type Integer (Etk_Image_Source)
+ * @prop_ro
+ * @prop_val ETK_IMAGE_FILE
* \par
- * @prop_name "edje_file": The edje file (.edj) which the image is loaded from.
- * Set to NULL if the image is loaded from an image file (.png, .jpg, ...)
+ * @prop_name "file": The path of the loaded file (path to the image-file or
to the edje-file, or NULL if the image is
+ * not loaded from a file)
* @prop_type String (char *)
* @prop_rw
* @prop_val NULL
* \par
- * @prop_name "edje_group": The edje group of the image.
- * Set to NULL if the image is loaded from an image file (.png, .jpg, ...)
+ * @prop_name "key": The name of the loaded key: it corresponds to the loaded
edje-group if the image is loaded from an
+ * Edje-file, or to the key corresponding to the image if it is loaded from an
Eet-file. Otherwise it is set to NULL
* @prop_type String (char *)
* @prop_rw
* @prop_val NULL
* \par
- * @prop_name "keep_aspect": Whether of not the image keeps its aspect ratio
when it is resized
- * @prop_type Boolean
- * @prop_rw
- * @prop_val ETK_TRUE
- * \par
- * @prop_name "use_edje": Whether of not the image is loaded from an edje file
(.edj)
- * @prop_type Boolean
- * @prop_ro
- * @prop_val ETK_FALSE
- * \par
* @prop_name "stock_id": The stock ID used by the image.
- * Set to ETK_STOCK_NO_STOCK if the image is not loaded from a stock icon
+ * It is set to ETK_STOCK_NO_STOCK if the image is not a stock-icon
* @prop_type Integer
* @prop_rw
* @prop_val ETK_STOCK_NO_STOCK
* \par
- * @prop_name "stock_size": The size of the stock icon used by the image.
- * Set to a random value if the image is not loaded from a stock icon
+ * @prop_name "stock_size": The size of the stock-icon used by the image.
+ * It is set to ETK_STOCK_MEDIUM if the image is not a stock-icon
* @prop_type Integer
* @prop_rw
* @prop_val ETK_STOCK_MEDIUM
+ * \par
+ * @prop_name "evas_object": A pointer to the Evas object corresponding to the
image. You must be careful if you
+ * manipulate it directly (do not call an Edje function on an Evas image
object)
+ * @prop_type Pointer (Evas_Object *)
+ * @prop_rw
+ * @prop_val NULL
+ * \par
+ * @prop_name "keep_aspect": Whether of not the image keeps its aspect ratio
when it is resized
+ * @prop_type Boolean
+ * @prop_rw
+ * @prop_val ETK_TRUE
+ * \par
+ * @prop_name "aspect_ratio": The aspect-ratio of the image. If it is set to
0.0, Etk calculates it automatically
+ * @prop_type Double
+ * @prop_rw
+ * @prop_val 0.0
*/
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
