luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-14 22:37:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

opened up a new section on signals.

Browse Source 
Mon Oct 30 06:01:43 2000  Tim Janik  <timj@gtk.org>

        * gobject/gobject-sections.txt: opened up a new section on signals.

Mon Oct 30 05:52:45 2000  Tim Janik  <timj@gtk.org>

        * gsignal.c (g_signal_list_ids): get rid of inline documentation owen
        added, the doc system would ignore it anyways (for some reason not
        aparent to me).
This commit is contained in:
Tim Janik 2000-10-30 05:03:19 +00:00 committed by Tim Janik
parent 65c423b458
commit 817110279d
10 changed files with 406 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/ChangeLog
View File

@ -1,3 +1,7 @@
Mon Oct 30 06:01:43 2000 Tim Janik <timj@gtk.org>
* gobject/gobject-sections.txt: opened up a new section on signals.
2000-10-27 Sebastian Wilhelmi <wilhelmi@ira.uka.de> 2000-10-27 Sebastian Wilhelmi <wilhelmi@ira.uka.de>
* glib/tmpl/misc_utils.sgml: Removed the win32 limitation. * glib/tmpl/misc_utils.sgml: Removed the win32 limitation.

1
docs/reference/gobject/Makefile.am
View File

@ -21,6 +21,7 @@ tmpl_sources = \
tmpl/gobject-unused.sgml \ tmpl/gobject-unused.sgml \
tmpl/objects.sgml \ tmpl/objects.sgml \
tmpl/param_specs.sgml \ tmpl/param_specs.sgml \
tmpl/signals.sgml \
tmpl/standard_params.sgml \ tmpl/standard_params.sgml \
tmpl/types.sgml \ tmpl/types.sgml \
tmpl/value_collection.sgml \ tmpl/value_collection.sgml \

2
docs/reference/gobject/gobject-docs.sgml
View File

@ -3,6 +3,7 @@
<!entity gobject-generic-values SYSTEM "sgml/generic_values.sgml"> <!entity gobject-generic-values SYSTEM "sgml/generic_values.sgml">
<!entity gobject-objects SYSTEM "sgml/objects.sgml"> <!entity gobject-objects SYSTEM "sgml/objects.sgml">
<!entity gobject-param-specs SYSTEM "sgml/param_specs.sgml"> <!entity gobject-param-specs SYSTEM "sgml/param_specs.sgml">
<!entity gobject-signals SYSTEM "sgml/signals.sgml">
<!entity gobject-standard-params SYSTEM "sgml/standard_params.sgml"> <!entity gobject-standard-params SYSTEM "sgml/standard_params.sgml">
<!entity gobject-types SYSTEM "sgml/types.sgml"> <!entity gobject-types SYSTEM "sgml/types.sgml">
<!entity gobject-value-collection SYSTEM "sgml/value_collection.sgml"> <!entity gobject-value-collection SYSTEM "sgml/value_collection.sgml">
@ -24,6 +25,7 @@
&gobject-value-collection; &gobject-value-collection;
&gobject-param-specs; &gobject-param-specs;
&gobject-standard-params; &gobject-standard-params;
&gobject-signals;
</reference> </reference>
</book> </book>

35
docs/reference/gobject/gobject-sections.txt
View File

@ -81,6 +81,10 @@ g_type_remove_class_cache_func
g_type_class_unref_uncached g_type_class_unref_uncached
g_type_get_plugin g_type_get_plugin
g_type_fundamental_last g_type_fundamental_last
g_type_check_instance
g_type_check_value
g_type_is_dynamic
g_type_value_conforms_to
<SUBSECTION Private> <SUBSECTION Private>
g_log_domain_gobject g_log_domain_gobject
@ -220,7 +224,7 @@ g_value_dup_string
</SECTION> </SECTION>
<SECTION> <SECTION>
<TITLE>Object Parameter Specifications</TITLE> <TITLE>Parameter Specifications</TITLE>
<FILE>param_specs</FILE> <FILE>param_specs</FILE>
GParamSpec GParamSpec
GParamSpecClass GParamSpecClass
@ -316,3 +320,32 @@ G_VALUE_COLLECT
G_VALUE_LCOPY G_VALUE_LCOPY
</SECTION> </SECTION>
<SECTION>
<TITLE>Signals</TITLE>
<FILE>signals</FILE>
GSignalInvocationHint
GSignalAccumulator
GSignalCMarshaller
GSignalEmissionHook
GSignalFlags
GSignalMatchType
GSignalQuery
g_signal_newv
g_signal_emitv
g_signal_lookup
g_signal_name
g_signal_query
g_signal_list_ids
g_signal_connect_closure
g_signal_handler_find
g_signal_handler_block
g_signal_handler_unblock
g_signal_handler_disconnect
g_signal_has_handler_pending
g_signal_stop_emission
g_signal_type_closure_new
g_signal_add_emission_hook_full
g_signal_remove_emission_hook
g_signal_handlers_destroy
g_signals_destroy
</SECTION>

