diff options
| author | Matthias Clasen <mclasen@redhat.com> | 2019-05-02 02:49:10 +0000 |
|---|---|---|
| committer | Matthias Clasen <mclasen@redhat.com> | 2019-05-01 23:24:14 -0400 |
| commit | 7b1201cd4d87ffa4be52669091a3bbdf64fb99b0 (patch) | |
| tree | c685b3ee045d9328ec26f9d3cdcc1c5404b3fa7e /gtk/gtkboxlayout.c | |
| parent | 3f940715e40b93c55fd9dc24d473fe621081f654 (diff) | |
| download | gtk+-7b1201cd4d87ffa4be52669091a3bbdf64fb99b0.tar.gz | |
box layout: Documentation additions
Diffstat (limited to 'gtk/gtkboxlayout.c')
| -rw-r--r-- | gtk/gtkboxlayout.c | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/gtk/gtkboxlayout.c b/gtk/gtkboxlayout.c index 88215192a0..6660dcafd4 100644 --- a/gtk/gtkboxlayout.c +++ b/gtk/gtkboxlayout.c @@ -766,6 +766,14 @@ gtk_box_layout_init (GtkBoxLayout *self) self->baseline_position = GTK_BASELINE_POSITION_CENTER; } +/** + * gtk_box_layout_new: + * @orientation: the orientation for the new layout + * + * Creates a new box layout. + * + * Returns: a new box layout + */ GtkLayoutManager * gtk_box_layout_new (GtkOrientation orientation) { @@ -774,6 +782,14 @@ gtk_box_layout_new (GtkOrientation orientation) NULL); } +/** + * gtk_box_layout_set_homogeneous: + * @box_layout: a #GtkBoxLayout + * @homogeneous: %TRUE to set the box layout as homogeneous + * + * Sets whether the box layout will allocate the same + * size to all children. + */ void gtk_box_layout_set_homogeneous (GtkBoxLayout *box_layout, gboolean homogeneous) @@ -790,6 +806,14 @@ gtk_box_layout_set_homogeneous (GtkBoxLayout *box_layout, g_object_notify_by_pspec (G_OBJECT (box_layout), box_layout_props[PROP_HOMOGENEOUS]); } +/** + * gtk_box_layout_get_homogeneous: + * @box_layout: a #GtkBoxLayout + * + * Returns whether the layout is set to be homogeneous. + * + * Return: %TRUE if the layout is homogeneous + */ gboolean gtk_box_layout_get_homogeneous (GtkBoxLayout *box_layout) { @@ -798,6 +822,13 @@ gtk_box_layout_get_homogeneous (GtkBoxLayout *box_layout) return box_layout->homogeneous; } +/** + * gtk_box_layout_set_spacing: + * @box_layout: a #GtkBoxLayout + * @spacing: the spacing to apply between children + * + * Sets how much spacing to put between children. + */ void gtk_box_layout_set_spacing (GtkBoxLayout *box_layout, guint spacing) @@ -813,6 +844,14 @@ gtk_box_layout_set_spacing (GtkBoxLayout *box_layout, g_object_notify_by_pspec (G_OBJECT (box_layout), box_layout_props[PROP_SPACING]); } +/** + * gtk_box_layout_get_spacing: + * @box_layout: a #GtkBoxLayout + * + * Returns the space that @box_layout puts between children. + * + * Returns: the spacing of the layout + */ guint gtk_box_layout_get_spacing (GtkBoxLayout *box_layout) { |