Enlightenment CVS committal
Author : dj2
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/lib
Modified Files:
ewl_entry.c
Log Message:
- add some documentation
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/lib/ewl_entry.c,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -3 -r1.21 -r1.22
--- ewl_entry.c 10 Jul 2005 04:44:25 -0000 1.21
+++ ewl_entry.c 10 Jul 2005 23:10:51 -0000 1.22
@@ -2,6 +2,10 @@
#include "ewl_debug.h"
#include "ewl_macros.h"
+/**
+ * @param text: The text to set into the entry
+ * @return Returns a new Ewl_Widget on success or NULL on failure
+ */
Ewl_Widget *
ewl_entry_new(const char *text)
{
@@ -22,6 +26,11 @@
DRETURN_PTR(w, DLEVEL_STABLE);
}
+/**
+ * @param e: The Ewl_Entry to initialize
+ * @param text: The text to put into the entry
+ * @return Returns TRUE on success or FALSE on failure
+ */
int
ewl_entry_init(Ewl_Entry *e, const char *text)
{
@@ -67,6 +76,11 @@
DRETURN_INT(TRUE, DLEVEL_STABLE);
}
+/**
+ * @param e: The Ewl_Entry to set the multiline status
+ * @param multiline: The multiline status to set
+ * @return Returns no value
+ */
void
ewl_entry_multiline_set(Ewl_Entry *e, unsigned int multiline)
{
@@ -78,6 +92,10 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param e: The Ewl_Entry to get the multiline status from
+ * @return Returns the multline status of the widget
+ */
unsigned int
ewl_entry_multline_get(Ewl_Entry *e)
{
@@ -87,6 +105,11 @@
DRETURN_INT(e->multiline, DLEVEL_STABLE);
}
+/**
+ * @param e: The Ewl_Entry to set the editable status of
+ * @param editable: The value to set for the editable flag
+ * @return Returns no value
+ */
void
ewl_entry_editable_set(Ewl_Entry *e, unsigned int editable)
{
@@ -120,6 +143,10 @@
DLEAVE_FUNCTION(DLEVEL_STABLE);
}
+/**
+ * @param e: The Ewl_Entry to get the editable status from
+ * @return Returns the editable status of the entry
+ */
unsigned int
ewl_entry_editable_get(Ewl_Entry *e)
{
@@ -154,8 +181,6 @@
if (!cw) cw = CURRENT_W(e->cursor);
if (!ch) ch = CURRENT_H(e->cursor);
-//printf("entry_configure pos: %02d cx: %02d cy: %02d cw: %02d ch: %02d\n",
c_pos, cx, cy, cw, ch);
-
/* XXX this needs to move over a little so it dosen't sit right on
* top of the char */
ewl_object_geometry_request(EWL_OBJECT(e->cursor), cx, cy, cw, ch);
-------------------------------------------------------
This SF.Net email is sponsored by the 'Do More With Dual!' webinar happening
July 14 at 8am PDT/11am EDT. We invite you to explore the latest in dual
core and dual graphics technology at this free one hour event hosted by HP,
AMD, and NVIDIA. To register visit http://www.hp.com/go/dualwebinar
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
