:right-sidebar: True

ApplicationWindow
===================================================================

.. currentmodule:: gi.repository.Gtk





.. class:: ApplicationWindow(*args, **kwargs)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gtk.Window`, :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gio.ActionGroup`, :class:`~gi.repository.Gio.ActionMap`, :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`, :class:`~gi.repository.Gtk.Native`, :class:`~gi.repository.Gtk.Root`, :class:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.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
:obj:`~gi.repository.Gtk.Actionable` interface.

The settings :obj:`~gi.repository.Gtk.Settings.props.gtk_shell_shows_app_menu` and
:obj:`~gi.repository.Gtk.Settings.props.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
:obj:`~gi.repository.Gtk.ApplicationWindow.props.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 :obj:`~gi.repository.Gtk.PopoverMenu` for information about the XML language
used by ``GtkBuilder`` for menu models.

See also: :obj:`~gi.repository.Gtk.Application.set_menubar`.

A GtkApplicationWindow with a menubar
-------------------------------------

The code sample below shows how to set up a ``GtkApplicationWindow``
with a menu bar defined on the :obj:`~gi.repository.Gtk.Application`:


.. code-block::
   :dedent:

   GtkApplication *app = gtk_application_new ("org.gtk.test", 0);
   
   GtkBuilder *builder = gtk_builder_new_from_string (
       "<interface>"
       "  <menu id='menubar'>"
       "    <submenu>"
       "      <attribute name='label' translatable='yes'>_Edit</attribute>"
       "      <item>"
       "        <attribute name='label' translatable='yes'>_Copy</attribute>"
       "        <attribute name='action'>win.copy</attribute>"
       "      </item>"
       "      <item>"
       "        <attribute name='label' translatable='yes'>_Paste</attribute>"
       "        <attribute name='action'>win.paste</attribute>"
       "      </item>"
       "    </submenu>"
       "  </menu>"
       "</interface>",
       -1);
   
   GMenuModel *menubar = G_MENU_MODEL (gtk_builder_get_object (builder, "menubar"));
   gtk_application_set_menubar (GTK_APPLICATION (app), menubar);
   g_object_unref (builder);
   
   // ...
   
   GtkWidget *window = gtk_application_window_new (app);




Constructors
------------

.. rst-class:: interim-class

.. class:: ApplicationWindow
   :no-index:


   .. classmethod:: new(application: ~gi.repository.Gtk.Application) -> ~gi.repository.Gtk.Widget

      Creates a new ``GtkApplicationWindow``.







      :param application: a ``GtkApplication``









Methods
-------

.. rst-class:: interim-class

.. class:: ApplicationWindow
   :no-index:


   .. method:: get_help_overlay() -> ~gi.repository.Gtk.ShortcutsWindow | None

      Gets the ``GtkShortcutsWindow`` that is associated with ``window``.

      See :obj:`~gi.repository.Gtk.ApplicationWindow.set_help_overlay`.










   .. method:: get_id() -> int

      Returns the unique ID of the window.

      If the window has not yet been added to a ``GtkApplication``, returns ``0``.










   .. method:: get_show_menubar() -> bool

      Returns whether the window will display a menubar for the app menu
      and menubar as needed.










   .. method:: set_help_overlay(help_overlay: ~gi.repository.Gtk.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 destroying ``help_overlay``.







      :param help_overlay: a ``GtkShortcutsWindow``





   .. method:: set_show_menubar(show_menubar: bool) -> None

      Sets whether the window will display a menubar for the app menu
      and menubar as needed.







      :param show_menubar: whether to show a menubar when needed









Properties
----------

.. rst-class:: interim-class

.. class:: ApplicationWindow
   :no-index:
   

   .. attribute:: props.show_menubar
      :type: bool

      If this property is :const:`True`, the window will display a menubar
      unless it is shown by the desktop shell.

      See :obj:`~gi.repository.Gtk.Application.set_menubar`.

      If :const:`False`, the window will not display a menubar, regardless
      of whether the desktop shell is showing it or not.















Fields
------

.. rst-class:: interim-class

.. class:: ApplicationWindow
   :no-index:
   

   .. attribute:: parent_instance