Menu Model

class ignis.menu_model.IgnisMenuModel(*args: IgnisMenuItem | IgnisMenuModel | IgnisMenuSeparator, label: str | None = None)

A helper class that provides a convenient way to construct a Gio.Menu.

Parameters:

• *args (IgnisMenuItem | IgnisMenuModel | IgnisMenuSeparator) -- Items to add.

• label (str | None, default: None) -- The label of the submenu. Only works if this model passed as an item of the parent model. Must be provided only as a keyword argument.

from ignis.menu_model import IgnisMenuModel, IgnisMenuItem, IgnisMenuSeparator

model = IgnisMenuModel(
    IgnisMenuItem(
        label="Item 1",
        on_activate=lambda x: print("item 1 activated!"),
    ),
    IgnisMenuItem(
        label="This is disabled item",
        enabled=False,
        on_activate=lambda x: print(
            "you will not see this message in terminal hehehehehe"
        ),
    ),
    IgnisMenuModel(
        *(  # unpacking because items must be passed as *args
            IgnisMenuItem(
                label=str(i),
                on_activate=lambda x, i=i: print(f"Clicked on item {i}!"),
            )
            for i in range(10)
        ),
        label="Submenu",  # pass label as keyword argument
    ),
)

# Access built Gio.Menu
print(model.gmenu)

gproperty items: list[IgnisMenuItem | IgnisMenuModel | IgnisMenuSeparator]

• read-write

A list of items.

gproperty gmenu: Gio.Menu | None

• read-only

The Gio.Menu built from the contents of items, or None if no items are present.

gproperty label: str | None

• read-only

The label of the submenu. Only Works if this model passed as an item of the parent model.

clean_gmenu() → None

Clean gmenu. This will gracefully destroy it, avoiding a memory leak.

Return type:

None

class ignis.menu_model.IgnisMenuItem(label: str, enabled: bool = True, on_activate: Callable | None = None)

A menu item.

Parameters:

• label (str) -- The label of item.

• enabled (bool, default: True) -- Whether the item is enabled. If False, the item cannot be selected.

• on_activate (Callable | None, default: None) -- The function to call when the user clicks on the item.

gproperty label: str

• read-only

The label of item.

gproperty uniq_name: str

• read-only

The unique name of the Gio.Action.

gproperty action_name: str

• read-only

The full action name (app.UNIQ_NAME).

gproperty enabled: bool

• read-only

Whether the item is enabled. If False, the item cannot be selected.

gproperty on_activate: Callable

• read-write

The function to call when the user clicks on the item.

class ignis.menu_model.IgnisMenuSeparator

A simple object representing a menu separator.