Enlightenment CVS committal
Author : rephorm
Project : e17
Module : libs/ecore
Dir : e17/libs/ecore/src/lib/ecore_evas
Modified Files:
Tag: SPLIT
ecore_evas.c
Log Message:
Documentation.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ecore/src/lib/ecore_evas/Attic/ecore_evas.c,v
retrieving revision 1.1.2.19
retrieving revision 1.1.2.20
diff -u -3 -r1.1.2.19 -r1.1.2.20
--- ecore_evas.c 16 Jul 2003 04:49:07 -0000 1.1.2.19
+++ ecore_evas.c 9 Aug 2003 04:16:48 -0000 1.1.2.20
@@ -46,9 +46,10 @@
}
/**
- * To be documented.
+ * Free an Ecore_Evas
+ * @param ee The Ecore_Evas to free
*
- * FIXME: To be fixed.
+ * This frees up any memory used by the Ecore_Evas.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -80,9 +81,12 @@
#define IFE return;}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas resize events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever @p ee is resized.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -100,9 +104,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas move events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever @p ee is moved.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -120,9 +127,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas show events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever @p ee is shown.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -140,9 +150,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas hide events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever @p ee is hidden.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -160,9 +173,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas delete request events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever @p ee gets a delete request.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -180,9 +196,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas destroy events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever @p ee is destroyed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -200,9 +219,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas focus in events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever @p ee gets focus.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -220,9 +242,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas focus out events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever @p ee loses focus.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -240,9 +265,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas mouse in events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever the mouse enters @p ee.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -260,9 +288,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas mouse out events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called whenever the mouse leaves @p ee.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -280,9 +311,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas mouse pre render events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called just before the evas in @p ee is rendered.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -300,9 +334,12 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set a callback for Ecore_Evas mouse post render events.
+ * @param ee The Ecore_Evas to set callbacks on
+ * @param func The function to call
+
+ * A call to this function will set a callback on an Ecore_Evas, causing
+ * @p func to be called just after the evas in @p ee is rendered.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -320,9 +357,11 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Get an Ecore_Evas's Evas
+ * @param ee The Ecore_Evas whose Evas you wish to get
+ * @return The Evas wrapped by @p ee
+ *
+ * This function returns the Evas contained within @p ee.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
Evas *
@@ -338,9 +377,12 @@
}
/**
- * To be documented.
+ * Move an Ecore_Evas
+ * @param ee The Ecore_Evas to move
+ * @param x The x coordinate to move to
+ * @param y The y coordinate to move to
*
- * FIXME: To be fixed.
+ * This moves @p ee to the screen coordinates (@p x, @p y)
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -357,9 +399,12 @@
}
/**
- * To be documented.
+ * Resize an Ecore_Evas
+ * @param ee The Ecore_Evas to move
+ * @param w The w coordinate to resize to
+ * @param h The h coordinate to resize to
*
- * FIXME: To be fixed.
+ * This resizes @p ee to @p w x @p h
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -386,9 +431,16 @@
}
/**
- * To be documented.
+ * Resize an Ecore_Evas
+ * @param ee The Ecore_Evas to move
+ * @param x The x coordinate to move to
+ * @param y The y coordinate to move to
+ * @param w The w coordinate to resize to
+ * @param h The h coordinate to resize to
+ *
+ * This moves @p ee to the screen coordinates (@p x, @p y) and resizes
+ * it to @p w x @p h.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -415,9 +467,21 @@
}
/**
- * To be documented.
+ * Get the geometry of an Ecore_Evas
+ * @param ee The Ecore_Evas whose geometry y
+ * @param x A pointer to an int to place the x coordinate in
+ * @param y A pointer to an int to place the y coordinate in
+ * @param w A pointer to an int to place the w size in
+ * @param h A pointer to an int to place the h size in
+ *
+ * This function takes four pointers to (already allocated) ints, and places
+ * the geometry of @p ee in them.
+ *
+ * @code
+ * int x, y, w, h;
+ * ecore_evas_geometry_get(ee, &x, &y, &w, &h);
+ * @endcode
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -446,9 +510,13 @@
}
/**
- * To be documented.
+ * Set the rotation of an Ecore_Evas' window
+ *
+ * @param ee The Ecore_Evas
+ * @param rot the angle (in degrees) of rotation.
*
- * FIXME: To be fixed.
+ * The allowed values of @p rot depend on the engine being used. Most only
+ * allow multiples of 90.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -468,9 +536,11 @@
}
/**
- * To be documented.
+ * Set the rotation of an Ecore_Evas' window
+ *
+ * @param ee The Ecore_Evas
+ * @return the angle (in degrees) of rotation.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -486,9 +556,16 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set whether an Ecore_Evas is shaped or not.
+ * @param ee The Ecore_Evas to shape
+ * @param shaped 1 to shape, 0 to not
+ *
+ * This function allows one to make an Ecore_Evas shaped to the contents of the
+ * evas. If @p shaped is 1, @p ee will be transparent in parts of the evas that
+ * contain no objects. If @p shaped is 0, then @p ee will be rectangular, and
+ * and parts with no data will show random framebuffer artifacting. For
+ * non-shaped Ecore_Evases, it is recommend to cover the entire evas with a
+ * background object.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -505,9 +582,11 @@
}
/**
- * To be documented.
+ * Query whether an Ecore_Evas is shaped or not.
+ * @param ee The Ecore_Evas to query.
+ * @return 1 if shaped, 0 if not.
*
- * FIXME: To be fixed.
+ * This function returns 1 if @p ee is shaped, and 0 if not.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -523,9 +602,10 @@
}
/**
- * To be documented.
+ * Show an Ecore_Evas' window
+ * @param ee The Ecore_Evas to show.
*
- * FIXME: To be fixed.
+ * This function makes @p ee visible.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -542,9 +622,10 @@
}
/**
- * To be documented.
+ * Hide an Ecore_Evas' window
+ * @param ee The Ecore_Evas to show.
*
- * FIXME: To be fixed.
+ * This function makes @p ee hidden.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -561,9 +642,11 @@
}
/**
- * To be documented.
+ * Query whether an Ecore_Evas' window is visible or not.
+ * @param ee The Ecore_Evas to query.
+ * @return 1 if visible, 0 if not.
*
- * FIXME: To be fixed.
+ * This function queries @p ee and returns 1 if it is visible, and 0 if not.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -579,9 +662,10 @@
}
/**
- * To be documented.
+ * Raise and Ecore_Evas' window.
+ * @param ee The Ecore_Evas to raise.
*
- * FIXME: To be fixed.
+ * This functions raises the Ecore_Evas to the front.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -598,9 +682,10 @@
}
/**
- * To be documented.
+ * Lower an Ecore_Evas' window.
+ * @param ee The Ecore_Evas to raise.
*
- * FIXME: To be fixed.
+ * This functions lowers the Ecore_Evas to the back.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -617,9 +702,11 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set the title of an Ecore_Evas' window
+ * @param ee The Ecore_Evas whose title you wish to set.
+ * @param t The title
+ *
+ * This function sets the title of @p ee to @p t.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -636,9 +723,11 @@
}
/**
- * To be documented.
+ * Get the title of an Ecore_Evas' window
+ * @param ee The Ecore_Evas whose title you wish to get.
+ * @return The title of @p ee.
*
- * FIXME: To be fixed.
+ * This function returns the title of @p ee.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
const char *
@@ -654,9 +743,12 @@
}
/**
- * To be documented.
+ * Set the name and class of an Ecore_Evas' window
+ * @param ee the Ecore_Evas
+ * @param n the name
+ * @param c the class
*
- * FIXME: To be fixed.
+ * This function sets the name of @p ee to @p n, and its class to @p c.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -673,9 +765,13 @@
}
/**
- * To be documented.
+ * Get the name and class of an Ecore_Evas' window
+ * @p ee The Ecore_Evas to query
+ * @p n A pointer to a string to place the name in.
+ * @p c A pointer to a string to place the class in.
*
- * FIXME: To be fixed.
+ * This function gets puts the name of @p ee into @p n, and its class into
+ * @p c.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -692,9 +788,12 @@
}
/**
- * To be documented.
+ * Set the min size of an Ecore_Evas' window
+ * @param ee The Ecore_Evas to set
+ * @param w The minimum width
+ * @param h The minimum height
*
- * FIXME: To be fixed.
+ * This function sets the minimum size of @p ee to @p w x @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -721,9 +820,12 @@
}
/**
- * To be documented.
+ * Get the min size of an Ecore_Evas' window
+ * @param ee The Ecore_Evas to set
+ * @param w A pointer to an int to place the min width in.
+ * @param h A pointer to an int to place the min height in.
*
- * FIXME: To be fixed.
+ * This function puts the minimum size of @p ee into @p w and @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -748,9 +850,12 @@
}
/**
- * To be documented.
+ * Set the max size of an Ecore_Evas' window
+ * @param ee The Ecore_Evas to set
+ * @param w The maximum width
+ * @param h The maximum height
*
- * FIXME: To be fixed.
+ * This function sets the maximum size of @p ee to @p w x @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -777,9 +882,12 @@
}
/**
- * To be documented.
+ * Get the max size of an Ecore_Evas' window
+ * @param ee The Ecore_Evas to set
+ * @param w A pointer to an int to place the max width in.
+ * @param h A pointer to an int to place the max height in.
*
- * FIXME: To be fixed.
+ * This function puts the maximum size of @p ee into @p w and @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -804,9 +912,12 @@
}
/**
- * To be documented.
+ * Set the base size of an Ecore_Evas' window
+ * @param ee The Ecore_Evas to set
+ * @param w The base width
+ * @param h The base height
*
- * FIXME: To be fixed.
+ * This function sets the base size of @p ee to @p w x @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -833,9 +944,12 @@
}
/**
- * To be documented.
+ * Get the base size of an Ecore_Evas' window
+ * @param ee The Ecore_Evas to set
+ * @param w A pointer to an int to place the base width in.
+ * @param h A pointer to an int to place the base height in.
*
- * FIXME: To be fixed.
+ * This function puts the base size of @p ee into @p w and @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -860,9 +974,13 @@
}
/**
- * To be documented.
+ * Set the step size of an Ecore_Evas
+ * @param ee The Ecore_Evas to set
+ * @param w The step width
+ * @param h The step height
*
- * FIXME: To be fixed.
+ * This function sets the step size of @p ee to @p w x @p h. This limits the
+ * size of an Ecore_Evas to always being an integer multiple of the step size.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -889,9 +1007,12 @@
}
/**
- * To be documented.
+ * Get the step size of an Ecore_Evas' window
+ * @param ee The Ecore_Evas to set
+ * @param w A pointer to an int to place the step width in.
+ * @param h A pointer to an int to place the step height in.
*
- * FIXME: To be fixed.
+ * This function puts the step size of @p ee into @p w and @p h.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -916,9 +1037,16 @@
}
/**
- * To be documented.
- *
- * FIXME: To be fixed.
+ * Set the cursor of an Ecore_Evas
+ * @param ee The Ecore_Evas
+ * @param file The path to an image file for the cursor
+ * @param hot_x The x coordinate of the cursor's hot spot
+ * @param hot_y The y coordinate of the cursor's hot spot
+ *
+ * This function makes the mouse cursor over @p ee be the image specified by
+ * @p file. The actual point within the image that the mouse is at is specified
+ * by @p hot_x and @p hot_y, which are coordinates with respect to the top left
+ * corner of the cursor image.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -935,9 +1063,14 @@
}
/**
- * To be documented.
+ * Get information about an Ecore_Evas' cursor
+ * @param ee The Ecore_Evas to set
+ * @param file A pointer to a string to place the cursor file name in.
+ * @param layer A pointer to an int to place the cursor's layer in..
+ * @param hot_x A pointer to an int to place the cursor's hot_x coordinate in.
+ * @param hot_y A pointer to an int to place the cursor's hot_y coordinate in.
*
- * FIXME: To be fixed.
+ * This function queries information about an Ecore_Evas' cursor.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -956,9 +1089,11 @@
}
/**
- * To be documented.
+ * Set the layer of an Ecore_Evas' window
+ * @param ee The Ecore_Evas
+ * @param layer The layer to put @p ee on.
*
- * FIXME: To be fixed.
+ * This function moves @p ee to the layer @p layer.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -975,9 +1110,10 @@
}
/**
- * To be documented.
+ * Get the layer of an Ecore_Evas' window
+ * @param ee The Ecore_Evas to set
+ * @return the layer @p ee's window is on.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -993,9 +1129,11 @@
}
/**
- * To be documented.
+ * Set the focus of an Ecore_Evas' window
+ * @param ee The Ecore_Evas
+ * @param on 1 for focus, 0 to defocus.
*
- * FIXME: To be fixed.
+ * This function focuses @p ee if @p on is 1, or defocuses @p ee if @p on is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -1012,9 +1150,10 @@
}
/**
- * To be documented.
+ * Query whether an Ecore_Evas' window is focused or not
+ * @param ee The Ecore_Evas to set
+ * @return 1 if @p ee if focused, 0 if not.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -1030,9 +1169,12 @@
}
/**
- * To be documented.
+ * Iconify or uniconify an Ecore_Evas' window
+ * @param ee The Ecore_Evas
+ * @param on 1 to iconify, 0 to uniconify.
*
- * FIXME: To be fixed.
+ * This function iconifies @p ee if @p on is 1, or uniconifies @p ee if @p on
+ * is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -1049,9 +1191,10 @@
}
/**
- * To be documented.
+ * Query whether an Ecore_Evas' window is iconified or not
+ * @param ee The Ecore_Evas to set
+ * @return 1 if @p ee is iconified, 0 if not.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -1067,9 +1210,12 @@
}
/**
- * To be documented.
+ * Set whether an Ecore_Evas' window is borderless or not
+ * @param ee The Ecore_Evas
+ * @param on 1 for borderless, 0 for bordered.
*
- * FIXME: To be fixed.
+ * This function makes @p ee borderless if @p on is 1, or bordered if @p on
+ * is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -1086,9 +1232,10 @@
}
/**
- * To be documented.
+ * Query whether an Ecore_Evas' window is borderless or not
+ * @param ee The Ecore_Evas to set
+ * @return 1 if @p ee is borderless, 0 if not.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -1104,9 +1251,12 @@
}
/**
- * To be documented.
+ * Tell the WM whether or not to ignore an Ecore_Evas' window
+ * @param ee The Ecore_Evas
+ * @param on 1 to ignore, 0 to not.
*
- * FIXME: To be fixed.
+ * This function causes the window manager to ignore @p ee if @p on is 1,
+ * or not ignore @p ee if @p on is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -1123,9 +1273,10 @@
}
/**
- * To be documented.
+ * Query whether an Ecore_Evas' window is overridden or not
+ * @param ee The Ecore_Evas to set
+ * @return 1 if @p ee is overridden, 0 if not.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -1141,9 +1292,12 @@
}
/**
- * To be documented.
+ * Maximize (or unmaximize) an Ecore_Evas' window
+ * @param ee The Ecore_Evas
+ * @param on 1 to maximize, 0 to unmaximize.
*
- * FIXME: To be fixed.
+ * This function maximizes @p ee if @p on is 1, or unmaximizes @p ee
+ * if @p on is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -1160,9 +1314,10 @@
}
/**
- * To be documented.
+ * Query whether an Ecore_Evas' window is maximized or not
+ * @param ee The Ecore_Evas to set
+ * @return 1 if @p ee is maximized, 0 if not.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -1178,9 +1333,12 @@
}
/**
- * To be documented.
+ * Set whether or not an Ecore_Evas' window is fullscreen
+ * @param ee The Ecore_Evas
+ * @param on 1 fullscreen, 0 not.
*
- * FIXME: To be fixed.
+ * This function causes @p ee to be fullscreen if @p on is 1,
+ * or not if @p on is 0.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -1197,9 +1355,10 @@
}
/**
- * To be documented.
+ * Query whether an Ecore_Evas' window is fullscreen or not
+ * @param ee The Ecore_Evas to set
+ * @return 1 if @p ee is fullscreen, 0 if not.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
@@ -1214,10 +1373,14 @@
return ee->prop.fullscreen;
}
-/**
- * To be documented.
+/**
+ * Set whether or not an Ecore_Evas' window should avoid damage
*
- * FIXME: To be fixed.
+ * @param ee The Ecore_Evas
+ * @param on 1 to avoid damage, 0 to not
+ *
+ * This function causes @p ee to be drawn to a pixmap to avoid recalculations.
+ * On expose events it will copy from the pixmap to the window.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
void
@@ -1234,9 +1397,10 @@
}
/**
- * To be documented.
+ * Query whether an Ecore_Evas' window avoids damage or not
+ * @param ee The Ecore_Evas to set
+ * @return 1 if @p ee avoids damage, 0 if not.
*
- * FIXME: To be fixed.
* <hr><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br><br>
*/
int
-------------------------------------------------------
This SF.Net email sponsored by: Free pre-built ASP.NET sites including
Data Reports, E-commerce, Portals, and Forums are available now.
Download today and enter to win an XBOX or Visual Studio .NET.
http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet_072303_01/01
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
