diff options
author | Matthias Clasen <mclasen@redhat.com> | 2021-02-26 16:08:08 -0500 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2021-03-11 16:37:33 +0000 |
commit | 53d3b46d4a756e6d556e8b1da7e8bc35334349f6 (patch) | |
tree | f67e52270b42056bc3f2ac42bec30830c3a5e500 /gtk/gtkactionbar.c | |
parent | fc554788906edde0de1f5dbf467a51f7ea165d70 (diff) | |
download | gtk+-53d3b46d4a756e6d556e8b1da7e8bc35334349f6.tar.gz |
actionbar: Convert docs
Diffstat (limited to 'gtk/gtkactionbar.c')
-rw-r--r-- | gtk/gtkactionbar.c | 67 |
1 files changed, 36 insertions, 31 deletions
diff --git a/gtk/gtkactionbar.c b/gtk/gtkactionbar.c index 6846f41cd7..8058fecde0 100644 --- a/gtk/gtkactionbar.c +++ b/gtk/gtkactionbar.c @@ -33,14 +33,14 @@ #include <string.h> /** - * SECTION:gtkactionbar - * @Short_description: A full width bar for presenting contextual actions - * @Title: GtkActionBar - * @See_also: #GtkBox + * GtkActionBar: * - * GtkActionBar is designed to present contextual actions. It is - * expected to be displayed below the content and expand horizontally - * to fill the area. + * `GtkActionBar` is designed to present contextual actions. + * + * ![An example GtkActionBar](action-bar.png) + * + * It is expected to be displayed below the content and expand + * horizontally to fill the area. * * It allows placing children at the start or the end. In addition, it * contains an internal centered box which is centered with respect to @@ -49,7 +49,7 @@ * * # CSS nodes * - * GtkActionBar has a single CSS node with name actionbar. + * `GtkActionBar` has a single CSS node with name actionbar. */ typedef struct _GtkActionBarClass GtkActionBarClass; @@ -149,6 +149,11 @@ gtk_action_bar_class_init (GtkActionBarClass *klass) widget_class->focus = gtk_widget_focus_child; + /** + * GtkActionBar:revealed: (attributes org.gtk.Property.get=gtk_action_bar_get_revealed org.gtk.Property.set=gtk_action_bar_set_revealed) + * + * Controls whether the action bar shows its contents. + */ props[PROP_REVEALED] = g_param_spec_boolean ("revealed", P_("Reveal"), @@ -214,8 +219,8 @@ gtk_action_bar_buildable_interface_init (GtkBuildableIface *iface) /** * gtk_action_bar_pack_start: - * @action_bar: A #GtkActionBar - * @child: the #GtkWidget to be added to @action_bar + * @action_bar: A `GtkActionBar` + * @child: the `GtkWidget` to be added to @action_bar * * Adds @child to @action_bar, packed with reference to the * start of the @action_bar. @@ -229,8 +234,8 @@ gtk_action_bar_pack_start (GtkActionBar *action_bar, /** * gtk_action_bar_pack_end: - * @action_bar: A #GtkActionBar - * @child: the #GtkWidget to be added to @action_bar + * @action_bar: A `GtkActionBar` + * @child: the `GtkWidget` to be added to @action_bar * * Adds @child to @action_bar, packed with reference to the * end of the @action_bar. @@ -244,8 +249,8 @@ gtk_action_bar_pack_end (GtkActionBar *action_bar, /** * gtk_action_bar_remove: - * @action_bar: a #GtkActionBar - * @child: the #GtkWidget to be removed + * @action_bar: a `GtkActionBar` + * @child: the `GtkWidget` to be removed * * Removes a child from @action_bar. */ @@ -266,10 +271,10 @@ gtk_action_bar_remove (GtkActionBar *action_bar, /** * gtk_action_bar_set_center_widget: - * @action_bar: a #GtkActionBar + * @action_bar: a `GtkActionBar` * @center_widget: (allow-none): a widget to use for the center * - * Sets the center widget for the #GtkActionBar. + * Sets the center widget for the `GtkActionBar`. */ void gtk_action_bar_set_center_widget (GtkActionBar *action_bar, @@ -280,11 +285,11 @@ gtk_action_bar_set_center_widget (GtkActionBar *action_bar, /** * gtk_action_bar_get_center_widget: - * @action_bar: a #GtkActionBar + * @action_bar: a `GtkActionBar` * * Retrieves the center bar widget of the bar. * - * Returns: (transfer none) (nullable): the center #GtkWidget or %NULL. + * Returns: (transfer none) (nullable): the center `GtkWidget` or %NULL. */ GtkWidget * gtk_action_bar_get_center_widget (GtkActionBar *action_bar) @@ -297,9 +302,9 @@ gtk_action_bar_get_center_widget (GtkActionBar *action_bar) /** * gtk_action_bar_new: * - * Creates a new #GtkActionBar widget. + * Creates a new `GtkActionBar` widget. * - * Returns: a new #GtkActionBar + * Returns: a new `GtkActionBar` */ GtkWidget * gtk_action_bar_new (void) @@ -308,16 +313,15 @@ gtk_action_bar_new (void) } /** - * gtk_action_bar_set_revealed: - * @action_bar: a #GtkActionBar + * gtk_action_bar_set_revealed: (attributes org.gtk.Method.set_property=revealed) + * @action_bar: a `GtkActionBar` * @revealed: The new value of the property * - * Sets the #GtkActionBar:revealed property to @revealed. Changing this will - * make @action_bar reveal (%TRUE) or conceal (%FALSE) itself via a sliding - * transition. + * Reveals or conceals the content of the action bar. * - * Note: this does not show or hide @action_bar in the #GtkWidget:visible sense, - * so revealing has no effect if #GtkWidget:visible is %FALSE. + * Note: this does not show or hide @action_bar in the + * [property@Gtk.Widget:visible] sense, so revealing has + * no effect if the action bar is hidden. */ void gtk_action_bar_set_revealed (GtkActionBar *action_bar, @@ -333,12 +337,13 @@ gtk_action_bar_set_revealed (GtkActionBar *action_bar, } /** - * gtk_action_bar_get_revealed: - * @action_bar: a #GtkActionBar + * gtk_action_bar_get_revealed: (attributes org.gtk.Method.get_property=revealed) + * @action_bar: a `GtkActionBar` * - * Gets the value of the #GtkActionBar:revealed property. + * Gets whether the contents of the action bar are revealed. * - * Returns: the current value of the #GtkActionBar:revealed property. + * Returns: the current value of the [property@Gtk.ActionBar:revealed] + * property. */ gboolean gtk_action_bar_get_revealed (GtkActionBar *action_bar) |