Enlightenment CVS committal
Author : raster
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore_evas
Modified Files:
ecore_evas.c
Log Message:
documentation from brett... tiler can compiler again.
===================================================================
RCS file: /cvs/e/e17/libs/ecore/src/lib/ecore_evas/ecore_evas.c,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -3 -r1.31 -r1.32
--- ecore_evas.c 7 Apr 2007 13:19:18 -0000 1.31
+++ ecore_evas.c 4 Jun 2007 09:48:27 -0000 1.32
@@ -111,7 +111,7 @@
}
/**
- * Return the Ecore_Evase for this Evas
+ * Return the Ecore_Evas for this Evas
*
* @param e The Evas to get the Ecore_Evas from
* @return The Ecore_Evas that holds this Evas
@@ -141,6 +141,19 @@
return;
}
+/**
+ * Retrieve user data associated with an Ecore_Evas.
+ * @param ee The Ecore_Evas to retrieve the user data from.
+ * @param key The key which the user data to be retrieved is associated with.
+ *
+ * This function retrieves user specific data that has been stored within an
+ * Ecore_Evas structure with ecore_evas_data_set().
+ *
+ * @returns NULL on error or no data found, A pointer to the user data on
+ * success.
+ *
+ * @see ecore_evas_data_set
+ */
EAPI void *
ecore_evas_data_get(Ecore_Evas *ee, const char *key)
{
@@ -156,6 +169,21 @@
return evas_hash_find(ee->data, key);
}
+/**
+ * Store user data in an Ecore_Evas structure.
+ *
+ * @param eeThe Ecore_Evas to store the user data in.
+ * @param keyA unique string to associate the user data against. Cannot
+ * be NULL.
+ * @param dataA pointer to the user data to store.
+ *
+ * This function associates the @p data with a @p key which is stored by
+ * the Ecore_Evas @p ee. Be aware that a call to ecore_evas_free() will
+ * not free any memory for the associated user data, this is the responsibility
+ * of the caller.
+ *
+ * @see ecore_evas_free
+ */
EAPI void
ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data)
{
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
