Enlightenment CVS committal

Author  : ningerso
Project : e17
Module  : libs/ewl

Dir     : e17/libs/ewl/src/bin/tests/box


Modified Files:
        ewl_box.c 


Log Message:
Add a simple box tutorial.

===================================================================
RCS file: /cvs/e/e17/libs/ewl/src/bin/tests/box/ewl_box.c,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- ewl_box.c   4 Jan 2007 05:09:39 -0000       1.3
+++ ewl_box.c   12 Feb 2007 10:51:49 -0000      1.4
@@ -3,6 +3,38 @@
 #include "ewl_test_private.h"
 #include <stdio.h>
 
+/**
+ * @addtogroup Ewl_Box
+ * @section box_tut Tutorial
+ *
+ * The Ewl_Box provides a simple linear layout container. There are a few
+ * options to control the layout characteristics, but much of the layout is
+ * dependent on the child widget settings. The first option encountered is the
+ * orientation, which is either horizontal or vertical. Both orientations are
+ * implemented within the same box widget, and is set with
+ * ewl_box_orientation_set, but shortcuts exist in the form of ewl_hbox_new and
+ * ewl_vbox_new. The default orientation is horizontal.
+ *
+ * @code
+ * Ewl_Widget *box;
+ * box = ewl_hbox_new();
+ * ewl_widget_show(box);
+ * @endcode
+ *
+ * After creating the box, children are added with the standard container calls
+ * common to most containers. For example, a label and entry would be added as
+ * follows.
+ *
+ * @code
+ * ewl_container_child_append(EWL_CONTAINER(box), label);
+ * ewl_container_child_append(EWL_CONTAINER(box), entry);
+ * @endcode
+ *
+ * This would result in a label followed by the entry laid out horizontally.
+ */
+
+
+
 static int create_test(Ewl_Container *box);
 static void toggle_child_vertical_align(Ewl_Widget *w, void *ev, void *data);
 static void toggle_child_horizontal_align(Ewl_Widget *w, void *ev, void *data);



-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier.
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs

Reply via email to