Enlightenment CVS committal

Author  : rbdpngn
Project : e17
Module  : libs/ewl

Dir     : e17/libs/ewl/src


Modified Files:
        ewl_embed.c ewl_image.c ewl_media.c ewl_media.h ewl_menu.h 
        ewl_text.c ewl_text.h 


Log Message:
Documentation fixes for doxygen output.
A function to prune out duplicate or unnecessary text operation.

===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_embed.c,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -3 -r1.40 -r1.41
--- ewl_embed.c 10 Jul 2004 20:13:31 -0000      1.40
+++ ewl_embed.c 21 Jul 2004 05:47:43 -0000      1.41
@@ -282,6 +282,7 @@
 /**
  * @param embed: the embed where the mouse event is to occur
  * @param b: the number of the button pressed
+ * @param clicks: the number of times the button was pressed
  * @param x: the x coordinate of the mouse press
  * @param y: the y coordinate of the mouse press
  * @param mods: the mask of key modifiers currently pressed
@@ -524,8 +525,10 @@
 
 /**
  * @param embed: the embed where the mouse event is to occur
- * @param x: the x coordinate of the mouse out
- * @param y: the y coordinate of the mouse out
+ * @param x: the x coordinate of the mouse when the wheel event occurred
+ * @param y: the y coordinate of the mouse when wheel event occurred
+ * @param z: the direction the mouse wheel rotated
+ * @param dir: FIXME, not sure what this does, it's always 0
  * @param mods: the mask of key modifiers currently release
  * @return Returns no value.
  * @brief Sends a mouse out event to the last focused widget
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_image.c,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -3 -r1.43 -r1.44
--- ewl_image.c 15 May 2004 05:03:07 -0000      1.43
+++ ewl_image.c 21 Jul 2004 05:47:44 -0000      1.44
@@ -30,6 +30,7 @@
 /**
  * @param i: the image widget to initialize
  * @param path: the path to the image displayed
+ * @param key: the key in the file for the image
  * @return Returns no value.
  * @brief Initialize an image widget to default values and callbacks
  *
@@ -73,6 +74,7 @@
 /**
  * @param i: the image widget to change the displayed image
  * @param im: the path to the new image to be displayed by @a i
+ * @param key: the key in the file for the image
  * @return Returns no value.
  * @brief Change the image file displayed by an image widget
  *
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_media.c,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -3 -r1.9 -r1.10
--- ewl_media.c 19 Jul 2004 17:51:21 -0000      1.9
+++ ewl_media.c 21 Jul 2004 05:47:44 -0000      1.10
@@ -127,7 +127,7 @@
  * @param h: hours variable
  * @param min: minutes variable
  * @param s: seconds variable
- * @brief Puts the length of the video into the @h, @m, @s variables
+ * @brief Puts the length of the video into the @a h, @a m, @a s variables
  */
 void ewl_media_length_time_get(Ewl_Media *m, int *h, int *min, double *s)
 {
@@ -197,7 +197,7 @@
  * @param h: hours variable
  * @param min: minutes variable
  * @param s: seconds variable
- * @brief Puts the position of the video into the @h, @m, @s variables
+ * @brief Puts the position of the video into the @a h, @a m, @a s variables
  */
 void ewl_media_position_time_get(Ewl_Media *m, int *h, int *min, double *s)
 {
@@ -249,6 +249,7 @@
 
 /**
  * @param m: the media widget to act upon
+ * @param mute: boolean to indicate if the sound should be muted
  * @return Returns no value
  * @brief Mutes the media widget
  */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_media.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- ewl_media.h 19 Jul 2004 17:50:09 -0000      1.6
+++ ewl_media.h 21 Jul 2004 05:47:44 -0000      1.7
@@ -4,7 +4,7 @@
 #include <Emotion.h>
 
 /**
- * @defgroup Ewl_Media : A Multi media widget
+ * @defgroup Ewl_Media Media: A Multi media widget
  * @brief Defines a class for displaing video
  *
  * @{
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_menu.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- ewl_menu.h  27 May 2004 20:15:16 -0000      1.7
+++ ewl_menu.h  21 Jul 2004 05:47:44 -0000      1.8
@@ -2,9 +2,9 @@
 #define __EWL_MENU_H__
 
 /**
- * @defgroup Ewl_Imenu Imenu: A Simple Internal Menu
- * Defines a menu used internally. The contents on the menu are not drawn
- * outside of the Evas.
+ * @defgroup Ewl_Menu Menu: A Simple Windowed Menu
+ * Defines a menu used globally. The contents on the menu are drawn outside of
+ * the Evas.
  *
  * @{
  */
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_text.c,v
retrieving revision 1.72
retrieving revision 1.73
diff -u -3 -r1.72 -r1.73
--- ewl_text.c  20 Jul 2004 19:19:47 -0000      1.72
+++ ewl_text.c  21 Jul 2004 05:47:44 -0000      1.73
@@ -1,6 +1,8 @@
 #include <Ewl.h>
 
 static void ewl_text_ops_apply(Ewl_Text *ta);
+static void ewl_text_op_prune_list(Ewl_Text *ta, int rstart, int rend, 
+                                  int bstart, int bend);
 static void ewl_text_op_free(void *data);
 static Ewl_Text_Op *ewl_text_op_relevant_find(Ewl_Text *ta,
                                              Ewl_Text_Op_Type type);
@@ -117,6 +119,8 @@
        DCHECK_PARAM_PTR("ta", ta);
 
        op = ewl_text_op_text_set_new(ta, text);
+       ewl_text_op_prune_list(ta, EWL_TEXT_OP_TYPE_TEXT_SET,
+                                  EWL_TEXT_OP_TYPE_TEXT_DELETE, -1, -1);
        ecore_dlist_append(ta->ops, op);
        if (REALIZED(ta))
                ewl_text_ops_apply(ta);
@@ -201,6 +205,7 @@
 /**
  * @param ta: the text area widget to insert the text
  * @param text: the text to insert in the text area widget @a ta
+ * @param index: the index into the text to start inserting new text
  * @return Returns no value.
  * @brief Append text to a text area widget
  *
@@ -272,6 +277,13 @@
        DCHECK_PARAM_PTR("ta", ta);
 
        op = ewl_text_op_color_new(ta, r, g, b, a);
+       /*
+        * Remove all color sets prior to a text addition/set operation.
+        */
+       ewl_text_op_prune_list(ta, EWL_TEXT_OP_TYPE_COLOR_SET,
+                                  EWL_TEXT_OP_TYPE_COLOR_SET,
+                                  EWL_TEXT_OP_TYPE_TEXT_SET,
+                                  EWL_TEXT_OP_TYPE_TEXT_INSERT);
        ecore_dlist_append(ta->ops, op);
        if (REALIZED(ta))
                ewl_text_ops_apply(ta);
@@ -294,6 +306,10 @@
        DCHECK_PARAM_PTR("ta", ta);
 
        op = ewl_text_op_font_new(ta, font, size);
+       ewl_text_op_prune_list(ta, EWL_TEXT_OP_TYPE_FONT_SET,
+                                  EWL_TEXT_OP_TYPE_FONT_SET,
+                                  EWL_TEXT_OP_TYPE_TEXT_SET,
+                                  EWL_TEXT_OP_TYPE_TEXT_INSERT);
        ecore_dlist_append(ta->ops, op);
        if (REALIZED(ta))
                ewl_text_ops_apply(ta);
@@ -302,11 +318,9 @@
 }
 
 /**
- * @param ta: the text widget to change font
- * @param font: the name of the font
- * @param size: the size of the font
- * @brief Changes the currently applied font of the text to specified values
- * @return Returns no value.
+ * @param ta: the text widget to retrieve the current font
+ * @brief Retrieve the name of the currently used font.
+ * @return Returns a copied string containing the name of the current font.
  */
 char *ewl_text_font_get(Ewl_Text *ta)
 {
@@ -340,6 +354,10 @@
        DCHECK_PARAM_PTR("ta", ta);
 
        op = ewl_text_op_style_new(ta, style);
+       ewl_text_op_prune_list(ta, EWL_TEXT_OP_TYPE_STYLE_SET,
+                                  EWL_TEXT_OP_TYPE_STYLE_SET,
+                                  EWL_TEXT_OP_TYPE_TEXT_SET,
+                                  EWL_TEXT_OP_TYPE_TEXT_INSERT);
        ecore_dlist_append(ta->ops, op);
        if (REALIZED(ta))
                ewl_text_ops_apply(ta);
@@ -384,6 +402,10 @@
        DCHECK_PARAM_PTR("ta", ta);
 
        op = ewl_text_op_align_new(ta, align);
+       ewl_text_op_prune_list(ta, EWL_TEXT_OP_TYPE_ALIGN_SET,
+                                  EWL_TEXT_OP_TYPE_ALIGN_SET,
+                                  EWL_TEXT_OP_TYPE_TEXT_SET,
+                                  EWL_TEXT_OP_TYPE_TEXT_INSERT);
        ecore_dlist_append(ta->ops, op);
        if (REALIZED(ta))
                ewl_text_ops_apply(ta);
@@ -954,3 +976,27 @@
 
        DLEAVE_FUNCTION(DLEVEL_STABLE);
 }
+
+static void
+ewl_text_op_prune_list(Ewl_Text *ta, int rstart, int rend, int bstart, int bend)
+{
+       Ewl_Text_Op *op;
+
+       ecore_dlist_goto_last(ta->ops);
+       while ((op = ecore_dlist_current(ta->ops))) {
+               /*
+                * Stop searching the list if we hit these events.
+                */
+               if (op->type >= bstart && op->type <= bend)
+                       break;
+               if (op->type >= rstart && op->type <= rend) {
+                       ecore_dlist_remove(ta->ops);
+                       if (op->free)
+                               op->free(op);
+                       else {
+                               FREE(op);
+                       }
+               }
+               ecore_dlist_previous(ta->ops);
+       }
+}
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_text.h,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -3 -r1.31 -r1.32
--- ewl_text.h  19 Jul 2004 05:59:41 -0000      1.31
+++ ewl_text.h  21 Jul 2004 05:47:45 -0000      1.32
@@ -51,7 +51,7 @@
 } Ewl_Text_Overrides;
 
 /**
- * @enum  Ewl_Text_Ops
+ * @enum  Ewl_Text_Op_Type
  * Provides a series of operations that can be performed on the text.
  */
 typedef enum
@@ -65,6 +65,7 @@
        EWL_TEXT_OP_TYPE_TEXT_PREPEND,
        EWL_TEXT_OP_TYPE_TEXT_APPEND,
        EWL_TEXT_OP_TYPE_TEXT_INSERT,
+       EWL_TEXT_OP_TYPE_TEXT_DELETE,
 } Ewl_Text_Op_Type;
 
 typedef struct Ewl_Text_Op Ewl_Text_Op;




-------------------------------------------------------
This SF.Net email is sponsored by BEA Weblogic Workshop
FREE Java Enterprise J2EE developer tools!
Get your free copy of BEA WebLogic Workshop 8.1 today.
http://ads.osdn.com/?ad_id=4721&alloc_id=10040&op=click
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs

Reply via email to