[gtk/ebassi/aspect-frame-doc: 2/3] Document GtkAspectFrame properties
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/ebassi/aspect-frame-doc: 2/3] Document GtkAspectFrame properties
- Date: Tue, 12 Jan 2021 12:29:38 +0000 (UTC)
commit 5286743cbe9657ddda9340cd5dcf85a0103235de
Author: Emmanuele Bassi <ebassi gnome org>
Date: Tue Jan 12 12:28:00 2021 +0000
Document GtkAspectFrame properties
gtk/gtkaspectframe.c | 32 +++++++++++++++++++++++++++++++-
1 file changed, 31 insertions(+), 1 deletion(-)
---
diff --git a/gtk/gtkaspectframe.c b/gtk/gtkaspectframe.c
index 45a9bf80e1..23d1ea8692 100644
--- a/gtk/gtkaspectframe.c
+++ b/gtk/gtkaspectframe.c
@@ -137,6 +137,12 @@ gtk_aspect_frame_class_init (GtkAspectFrameClass *class)
widget_class->compute_expand = gtk_aspect_frame_compute_expand;
widget_class->get_request_mode = gtk_aspect_frame_get_request_mode;
+ /**
+ * GtkAspectFrame:xalign:
+ *
+ * The horizontal alignment of the #GtkAspectFrame:child widget
+ * of the aspect frame.
+ */
g_object_class_install_property (gobject_class,
PROP_XALIGN,
g_param_spec_float ("xalign",
@@ -144,6 +150,12 @@ gtk_aspect_frame_class_init (GtkAspectFrameClass *class)
P_("X alignment of the child"),
0.0, 1.0, 0.5,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
+ /**
+ * GtkAspectFrame:yalign:
+ *
+ * The vertical alignment of the #GtkAspectFrame:child widget
+ * of the aspect frame.
+ */
g_object_class_install_property (gobject_class,
PROP_YALIGN,
g_param_spec_float ("yalign",
@@ -151,6 +163,14 @@ gtk_aspect_frame_class_init (GtkAspectFrameClass *class)
P_("Y alignment of the child"),
0.0, 1.0, 0.5,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
+ /**
+ * GtkAspectFrame:ratio:
+ *
+ * The aspect ratio to be used by the #GtkAspectFrame.
+ *
+ * This property is only used if #GtkAspectFrame:obey-child is
+ * set to %FALSE.
+ */
g_object_class_install_property (gobject_class,
PROP_RATIO,
g_param_spec_float ("ratio",
@@ -158,6 +178,12 @@ gtk_aspect_frame_class_init (GtkAspectFrameClass *class)
P_("Aspect ratio if obey_child is FALSE"),
MIN_RATIO, MAX_RATIO, 1.0,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
+ /**
+ * GtkAspectFrame:obey-child:
+ *
+ * Whether the #GtkAspectFrame should use the aspect ratio of
+ * its #GtkAspectFrame:child widget.
+ */
g_object_class_install_property (gobject_class,
PROP_OBEY_CHILD,
g_param_spec_boolean ("obey-child",
@@ -165,7 +191,11 @@ gtk_aspect_frame_class_init (GtkAspectFrameClass *class)
P_("Force aspect ratio to match that of the frame’s
child"),
TRUE,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY));
-
+ /**
+ * GtkAspectFrame:child:
+ *
+ * The child widget of the #GtkAspectFrame.
+ */
g_object_class_install_property (gobject_class,
PROP_CHILD,
g_param_spec_object ("child",
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]