12
docs/reference/gobject/tmpl/gobject-unused.sgml
View File

@ -0,0 +1,12 @@
<!-- ##### ENUM GSignalType ##### -->
<para>
</para>
@G_SIGNAL_RUN_FIRST:
@G_SIGNAL_RUN_LAST:
@G_SIGNAL_RUN_CLEANUP:
@G_SIGNAL_NO_RECURSE:
@G_SIGNAL_ACTION:
@G_SIGNAL_NO_HOOKS:

2
docs/reference/gobject/tmpl/param_specs.sgml
View File

@ -1,5 +1,5 @@
<!-- ##### SECTION Title ##### --> <!-- ##### SECTION Title ##### -->
Object Parameter Specifications Parameter Specifications
<!-- ##### SECTION Short_Description ##### --> <!-- ##### SECTION Short_Description ##### -->

307
docs/reference/gobject/tmpl/signals.sgml Normal file
View File

@ -0,0 +1,307 @@
<!-- ##### SECTION Title ##### -->
Signals
<!-- ##### SECTION Short_Description ##### -->
Signals provide a means for customization of object behaviour and are used
as general purpose notification mechanism.
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GSignalInvocationHint ##### -->
<para>
The @GSignalInvocationHint structure is used to pass on additional information
to callbacks during a signal emission.
</para>
@signal_id: The signal id of the signal invoking the callback
@detail: The detail passed on for this emission
@run_type: The stage the signal emission is currently in, this
field will contain either of @G_SIGNAL_RUN_FIRST,
@G_SIGNAL_RUN_LAST or @G_SIGNAL_RUN_CLEANUP.
<!-- ##### USER_FUNCTION GSignalAccumulator ##### -->
<para>
The signal accumulator is a special callback function that can be used
to collect return values of the various callbacks that are called
during a signal emission. The signal accumulator is at signal creation
time, if it is left NULL, no accumulation of callback return values is
perfomed, the return value of the signal emission is the value returned
by the last callback.
</para>
@ihint: Signal invokation hint, see @GSignalInvocationHint
@return_accu: Accumulator to collect callback return values in, this
is the return value of the current signal emission
@return_value: The return value of the most recent callback function
@Returns: The accumulator function returns whether signal emission
should be aborted. Returning @FALSE means to abort the
current emission and @TRUE is returned for continuation.
<!-- ##### TYPEDEF GSignalCMarshaller ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GSignalEmissionHook ##### -->
<para>
</para>
@ihint:
@n_param_values:
@param_values:
@Returns:
<!-- # Unused Parameters # -->
@signal_id:
@n_values:
@values:
<!-- ##### ENUM GSignalFlags ##### -->
<para>
</para>
@G_SIGNAL_RUN_FIRST:
@G_SIGNAL_RUN_LAST:
@G_SIGNAL_RUN_CLEANUP:
@G_SIGNAL_NO_RECURSE:
@G_SIGNAL_DETAILED:
@G_SIGNAL_ACTION:
@G_SIGNAL_NO_HOOKS:
<!-- ##### ENUM GSignalMatchType ##### -->
<para>
</para>
@G_SIGNAL_MATCH_ID:
@G_SIGNAL_MATCH_DETAIL:
@G_SIGNAL_MATCH_CLOSURE:
@G_SIGNAL_MATCH_FUNC:
@G_SIGNAL_MATCH_DATA:
@G_SIGNAL_MATCH_UNBLOCKED:
<!-- ##### STRUCT GSignalQuery ##### -->
<para>
A structure holding in-depth information for a specific signal. It is
filled in by the @g_signal_query() function.
</para>
@signal_id: The signal id of the signal being querried, or 0 if the
signal to be querried was unknown
@signal_name: The signal name
@itype: The interface/instance type that this signal can be emitted for
@signal_flags: The signal flags as passed in to @g_signal_new()
@return_type: The return type for user callbacks
@n_params: The number of parameters that user callbacks take
@param_types: The individual parameter types for user callbacks, note that the
effective callback signature is:
@return_type callback (gpointer data1, @[parameters], gpointer data2);
<!-- ##### FUNCTION g_signal_newv ##### -->
<para>
</para>
@signal_name:
@itype:
@signal_flags:
@class_closure:
@accumulator:
@c_marshaller:
@return_type:
@n_params:
@param_types:
@Returns:
<!-- ##### FUNCTION g_signal_emitv ##### -->
<para>
</para>
@instance_and_params:
@signal_id:
@detail:
@return_value:
<!-- ##### FUNCTION g_signal_lookup ##### -->
<para>
</para>
@name:
@itype:
@Returns:
<!-- ##### FUNCTION g_signal_name ##### -->
<para>
</para>
@signal_id:
@Returns:
<!-- ##### FUNCTION g_signal_query ##### -->
<para>
Query the signal system for in-depth information about a
specific signal. This function will fill in a user-provided
structure to hold signal-specific information. If an invalid
dignal id is passed in, the @signal_id member of the @GSignalQuery
is 0. All members filled into the @GSignalQuery structure should
be considered constant and have to be left untouched.
</para>
@signal_id: The signal id of the signal to query information for
@query: A user provided structure that is filled in with constant
values upon success.
<!-- ##### FUNCTION g_signal_list_ids ##### -->
<para>
List the signals by id, that a certain instance or interface type
created. Further information about the signals can be aquired through
@g_signal_query().
</para>
@itype: Instance or interface type
@n_ids: Location to store the number of signal ids for @itype
@Returns: Newly allocated array of signal ids
<!-- ##### FUNCTION g_signal_connect_closure ##### -->
<para>
</para>
@instance:
@signal_id:
@detail:
@closure:
@after:
@Returns:
<!-- ##### FUNCTION g_signal_handler_find ##### -->
<para>
</para>
@instance:
@mask:
@signal_id:
@detail:
@closure:
@func:
@data:
@Returns:
<!-- ##### FUNCTION g_signal_handler_block ##### -->
<para>
</para>
@instance:
@handler_id:
<!-- ##### FUNCTION g_signal_handler_unblock ##### -->
<para>
</para>
@instance:
@handler_id:
<!-- ##### FUNCTION g_signal_handler_disconnect ##### -->
<para>
</para>
@instance:
@handler_id:
<!-- ##### FUNCTION g_signal_has_handler_pending ##### -->
<para>
</para>
@instance:
@signal_id:
@detail:
@may_be_blocked:
@Returns:
<!-- ##### FUNCTION g_signal_stop_emission ##### -->
<para>
</para>
@instance:
@signal_id:
@detail:
<!-- ##### FUNCTION g_signal_type_closure_new ##### -->
<para>
</para>
@itype:
@struct_offset:
@Returns:
<!-- ##### FUNCTION g_signal_add_emission_hook_full ##### -->
<para>
</para>
@signal_id:
@closure:
@Returns:
<!-- ##### FUNCTION g_signal_remove_emission_hook ##### -->
<para>
</para>
@signal_id:
@hook_id:
<!-- ##### FUNCTION g_signal_handlers_destroy ##### -->
<para>
</para>
@instance:
<!-- ##### FUNCTION g_signals_destroy ##### -->
<para>
</para>
@itype:

