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

docs: Move the GPropertyAction SECTION

Browse Source 
Move it to the struct docs.

Signed-off-by: Philip Withnall <philip@tecnocode.co.uk>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-10-24 10:55:38 +01:00
parent ca02613987
commit 658bb30f06
1 changed files with 21 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
gio/gpropertyaction.c
View File

@ -28,17 +28,14 @@
#include "glibintl.h" #include "glibintl.h"
/** /**
* SECTION:gpropertyaction * GPropertyAction:
* @title: GPropertyAction
* @short_description: A GAction reflecting a GObject property
* @include: gio/gio.h
* *
* A #GPropertyAction is a way to get a #GAction with a state value * A `GPropertyAction` is a way to get a [iface@Gio.Action] with a state value
* reflecting and controlling the value of a #GObject property. * reflecting and controlling the value of a [class@GObject.Object] property.
* *
* The state of the action will correspond to the value of the property. * The state of the action will correspond to the value of the property.
* Changing it will change the property (assuming the requested value * Changing it will change the property (assuming the requested value
* matches the requirements as specified in the #GParamSpec). * matches the requirements as specified in the [type@GObject.ParamSpec]).
* *
* Only the most common types are presently supported. Booleans are * Only the most common types are presently supported. Booleans are
* mapped to booleans, strings to strings, signed/unsigned integers to * mapped to booleans, strings to strings, signed/unsigned integers to
@ -46,16 +43,16 @@
* *
* If the property is an enum then the state will be string-typed and * If the property is an enum then the state will be string-typed and
* conversion will automatically be performed between the enum value and * conversion will automatically be performed between the enum value and
* "nick" string as per the #GEnumValue table. * ‘nick’ string as per the [type@GObject.EnumValue] table.
* *
* Flags types are not currently supported. * Flags types are not currently supported.
* *
* Properties of object types, boxed types and pointer types are not * Properties of object types, boxed types and pointer types are not
* supported and probably never will be. * supported and probably never will be.
* *
* Properties of #GVariant types are not currently supported. * Properties of [type@GLib.Variant] types are not currently supported.
* *
* If the property is boolean-valued then the action will have a NULL * If the property is boolean-valued then the action will have a `NULL`
* parameter type, and activating the action (with no parameter) will * parameter type, and activating the action (with no parameter) will
* toggle the value of the property. * toggle the value of the property.
* *
@ -64,26 +61,26 @@
* *
* The general idea here is to reduce the number of locations where a * The general idea here is to reduce the number of locations where a
* particular piece of state is kept (and therefore has to be synchronised * particular piece of state is kept (and therefore has to be synchronised
* between). #GPropertyAction does not have a separate state that is kept * between). `GPropertyAction` does not have a separate state that is kept
* in sync with the property value -- its state is the property value. * in sync with the property value — its state is the property value.
* *
* For example, it might be useful to create a #GAction corresponding to * For example, it might be useful to create a [iface@Gio.Action] corresponding
* the "visible-child-name" property of a #GtkStack so that the current * to the `visible-child-name` property of a [class@Gtk.Stack] so that the
* page can be switched from a menu. The active radio indication in the * current page can be switched from a menu. The active radio indication in the
* menu is then directly determined from the active page of the * menu is then directly determined from the active page of the
* #GtkStack. * [class@Gtk.Stack].
* *
* An anti-example would be binding the "active-id" property on a * An anti-example would be binding the `active-id` property on a
* #GtkComboBox. This is because the state of the combobox itself is * [class@Gtk.ComboBox]. This is because the state of the combobox itself is
* probably uninteresting and is actually being used to control * probably uninteresting and is actually being used to control
* something else. * something else.
* *
* Another anti-example would be to bind to the "visible-child-name" * Another anti-example would be to bind to the `visible-child-name`
* property of a #GtkStack if this value is actually stored in * property of a [class@Gtk.Stack] if this value is actually stored in
* #GSettings. In that case, the real source of the value is * [class@Gio.Settings]. In that case, the real source of the value is
* #GSettings. If you want a #GAction to control a setting stored in * [class@Gio.Settings]. If you want a [iface@Gio.Action] to control a setting
* #GSettings, see g_settings_create_action() instead, and possibly * stored in [class@Gio.Settings], see [method@Gio.Settings.create_action]
* combine its use with g_settings_bind(). * instead, and possibly combine its use with [method@Gio.Settings.bind].
* *
* Since: 2.38 * Since: 2.38
**/ **/
@ -98,14 +95,6 @@ struct _GPropertyAction
gboolean invert_boolean; gboolean invert_boolean;
}; };
/**
* GPropertyAction:
*
* This type is opaque.
*
* Since: 2.38
**/
typedef GObjectClass GPropertyActionClass; typedef GObjectClass GPropertyActionClass;
static void g_property_action_iface_init (GActionInterface *iface); static void g_property_action_iface_init (GActionInterface *iface);