Class ApplicationWindow

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gobject.InitiallyUnowned
org.gnome.gtk.Widget
org.gnome.gtk.Window
org.gnome.gtk.ApplicationWindow
All Implemented Interfaces:
ActionGroup, ActionMap, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager, Proxy
Direct Known Subclasses:
ApplicationWindow
@Generated("org.javagi.JavaGI") public class ApplicationWindow extends Window implements ActionGroup, ActionMap, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager

A GtkWindow subclass that integrates with GtkApplication.

Notably, GtkApplicationWindow can handle an application menubar.

This class implements the ActionGroup and ActionMap 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 menu model.

Note that widgets that are placed inside a GtkApplicationWindow can also activate these actions, if they implement the Actionable interface.

The settings Gtk.Settings:gtk-shell-shows-app-menu and Gtk.Settings: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, it can be shown in the GtkApplicationWindow by setting the Gtk.ApplicationWindow:show-menubar property to true. If the desktop environment does not display the application menu, then it will automatically be included in the menubar or in the window’s client-side decorations.

See PopoverMenu for information about the XML language used by GtkBuilder for menu models.

See also: Application.setMenubar(MenuModel).

A GtkApplicationWindow with a menubar

The code sample below shows how to set up a GtkApplicationWindow with a menu bar defined on the Application:

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);

  • Constructor Details

    • ApplicationWindow

      public ApplicationWindow(MemorySegment address)
      Create a ApplicationWindow instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • ApplicationWindow

      public ApplicationWindow(Application application)
      Creates a new GtkApplicationWindow.
      Parameters:
      application - an application

    • ApplicationWindow

      public ApplicationWindow()
      Create a new ApplicationWindow.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the ApplicationWindow class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected ApplicationWindow asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class Window
      Returns:
      the instance as if it were its parent type

    • getHelpOverlay

      @Deprecated public @Nullable ShortcutsWindow getHelpOverlay()
      Deprecated.
      GtkShortcutsWindow will be removed in GTK 5

      Gets the GtkShortcutsWindow that is associated with window.

      See setHelpOverlay(ShortcutsWindow).

      Returns:
      the help overlay associated with the window

    • getWindowId

      public int getWindowId()

      Returns the unique ID of the window.

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

      Returns:
      the unique ID for the window, or 0 if the window has not yet been added to an application

    • getShowMenubar

      public boolean getShowMenubar()
      Returns whether the window will display a menubar for the app menu and menubar as needed.
      Returns:
      True if the window will display a menubar when needed

    • setHelpOverlay

      @Deprecated public void setHelpOverlay(@Nullable ShortcutsWindow helpOverlay)
      Deprecated.
      GtkShortcutsWindow will be removed in GTK 5

      Associates a shortcuts window with the application window.

      Additionally, sets up an action with the name win.show-help-overlay to present it.

      The window takes responsibility for destroying the help overlay.

      Parameters:
      helpOverlay - a shortcuts window

    • setShowMenubar

      public void setShowMenubar(boolean showMenubar)
      Sets whether the window will display a menubar for the app menu and menubar as needed.
      Parameters:
      showMenubar - whether to show a menubar when needed

    • builder

      public static ApplicationWindow.Builder<? extends ApplicationWindow.Builder> builder()
      A ApplicationWindow.Builder object constructs a ApplicationWindow with the specified properties. Use the various set...() methods to set properties, and finish construction with ApplicationWindow.Builder.build().
      Returns:
      the builder object