Enlightenment CVS committal
Author : moom
Project : e17
Module : libs/etk
Dir : e17/libs/etk/src/lib
Modified Files:
etk_object.c etk_object.h etk_signal.c etk_signal.h
Log Message:
* Fix doc
===================================================================
RCS file: /cvs/e/e17/libs/etk/src/lib/etk_object.c,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -3 -r1.31 -r1.32
--- etk_object.c 13 Jan 2007 05:52:40 -0000 1.31
+++ etk_object.c 13 Jan 2007 16:20:11 -0000 1.32
@@ -82,7 +82,6 @@
* @internal
* @brief Gets the type of an Etk_Object
* @return Returns the type of an Etk_Object
- * TODO: improve the doc, its confusing here (with
etk_object_object_type_get()) (or rename those functions...)
*/
Etk_Type *etk_object_type_get(void)
{
===================================================================
RCS file: /cvs/e/e17/libs/etk/src/lib/etk_object.h,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -3 -r1.14 -r1.15
--- etk_object.h 13 Jan 2007 05:52:40 -0000 1.14
+++ etk_object.h 13 Jan 2007 16:20:11 -0000 1.15
@@ -7,6 +7,12 @@
#include "etk_type.h"
#include "etk_types.h"
+/* TODO/FIXME list:
+ * - etk_object_type_get() and etk_object_object_type_get() are confusing:
maybe we should rename them
+ * - instead of having one list for all the signal-callbacks, we could maybe
use one list per type of signal. It
+ * would make things more optimized
+ */
+
/**
* @defgroup Etk_Object Etk_Object
* @brief The Etk_Object class is the base class for all the objects and
widgets of Etk
===================================================================
RCS file: /cvs/e/e17/libs/etk/src/lib/etk_signal.c,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -3 -r1.20 -r1.21
--- etk_signal.c 13 Jan 2007 05:52:40 -0000 1.20
+++ etk_signal.c 13 Jan 2007 16:20:11 -0000 1.21
@@ -35,7 +35,7 @@
* @internal
* @brief Shutdowns the signal system: it destroys all the created signals
*/
-void etk_signal_shutdown()
+void etk_signal_shutdown(void)
{
while (_etk_signal_emitted_signals)
{
@@ -142,9 +142,8 @@
* @param data the data to pass to the callback
* @param swapped if @a swapped == ETK_TRUE, the callback will be called with
@a data as the only argument.
* It can be useful to set it to ETK_TRUE if you just want to call one
function on an object when the signal is emitted
- * @param after if @a after == ETK_TRUE, the callback will be called after the
default handler is called.
- * 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.
+ * @param after if @a after == ETK_TRUE, the callback will be called after all
the callbacks already connected to this
+ * signal. Otherwise, it will be called before all of them (default behavior)
*/
void etk_signal_connect_full(Etk_Signal *signal, Etk_Object *object,
Etk_Callback callback, void *data, Etk_Bool swapped, Etk_Bool after)
{
@@ -158,8 +157,9 @@
}
/**
- * @brief Connects a callback to a signal of the object @a object. When the
signal of the object will be emitted, this
- * callback will be automatically called <b>before</b> the default handler
+ * @brief Connects a callback to a signal of the object @a object. The
callback is added at the start of the list of
+ * callbacks to call. It means that when the signal is emitted, this callback
will the first to be called. This way, you
+ * can prevent the other callbacks from being called using etk_signal_stop()
when this callback gets called
* @param signal the signal to connect to the callback
* @param object the object to connect to the callback
* @param callback the callback to call when the signal is emitted
@@ -183,8 +183,9 @@
}
/**
- * @brief Connects a callback to a signal of the object @a object. When the
signal of the object will be emitted, this
- * callback will be automatically called <b>after</b> the default handler
+ * @brief Connects a callback to a signal of the object @a object. The
callback is added at the end of the list of
+ * callbacks to call which means that when the signal is emitted, this
callback will the last to be called. If you don't
+ * need a specific call-order, use etk_signal_connect() rather
* @param signal the signal to connect to the callback
* @param object the object to connect to the callback
* @param callback the callback to call when the signal is emitted
@@ -208,9 +209,9 @@
}
/**
- * @brief Connects a callback to a signal of the object @a object. When the
signal of the object will be emitted, this
- * callback will be automatically called <b>vefore</b> the default handler,
with @a data as the only argument. @n
- * It can be useful if you just want to call one function on an object when
the signal is emitted
+ * @brief Connects a callback to a signal of the object @a object. The
callback is added at the start of the list of
+ * callbacks to call. It means that when the signal is emitted, this callback
will the first to be called. This way, you
+ * can prevent the other callbacks from being called using etk_signal_stop()
when this callback gets called
* @param signal_name the name of the signal to connect to the object to
* @param object the object that will connect the signal
* @param callback the callback to call when the signal is emitted
===================================================================
RCS file: /cvs/e/e17/libs/etk/src/lib/etk_signal.h,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -3 -r1.12 -r1.13
--- etk_signal.h 13 Jan 2007 05:19:11 -0000 1.12
+++ etk_signal.h 13 Jan 2007 16:20:11 -0000 1.13
@@ -31,13 +31,13 @@
void *accum_data;
};
-void etk_signal_shutdown();
+void etk_signal_shutdown(void);
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);
+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_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_Callback callback, void *data);
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
