Enlightenment CVS committal
Author : ncn
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore_x
Modified Files:
ecore_x_pixmap.c ecore_x_window.c ecore_x_window_shape.c
Log Message:
More documentation, simplification, mode-ification, grouping.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_x/ecore_x_pixmap.c,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -3 -r1.4 -r1.5
--- ecore_x_pixmap.c 21 Feb 2004 21:44:48 -0000 1.4
+++ ecore_x_pixmap.c 12 Aug 2004 11:29:18 -0000 1.5
@@ -3,9 +3,22 @@
#include "Ecore_X.h"
/**
- * To be documented.
+ * @defgroup Ecore_X_Pixmap_Group X Pixmap Functions
*
- * FIXME: To be fixed.
+ * Functions that operate on pixmaps.
+ */
+
+/**
+ * Creates a new pixmap.
+ * @param win Window used to determine which screen of the display the
+ * pixmap should be created on. If 0, the default root window
+ * is used.
+ * @param w Width of the new pixmap.
+ * @param h Height of the new pixmap.
+ * @param dep Depth of the pixmap. If 0, the default depth of the default
+ * screen is used.
+ * @return New pixmap.
+ * @ingroup Ecore_X_Pixmap_Group
*/
Ecore_X_Pixmap
ecore_x_pixmap_new(Ecore_X_Window win, int w, int h, int dep)
@@ -16,9 +29,13 @@
}
/**
- * To be documented.
+ * Deletes the reference to the given pixmap.
+ *
+ * If no other clients have a reference to the given pixmap, the server
+ * will destroy it.
*
- * FIXME: To be fixed.
+ * @param pmap The given pixmap.
+ * @ingroup Ecore_X_Pixmap_Group
*/
void
ecore_x_pixmap_del(Ecore_X_Pixmap pmap)
@@ -27,9 +44,18 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Pastes a rectangular area of the given pixmap onto the given drawable.
+ * @param pmap The given pixmap.
+ * @param dest The given drawable.
+ * @param gc The graphics context which governs which operation will
+ * be used to paste the area onto the drawable.
+ * @param sx The X position of the area on the pixmap.
+ * @param sy The Y position of the area on the pixmap.
+ * @param w The width of the area.
+ * @param h The height of the area.
+ * @param dx The X position at which to paste the area on @p dest.
+ * @param dy The Y position at which to paste the area on @p dest.
+ * @ingroup Ecore_X_Pixmap_Group
*/
void
ecore_x_pixmap_paste(Ecore_X_Pixmap pmap, Ecore_X_Drawable dest,
@@ -40,9 +66,13 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Retrieves the size of the given pixmap.
+ * @param pmap The given pixmap.
+ * @param x Pointer to an integer in which to store the X position.
+ * @param y Pointer to an integer in which to store the Y position.
+ * @param w Pointer to an integer in which to store the width.
+ * @param h Pointer to an integer in which to store the height.
+ * @ingroup Ecore_X_Pixmap_Group
*/
void
ecore_x_pixmap_geometry_get(Ecore_X_Pixmap pmap, int *x, int *y, int *w, int *h)
@@ -52,9 +82,10 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Retrieves the depth of the given pixmap.
+ * @param pmap The given pixmap.
+ * @return The depth of the pixmap.
+ * @ingroup Ecore_X_Pixmap_Group
*/
int
ecore_x_pixmap_depth_get(Ecore_X_Pixmap pmap)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_x/ecore_x_window.c,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -3 -r1.20 -r1.21
--- ecore_x_window.c 1 Aug 2004 12:48:39 -0000 1.20
+++ ecore_x_window.c 12 Aug 2004 11:29:18 -0000 1.21
@@ -391,11 +391,18 @@
}
/**
+ * @defgroup Ecore_X_Window_Parent_Group X Window Parent Functions
+ *
+ * Functions that retrieve or changes the parent window of a window.
+ */
+
+/**
* Moves a window to within another window at a given position.
- * @param win The window to reparent.
- * @param new_parent The new parent window.
- * @param x X position within new parent window.
- * @param y Y position within new parent window.
+ * @param win The window to reparent.
+ * @param new_parent The new parent window.
+ * @param x X position within new parent window.
+ * @param y Y position within new parent window.
+ * @ingroup Ecore_X_Window_Parent_Group
*/
void
ecore_x_window_reparent(Ecore_X_Window win, Ecore_X_Window new_parent, int x, int y)
@@ -406,9 +413,10 @@
/**
* Retrieves the size of the given window.
- * @param win The given window.
- * @param w Pointer to an integer into which the width is to be stored.
- * @param h Pointer to an integer into which the height is to be stored.
+ * @param win The given window.
+ * @param w Pointer to an integer into which the width is to be stored.
+ * @param h Pointer to an integer into which the height is to be stored.
+ * @ingroup Ecore_X_Window_Geometry_Group
*/
void
ecore_x_window_size_get(Ecore_X_Window win, int *w, int *h)
@@ -423,11 +431,12 @@
/**
* Retrieves the geometry of the given window.
- * @param win The given window.
- * @param x Pointer to an integer in which the X position is to be stored.
- * @param y Pointer to an integer in which the Y position is to be stored.
- * @param w Pointer to an integer in which the width is to be stored.
- * @param h Pointer to an integer in which the height is to be stored.
+ * @param win The given window.
+ * @param x Pointer to an integer in which the X position is to be stored.
+ * @param y Pointer to an integer in which the Y position is to be stored.
+ * @param w Pointer to an integer in which the width is to be stored.
+ * @param h Pointer to an integer in which the height is to be stored.
+ * @ingroup Ecore_X_Window_Geometry_Group
*/
void
ecore_x_window_geometry_get(Ecore_X_Window win, int *x, int *y, int *w, int *h)
@@ -440,8 +449,9 @@
/**
* Retrieves the width of the border of the given window.
- * @param win The given window.
- * @return Width of the border of @p win.
+ * @param win The given window.
+ * @return Width of the border of @p win.
+ * @ingroup Ecore_X_Window_Geometry_Group
*/
int
ecore_x_window_border_width_get(Ecore_X_Window win)
@@ -551,9 +561,10 @@
/**
* Retrieves the top, visible window at the given location.
- * @param x The given X position.
- * @param y The given Y position.
- * @return The window at that position.
+ * @param x The given X position.
+ * @param y The given Y position.
+ * @return The window at that position.
+ * @ingroup Ecore_X_Window_Geometry_Group
*/
Ecore_X_Window
ecore_x_window_at_xy_get(int x, int y)
@@ -573,8 +584,9 @@
/**
* Retrieves the parent window of the given window.
- * @param win The given window.
- * @return The parent window of @p win.
+ * @param win The given window.
+ * @return The parent window of @p win.
+ * @ingroup Ecore_X_Window_Parent_Group
*/
Ecore_X_Window
ecore_x_window_parent_get(Ecore_X_Window win)
===================================================================
RCS file:
/cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_x/ecore_x_window_shape.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- ecore_x_window_shape.c 20 Feb 2004 07:06:29 -0000 1.3
+++ ecore_x_window_shape.c 12 Aug 2004 11:29:19 -0000 1.4
@@ -3,9 +3,18 @@
#include "Ecore_X.h"
/**
- * To be documented.
+ * @defgroup Ecore_X_Window_Shape X Window Shape Functions
*
- * FIXME: To be fixed.
+ * These functions use the shape extension of the X server to change
+ * shape of given windows.
+ */
+
+/**
+ * Sets the shape of the given window to that given by the pixmap @p mask.
+ * @param win The given window.
+ * @param mask A 2-bit depth pixmap that provides the new shape of the
+ * window.
+ * @ingroup Ecore_X_Window_Shape
*/
void
ecore_x_window_shape_mask_set(Ecore_X_Window win, Ecore_X_Pixmap mask)
-------------------------------------------------------
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
