Code Snippets

This page provides useful code snippets to help you implement additional functionality.

Clicking outside of a window

A common use case is to close a window.

Widget.Window(
    namespace="my-window",
    anchor=["left", "right", "top", "bottom"],  # to make a window fullscreen
    child=Widget.Overlay(
        child=Widget.Button(
            vexpand=True,
            hexpand=True,
            can_focus=False,
            on_click=lambda x: CALLBACK, # e.g., app.close_window("my-window")
        ),
        overlays=[ACTUAL_CONTENT],
    ),
)

Replace ACTUAL_CONTENT with the actual widgets you want to put in the window.

Warning

If ACTUAL_CONTENT fills all of the screen, set valign and halign with values other than fill (e.g., center).

Listen for key events

Currently Ignis doesn't have a convenient API for this. But you can always use GTK directly.

Use Gtk.EventControllerKey:

from gi.repository import Gtk

def handle_key_press(
    event_controller_key: Gtk.EventControllerKey,
    keyval: int,
    keycode: int,
    state: Gdk.ModifierType,
) -> None:
    print(keyval)

key_controller = Gtk.EventControllerKey()
WIDGET.add_controller(key_controller)
# Listen for the pressed event
# Gtk.EventControllerKey has other signals, e.g., "key-released"
# Check out PyGObject docs for more info
key_controller.connect("key-pressed", handle_key_press)

Replace WIDGET with the widget on which you want to listen for key events.