Enlightenment CVS committal
Author : moom
Project : e17
Module : proto
Dir : e17/proto/etk/src/lib
Modified Files:
Etk.h etk_alignment.c etk_alignment.h etk_argument.c
etk_argument.h etk_bin.c etk_bin.h etk_marshallers.c
etk_marshallers.h etk_object.h etk_signal.c etk_signal.h
etk_signal_callback.c etk_signal_callback.h etk_types.h
Log Message:
Doc fix + clean up
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/Etk.h,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -3 -r1.37 -r1.38
--- Etk.h 15 Aug 2006 20:56:19 -0000 1.37
+++ Etk.h 17 Aug 2006 17:18:14 -0000 1.38
@@ -9,71 +9,71 @@
extern "C" {
#endif
+#include "etk_argument.h"
#include "etk_main.h"
-#include "etk_types.h"
-#include "etk_utils.h"
-#include "etk_type.h"
-#include "etk_object.h"
-#include "etk_signal.h"
-#include "etk_signal_callback.h"
#include "etk_marshallers.h"
+#include "etk_object.h"
#include "etk_property.h"
+#include "etk_signal_callback.h"
+#include "etk_signal.h"
#include "etk_string.h"
+#include "etk_type.h"
+#include "etk_types.h"
+#include "etk_utils.h"
-#include "etk_theme.h"
-#include "etk_cache.h"
-#include "etk_widget.h"
-#include "etk_stock.h"
+#include "etk_alignment.h"
#include "etk_bin.h"
#include "etk_box.h"
-#include "etk_table.h"
-#include "etk_alignment.h"
-#include "etk_frame.h"
-#include "etk_paned.h"
-#include "etk_scrolled_view.h"
-#include "etk_viewport.h"
-#include "etk_window.h"
-#include "etk_engine.h"
-#include "etk_dialog.h"
-#include "etk_label.h"
-#include "etk_image.h"
#include "etk_button.h"
-#include "etk_toggle_button.h"
+#include "etk_cache.h"
+#include "etk_canvas.h"
#include "etk_check_button.h"
-#include "etk_radio_button.h"
-#include "etk_toolbar.h"
-#include "etk_tool_button.h"
+#include "etk_clipboard.h"
+#include "etk_colorpicker.h"
+#include "etk_combobox.h"
+#include "etk_dialog.h"
+#include "etk_dnd.h"
+#include "etk_drag.h"
#include "etk_editable_text_object.h"
-#include "etk_textblock.h"
+#include "etk_embed.h"
+#include "etk_engine.h"
#include "etk_entry.h"
-#include "etk_text_view.h"
-#include "etk_canvas.h"
-#include "etk_colorpicker.h"
-#include "etk_tree.h"
-#include "etk_tree_model.h"
-#include "etk_range.h"
-#include "etk_slider.h"
-#include "etk_scrollbar.h"
-#include "etk_separator.h"
-#include "etk_popup_window.h"
-#include "etk_menu_shell.h"
+#include "etk_filechooser_widget.h"
+#include "etk_frame.h"
+#include "etk_iconbox.h"
+#include "etk_image.h"
+#include "etk_label.h"
#include "etk_menu.h"
#include "etk_menu_bar.h"
#include "etk_menu_item.h"
-#include "etk_combobox.h"
-#include "etk_statusbar.h"
-#include "etk_filechooser_widget.h"
+#include "etk_menu_shell.h"
+#include "etk_message_dialog.h"
#include "etk_notebook.h"
+#include "etk_paned.h"
+#include "etk_popup_window.h"
#include "etk_progress_bar.h"
-#include "etk_dnd.h"
-#include "etk_clipboard.h"
+#include "etk_radio_button.h"
+#include "etk_range.h"
+#include "etk_scrollbar.h"
+#include "etk_scrolled_view.h"
#include "etk_selection.h"
-#include "etk_drag.h"
-#include "etk_argument.h"
+#include "etk_separator.h"
+#include "etk_slider.h"
+#include "etk_statusbar.h"
+#include "etk_stock.h"
+#include "etk_table.h"
+#include "etk_textblock.h"
+#include "etk_text_view.h"
+#include "etk_theme.h"
+#include "etk_toggle_button.h"
+#include "etk_tool_button.h"
+#include "etk_toolbar.h"
#include "etk_tooltips.h"
-#include "etk_message_dialog.h"
-#include "etk_iconbox.h"
-#include "etk_embed.h"
+#include "etk_tree.h"
+#include "etk_tree_model.h"
+#include "etk_viewport.h"
+#include "etk_widget.h"
+#include "etk_window.h"
#ifdef __cplusplus
}
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_alignment.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- etk_alignment.c 13 Aug 2006 22:42:23 -0000 1.8
+++ etk_alignment.c 17 Aug 2006 17:18:14 -0000 1.9
@@ -28,6 +28,7 @@
**************************/
/**
+ * @internal
* @brief Gets the type of an Etk_Alignment
* @return Returns the type of an Etk_Alignment
*/
@@ -60,8 +61,8 @@
* @brief Creates a new alignment
* @param xalign the horizontal alignment, from 0.0 (left) to 1.0 (right)
* @param yalign the vertical alignment, from 0.0 (top) to 1.0 (bottom)
- * @param xscale the horizontal scale factor, from 0.0 (do not scale) to 1.0
(take all the available space)
- * @param yscale the vertical scale factor, from 0.0 (do not scale) to 1.0
(take all the available space)
+ * @param xscale the horizontal scale factor, from 0.0 (do not scale) to 1.0
(fill all the available space)
+ * @param yscale the vertical scale factor, from 0.0 (do not scale) to 1.0
(fill all the available space)
* @return Returns the new alignment widget
*/
Etk_Widget *etk_alignment_new(float xalign, float yalign, float xscale, float
yscale)
@@ -75,8 +76,8 @@
* @param alignment an alignment
* @param xalign the horizontal alignment, from 0.0 (left) to 1.0 (right)
* @param yalign the vertical alignment, from 0.0 (top) to 1.0 (bottom)
- * @param xscale the horizontal scale factor, from 0.0 (do not scale) to 1.0
(take all the available space)
- * @param yscale the vertical scale factor, from 0.0 (do not scale) to 1.0
(take all the available space)
+ * @param xscale the horizontal scale factor, from 0.0 (do not scale) to 1.0
(fill all the available space)
+ * @param yscale the vertical scale factor, from 0.0 (do not scale) to 1.0
(fill all the available space)
*/
void etk_alignment_set(Etk_Alignment *alignment, float xalign, float yalign,
float xscale, float yscale)
{
@@ -259,7 +260,7 @@
* @addtogroup Etk_Alignment
*
* The scale settings control how much the child should expand to fill the
available space,
- * from 0.0 (the child doesn't expand at all) to 1.0 (the child takes all the
available space). @n
+ * from 0.0 (the child doesn't expand at all) to 1.0 (the child takes up all
the available space). @n
* The align settings control the alignment of the child inside the container,
* from 0.0 (the child is aligned on the left/top) to 1.0 (the child is
aligned on the right/bottom). @n
* The align settings have no effect if the scale factors are set to 1.0.
@@ -282,14 +283,14 @@
* @prop_rw
* @prop_val 0.5
* \par
- * @prop_name "xscale": How much of the horizontal space should use the child,
- * from 0.0 (none, the child does not expand) to 1.0 (the child fill all the
horizontal space).
+ * @prop_name "xscale": How much of the horizontal space the child should use,
+ * from 0.0 (none, the child does not expand) to 1.0 (the child fills all the
horizontal space).
* @prop_type Float
* @prop_rw
* @prop_val 1.0
* \par
- * @prop_name "yscale": How much of the vertical space should use the child,
- * from 0.0 (none, the child does not expand) to 1.0 (the child fill all the
vertical space).
+ * @prop_name "yscale": How much of the vertical space the child should use,
+ * from 0.0 (none, the child does not expand) to 1.0 (the child fills all the
vertical space).
* @prop_type Float
* @prop_rw
* @prop_val 1.0
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_alignment.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- etk_alignment.h 12 May 2006 19:13:39 -0000 1.3
+++ etk_alignment.h 17 Aug 2006 17:18:14 -0000 1.4
@@ -20,7 +20,7 @@
#define ETK_IS_ALIGNMENT(obj) (ETK_OBJECT_CHECK_TYPE((obj),
ETK_ALIGNMENT_TYPE))
/**
- * @brief @widget The structure of an alignment
+ * @brief @widget A container containing one child which can be aligned and
scaled
* @structinfo
*/
struct Etk_Alignment
@@ -35,7 +35,7 @@
float yscale;
};
-Etk_Type *etk_alignment_type_get();
+Etk_Type *etk_alignment_type_get();
Etk_Widget *etk_alignment_new(float xalign, float yalign, float xscale, float
yscale);
void etk_alignment_set(Etk_Alignment *alignment, float xalign, float yalign,
float xscale, float yscale);
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_argument.c,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- etk_argument.c 5 Aug 2006 02:37:25 -0000 1.8
+++ etk_argument.c 17 Aug 2006 17:18:14 -0000 1.9
@@ -19,10 +19,10 @@
* @brief Checks whether the argument has been passed to the program
* @param argc the location of the "argc" parameter passed to main()
* @param argv the location of the "argv" parameter passed to main()
- * @param long_name the complete name of the argument to find. If --long_name
is found in @a argv, this function will
- * return ETK_TRUE. It can be set to NULL to be ignored it
- * @param short_name a shortcut for the argument to find. If -short_name is
found in @a argv, this function will
- * return ETK_TRUE. It can be set to 0 to be ignored it
+ * @param long_name the complete name of the argument to find. If
'--long_name' is found in @a argv, this function will
+ * return ETK_TRUE. You can set it to NULL to ignore it
+ * @param short_name a shortcut for the argument to find. If '-short_name' is
found in @a argv, this function will
+ * return ETK_TRUE. You can set it to NULL to ignore it
* @param remove if @a remove is ETK_TRUE, the argument will be removed from
@a argv if it has been found
* @return Returns ETK_TRUE if the argument has been found, ETK_FALSE otherwise
*/
@@ -70,9 +70,9 @@
* @param argc the location of the "argc" parameter passed to main()
* @param argv the location of the "argv" parameter passed to main()
* @param long_name the complete name of the argument to find. If --long_name
is found in @a argv and is followed by a
- * value, this function will return ETK_TRUE. It can be set to NULL to be
ignored it
+ * value, this function will return ETK_TRUE. You can set it to NULL to ignore
it
* @param short_name a shortcut for the argument to find. If -short_name is
found in @a argv and is followed by a
- * value, this function will return ETK_TRUE. It can be set to 0 to be ignored
it
+ * value, this function will return ETK_TRUE. You can set it to NULL to ignore
it
* @param remove if @a remove is ETK_TRUE, the argument and its value will be
removed from @a argv
* if they have been found
* @param value the location where to store the value of the argument. You'll
have to free it when you no longer need it
@@ -164,3 +164,18 @@
}
/** @} */
+
+/**************************
+ *
+ * Documentation
+ *
+ **************************/
+
+/**
+ * @addtogroup Etk_Argument
+ *
+ * You can use those two functions to parse the arguments given to your
program. @n
+ * Two kinds of arguments are supported:
+ * - <b>Short arguments</b>: <i>"-c"</i>, <i>"-c value"</i> or <i>"-cvalue"</i>
+ * - <b>Long arguments</b>: <i>"--argument"</i>, <i>"--agument value"</i> or
<i>"--argument=value"</i>
+ */
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_argument.h,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -3 -r1.8 -r1.9
--- etk_argument.h 5 Aug 2006 02:37:25 -0000 1.8
+++ etk_argument.h 17 Aug 2006 17:18:14 -0000 1.9
@@ -3,9 +3,10 @@
#define _ETK_ARGUMENT_H_
#include "etk_types.h"
-
+
/**
* @defgroup Etk_Argument Etk_Argument
+ * @brief A couple of functions to parse the arguments of a program
* @{
*/
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_bin.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -3 -r1.14 -r1.15
--- etk_bin.c 15 Aug 2006 22:26:55 -0000 1.14
+++ etk_bin.c 17 Aug 2006 17:18:14 -0000 1.15
@@ -33,6 +33,7 @@
**************************/
/**
+ * @internal
* @brief Gets the type of an Etk_Bin
* @return Returns the type of an Etk_Bin
*/
@@ -258,7 +259,7 @@
/**
* @addtogroup Etk_Bin
*
- * The Etk_Bin widget is mainly used as a base class for containers that only
have one children
+ * The Etk_Bin widget is mainly used as a base class for containers that only
have one child
* (such as Etk_Alignment, Etk_Window, Etk_Frame...).
*
* \par Object Hierarchy:
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_bin.h,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -3 -r1.7 -r1.8
--- etk_bin.h 15 Aug 2006 22:26:55 -0000 1.7
+++ etk_bin.h 17 Aug 2006 17:18:14 -0000 1.8
@@ -38,7 +38,7 @@
Etk_Type *etk_bin_type_get();
Etk_Widget *etk_bin_child_get(Etk_Bin *bin);
-void etk_bin_child_set(Etk_Bin *bin, Etk_Widget *child);
+void etk_bin_child_set(Etk_Bin *bin, Etk_Widget *child);
/** @} */
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_marshallers.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- etk_marshallers.c 13 Feb 2006 15:20:32 -0000 1.5
+++ etk_marshallers.c 17 Aug 2006 17:18:14 -0000 1.6
@@ -2,82 +2,82 @@
#include "etk_marshallers.h"
/* etk_marshaller_VOID__VOID */
-void etk_marshaller_VOID__VOID(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments)
+void etk_marshaller_VOID__VOID(Etk_Callback callback, Etk_Object *object, void
*data, void *return_value, va_list arguments)
{
- typedef void (*Etk_Signal_Callback_Function_VOID__VOID)(Etk_Object *object,
void *data);
+ typedef void (*Etk_Callback_VOID__VOID)(Etk_Object *object, void *data);
- Etk_Signal_Callback_Function_VOID__VOID callback_VOID__VOID;
+ Etk_Callback_VOID__VOID callback_VOID__VOID;
if (!callback || !object)
return;
- callback_VOID__VOID = (Etk_Signal_Callback_Function_VOID__VOID)callback;
+ callback_VOID__VOID = (Etk_Callback_VOID__VOID)callback;
callback_VOID__VOID(object, data);
}
/* etk_marshaller_VOID__INT */
-void etk_marshaller_VOID__INT(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments)
+void etk_marshaller_VOID__INT(Etk_Callback callback, Etk_Object *object, void
*data, void *return_value, va_list arguments)
{
- typedef void (*Etk_Signal_Callback_Function_VOID__INT)(Etk_Object *object,
int arg1, void *data);
+ typedef void (*Etk_Callback_VOID__INT)(Etk_Object *object, int arg1, void
*data);
int arg1;
- Etk_Signal_Callback_Function_VOID__INT callback_VOID__INT;
+ Etk_Callback_VOID__INT callback_VOID__INT;
if (!callback || !object)
return;
arg1 = va_arg(arguments, int);
- callback_VOID__INT = (Etk_Signal_Callback_Function_VOID__INT)callback;
+ callback_VOID__INT = (Etk_Callback_VOID__INT)callback;
callback_VOID__INT(object, arg1, data);
}
/* etk_marshaller_VOID__DOUBLE */
-void etk_marshaller_VOID__DOUBLE(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments)
+void etk_marshaller_VOID__DOUBLE(Etk_Callback callback, Etk_Object *object,
void *data, void *return_value, va_list arguments)
{
- typedef void (*Etk_Signal_Callback_Function_VOID__DOUBLE)(Etk_Object
*object, double arg1, void *data);
+ typedef void (*Etk_Callback_VOID__DOUBLE)(Etk_Object *object, double arg1,
void *data);
double arg1;
- Etk_Signal_Callback_Function_VOID__DOUBLE callback_VOID__DOUBLE;
+ Etk_Callback_VOID__DOUBLE callback_VOID__DOUBLE;
if (!callback || !object)
return;
arg1 = va_arg(arguments, double);
- callback_VOID__DOUBLE = (Etk_Signal_Callback_Function_VOID__DOUBLE)callback;
+ callback_VOID__DOUBLE = (Etk_Callback_VOID__DOUBLE)callback;
callback_VOID__DOUBLE(object, arg1, data);
}
/* etk_marshaller_VOID__POINTER */
-void etk_marshaller_VOID__POINTER(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments)
+void etk_marshaller_VOID__POINTER(Etk_Callback callback, Etk_Object *object,
void *data, void *return_value, va_list arguments)
{
- typedef void (*Etk_Signal_Callback_Function_VOID__POINTER)(Etk_Object
*object, void *arg1, void *data);
+ typedef void (*Etk_Callback_VOID__POINTER)(Etk_Object *object, void *arg1,
void *data);
void *arg1;
- Etk_Signal_Callback_Function_VOID__POINTER callback_VOID__POINTER;
+ Etk_Callback_VOID__POINTER callback_VOID__POINTER;
if (!callback || !object)
return;
arg1 = va_arg(arguments, void *);
- callback_VOID__POINTER =
(Etk_Signal_Callback_Function_VOID__POINTER)callback;
+ callback_VOID__POINTER = (Etk_Callback_VOID__POINTER)callback;
callback_VOID__POINTER(object, arg1, data);
}
/* etk_marshaller_VOID__POINTER_POINTER */
-void etk_marshaller_VOID__POINTER_POINTER(Etk_Signal_Callback_Function
callback, Etk_Object *object, void *data, void *return_value, va_list arguments)
+void etk_marshaller_VOID__POINTER_POINTER(Etk_Callback callback, Etk_Object
*object, void *data, void *return_value, va_list arguments)
{
- typedef void
(*Etk_Signal_Callback_Function_VOID__POINTER_POINTER)(Etk_Object *object, void
*arg1, void *arg2, void *data);
+ typedef void (*Etk_Callback_VOID__POINTER_POINTER)(Etk_Object *object, void
*arg1, void *arg2, void *data);
void *arg1;
void *arg2;
- Etk_Signal_Callback_Function_VOID__POINTER_POINTER
callback_VOID__POINTER_POINTER;
+ Etk_Callback_VOID__POINTER_POINTER callback_VOID__POINTER_POINTER;
if (!callback || !object)
return;
@@ -85,19 +85,19 @@
arg1 = va_arg(arguments, void *);
arg2 = va_arg(arguments, void *);
- callback_VOID__POINTER_POINTER =
(Etk_Signal_Callback_Function_VOID__POINTER_POINTER)callback;
+ callback_VOID__POINTER_POINTER =
(Etk_Callback_VOID__POINTER_POINTER)callback;
callback_VOID__POINTER_POINTER(object, arg1, arg2, data);
}
/* etk_marshaller_VOID__INT_POINTER */
-void etk_marshaller_VOID__INT_POINTER(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments)
+void etk_marshaller_VOID__INT_POINTER(Etk_Callback callback, Etk_Object
*object, void *data, void *return_value, va_list arguments)
{
- typedef void (*Etk_Signal_Callback_Function_VOID__INT_POINTER)(Etk_Object
*object, int arg1, void *arg2, void *data);
+ typedef void (*Etk_Callback_VOID__INT_POINTER)(Etk_Object *object, int
arg1, void *arg2, void *data);
int arg1;
void *arg2;
- Etk_Signal_Callback_Function_VOID__INT_POINTER callback_VOID__INT_POINTER;
+ Etk_Callback_VOID__INT_POINTER callback_VOID__INT_POINTER;
if (!callback || !object)
return;
@@ -105,24 +105,24 @@
arg1 = va_arg(arguments, int);
arg2 = va_arg(arguments, void *);
- callback_VOID__INT_POINTER =
(Etk_Signal_Callback_Function_VOID__INT_POINTER)callback;
+ callback_VOID__INT_POINTER = (Etk_Callback_VOID__INT_POINTER)callback;
callback_VOID__INT_POINTER(object, arg1, arg2, data);
}
/* etk_marshaller_BOOL__VOID */
-void etk_marshaller_BOOL__VOID(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments)
+void etk_marshaller_BOOL__VOID(Etk_Callback callback, Etk_Object *object, void
*data, void *return_value, va_list arguments)
{
- typedef Etk_Bool (*Etk_Signal_Callback_Function_BOOL__VOID)(Etk_Object
*object, void *data);
+ typedef Etk_Bool (*Etk_Callback_BOOL__VOID)(Etk_Object *object, void *data);
Etk_Bool result;
- Etk_Signal_Callback_Function_BOOL__VOID callback_BOOL__VOID;
+ Etk_Callback_BOOL__VOID callback_BOOL__VOID;
if (!callback || !object)
return;
- callback_BOOL__VOID = (Etk_Signal_Callback_Function_BOOL__VOID)callback;
+ callback_BOOL__VOID = (Etk_Callback_BOOL__VOID)callback;
result = callback_BOOL__VOID(object, data);
if (return_value)
@@ -130,21 +130,21 @@
}
/* etk_marshaller_BOOL__DOUBLE */
-void etk_marshaller_BOOL__DOUBLE(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments)
+void etk_marshaller_BOOL__DOUBLE(Etk_Callback callback, Etk_Object *object,
void *data, void *return_value, va_list arguments)
{
- typedef Etk_Bool (*Etk_Signal_Callback_Function_BOOL__DOUBLE)(Etk_Object
*object, double arg1, void *data);
+ typedef Etk_Bool (*Etk_Callback_BOOL__DOUBLE)(Etk_Object *object, double
arg1, void *data);
double arg1;
Etk_Bool result;
- Etk_Signal_Callback_Function_BOOL__DOUBLE callback_BOOL__DOUBLE;
+ Etk_Callback_BOOL__DOUBLE callback_BOOL__DOUBLE;
if (!callback || !object)
return;
arg1 = va_arg(arguments, double);
- callback_BOOL__DOUBLE = (Etk_Signal_Callback_Function_BOOL__DOUBLE)callback;
+ callback_BOOL__DOUBLE = (Etk_Callback_BOOL__DOUBLE)callback;
result = callback_BOOL__DOUBLE(object, arg1, data);
if (return_value)
@@ -152,15 +152,15 @@
}
/* etk_marshaller_BOOL__POINTER_POINTER */
-void etk_marshaller_BOOL__POINTER_POINTER(Etk_Signal_Callback_Function
callback, Etk_Object *object, void *data, void *return_value, va_list arguments)
+void etk_marshaller_BOOL__POINTER_POINTER(Etk_Callback callback, Etk_Object
*object, void *data, void *return_value, va_list arguments)
{
- typedef Etk_Bool
(*Etk_Signal_Callback_Function_BOOL__POINTER_POINTER)(Etk_Object *object, void
*arg1, void *arg2, void *data);
+ typedef Etk_Bool (*Etk_Callback_BOOL__POINTER_POINTER)(Etk_Object *object,
void *arg1, void *arg2, void *data);
void *arg1;
void *arg2;
Etk_Bool result;
- Etk_Signal_Callback_Function_BOOL__POINTER_POINTER
callback_BOOL__POINTER_POINTER;
+ Etk_Callback_BOOL__POINTER_POINTER callback_BOOL__POINTER_POINTER;
if (!callback || !object)
return;
@@ -168,7 +168,7 @@
arg1 = va_arg(arguments, void *);
arg2 = va_arg(arguments, void *);
- callback_BOOL__POINTER_POINTER =
(Etk_Signal_Callback_Function_BOOL__POINTER_POINTER)callback;
+ callback_BOOL__POINTER_POINTER =
(Etk_Callback_BOOL__POINTER_POINTER)callback;
result = callback_BOOL__POINTER_POINTER(object, arg1, arg2, data);
if (return_value)
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_marshallers.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -3 -r1.6 -r1.7
--- etk_marshallers.h 12 May 2006 19:13:39 -0000 1.6
+++ etk_marshallers.h 17 Aug 2006 17:18:14 -0000 1.7
@@ -5,17 +5,14 @@
#include <stdarg.h>
#include "etk_types.h"
-/** Casts the function pointer to an Etk_Signal_Marshaller */
-#define ETK_MARSHALLER(marshaller) ((Etk_Signal_Marshaller)(marshaller))
-
-void etk_marshaller_VOID__VOID(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments);
-void etk_marshaller_VOID__INT(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments);
-void etk_marshaller_VOID__DOUBLE(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments);
-void etk_marshaller_VOID__POINTER(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments);
-void etk_marshaller_VOID__POINTER_POINTER(Etk_Signal_Callback_Function
callback, Etk_Object *object, void *data, void *return_value, va_list
arguments);
-void etk_marshaller_VOID__INT_POINTER(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments);
-void etk_marshaller_BOOL__VOID(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments);
-void etk_marshaller_BOOL__DOUBLE(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments);
-void etk_marshaller_BOOL__POINTER_POINTER(Etk_Signal_Callback_Function
callback, Etk_Object *object, void *data, void *return_value, va_list
arguments);
+void etk_marshaller_VOID__VOID(Etk_Callback callback, Etk_Object *object, void
*data, void *return_value, va_list arguments);
+void etk_marshaller_VOID__INT(Etk_Callback callback, Etk_Object *object, void
*data, void *return_value, va_list arguments);
+void etk_marshaller_VOID__DOUBLE(Etk_Callback callback, Etk_Object *object,
void *data, void *return_value, va_list arguments);
+void etk_marshaller_VOID__POINTER(Etk_Callback callback, Etk_Object *object,
void *data, void *return_value, va_list arguments);
+void etk_marshaller_VOID__POINTER_POINTER(Etk_Callback callback, Etk_Object
*object, void *data, void *return_value, va_list arguments);
+void etk_marshaller_VOID__INT_POINTER(Etk_Callback callback, Etk_Object
*object, void *data, void *return_value, va_list arguments);
+void etk_marshaller_BOOL__VOID(Etk_Callback callback, Etk_Object *object, void
*data, void *return_value, va_list arguments);
+void etk_marshaller_BOOL__DOUBLE(Etk_Callback callback, Etk_Object *object,
void *data, void *return_value, va_list arguments);
+void etk_marshaller_BOOL__POINTER_POINTER(Etk_Callback callback, Etk_Object
*object, void *data, void *return_value, va_list arguments);
#endif
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_object.h,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -3 -r1.10 -r1.11
--- etk_object.h 13 Aug 2006 19:20:28 -0000 1.10
+++ etk_object.h 17 Aug 2006 17:18:14 -0000 1.11
@@ -9,7 +9,7 @@
/**
* @defgroup Etk_Object Etk_Object
- * @brief The Etk_Object class is the base class of all the objects and the
widgets of Etk
+ * @brief The Etk_Object class is the base class for all the objects and the
widgets of Etk
* @{
*/
@@ -39,7 +39,7 @@
};
/**
- * @brief @object The structure of an object
+ * @brief @object The base class for all the objects and widgets of Etk
* @structinfo
*/
struct Etk_Object
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_signal.c,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -3 -r1.16 -r1.17
--- etk_signal.c 13 Aug 2006 22:42:23 -0000 1.16
+++ etk_signal.c 17 Aug 2006 17:18:14 -0000 1.17
@@ -33,8 +33,7 @@
/**
* @internal
- * @brief Shutdowns the signal system
- * @warning You must not call it manually, etk_shudown() calls it automatically
+ * @brief Shutdowns the signal system: it destroys all the created signals
*/
void etk_signal_shutdown()
{
@@ -55,7 +54,7 @@
* @brief Creates a new signal called @a signal_name, for the object type @a
object_type
* @param signal_name the name of the new signal
* @param object_type the object type of the new signal
- * @param default_handler_offset the offset of the default handler in the
object's struct
+ * @param handler_offset the offset of the default handler in the object's
struct
* (use ETK_MEMBER_OFFSET() to get it). -1 if there is no default handler
* @param marshaller the marshaller of the signal: it will treat and pass the
arguments to the callbacks
* @param accumulator the accumulator used to combine together the different
values returned by the callbacks.
@@ -63,7 +62,7 @@
* @param accum_data the value to pass to the accumulator
* @return Returns the new signal, or NULL on failure
*/
-Etk_Signal *etk_signal_new(const char *signal_name, Etk_Type *object_type,
long default_handler_offset, Etk_Marshaller marshaller, Etk_Accumulator
accumulator, void *accum_data)
+Etk_Signal *etk_signal_new(const char *signal_name, Etk_Type *object_type,
long handler_offset, Etk_Marshaller marshaller, Etk_Accumulator accumulator,
void *accum_data)
{
Etk_Signal *new_signal;
@@ -73,7 +72,7 @@
new_signal = malloc(sizeof(Etk_Signal));
new_signal->name = strdup(signal_name);
new_signal->object_type = object_type;
- new_signal->default_handler_offset = default_handler_offset;
+ new_signal->handler_offset = handler_offset;
new_signal->marshaller = marshaller;
new_signal->accumulator = accumulator;
new_signal->accum_data = accum_data;
@@ -147,7 +146,7 @@
* Otherwise, it will be called before the default handler. It can be useful
to set it to ETK_TRUE if you want the
* callback to be called after all the other callbacks connect to the signal.
*/
-void etk_signal_connect_full(Etk_Signal *signal, Etk_Object *object,
Etk_Signal_Callback_Function callback, void *data, Etk_Bool swapped, Etk_Bool
after)
+void etk_signal_connect_full(Etk_Signal *signal, Etk_Object *object,
Etk_Callback callback, void *data, Etk_Bool swapped, Etk_Bool after)
{
Etk_Signal_Callback *new_callback;
if (!object || !signal || !callback)
@@ -166,7 +165,7 @@
* @param callback the callback to call when the signal is emitted
* @param data the data to pass to the callback
*/
-void etk_signal_connect(const char *signal_name, Etk_Object *object,
Etk_Signal_Callback_Function callback, void *data)
+void etk_signal_connect(const char *signal_name, Etk_Object *object,
Etk_Callback callback, void *data)
{
Etk_Signal *signal;
@@ -191,7 +190,7 @@
* @param callback the callback to call when the signal is emitted
* @param data the data to pass to the callback
*/
-void etk_signal_connect_after(const char *signal_name, Etk_Object *object,
Etk_Signal_Callback_Function callback, void *data)
+void etk_signal_connect_after(const char *signal_name, Etk_Object *object,
Etk_Callback callback, void *data)
{
Etk_Signal *signal;
@@ -217,7 +216,7 @@
* @param callback the callback to call when the signal is emitted
* @param data the data to pass to the callback
*/
-void etk_signal_connect_swapped(const char *signal_name, Etk_Object *object,
Etk_Signal_Callback_Function callback, void *data)
+void etk_signal_connect_swapped(const char *signal_name, Etk_Object *object,
Etk_Callback callback, void *data)
{
Etk_Signal *signal;
@@ -240,7 +239,7 @@
* @param object the object connected to the callback to disconnect
* @param callback the callback to disconnect
*/
-void etk_signal_disconnect(const char *signal_name, Etk_Object *object,
Etk_Signal_Callback_Function callback)
+void etk_signal_disconnect(const char *signal_name, Etk_Object *object,
Etk_Callback callback)
{
Etk_Signal *signal;
Evas_List *callbacks;
@@ -378,11 +377,11 @@
}
/* Calls the default handler */
- if (object_ptr && !emitted_signal->stop_emission &&
signal->default_handler_offset >= 0 && signal->marshaller)
+ if (object_ptr && !emitted_signal->stop_emission && signal->handler_offset
>= 0 && signal->marshaller)
{
- Etk_Signal_Callback_Function *default_handler;
+ Etk_Callback *default_handler;
- default_handler = (void *)object + signal->default_handler_offset;
+ default_handler = (void *)object + signal->handler_offset;
if (*default_handler)
{
if (!return_value_set || !signal->accumulator)
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_signal.h,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -3 -r1.9 -r1.10
--- etk_signal.h 13 Aug 2006 22:42:23 -0000 1.9
+++ etk_signal.h 17 Aug 2006 17:18:14 -0000 1.10
@@ -25,7 +25,7 @@
/* private: */
char *name;
Etk_Type *object_type;
- long default_handler_offset;
+ long handler_offset;
Etk_Marshaller marshaller;
Etk_Accumulator accumulator;
void *accum_data;
@@ -33,18 +33,18 @@
void etk_signal_shutdown();
-Etk_Signal *etk_signal_new(const char *signal_name, Etk_Type *object_type,
long default_handler_offset, Etk_Marshaller marshaller, Etk_Accumulator
accumulator, void *accum_data);
+Etk_Signal *etk_signal_new(const char *signal_name, Etk_Type *object_type,
long handler_offset, Etk_Marshaller marshaller, Etk_Accumulator accumulator,
void *accum_data);
void etk_signal_delete(Etk_Signal *signal);
Etk_Signal *etk_signal_lookup(const char *signal_name, Etk_Type *type);
const char *etk_signal_name_get(Etk_Signal *signal);
Etk_Marshaller etk_signal_marshaller_get(Etk_Signal *signal);
-void etk_signal_connect(const char *signal_name, Etk_Object *object,
Etk_Signal_Callback_Function callback, void *data);
-void etk_signal_connect_after(const char *signal_name, Etk_Object *object,
Etk_Signal_Callback_Function callback, void *data);
-void etk_signal_connect_swapped(const char *signal_name, Etk_Object *object,
Etk_Signal_Callback_Function callback, void *data);
-void etk_signal_connect_full(Etk_Signal *signal, Etk_Object *object,
Etk_Signal_Callback_Function callback, void *data, Etk_Bool swapped, Etk_Bool
after);
-void etk_signal_disconnect(const char *signal_name, Etk_Object *object,
Etk_Signal_Callback_Function callback);
+void etk_signal_connect(const char *signal_name, Etk_Object *object,
Etk_Callback callback, void *data);
+void etk_signal_connect_after(const char *signal_name, Etk_Object *object,
Etk_Callback callback, void *data);
+void etk_signal_connect_swapped(const char *signal_name, Etk_Object *object,
Etk_Callback callback, void *data);
+void etk_signal_connect_full(Etk_Signal *signal, Etk_Object *object,
Etk_Callback callback, void *data, Etk_Bool swapped, Etk_Bool after);
+void etk_signal_disconnect(const char *signal_name, Etk_Object *object,
Etk_Callback callback);
void etk_signal_emit(Etk_Signal *signal, Etk_Object *object, void
*return_value, ...);
void etk_signal_emit_by_name(const char *signal_name, Etk_Object *object, void
*return_value, ...);
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_signal_callback.c,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -3 -r1.5 -r1.6
--- etk_signal_callback.c 4 Mar 2006 18:04:10 -0000 1.5
+++ etk_signal_callback.c 17 Aug 2006 17:18:14 -0000 1.6
@@ -1,6 +1,7 @@
/** @file etk_signal_callback.c */
#include "etk_signal_callback.h"
#include <stdlib.h>
+#include <stdarg.h>
#include "etk_signal.h"
/**
@@ -15,15 +16,17 @@
**************************/
/**
- * @brief Creates a new signal callback for the signal @a signal, with
callback function @a callback, and with user data @a data
- * @param signal the signal to add this callback to
- * @param callback the callback function called when the signal is emitted
+ * @internal
+ * @brief Creates a new signal callback for the signal @a signal, using the
callback function @a callback, and
+ * associated to user data @a data
+ * @param signal the signal to which this callback should be added
+ * @param callback the callback function to call when the signal is emitted
* @param data the user data to pass to the callback function
- * @param swapped if @a swapped != 0, the callback function with the data as
the only arguments
- * @return Returns the new callback on succes or NULL on failure
+ * @param swapped if @a swapped is ETK_TRUE, the callback function will be
called with the data as the only argument
+ * @return Returns the new signal callback on success or NULL on failure
* @warning The new signal callback has to be freed with
etk_signal_callback_del()
*/
-Etk_Signal_Callback *etk_signal_callback_new(Etk_Signal *signal,
Etk_Signal_Callback_Function callback, void *data, Etk_Bool swapped)
+Etk_Signal_Callback *etk_signal_callback_new(Etk_Signal *signal, Etk_Callback
callback, void *data, Etk_Bool swapped)
{
Etk_Signal_Callback *new_callback;
@@ -40,6 +43,7 @@
}
/**
+ * @internal
* @brief Deletes the signal callback
* @param signal_callback the signal callback to delete
*/
@@ -49,7 +53,8 @@
}
/**
- * @brief Calls the callback @a callback on the object @a object
+ * @internal
+ * @brief Calls the signal callback @a callback on the object @a object
* @param callback the signal callback to call
* @param object the object to call the callback on
* @param return_value the location for the return value (if none, it can be
NULL)
@@ -68,6 +73,7 @@
}
/**
+ * @internal
* @brief Calls the callback @a callback on the object @a object
* @param callback the signal callback to call
* @param object the object to call the callback on
@@ -79,12 +85,14 @@
Etk_Marshaller marshaller;
if (!callback || !callback->callback || !callback->signal ||
- !object || !(marshaller =
etk_signal_marshaller_get(callback->signal)))
+ !object || !(marshaller = etk_signal_marshaller_get(callback->signal)))
+ {
return;
+ }
if (callback->swapped)
{
- Etk_Signal_Swapped_Callback_Function swapped_callback =
ETK_SWAPPED_CALLBACK(callback->callback);
+ Etk_Callback_Swapped swapped_callback = callback->callback;
swapped_callback(callback->data);
}
else
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_signal_callback.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- etk_signal_callback.h 2 Dec 2005 21:57:55 -0000 1.2
+++ etk_signal_callback.h 17 Aug 2006 17:18:14 -0000 1.3
@@ -7,33 +7,31 @@
/**
* @defgroup Etk_Signal_Callback Etk_Signal_Callback
+ * @brief For more infos, see the page about Etk_Signal
* @{
*/
-/** @brief Casts the function pointer to an Etk_Signal_Callback_Function */
-#define ETK_CALLBACK(callback)
((Etk_Signal_Callback_Function)(callback))
-/** @brief Casts the function pointer to an
Etk_Signal_Swapped_Callback_Function */
-#define ETK_SWAPPED_CALLBACK(callback)
((Etk_Signal_Swapped_Callback_Function)(callback))
+/** Casts the function pointer to an Etk_Signal_Callback_Function */
+#define ETK_CALLBACK(callback) ((Etk_Callback)(callback))
/**
- * @struct Etk_Signal_Callback
- * @brief An Etk_Signal_Callback is a function called when the associated
signal is emmited. @n
- * If it swapped, it is called with @a data as the only argument. @n
- * Otherwise, its arguments are (Etk_Object *object, ..., void *data) where
... are optionnal arguments depending on the signal
+ * @brief A callback that will be called when the corresponding signal is
emitted
+ * @structinfo
*/
-struct _Etk_Signal_Callback
+struct Etk_Signal_Callback
{
/* private: */
Etk_Signal *signal;
- Etk_Signal_Callback_Function callback;
- void *data;
+ Etk_Callback callback;
Etk_Bool swapped;
+ void *data;
};
-Etk_Signal_Callback *etk_signal_callback_new(Etk_Signal *signal,
Etk_Signal_Callback_Function callback, void *data, Etk_Bool swapped);
-void etk_signal_callback_del(Etk_Signal_Callback *signal_callback);
-void etk_signal_callback_call(Etk_Signal_Callback *callback, Etk_Object
*object, void *return_value, ...);
-void etk_signal_callback_call_valist(Etk_Signal_Callback *callback, Etk_Object
*object, void *return_value, va_list args);
+
+Etk_Signal_Callback *etk_signal_callback_new(Etk_Signal *signal, Etk_Callback
callback, void *data, Etk_Bool swapped);
+void etk_signal_callback_del(Etk_Signal_Callback
*signal_callback);
+void etk_signal_callback_call(Etk_Signal_Callback *callback,
Etk_Object *object, void *return_value, ...);
+void etk_signal_callback_call_valist(Etk_Signal_Callback
*callback, Etk_Object *object, void *return_value, va_list args);
/** @} */
===================================================================
RCS file: /cvs/e/e17/proto/etk/src/lib/etk_types.h,v
retrieving revision 1.51
retrieving revision 1.52
diff -u -3 -r1.51 -r1.52
--- etk_types.h 17 Aug 2006 15:44:07 -0000 1.51
+++ etk_types.h 17 Aug 2006 17:18:14 -0000 1.52
@@ -11,26 +11,25 @@
#define ETK_FALSE 0
#define ETK_TRUE 1
-
typedef unsigned char Etk_Bool;
+
typedef struct Etk_Notification_Callback Etk_Notification_Callback;
typedef struct Etk_Object Etk_Object;
typedef struct Etk_Property Etk_Property;
typedef struct Etk_Property_Value Etk_Property_Value;
typedef struct Etk_Signal Etk_Signal;
-typedef struct _Etk_Signal_Callback Etk_Signal_Callback;
+typedef struct Etk_Signal_Callback Etk_Signal_Callback;
typedef struct _Etk_String Etk_String;
typedef struct _Etk_Type Etk_Type;
typedef void (*Etk_Accumulator)(void *return_value, const void
*value_to_accum, void *data);
typedef void (*Etk_Constructor)(Etk_Object *object);
typedef void (*Etk_Destructor)(Etk_Object *object);
-typedef void (*Etk_Signal_Callback_Function)(void);
-typedef void (*Etk_Signal_Swapped_Callback_Function)(void *data);
-typedef void (*Etk_Marshaller)(Etk_Signal_Callback_Function callback,
Etk_Object *object, void *data, void *return_value, va_list arguments);
+typedef void (*Etk_Callback)();
+typedef void (*Etk_Callback_Swapped)(void *data);
+typedef void (*Etk_Marshaller)(Etk_Callback callback, Etk_Object *object, void
*data, void *return_value, va_list arguments);
typedef struct Etk_Alignment Etk_Alignment;
-typedef struct _Etk_Argument Etk_Argument;
typedef struct Etk_Bin Etk_Bin;
typedef struct Etk_Box Etk_Box;
typedef struct Etk_HBox Etk_HBox;
@@ -111,8 +110,6 @@
typedef struct _Etk_Viewport Etk_Viewport;
typedef struct _Etk_Widget Etk_Widget;
typedef struct _Etk_Window Etk_Window;
-
-typedef Etk_Engine *(*Etk_Engine_Constructor)(void);
/**
* @struct Etk_Position
-------------------------------------------------------------------------
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
