GtkPopoverMenu

GtkPopoverMenu — Popovers to use as menus

Functions

GtkWidget * gtk_popover_menu_new ()
void gtk_popover_menu_open_submenu ()

Properties

char * visible-submenu Read / Write

Child Properties

int position Read / Write
char * submenu Read / Write

Types and Values

GtkPopoverMenu

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBin
                    ╰── GtkPopover
                        ╰── GtkPopoverMenu

Implemented Interfaces

GtkPopoverMenu implements AtkImplementorIface and GtkBuildable.

Includes

#include <gtk/gtk.h>

Description

GtkPopoverMenu is a subclass of GtkPopover that treats its children like menus and allows switching between them. It is meant to be used primarily together with GtkModelButton, but any widget can be used, such as GtkSpinButton or GtkScale. In this respect, GtkPopoverMenu is more flexible than popovers that are created from a GMenuModel with gtk_popover_new_from_model().

To add a child as a submenu, set the “submenu” child property to the name of the submenu. To let the user open this submenu, add a GtkModelButton whose “menu-name” property is set to the name you've given to the submenu.

By convention, the first child of a submenu should be a GtkModelButton to switch back to the parent menu. Such a button should use the “inverted” and “centered” properties to achieve a title-like appearance and place the submenu indicator at the opposite side. To switch back to the main menu, use "main" as the menu name.

Example

<object class="GtkPopoverMenu">
  <child>
    <object class="GtkBox">
      <property name="visible">True</property>
      <property name="margin">10</property>
      <child>
        <object class="GtkModelButton">
          <property name="visible">True</property>
          <property name="action-name">win.frob</property>
          <property name="text" translatable="yes">Frob</property>
        </object>
      </child>
      <child>
        <object class="GtkModelButton">
          <property name="visible">True</property>
          <property name="menu-name">more</property>
          <property name="text" translatable="yes">More</property>
        </object>
      </child>
    </object>
  </child>
  <child>
    <object class="GtkBox">
      <property name="visible">True</property>
      <property name="margin">10</property>
      <child>
        <object class="GtkModelButton">
          <property name="visible">True</property>
          <property name="action-name">win.foo</property>
          <property name="text" translatable="yes">Foo</property>
        </object>
      </child>
      <child>
        <object class="GtkModelButton">
          <property name="visible">True</property>
          <property name="action-name">win.bar</property>
          <property name="text" translatable="yes">Bar</property>
        </object>
      </child>
    </object>
    <packing>
      <property name="submenu">more</property>
    </packing>
  </child>
</object>

Just like normal popovers created using gtk_popover_new_from_model, GtkPopoverMenu instances have a single css node called "popover" and get the .menu style class.

Functions

gtk_popover_menu_new ()

GtkWidget *
gtk_popover_menu_new (void);

Creates a new popover menu.

Returns

a new GtkPopoverMenu

Since: 3.16

gtk_popover_menu_open_submenu ()

void
gtk_popover_menu_open_submenu (GtkPopoverMenu *popover,
                               const gchar *name);

Opens a submenu of the popover . The name must be one of the names given to the submenus of popover with “submenu”, or "main" to switch back to the main menu.

GtkModelButton will open submenus automatically when the “menu-name” property is set, so this function is only needed when you are using other kinds of widgets to initiate menu changes.

Parameters

popover

a GtkPopoverMenu

name

the name of the menu to switch to

Since: 3.16

Types and Values

GtkPopoverMenu

typedef struct _GtkPopoverMenu GtkPopoverMenu;

Property Details

The “visible-submenu” property

  “visible-submenu”          char *

The name of the visible submenu.

Owner: GtkPopoverMenu

Flags: Read / Write

Default value: NULL

Child Property Details

The “position” child property

  “position”                 int

The index of the child in the parent.

Owner: GtkPopoverMenu

Flags: Read / Write

Allowed values: >= -1

Default value: 0

The “submenu” child property

  “submenu”                  char *

The submenu child property specifies the name of the submenu If it is NULL or "main", the child is used as the main menu, which is shown initially when the popover is mapped.

Owner: GtkPopoverMenu

Flags: Read / Write

Default value: NULL

Since: 3.16

© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk3/3.24/GtkPopoverMenu.html