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

docs: Move the GSignalGroup SECTION

Browse Source 
Move the contents to the struct docs.

Helps: #3037
This commit is contained in:
Matthias Clasen 2023-09-25 15:13:44 -04:00 committed by Philip Withnall
parent 36d65922e2
commit 6e1d5302ed
2 changed files with 10 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
gobject/gsignalgroup.c
View File

@ -28,13 +28,12 @@
#include "gvaluetypes.h" #include "gvaluetypes.h"
/** /**
* SECTION:gsignalgroup * GSignalGroup:
* @Title: GSignalGroup
* @Short_description: Manage a collection of signals on a GObject
* *
* #GSignalGroup manages to simplify the process of connecting * `GSignalGroup` manages a collection of signals on a `GObject`.
* many signals to a #GObject as a group. As such there is no API *
* to disconnect a signal from the group. * `GSignalGroup` simplifies the process of connecting many signals to a `GObject`
* as a group. As such there is no API to disconnect a signal from the group.
* *
* In particular, this allows you to: * In particular, this allows you to:
* *
@ -43,12 +42,12 @@
* - Block and unblock signals as a group * - Block and unblock signals as a group
* - Ensuring that blocked state transfers across target instances. * - Ensuring that blocked state transfers across target instances.
* *
* One place you might want to use such a structure is with #GtkTextView and * One place you might want to use such a structure is with `GtkTextView` and
* #GtkTextBuffer. Often times, you'll need to connect to many signals on * `GtkTextBuffer`. Often times, you'll need to connect to many signals on
* #GtkTextBuffer from a #GtkTextView subclass. This allows you to create a * `GtkTextBuffer` from a `GtkTextView` subclass. This allows you to create a
* signal group during instance construction, simply bind the * signal group during instance construction, simply bind the
* #GtkTextView:buffer property to #GSignalGroup:target and connect * `GtkTextView:buffer` property to `GSignalGroup:target` and connect
* all the signals you need. When the #GtkTextView:buffer property changes * all the signals you need. When the `GtkTextView:buffer` property changes
* all of the signals will be transitioned correctly. * all of the signals will be transitioned correctly.
* *
* Since: 2.72 * Since: 2.72

8
gobject/gsignalgroup.h
View File

@ -36,14 +36,6 @@ G_BEGIN_DECLS
#define G_IS_SIGNAL_GROUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SIGNAL_GROUP)) #define G_IS_SIGNAL_GROUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_SIGNAL_GROUP))
#define G_TYPE_SIGNAL_GROUP (g_signal_group_get_type()) #define G_TYPE_SIGNAL_GROUP (g_signal_group_get_type())
/**
* GSignalGroup:
*
* #GSignalGroup is an opaque structure whose members
* cannot be accessed directly.
*
* Since: 2.72
*/
typedef struct _GSignalGroup GSignalGroup; typedef struct _GSignalGroup GSignalGroup;
GOBJECT_AVAILABLE_IN_2_72 GOBJECT_AVAILABLE_IN_2_72