[gtk/new-style-menu: 48/48] popovermenubar: Add docs
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/new-style-menu: 48/48] popovermenubar: Add docs
- Date: Sun, 9 Jun 2019 17:47:02 +0000 (UTC)
commit 3c1163e7f45a8506874b7bff6038317d6a9d1d20
Author: Matthias Clasen <mclasen redhat com>
Date: Sun Jun 9 16:53:59 2019 +0000
popovermenubar: Add docs
docs/reference/gtk/gtk4-docs.xml | 1 +
docs/reference/gtk/gtk4-sections.txt | 17 ++++++++++++
docs/reference/gtk/gtk4.types.in | 1 +
gtk/gtkpopovermenubar.c | 53 ++++++++++++++++++++++++++++++++++++
4 files changed, 72 insertions(+)
---
diff --git a/docs/reference/gtk/gtk4-docs.xml b/docs/reference/gtk/gtk4-docs.xml
index bd04301299..e574d082ee 100644
--- a/docs/reference/gtk/gtk4-docs.xml
+++ b/docs/reference/gtk/gtk4-docs.xml
@@ -224,6 +224,7 @@
<xi:include href="xml/gtkradiotoolbutton.xml" />
<xi:include href="xml/gtkpopover.xml" />
<xi:include href="xml/gtkpopovermenu.xml" />
+ <xi:include href="xml/gtkpopovermenubar.xml" />
</chapter>
<chapter id="SelectorWidgets">
diff --git a/docs/reference/gtk/gtk4-sections.txt b/docs/reference/gtk/gtk4-sections.txt
index 4696255497..bbb9d6a475 100644
--- a/docs/reference/gtk/gtk4-sections.txt
+++ b/docs/reference/gtk/gtk4-sections.txt
@@ -6491,6 +6491,23 @@ GTK_POPOVER_MENU_GET_CLASS
gtk_popover_menu_get_type
</SECTION>
+<SECTION>
+<FILE>gtkpopovermenubar</FILE>
+<TITLE>GtkPopoverMenuBar</TITLE>
+GtkPopoverMenuBar
+gtk_popover_menu_bar_new_from_model
+gtk_popover_menu_bar_set_menu_model
+gtk_popover_menu_bar_get_menu_model
+
+<SUBSECTION Standard>
+GTK_TYPE_POPOVER_MENU_BAR
+GTK_IS_POPOVER_MENU_BAR
+GTK_POPOVER_MENU_BAR
+
+<SUBSECTION Private>
+gtk_popover_menu_bar_get_type
+</SECTION>
+
<SECTION>
<FILE>gtkmodelbutton</FILE>
<TITLE>GtkModelButton</TITLE>
diff --git a/docs/reference/gtk/gtk4.types.in b/docs/reference/gtk/gtk4.types.in
index 52f682d104..0cfaf1c4e4 100644
--- a/docs/reference/gtk/gtk4.types.in
+++ b/docs/reference/gtk/gtk4.types.in
@@ -129,6 +129,7 @@ gtk_password_entry_get_type
gtk_picture_get_type
gtk_popover_get_type
gtk_popover_menu_get_type
+gtk_popover_menu_bar_get_type
@DISABLE_ON_W32@gtk_printer_get_type
gtk_print_context_get_type
@DISABLE_ON_W32@gtk_print_job_get_type
diff --git a/gtk/gtkpopovermenubar.c b/gtk/gtkpopovermenubar.c
index 65bf0e59b7..023ae4cd42 100644
--- a/gtk/gtkpopovermenubar.c
+++ b/gtk/gtkpopovermenubar.c
@@ -18,6 +18,35 @@
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ * SECTION:gtkpopovermenubar
+ * @Title: GtkPopoverMenuBar
+ * @Short_description: A menu bar with popovers
+ * @See_also: #GtkPopover, #GtkPopoverMenu, #GMenuModel
+ *
+ * The #GtkPopoverBar presents a horizontal bar of items that pop
+ * up popover menus when clicked. The only way to create instances
+ * of GtkPopoverBar is from a #GMenuModel.
+ *
+ * # CSS nodes
+ *
+ * |[<!-- language="plain" -->
+ * menubar
+ * ├── item[.active]
+ * ┊ ╰── popover
+ * ╰── item
+ * ╰── popover
+ * ]|
+ *
+ * GtkMenuBar has a single CSS node with name menubar, below which
+ * each item has its CSS node, and below that the corresponding
+ * popover.
+ *
+ * The item whose popover is currently open gets the .active
+ * style class.
+ */
+
+
#include "config.h"
#include "gtkpopovermenubar.h"
@@ -482,6 +511,14 @@ gtk_popover_menu_bar_init (GtkPopoverMenuBar *bar)
{
}
+/**
+ * gtk_popover_menu_bar_new_from_model:
+ * @model: a #GMenuModel
+ *
+ * Creates a #GtkPopoverMenuBar from a #GMenuModel.
+ *
+ * Returns: a new #GtkPopoverMenuBar
+ */
GtkWidget *
gtk_popover_menu_bar_new_from_model (GMenuModel *model)
{
@@ -490,6 +527,14 @@ gtk_popover_menu_bar_new_from_model (GMenuModel *model)
NULL);
}
+/**
+ * gtk_popover_menu_bar_set_menu_model:
+ * @bar: a #GtkPopoverMenuBar
+ * @model: a #GMenuModel
+ *
+ * Sets a menu model from which @bar should take
+ * its contents.
+ */
void
gtk_popover_menu_bar_set_menu_model (GtkPopoverMenuBar *bar,
GMenuModel *model)
@@ -522,6 +567,14 @@ gtk_popover_menu_bar_set_menu_model (GtkPopoverMenuBar *bar,
}
}
+/**
+ * gtk_popover_menu_bar_get_menu_model:
+ * @bar: a #GtkPopoverMenuBar
+ *
+ * Returns the model from which the contents of @bar are taken.
+ *
+ * Returns: (transfer none): a #GMenuModel
+ */
GMenuModel *
gtk_popover_menu_bar_get_menu_model (GtkPopoverMenuBar *bar)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]