ApplicationWindow
- class ApplicationWindow(*args, **kwargs)
Superclasses: Window
, Widget
, InitiallyUnowned
, Object
Implemented Interfaces: ActionGroup
, ActionMap
, Accessible
, Buildable
, ConstraintTarget
, Native
, Root
, ShortcutManager
GtkApplicationWindow
is a GtkWindow
subclass that integrates with
GtkApplication
.
Notably, GtkApplicationWindow
can handle an application menubar.
This class implements the GActionGroup
and GActionMap
interfaces,
to let you add window-specific actions that will be exported by the
associated Application
, together with its application-wide
actions. Window-specific actions are prefixed with the “win.”
prefix and application-wide actions are prefixed with the “app.”
prefix. Actions must be addressed with the prefixed name when
referring to them from a GMenuModel
.
Note that widgets that are placed inside a GtkApplicationWindow
can also activate these actions, if they implement the
Actionable
interface.
The settings gtk_shell_shows_app_menu
and
gtk_shell_shows_menubar
tell GTK whether the
desktop environment is showing the application menu and menubar
models outside the application as part of the desktop shell.
For instance, on OS X, both menus will be displayed remotely;
on Windows neither will be.
If the desktop environment does not display the menubar, then
GtkApplicationWindow
will automatically show a menubar for it.
This behaviour can be overridden with the
show_menubar
property. If the
desktop environment does not display the application menu, then
it will automatically be included in the menubar or in the windows
client-side decorations.
See PopoverMenu
for information about the XML language
used by GtkBuilder
for menu models.
See also: set_menubar
.
Constructors
- class ApplicationWindow
- classmethod new(application: Application) Widget
Creates a new
GtkApplicationWindow
.- Parameters:
application – a
GtkApplication
Methods
- class ApplicationWindow
- get_help_overlay() ShortcutsWindow | None
Gets the
GtkShortcutsWindow
that is associated withwindow
.See
set_help_overlay
.
- get_id() int
Returns the unique ID of the window.
If the window has not yet been added to a
GtkApplication
, returns0
.
Returns whether the window will display a menubar for the app menu and menubar as needed.
- set_help_overlay(help_overlay: ShortcutsWindow | None = None) None
Associates a shortcuts window with the application window.
Additionally, sets up an action with the name
win.show-help-overlay
to present it.window
takes responsibility for destroyinghelp_overlay
.- Parameters:
help_overlay – a
GtkShortcutsWindow
Sets whether the window will display a menubar for the app menu and menubar as needed.
- Parameters:
show_menubar – whether to show a menubar when needed
Properties
- class ApplicationWindow
If this property is
True
, the window will display a menubar unless it is shown by the desktop shell.See
set_menubar
.If
False
, the window will not display a menubar, regardless of whether the desktop shell is showing it or not.
Fields
- class ApplicationWindow
- parent_instance