Just some more docs. A few todos inserted, to be fixed soon.

SVN revision: 11330
This commit is contained in:
ncn 2004-08-23 23:04:34 +00:00 committed by ncn
parent 08e7335c1c
commit c7b724474c
5 changed files with 62 additions and 21 deletions

View File

@ -192,6 +192,17 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
evas_object_event_callback_call(obj->smart.parent, type, event_info);
}
/**
* @defgroup Evas_Object_Callback_Group Object Callback Functions
*
* Functions that add and remove callbacks to evas objects.
*/
/**
* @todo Move this next code example and most of the documentation for
* this next function into the group documentation.
*/
/**
* Add a callback function to an object
* @param obj Object to attach a callback to
@ -347,6 +358,7 @@ evas_object_event_callback_call(Evas_Object *obj, Evas_Callback_Type type, void
* exit(-1);
* }
* @endcode
* @ingroup Evas_Object_Callback_Group
*/
void
evas_object_event_callback_add(Evas_Object *obj, Evas_Callback_Type type, void (*func) (void *data, Evas *e, Evas_Object *obj, void *event_info), const void *data)
@ -453,6 +465,7 @@ evas_object_event_callback_add(Evas_Object *obj, Evas_Callback_Type type, void (
*
* my_data = evas_object_event_callback_del(object, EVAS_CALLBACK_MOUSE_UP, up_callback);
* @endcode
* @ingroup Evas_Object_Callback_Group
*/
void *
evas_object_event_callback_del(Evas_Object *obj, Evas_Callback_Type type, void (*func) (void *data, Evas *e, Evas_Object *obj, void *event_info))

View File

@ -2,6 +2,13 @@
#include "evas_private.h"
#include "Evas.h"
/**
* @defgroup Evas_Object_Data_Group Object Data Functions
*
* Functions that retrieve and set data associated attached to an evas
* object.
*/
/**
* Set an attached data pointer to an object with a given string key.
* @param obj The object to attach the data pointer to
@ -32,6 +39,7 @@
* evas_object_data_set(obj, "name_of_data", my_data);
* printf("The data that was attached was %p\n", evas_object_data_get(obj, "name_of_data"));
* @endcode
* @ingroup Evas_Object_Data_Group
*/
void
evas_object_data_set(Evas_Object *obj, const char *key, const void *data)
@ -75,6 +83,8 @@ evas_object_data_set(Evas_Object *obj, const char *key, const void *data)
* my_data = evas_object_data_get(obj, "name_of_my_data");
* if (my_data) printf("Data stored was %p\n", my_data);
* else printf("No data was stored on the object\n");
* @endcode
* @ingroup Evas_Object_Data_Group
*/
void *
evas_object_data_get(Evas_Object *obj, const char *key)
@ -119,6 +129,7 @@ evas_object_data_get(Evas_Object *obj, const char *key)
*
* my_data = evas_object_data_del(obj, "name_of_my_data");
* @endcode
* @ingroup Evas_Object_Data_Group
*/
void *
evas_object_data_del(Evas_Object *obj, const char *key)

View File

@ -119,10 +119,18 @@ evas_layer_del(Evas_Layer *lay)
/* public functions */
/**
* To be documented.
* @defgroup Evas_Object_Layer_Group Object Layer Functions
*
* FIXME: To be fixed.
* Functions that retrieve and set the layer that an evas object is on.
*
* @todo Document which way layers go.
*/
/**
* Sets the layer of the evas that the given object will be part of.
* @param obj The given evas object.
* @param l The number of the layer to place the object on.
* @ingroup Evas_Object_Layer_Group
*/
void
evas_object_layer_set(Evas_Object *obj, int l)
@ -167,10 +175,10 @@ evas_object_layer_set(Evas_Object *obj, int l)
}
/**
* To be documented.
*
* FIXME: To be fixed.
*
* Retrieves the layer of the evas that the given object is part of.
* @param obj The given evas object.
* @return Number of the layer.
* @ingroup Evas_Object_Layer_Group
*/
int
evas_object_layer_get(Evas_Object *obj)

View File

@ -3,10 +3,16 @@
#include "Evas.h"
/**
* To be documented.
* @defgroup Evas_Object_Name_Group Object Name Function
*
* FIXME: To be fixed.
*
* Functions that retrieve and set the name of an evas object.
*/
/**
* Sets the name of the given evas object to the given name.
* @param obj The given object.
* @param name The given name.
* @ingroup Evas_Object_Name_Group
*/
void
evas_object_name_set(Evas_Object *obj, const char *name)
@ -28,10 +34,11 @@ evas_object_name_set(Evas_Object *obj, const char *name)
}
/**
* To be documented.
*
* FIXME: To be fixed.
*
* Retrieves the name of the given evas object.
* @param obj The given object.
* @return The name of the object. @c NULL if no name has been given
* to the object.
* @ingroup Evas_Object_Name_Group
*/
const char *
evas_object_name_get(Evas_Object *obj)
@ -43,10 +50,12 @@ evas_object_name_get(Evas_Object *obj)
}
/**
* To be documented.
*
* FIXME: To be fixed.
*
* Retrieves the object on the given evas with the given name.
* @param e The given evas.
* @param name The given name.
* @return If successful, the evas object with the given name. Otherwise,
* @c NULL.
* @ingroup Evas_Object_Name_Group
*/
Evas_Object *
evas_object_name_find(Evas *e, const char *name)

View File

@ -56,10 +56,10 @@ static Evas_Object_Func object_func =
/* it has no other api calls as all properties are standard */
/**
* To be documented.
*
* FIXME: To be fixed.
*
* Adds a rectangle to the given evas.
* @param e The given evas.
* @return The new rectangle object.
* @todo Find a documentation group to put this under.
*/
Evas_Object *
evas_object_rectangle_add(Evas *e)