luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-14 19:48:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

[gisignalinfo] Document and check parameters

Browse Source
This commit is contained in:
Johan Dahlin 2010-06-07 17:20:02 -03:00 committed by Johan Dahlin
parent 27511f220b
commit 825c230941
1 changed files with 57 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
gisignalinfo.c
View File

@ -25,14 +25,38 @@
#include "girepository-private.h" #include "girepository-private.h"
#include "gitypelib-internal.h" #include "gitypelib-internal.h"
/**
* SECTION:gisignalinfo
* @Short_description: Struct representing a signal
* @Title: GISignalInfo
*
* GISignalInfo represents a signal. It's a sub-struct of #GICallableInfo
* and contains a set of flags and a class closure.
*
* See #GICallableInfo for information on how to retreive arguments
* and other metadata from the signal.
*/
/**
* g_signal_info_get_flags:
* @info: a #GISignalInfo
*
* Obtain the flags for this signal info. See #GSignalFlags for
* more information about possible flag values.
*
* Returns: the flags
*/
GSignalFlags GSignalFlags
g_signal_info_get_flags (GISignalInfo *info) g_signal_info_get_flags (GISignalInfo *info)
{ {
GSignalFlags flags; GSignalFlags flags;
GIRealInfo *rinfo = (GIRealInfo *)info; GIRealInfo *rinfo = (GIRealInfo *)info;
SignalBlob *blob = (SignalBlob *)&rinfo->typelib->data[rinfo->offset]; SignalBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_SIGNAL_INFO (info), 0);
blob = (SignalBlob *)&rinfo->typelib->data[rinfo->offset];
flags = 0; flags = 0;
if (blob->run_first) if (blob->run_first)
@ -59,11 +83,26 @@ g_signal_info_get_flags (GISignalInfo *info)
return flags; return flags;
} }
/**
* g_signal_info_get_class_closure:
* @info: a #GISignalInfo
*
* Obtain the class closure for this signal if one is set. The class
* closure is a virtual function on the type that the signal belongs to.
* If the signal lacks a closure %NULL will be returned.
*
* Returns: the class closure or %NULL
*/
GIVFuncInfo * GIVFuncInfo *
g_signal_info_get_class_closure (GISignalInfo *info) g_signal_info_get_class_closure (GISignalInfo *info)
{ {
GIRealInfo *rinfo = (GIRealInfo *)info; GIRealInfo *rinfo = (GIRealInfo *)info;
SignalBlob *blob = (SignalBlob *)&rinfo->typelib->data[rinfo->offset]; SignalBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_SIGNAL_INFO (info), 0);
blob = (SignalBlob *)&rinfo->typelib->data[rinfo->offset];
if (blob->has_class_closure) if (blob->has_class_closure)
return g_interface_info_get_vfunc ((GIInterfaceInfo *)rinfo->container, blob->class_closure); return g_interface_info_get_vfunc ((GIInterfaceInfo *)rinfo->container, blob->class_closure);
@ -71,11 +110,25 @@ g_signal_info_get_class_closure (GISignalInfo *info)
return NULL; return NULL;
} }
/**
* g_signal_info_true_stops_emit:
* @info: a #GISignalInfo
*
* Obtain if the returning true in the signal handler will
* stop the emission of the signal.
*
* Returns: %TRUE if returning true stops the signal emission
*/
gboolean gboolean
g_signal_info_true_stops_emit (GISignalInfo *info) g_signal_info_true_stops_emit (GISignalInfo *info)
{ {
GIRealInfo *rinfo = (GIRealInfo *)info; GIRealInfo *rinfo = (GIRealInfo *)info;
SignalBlob *blob = (SignalBlob *)&rinfo->typelib->data[rinfo->offset]; SignalBlob *blob;
g_return_val_if_fail (info != NULL, 0);
g_return_val_if_fail (GI_IS_SIGNAL_INFO (info), 0);
blob = (SignalBlob *)&rinfo->typelib->data[rinfo->offset];
return blob->true_stops_emit; return blob->true_stops_emit;
} }