Enlightenment CVS committal
Author : moom
Project : e17
Module : proto
Dir : e17/proto/etk/src/lib
Modified Files:
etk_box.c etk_box.h etk_property.h etk_table.h
Log Message:
Update the doc of the Box
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_box.c,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -3 -r1.13 -r1.14
--- etk_box.c 15 Aug 2006 15:59:01 -0000 1.13
+++ etk_box.c 15 Aug 2006 20:20:43 -0000 1.14
@@ -301,7 +301,7 @@
* @brief Sets the packing settings of a child of the box
* @param box a box
* @param child a child of the box. If @a child is not packed in the box, this
function has no effect
- * @param fill policy the fill policy of the child
+ * @param fill_policy the fill policy of the child
* @param padding the amount of free space on the two sides of the child, in
pixels
*/
void etk_box_child_packing_set(Etk_Box *box, Etk_Widget *child,
Etk_Box_Fill_Policy fill_policy, int padding)
@@ -323,9 +323,9 @@
* @brief Gets the packing settings of a child of the box
* @param box a box
* @param child a child of the box
- * @param fill policy the location where to store the fill policy of the child
+ * @param fill_policy the location where to store the fill policy of the child
* @param padding the location where to store the padding of the child
- * @param Returns ETK_TRUE on success, and ETK_FALSE on failure (because @a
child is not packed in @a box)
+ * @return Returns ETK_TRUE on success, and ETK_FALSE on failure (because @a
child is not packed in @a box)
*/
Etk_Bool etk_box_child_packing_get(Etk_Box *box, Etk_Widget *child,
Etk_Box_Fill_Policy *fill_policy, int *padding)
{
@@ -1077,10 +1077,14 @@
*
* Etk_Box is the base class for Etk_HBox and Etk_VBox:
* in an Etk_HBox, the children are packed horizontally, and in an Etk_VBox,
the children are packed vertically. @n
- * A child can be packed at the start of the box (left for the hbox, top for
the vbox),
- * or at the end of the box (right for the hbox, bottom for the vbox). @n @n
- * The "homogeneous" setting controls whether or not all the children of the
box should take the same amount of space. @n
+ * You can pack a child in two differen groups of widgets: the start-group and
the end-group. The children of the
+ * start-group are packed at the start of the box (left for the hbox, top for
the vbox) and the children of the
+ * end are packed at the end of the box (right for the hbox, bottom for the
vbox). @n
+ * Widgets can be packed with the functions etk_box_prepend(),
etk_box_append(), etk_box_insert() and
+ * etk_box_insert_at(). @n @n
+ * The "homogeneous" setting determines whether or not all the children of the
box take up the same amount of space. @n
* The "spacing" setting determines the amount of space between two children.
+ *
*
* \par Object Hierarchy:
* - Etk_Object
@@ -1091,7 +1095,7 @@
* - Etk_VBox
*
* \par Properties:
- * @prop_name "homogeneous": Whether or not the children of the box should
take the same amount of space
+ * @prop_name "homogeneous": Whether or not the children of the box take up
the same amount of space
* @prop_type Boolean
* @prop_rw
* @prop_val ETK_FALSE
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_box.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- etk_box.h 15 Aug 2006 15:59:01 -0000 1.6
+++ etk_box.h 15 Aug 2006 20:20:43 -0000 1.7
@@ -34,7 +34,8 @@
/** Checks if the object is an Etk_VBox */
#define ETK_IS_VBOX(obj) (ETK_OBJECT_CHECK_TYPE((obj), ETK_VBOX_TYPE))
-/** @brief The two groups where the children could be packed: the start-group
and the end-group */
+
+/** @brief The two groups where the children can be packed: the start-group
and the end-group */
typedef enum Etk_Box_Group
{
ETK_BOX_START, /**< The start-group of children: the children in this
group are displayed
@@ -46,14 +47,14 @@
/** @brief Describes how a child of the box expands and fills the space */
typedef enum Etk_Box_Fill_Policy
{
- ETK_BOX_NONE = 1 << 0, /**< The child does not fill or expand */
- ETK_BOX_EXPAND = 1 << 1, /**< The child will fill all the available
space in its cell */
- ETK_BOX_FILL = 1 << 2, /**< The cell containing the child will expand
to take all the available space */
+ ETK_BOX_NONE = 0, /**< The child does not fill or expand */
+ ETK_BOX_EXPAND = 1 << 0, /**< The cell containing the child will expand
to take all the available space */
+ ETK_BOX_FILL = 1 << 1, /**< The child will fill all the available
space in its cell */
ETK_BOX_EXPAND_FILL = ETK_BOX_EXPAND | ETK_BOX_FILL, /**< Equivalent to
ETK_BOX_EXPAND | ETK_BOX_FILL */
} Etk_Box_Fill_Policy;
/**
- * @brief @widget The structure of a box
+ * @brief @widget An abstract class for a box
* @structinfo
*/
struct Etk_Box
@@ -69,7 +70,7 @@
};
/**
- * @brief @widget The structure of a hbox
+ * @brief @widget A box in which the children are packed horizontally
* @structinfo
*/
struct Etk_HBox
@@ -80,7 +81,7 @@
};
/**
- * @brief @widget The structure of a vbox
+ * @brief @widget A box in which the children are packed vertically
* @structinfo
*/
struct Etk_VBox
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_property.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- etk_property.h 2 Jun 2006 18:46:34 -0000 1.5
+++ etk_property.h 15 Aug 2006 20:20:43 -0000 1.6
@@ -38,17 +38,17 @@
*/
typedef enum Etk_Property_Flags
{
- ETK_PROPERTY_NO_ACCESS = 1 << 0, /**< Used when the property type is
ETK_PROPERTY_OTHER */
- ETK_PROPERTY_READABLE = 1 << 1, /**< The value of the property is
readable */
- ETK_PROPERTY_WRITABLE = 1 << 2, /**< The value of the property is
writable */
+ ETK_PROPERTY_NO_ACCESS = 0, /**< Used when the property type is
ETK_PROPERTY_OTHER */
+ ETK_PROPERTY_READABLE = 1 << 0, /**< The value of the property is
readable */
+ ETK_PROPERTY_WRITABLE = 1 << 1, /**< The value of the property is
writable */
ETK_PROPERTY_READABLE_WRITABLE = /**< The value of the property is
readable and writable */
ETK_PROPERTY_READABLE | ETK_PROPERTY_WRITABLE,
- ETK_PROPERTY_CONSTRUCT = 1 << 3 /**< Use this flag to force the
default value of the property to be set when
+ ETK_PROPERTY_CONSTRUCT = 1 << 2 /**< Use this flag to force the
default value of the property to be set when
* the object is created */
} Etk_Property_Flags;
/**
- * @brief An Etk_Property is a name associated to a type.
+ * @brief An Etk_Property is a name/value couple that can be associated to a
type.
* A property has a default value and can be readable, writable or both
* @structinfo
*/
@@ -63,7 +63,7 @@
};
/**
- * @brief The value of a property. You usually do not need to manipulate
directly it, use etk_object_properties_set()
+ * @brief The value of a property. You usually do not need to manipulate it
directly, use etk_object_properties_set()
* and etk_object_properties_get() to set and get the value of a property of
an object.
* @structinfo
*/
@@ -85,14 +85,14 @@
Etk_Property_Type type;
};
-Etk_Property *etk_property_new(const char *name, int property_id,
Etk_Property_Type type, Etk_Property_Flags flags, Etk_Property_Value
*default_value);
-void etk_property_delete(Etk_Property *property);
-Etk_Bool etk_property_default_value_set(Etk_Property *property,
Etk_Property_Value *default_value);
+Etk_Property *etk_property_new(const char *name, int property_id,
Etk_Property_Type type, Etk_Property_Flags flags, Etk_Property_Value
*default_value);
+void etk_property_delete(Etk_Property *property);
+Etk_Bool etk_property_default_value_set(Etk_Property *property,
Etk_Property_Value *default_value);
Etk_Property_Type etk_property_type_get(Etk_Property *property);
Etk_Property_Value *etk_property_value_new();
-void etk_property_value_delete(Etk_Property_Value *value);
-Etk_Property_Type etk_property_value_type_get(Etk_Property_Value *value);
+void etk_property_value_delete(Etk_Property_Value *value);
+Etk_Property_Type etk_property_value_type_get(Etk_Property_Value *value);
Etk_Property_Value *etk_property_value_create (Etk_Property_Type type,
...);
Etk_Property_Value *etk_property_value_create_valist (Etk_Property_Type type,
va_list *arg);
@@ -126,7 +126,7 @@
double etk_property_value_double_get(Etk_Property_Value *value);
short etk_property_value_short_get(Etk_Property_Value *value);
long etk_property_value_long_get(Etk_Property_Value *value);
-void * etk_property_value_pointer_get(Etk_Property_Value *value);
+void *etk_property_value_pointer_get(Etk_Property_Value *value);
const char *etk_property_value_string_get(Etk_Property_Value *value);
/** @} */
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_table.h,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- etk_table.h 15 Aug 2006 16:33:26 -0000 1.5
+++ etk_table.h 15 Aug 2006 20:20:43 -0000 1.6
@@ -22,12 +22,12 @@
/** @brief Describes how a child of the table should fill and expand the space
allocated to it */
typedef enum Etk_Table_Fill_Policy
{
- ETK_TABLE_NONE = 1 << 0, /**< The child doesn't fill or expand */
- ETK_TABLE_HFILL = 1 << 1, /**< The child fills all the horizontal
space allocated to it */
- ETK_TABLE_VFILL = 1 << 2, /**< The child fills all the vertical space
allocated to it */
- ETK_TABLE_HEXPAND = 1 << 3, /**< The child expands horizontally: the
cell containing the child */
+ ETK_TABLE_NONE = 0, /**< The child doesn't fill or expand */
+ ETK_TABLE_HFILL = 1 << 0, /**< The child fills all the horizontal
space allocated to it */
+ ETK_TABLE_VFILL = 1 << 1, /**< The child fills all the vertical space
allocated to it */
+ ETK_TABLE_HEXPAND = 1 << 2, /**< The child expands horizontally: the
cell containing the child */
/**< will take as much place as possible in
the horizontal direction */
- ETK_TABLE_VEXPAND = 1 << 4, /**< The child expands vertically: the cell
containing the child */
+ ETK_TABLE_VEXPAND = 1 << 3, /**< The child expands vertically: the cell
containing the child */
/**< will take as much place as possible in
the vertical direction */
ETK_TABLE_FILL = ETK_TABLE_HFILL | ETK_TABLE_VFILL, /**< Equivalent
to ETK_TABLE_HFILL | ETK_TABLE_VFILL */
ETK_TABLE_EXPAND = ETK_TABLE_HEXPAND | ETK_TABLE_VEXPAND, /**< Equivalent
to ETK_TABLE_HEXPAND | ETK_TABLE_VEXPAND */
-------------------------------------------------------------------------
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
[email protected]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
