Enlightenment CVS committal
Author : dj2
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/lib
Modified Files:
ewl_object.h ewl_tree2.c
Log Message:
- documentation
===================================================================
RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_object.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -3 -r1.10 -r1.11
--- ewl_object.h 11 May 2006 04:01:20 -0000 1.10
+++ ewl_object.h 20 May 2006 08:14:54 -0000 1.11
@@ -260,43 +260,158 @@
#define ewl_object_state_get(o, state) \
ewl_object_flags_get(o, state, EWL_FLAGS_STATE_MASK)
+/**
+ * @def ewl_object_queued_add(o, queued)
+ * @param o: The object to work with
+ * @param queued: Add the given queue flag to the object
+ * Adds the given queue flag @a queued to the object @a o
+ */
#define ewl_object_queued_add(o, queued) \
ewl_object_flags_add(o, queued, EWL_FLAGS_QUEUED_MASK)
+
+/**
+ * @def ewl_object_queued_remove(o, queued)
+ * Remove the @a queued flag from the @a o object
+ */
#define ewl_object_queued_remove(o, queued) \
ewl_object_flags_remove(o, queued, EWL_FLAGS_QUEUED_MASK)
+
+/**
+ * @def ewl_object_queued_has(o, queued)
+ * Determine if the @a o object has the @a queued flag set
+ */
#define ewl_object_queued_has(o, queued) \
ewl_object_flags_has(o, queued, EWL_FLAGS_QUEUED_MASK)
+
+/**
+ * @def ewl_object_queued_get(o, queued)
+ * Retrieve the value for the @a queued queue flag
+ */
#define ewl_object_queued_get(o, queued) \
ewl_object_flags_get(o, queued, EWL_FLAGS_QUEUED_MASK)
+/**
+ * @def ewl_object_visible_add(o, visible)
+ * Add the @a visible flag to the object @a o
+ */
#define ewl_object_visible_add(o, visible) \
ewl_object_flags_add(o, visible, EWL_FLAGS_VISIBLE_MASK)
+
+/**
+ * @def ewl_object_visible_remove(o, visible)
+ * Remove the @a visible flag from the object @a o
+ */
#define ewl_object_visible_remove(o, visible) \
ewl_object_flags_remove(o, visible, EWL_FLAGS_VISIBLE_MASK)
+
+/**
+ * @def ewl_object_visible_has(o, visible)
+ * Check if the @a visible flag is set in the object @a o
+ */
#define ewl_object_visible_has(o, visible) \
ewl_object_flags_has(o, visible, EWL_FLAGS_VISIBLE_MASK)
+
+/**
+ * @def ewl_object_visible_get(o, visible)
+ * Retrieves the @a visble flag from the object @a o
+ */
#define ewl_object_visible_get(o, visible) \
ewl_object_flags_get(o, visible, EWL_FLAGS_VISIBLE_MASK)
+/**
+ * @def PADDING_TOP(o)
+ * Retrieve the size of the top pad
+ */
#define PADDING_TOP(o) EWL_OBJECT(o)->pad.t
+
+/**
+ * @def PADDING_BOTTOM(o)
+ * Retrieve the size of the bottom pad
+ */
#define PADDING_BOTTOM(o) EWL_OBJECT(o)->pad.b
+
+/**
+ * @def PADDING_LEFT(o)
+ * Retrieve the size of the left pad
+ */
#define PADDING_LEFT(o) EWL_OBJECT(o)->pad.l
+
+/**
+ * @def PADDING_RIGHT(o)
+ * Retrieve the size of the right pad
+ */
#define PADDING_RIGHT(o) EWL_OBJECT(o)->pad.r
+/**
+ * @def PADDING_HORIZONTAL(o)
+ * Retrieve the total size of the horizontal padding
+ */
#define PADDING_HORIZONTAL(o) (EWL_OBJECT(o)->pad.l + EWL_OBJECT(o)->pad.r)
+
+/**
+ * @def PADDING_VERTICAL(o)
+ * Retrieve the total size of the vertical padding
+ */
#define PADDING_VERTICAL(o) (EWL_OBJECT(o)->pad.t + EWL_OBJECT(o)->pad.b)
+/**
+ * @def INSET_LEFT(o)
+ * Retrieve the size of the left inset
+ */
#define INSET_LEFT(o) EWL_OBJECT(o)->insets.l
+
+/**
+ * @def INSET_RIGHT(o)
+ * Retrieve the size of the right inset
+ */
#define INSET_RIGHT(o) EWL_OBJECT(o)->insets.r
+
+/**
+ * @def INSET_TOP(o)
+ * Retrieve the size of the top inset
+ */
#define INSET_TOP(o) EWL_OBJECT(o)->insets.t
+
+/**
+ * @def INSET_BOTTOM(o)
+ * Retrieve the size of the bottom inset
+ */
#define INSET_BOTTOM(o) EWL_OBJECT(o)->insets.b
+/**
+ * @def INSET_HORIZONTAL(o)
+ * Retrieve the total size of the horizontal insets for the object
+ */
#define INSET_HORIZONTAL(o) (EWL_OBJECT(o)->insets.l + EWL_OBJECT(o)->insets.r)
+
+/**
+ * @def INSET_VERTICAL(o)
+ * Retrieve the total size of the vertical insets for the object
+ */
#define INSET_VERTICAL(o) (EWL_OBJECT(o)->insets.t + EWL_OBJECT(o)->insets.b)
+/**
+ * @def CURRENT_X(o)
+ * Retrieve the current x position of the object
+ */
#define CURRENT_X(o) EWL_OBJECT(o)->current.x
+
+/**
+ * @def CURRENT_Y(o)
+ * Retrieve the current y position of the object
+ */
#define CURRENT_Y(o) EWL_OBJECT(o)->current.y
+
+/**
+ * @def CURRENT_W(o)
+ * Retrieve the current width of the object without insets or padding
+ */
#define CURRENT_W(o) EWL_OBJECT(o)->current.w
+
+/**
+ * @def CURRENT_H(o)
+ * Retrieve the current height of the object without insets or padding
+ */
#define CURRENT_H(o) EWL_OBJECT(o)->current.h
/**
===================================================================
RCS file: /cvs/e/e17/libs/ewl/src/lib/ewl_tree2.c,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -3 -r1.17 -r1.18
--- ewl_tree2.c 21 Apr 2006 02:07:21 -0000 1.17
+++ ewl_tree2.c 20 May 2006 08:14:54 -0000 1.18
@@ -539,6 +539,11 @@
/*
* Ewl_Tree2_Column stuff
*/
+
+/**
+ * @return Returns a new Ewl_Tree2_Column
+ * @brief Creates a new Ewl_Tree2_Column object
+ */
Ewl_Tree2_Column *
ewl_tree2_column_new(void)
{
@@ -551,6 +556,11 @@
DRETURN_PTR(c, DLEVEL_STABLE);
}
+/**
+ * @param c: The column to work with
+ * @return Returns no value
+ * @brief Destroys the given column
+ */
void
ewl_tree2_column_destroy(Ewl_Tree2_Column *c)
{
@@ -564,6 +574,12 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param c: The column to work with
+ * @param m: The model to set
+ * @return Returns no value
+ * @brief Sets the given model @a m into the column @a c
+ */
void
ewl_tree2_column_model_set(Ewl_Tree2_Column *c, Ewl_Model *m)
{
@@ -576,6 +592,11 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param c: The column to work with
+ * @return Returns the model for the column
+ * @brief Retrieves the model for the given column
+ */
Ewl_Model *
ewl_tree2_column_model_get(Ewl_Tree2_Column *c)
{
@@ -585,6 +606,12 @@
DRETURN_PTR(c->model, DLEVEL_STABLE);
}
+/**
+ * @param c: The column to work with
+ * @param v: The view to set
+ * @return Returns no value
+ * @brief Sets the given view @a v into the column @a c
+ */
void
ewl_tree2_column_view_set(Ewl_Tree2_Column *c, Ewl_View *v)
{
@@ -597,6 +624,11 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param c: The Ewl_Tree2_Column to work with
+ * @return Returns the view set on the given column
+ * @brief Retrieves the view for the given column
+ */
Ewl_View *
ewl_tree2_column_view_get(Ewl_Tree2_Column *c)
{
-------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
