Enlightenment CVS committal
Author : ningerso
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src/bin/tests
Modified Files:
ewl_password.c
Log Message:
Add password tutorial.
===================================================================
RCS file: /cvs/e/e17/libs/ewl/src/bin/tests/ewl_password.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- ewl_password.c 10 Mar 2006 04:05:42 -0000 1.2
+++ ewl_password.c 31 Mar 2006 05:26:52 -0000 1.3
@@ -2,6 +2,40 @@
#include <stdio.h>
#include <stdlib.h>
+/**
+ * @addtogroup Ewl_Password
+ * @section text_tut Tutorial
+ *
+ * The password extends a basic Ewl_Entry to provide an obscured view of the
+ * text entered.
+ *
+ * @code
+ * Ewl_Widget *password;
+ * password = ewl_password_new();
+ * ewl_widget_show(password);
+ * @endcode
+ *
+ * Manipulation of the password widget is generally done through the Ewl_Entry
+ * API since the password widget inherits from the entry. The first point it
+ * diverges from the entry API is for retrieving the current string in the
+ * widget. This is necessary because the entry API returns the text that is
+ * hiding the actual contents entered.
+ *
+ * @code
+ * void ewl_password_text_set(Ewl_Password *e, const char *t);
+ * char *ewl_password_text_get(Ewl_Password *e);
+ * @endcode
+ *
+ * The character used to hide the text of the password is also configurable at
+ * runtime, the default obscuring character is '*'.
+ *
+ * @code
+ * void ewl_password_obscure_set(Ewl_Password *e, char o);
+ * char ewl_password_obscure_get(Ewl_Password *e);
+ * @endcode
+ *
+ */
+
static Ewl_Widget *password[2];
static int create_test(Ewl_Container *win);
-------------------------------------------------------
This SF.Net email is sponsored by xPML, a groundbreaking scripting language
that extends applications into web and mobile media. Attend the live webcast
and join the prime developer group breaking into this new coding territory!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
