CtkPopoverMenu: CTK+ 3 Reference Manual

## CtkPopoverMenu CtkPopoverMenu — Popovers to use as menus |

## Functions

CtkWidget * | ctk_popover_menu_new ()
void | ctk_popover_menu_open_submenu ()

## Properties

char * | visible-submenu | Read / Write

## Types and Values

| CtkPopoverMenu

## Object Hierarchy

        GObject
        ╰── GInitiallyUnowned
            ╰── CtkWidget
                ╰── CtkContainer
                    ╰── CtkBin
                        ╰── CtkPopover
                            ╰── CtkPopoverMenu

## Implemented Interfaces

CtkPopoverMenu implements AtkImplementorIface and CtkBuildable.

## Includes

    #include <ctk/ctk.h>

## Description

CtkPopoverMenu is a subclass of CtkPopover that treats its children like menus and allows switching between them. It is meant to be used primarily together with CtkModelButton, but any widget can be used, such as CtkSpinButton or CtkScale. In this respect, CtkPopoverMenu is more flexible than popovers that are created from a GMenuModel with `ctk_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 CtkModelButton 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 CtkModelButton 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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    <object class="CtkPopoverMenu">
      <child>
        <object class="CtkBox">
          <property name="visible">True</property>
          <property name="margin">10</property>
          <child>
            <object class="CtkModelButton">
              <property name="visible">True</property>
              <property name="action-name">win.frob</property>
              <property name="text" translatable="yes">Frob</property>
            </object>
          </child>
          <child>
            <object class="CtkModelButton">
              <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="CtkBox">
          <property name="visible">True</property>
          <property name="margin">10</property>
          <child>
            <object class="CtkModelButton">
              <property name="visible">True</property>
              <property name="action-name">win.foo</property>
              <property name="text" translatable="yes">Foo</property>
            </object>
          </child>
          <child>
            <object class="CtkModelButton">
              <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 ctk_popover_new_from_model, CtkPopoverMenu instances have a single css node called "popover" and get the .menu style class.

## Functions

### ctk_popover_menu_new ()

    CtkWidget *
    ctk_popover_menu_new (void);

Creates a new popover menu.

#### Returns

a new CtkPopoverMenu

Since: 3.16

### ctk_popover_menu_open_submenu ()

    void
    ctk_popover_menu_open_submenu (CtkPopoverMenu *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.

CtkModelButton 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 CtkPopoverMenu |
name | the name of the menu to switch to |

Since: 3.16

## Types and Values

### CtkPopoverMenu

    typedef struct _CtkPopoverMenu CtkPopoverMenu;

## Property Details

### The `“visible-submenu”` property

      “visible-submenu”          char *

The name of the visible submenu.

Owner: CtkPopoverMenu

Flags: Read / Write

Default value: NULL