Window

class Window(*args, **kwargs)

Superclasses: Window, Widget, InitiallyUnowned, Object

Subclasses: AboutWindow, PreferencesWindow

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

A freeform window.

The AdwWindow widget is a subclass of Window which has no titlebar area. Instead, ToolbarView can be used together with HeaderBar or HeaderBar as follows:

<object class="AdwWindow">
  <property name="content">
    <object class="AdwToolbarView">
      <child type="top">
        <object class="AdwHeaderBar"/>
      </child>
      <property name="content">
        <!-- ... -->
      </property>
    </object>
  </property>
</object>

Using titlebar or child is not supported and will result in a crash. Use content instead.

Dialogs

AdwWindow can contain Dialog. Use present with the window or a widget within a window to show a dialog.

Breakpoints

AdwWindow can be used with Breakpoint the same way as BreakpointBin. Refer to that widget’s documentation for details.

Example:

<object class="AdwWindow">
  <property name="content">
    <object class="AdwToolbarView">
      <child type="top">
        <object class="AdwHeaderBar"/>
      </child>
      <property name="content">
        <!-- ... -->
      </property>
      <child type="bottom">
        <object class="GtkActionBar" id="bottom_bar">
          <property name="revealed">True</property>
          <property name="visible">False</property>
        </object>
      </child>
    </object>
  </property>
  <child>
    <object class="AdwBreakpoint">
      <condition>max-width: 500px</condition>
      <setter object="bottom_bar" property="visible">True</setter>
    </object>
  </child>
</object>

When breakpoints are used, the minimum size must be larger than the smallest UI state. AdwWindow defaults to the minimum size of 360×200 px. If that’s too small, set the width_request and height_request properties manually.

Constructors

class Window

classmethod new() → Widget

Creates a new AdwWindow.

Methods

class Window

add_breakpoint(breakpoint: Breakpoint) → None

Adds breakpoint to self.

Added in version 1.4.

Parameters:

breakpoint – the breakpoint to add

get_content() → Widget | None

Gets the content widget of self.

This method should always be used instead of get_child.

get_current_breakpoint() → Breakpoint | None

Gets the current breakpoint.

Added in version 1.4.

get_dialogs() → ListModel

Returns a ListModel that contains the open dialogs of self.

This can be used to keep an up-to-date view.

Added in version 1.5.

get_visible_dialog() → Dialog | None

Returns the currently visible dialog in self, if there’s one.

Added in version 1.5.

set_content(content: Widget | None = None) → None

Sets the content widget of self.

This method should always be used instead of set_child.

Parameters:

content – the content widget

Properties

class Window

props.content: Widget

The type of the None singleton.

props.current_breakpoint: Breakpoint

The type of the None singleton.

Added in version 1.4.

props.dialogs: ListModel

The type of the None singleton.

Added in version 1.5.

props.visible_dialog: Dialog

The type of the None singleton.

Added in version 1.5.

Fields

class Window

parent_instance