38
docs/reference/gobject/tmpl/types.sgml
View File

@ -750,3 +750,41 @@ GType
@Returns: @Returns:
<!-- ##### FUNCTION g_type_check_instance ##### -->
<para>
</para>
@instance:
@Returns:
<!-- ##### FUNCTION g_type_check_value ##### -->
<para>
</para>
@value:
@Returns:
<!-- ##### FUNCTION g_type_is_dynamic ##### -->
<para>
</para>
@type:
@flags:
@Returns:
<!-- ##### FUNCTION g_type_value_conforms_to ##### -->
<para>
</para>
@value:
@type:
@Returns:

6
gobject/ChangeLog
View File

@ -1,3 +1,9 @@
Mon Oct 30 05:52:45 2000 Tim Janik <timj@gtk.org>
* gsignal.c (g_signal_list_ids): get rid of inline documentation owen
added, the doc system would ignore it anyways (for some reason not
aparent to me).
Mon Oct 30 03:00:07 2000 Tim Janik <timj@gtk.org> Mon Oct 30 03:00:07 2000 Tim Janik <timj@gtk.org>
* gsignal.[hc] (g_signal_list_ids): renamed owen's g_type_signals(), * gsignal.[hc] (g_signal_list_ids): renamed owen's g_type_signals(),

9
gobject/gsignal.c
View File

@ -692,15 +692,6 @@ g_signal_query (guint signal_id,
G_UNLOCK (g_signal_mutex); G_UNLOCK (g_signal_mutex);
} }
/**
* g_signal_list_ids:
* @itype: an
* @n_ids: location to store number of signal ids for @itype
*
* List all signals for a given type.
*
* Return value: Newly allocated array of signal ids.
**/
guint* guint*
g_signal_list_ids (GType itype, g_signal_list_ids (GType itype,
guint *n_ids) guint *n_ids)