Skip to content

Window

class Window (title: str = 'fabric', type: Literal['top-level', 'popup'] | WindowType = Gtk.WindowType.TOPLEVEL, child: Widget | None = None, name: str | None = None, visible: bool = True, all_visible: bool = False, style: str | None = None, style_classes: Iterable[str] | str | None = None, tooltip_text: str | None = None, tooltip_markup: str | None = None, h_align: Literal['fill', 'start', 'end', 'center', 'baseline'] | Align | None = None, v_align: Literal['fill', 'start', 'end', 'center', 'baseline'] | Align | None = None, h_expand: bool = False, v_expand: bool = False, size: Iterable[int] | int | None = None, **kwargs)

Bases: Window, Container

  • Parameters:
    • title (str , optional) — the title of this window (used for window manager scoping), defaults to “fabric”
    • type (Literal [ “top-level” , “popup” ] | Gtk.WindowType , optional) — the type of this window (useful with some window managers), defaults to Gtk.WindowType.TOPLEVEL
    • child (Gtk.Widget | None , optional) — a child widget to add into this window, defaults to None
    • name (str | None , optional) — the name identifer for this widget (useful for styling), defaults to None
    • visible (bool , optional) — whether should this widget be visible or not once initialized, defaults to True
    • all_visible (bool , optional) — whether should this widget and all of its children be visible or not once initialized, defaults to False
    • style (str | None , optional) — inline stylesheet to be applied on this widget, defaults to None
    • style_classes (Iterable *[*str ] | str | None , optional) — a list of style classes to be added into this widget once initialized, defaults to None
    • tooltip_text (str | None , optional) — the text that should be rendered inside the tooltip, defaults to None
    • tooltip_markup (str | None , optional) — same as tooltip_text but it accepts simple markup expressions, defaults to None
    • h_align (Literal [ “fill” , “start” , “end” , “center” , “baseline” ] | Gtk.Align | None , optional) — horizontal alignment of this widget (compared to its parent), defaults to None
    • v_align (Literal [ “fill” , “start” , “end” , “center” , “baseline” ] | Gtk.Align | None , optional) — vertical alignment of this widget (compared to its parent), defaults to None
    • h_expand (bool , optional) — whether should this widget fill in all the available horizontal space or not, defaults to False
    • v_expand (bool , optional) — whether should this widget fill in all the available vertical space or not, defaults to False
    • size (Iterable *[*int ] | int | None , optional) — a fixed size for this widget (not guranteed to get applied), defaults to None

property application Application

The application instance associated with this window (if any)

  • Return type: Application

def add_keybinding (keybind: str, callback: Callable[[Self, Any], Any]) int

Add a callback for a given keybinding (shortcut or keystroke)

  • Parameters:
    • keybind (str) — the string representing the keybinding (e.g. “Ctrl w”)
    • callback (Callable [ *[*Self , Any ] , Any ]) — the callback which should be called once the given keybinding is received
  • Returns: the keybinding connection’s id (for disconnecting later)
  • Return type: int

def remove_keybinding (reference: int | Callable | str)

Disconnect a keybinding callback via its handler, function or keybinding string

  • Parameters: reference (int | Callable | str) — the reference which can be the connection id, the callback itself or the string representing the keybinding