diff options
author | Murray Cumming <murrayc@murrayc.com> | 2015-06-21 13:06:20 +0200 |
---|---|---|
committer | Murray Cumming <murrayc@murrayc.com> | 2015-06-21 13:06:20 +0200 |
commit | 493eb8bfc6549c0c2aeba9dc331918e20dee500a (patch) | |
tree | 3a7a2be85f010e4f95d5460a75707a395424da33 /glib | |
parent | 49967e80f73032522c31707c4fcd25e092d7a14b (diff) | |
download | glibmm-493eb8bfc6549c0c2aeba9dc331918e20dee500a.tar.gz |
Regenerate glib docs.xml.
Diffstat (limited to 'glib')
-rw-r--r-- | glib/src/glib_docs.xml | 585 |
1 files changed, 255 insertions, 330 deletions
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml index 14472083..99b82185 100644 --- a/glib/src/glib_docs.xml +++ b/glib/src/glib_docs.xml @@ -9424,40 +9424,35 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_BOOLEAN__FLAGS"> <description> -A #GClosureMarshal function for use with signals with handlers that -take a flags type as an argument and return a boolean. If you have -such a signal, you will probably also need to use an accumulator, -such as g_signal_accumulator_true_handled(). +A marshaller for a #GCClosure with a callback of type +`gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter +denotes a flags type. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> a #GValue which can store the returned #gboolean </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding instance and arg1 </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -9586,78 +9581,44 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_BOOL__FLAGS"> <description> -An old alias for g_cclosure_marshal_BOOLEAN__FLAGS(). +Another name for g_cclosure_marshal_BOOLEAN__FLAGS(). </description> <parameters> -<parameter name="closure"> -<parameter_description> A #GClosure. -</parameter_description> -</parameter> -<parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. -</parameter_description> -</parameter> -<parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. -</parameter_description> -</parameter> -<parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. -</parameter_description> -</parameter> -<parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). -</parameter_description> -</parameter> -<parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() -</parameter_description> -</parameter> </parameters> <return></return> </function> <function name="g_cclosure_marshal_STRING__OBJECT_POINTER"> <description> -A #GClosureMarshal function for use with signals with handlers that -take a #GObject and a pointer and produce a string. It is highly -unlikely that your signal handler fits this description. +A marshaller for a #GCClosure with a callback of type +`gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> a #GValue, which can store the returned string </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 3 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding instance, arg1 and arg2 </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -9709,38 +9670,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__BOOLEAN"> <description> -A #GClosureMarshal function for use with signals with a single -boolean argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #gboolean parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -9792,38 +9749,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__BOXED"> <description> -A #GClosureMarshal function for use with signals with a single -argument which is any boxed pointer type. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #GBoxed* parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -9875,38 +9828,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__CHAR"> <description> -A #GClosureMarshal function for use with signals with a single -character argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gchar arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #gchar parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -9958,38 +9907,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__DOUBLE"> <description> -A #GClosureMarshal function for use with signals with one -double-precision floating point argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #gdouble parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10041,38 +9986,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__ENUM"> <description> -A #GClosureMarshal function for use with signals with a single -argument with an enumerated type. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes an enumeration type.. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the enumeration parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10124,38 +10065,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__FLAGS"> <description> -A #GClosureMarshal function for use with signals with a single -argument with a flags types. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the flags parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10207,38 +10144,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__FLOAT"> <description> -A #GClosureMarshal function for use with signals with one -single-precision floating point argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #gfloat parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10290,38 +10223,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__INT"> <description> -A #GClosureMarshal function for use with signals with a single -integer argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gint arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #gint parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10373,38 +10302,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__LONG"> <description> -A #GClosureMarshal function for use with signals with with a single -long integer argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, glong arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #glong parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10456,38 +10381,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__OBJECT"> <description> -A #GClosureMarshal function for use with signals with a single -#GObject argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #GObject* parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10539,38 +10460,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__PARAM"> <description> -A #GClosureMarshal function for use with signals with a single -argument of type #GParamSpec. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #GParamSpec* parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10622,42 +10539,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__POINTER"> <description> -A #GClosureMarshal function for use with signals with a single raw -pointer argument type. - -If it is possible, it is better to use one of the more specific -functions such as g_cclosure_marshal_VOID__OBJECT() or -g_cclosure_marshal_VOID__OBJECT(). +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #gpointer parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10709,38 +10618,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__STRING"> <description> -A #GClosureMarshal function for use with signals with a single string -argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #gchar* parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10792,38 +10697,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__UCHAR"> <description> -A #GClosureMarshal function for use with signals with a single -unsigned character argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, guchar arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #guchar parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10875,38 +10776,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__UINT"> <description> -A #GClosureMarshal function for use with signals with with a single -unsigned integer argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, guint arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #guint parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -10915,38 +10812,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__UINT_POINTER"> <description> -A #GClosureMarshal function for use with signals with a unsigned int -and a pointer as arguments. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 3 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding instance, arg1 and arg2 </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -11041,38 +10934,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__ULONG"> <description> -A #GClosureMarshal function for use with signals with a single -unsigned long integer argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gulong arg1, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #gulong parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -11124,38 +11013,36 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__VARIANT"> <description> -A #GClosureMarshal function for use with signals with a single -#GVariant argument. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)`. + +Since: 2.26 </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 2 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding the instance and the #GVariant* parameter </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -11207,37 +11094,34 @@ g_closure_set_meta_marshal() <function name="g_cclosure_marshal_VOID__VOID"> <description> -A #GClosureMarshal function for use with signals with no arguments. +A marshaller for a #GCClosure with a callback of type +`void (*callback) (gpointer instance, gpointer user_data)`. </description> <parameters> <parameter name="closure"> -<parameter_description> A #GClosure. +<parameter_description> the #GClosure to which the marshaller belongs </parameter_description> </parameter> <parameter name="return_value"> -<parameter_description> A #GValue to store the return value. May be %NULL -if the callback of closure doesn't return a value. +<parameter_description> ignored </parameter_description> </parameter> <parameter name="n_param_values"> -<parameter_description> The length of the @param_values array. +<parameter_description> 1 </parameter_description> </parameter> <parameter name="param_values"> -<parameter_description> An array of #GValues holding the arguments -on which to invoke the callback of closure. +<parameter_description> a #GValue array holding only the instance </parameter_description> </parameter> <parameter name="invocation_hint"> -<parameter_description> The invocation hint given as the last argument to -g_closure_invoke(). +<parameter_description> the invocation hint given as the last argument +to g_closure_invoke() </parameter_description> </parameter> <parameter name="marshal_data"> -<parameter_description> Additional data specified when registering the -marshaller, see g_closure_set_marshal() and -g_closure_set_meta_marshal() +<parameter_description> additional data specified when registering the marshaller </parameter_description> </parameter> </parameters> @@ -14234,8 +14118,8 @@ etc. The date must be valid. <function name="g_date_get_monday_week_of_year"> <description> Returns the week of the year, where weeks are understood to start on -Monday. If the date is before the first Monday of the year, return -0. The date must be valid. +Monday. If the date is before the first Monday of the year, return 0. +The date must be valid. </description> @@ -14289,9 +14173,9 @@ Returns the month of the year. The date must be valid. <function name="g_date_get_sunday_week_of_year"> <description> -Returns the week of the year during which this date falls, if weeks -are understood to being on Sunday. The date must be valid. Can return -0 if the day is before the first Sunday of the year. +Returns the week of the year during which this date falls, if +weeks are understood to being on Sunday. The date must be valid. +Can return 0 if the day is before the first Sunday of the year. </description> @@ -16853,8 +16737,7 @@ for an empty environment list </parameter_description> </parameter> <parameter name="variable"> -<parameter_description> the environment variable to get, in the GLib file name -encoding +<parameter_description> the environment variable to get </parameter_description> </parameter> </parameters> @@ -16992,7 +16875,7 @@ be returned. If @domain contains a `FAILED` (or otherwise generic) error code, you should generally not check for it explicitly, but should instead treat any not-explicitly-recognized error code as being -equilalent to the `FAILED` code. This way, if the domain is +equivalent to the `FAILED` code. This way, if the domain is extended in the future to provide a more specific error code for a certain case, your code will still work. @@ -18524,9 +18407,9 @@ GLib and should not be modified or freed. <description> Returns the value of an environment variable. -The name and value are in the GLib file name encoding. On UNIX, -this means the actual bytes which might or might not be in some -consistent character set and encoding. On Windows, it is in UTF-8. +On UNIX, the name and value are byte strings which might or might not +be in some consistent character set and encoding. On Windows, they are +in UTF-8. On Windows, in case the environment variable's value contains references to other environment variables, they are expanded. @@ -18534,8 +18417,7 @@ references to other environment variables, they are expanded. </description> <parameters> <parameter name="variable"> -<parameter_description> the environment variable to get, in the GLib file name -encoding +<parameter_description> the environment variable to get </parameter_description> </parameter> </parameters> @@ -21745,10 +21627,12 @@ should be freed with g_free() when no longer needed. <function name="g_key_file_get_comment"> <description> Retrieves a comment above @key from @group_name. -If @key is %NULL then @comment will be read from above -@group_name. If both @key and @group_name are %NULL, then +If @key is %NULL then @comment will be read from above +@group_name. If both @key and @group_name are %NULL, then @comment will be read from above the first group in the file. +Note that the returned string includes the '#' comment markers. + Since: 2.6 </description> @@ -22716,10 +22600,14 @@ Since: 2.6 <function name="g_key_file_set_comment"> <description> Places a comment above @key from @group_name. -If @key is %NULL then @comment will be written above @group_name. -If both @key and @group_name are %NULL, then @comment will be + +If @key is %NULL then @comment will be written above @group_name. +If both @key and @group_name are %NULL, then @comment will be written above the first group in the file. +Note that this function prepends a '#' comment marker to +each line of @comment. + Since: 2.6 </description> @@ -24338,6 +24226,44 @@ the log levels with the #G_LOG_FLAG_FATAL and </return> </function> +<function name="g_log_set_handler_full"> +<description> +Like g_log_sets_handler(), but takes a destroy notify for the @user_data. + +Since: 2.46 + +</description> +<parameters> +<parameter name="log_domain"> +<parameter_description> the log domain, or %NULL for the default "" +application domain +</parameter_description> +</parameter> +<parameter name="log_levels"> +<parameter_description> the log levels to apply the log handler for. +To handle fatal and recursive messages as well, combine +the log levels with the #G_LOG_FLAG_FATAL and +#G_LOG_FLAG_RECURSION bit flags. +</parameter_description> +</parameter> +<parameter name="log_func"> +<parameter_description> the log handler function +</parameter_description> +</parameter> +<parameter name="user_data"> +<parameter_description> data passed to the log handler +</parameter_description> +</parameter> +<parameter name="destroy"> +<parameter_description> destroy notify for @user_data, or %NULL +</parameter_description> +</parameter> +</parameters> +<return> the id of the new handler + +</return> +</function> + <function name="g_logv"> <description> Logs an error or debugging message. @@ -38529,10 +38455,9 @@ example. <function name="g_setenv"> <description> -Sets an environment variable. Both the variable's name and value -should be in the GLib file name encoding. On UNIX, this means that -they can be arbitrary byte strings. On Windows, they should be in -UTF-8. +Sets an environment variable. On UNIX, both the variable's name and +value can be arbitrary byte strings, except that the variable's name +cannot contain '='. On Windows, they should be in UTF-8. Note that on some systems, when variables are overwritten, the memory used for the previous variables and its value isn't reclaimed. |