GtkApplicationWindow — GtkWindow subclass with GtkApplication support
gboolean | show-menubar | Read / Write / Construct |
struct | GtkApplicationWindow |
struct | GtkApplicationWindowClass |
GtkApplicationWindow implements GtkAccessible, GtkBuildable, GtkConstraintTarget, GtkNative, GtkShortcutManager, GtkRoot, GActionGroup and GActionMap.
#include <gtk/gtk.h>
GtkApplicationWindow is a GtkWindow subclass that offers some extra functionality for better integration with GtkApplication features. Notably, it can handle an application menubar. See gtk_application_set_menubar()
.
This class implements the GActionGroup and GActionMap interfaces, to let you add window-specific actions that will be exported by the associated GtkApplication, 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 GtkActionable interface.
As with GtkApplication, the GDK lock will be acquired when processing actions arriving from other processes and should therefore be held when activating actions locally (if GDK threads are enabled).
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. gnome-shell (starting with version 3.4) will display the application menu, but not the menubar.
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 GtkPopoverMenu for information about the XML language used by GtkBuilder for menu models.
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);
GtkWidget *
gtk_application_window_new (GtkApplication *application
);
Creates a new GtkApplicationWindow.
application |
a newly created GtkApplicationWindow
void gtk_application_window_set_show_menubar (GtkApplicationWindow *window
,gboolean show_menubar
);
Sets whether the window will display a menubar for the app menu and menubar as needed.
window | ||
show_menubar | whether to show a menubar when needed |
gboolean
gtk_application_window_get_show_menubar
(GtkApplicationWindow *window
);
Returns whether the window will display a menubar for the app menu and menubar as needed.
window |
TRUE
if window
will display a menubar when needed
guint
gtk_application_window_get_id (GtkApplicationWindow *window
);
Returns the unique ID of the window. If the window has not yet been added to a GtkApplication, returns 0
.
window |
the unique ID for window
, or 0
if the window has not yet been added to a GtkApplication
void gtk_application_window_set_help_overlay (GtkApplicationWindow *window
,GtkShortcutsWindow *help_overlay
);
Associates a shortcuts window with the application window, and sets up an action with the name win.show-help-overlay to present it.
window
takes responsibility for destroying help_overlay
.
window | ||
help_overlay | [nullable] |
GtkShortcutsWindow *
gtk_application_window_get_help_overlay
(GtkApplicationWindow *window
);
Gets the GtkShortcutsWindow that has been set up with a prior call to gtk_application_window_set_help_overlay()
.
window |
the help overlay associated with window
, or NULL
.
[transfer none][nullable]
struct GtkApplicationWindow;
struct GtkApplicationWindowClass { GtkWindowClass parent_class; };
“show-menubar”
property“show-menubar” gboolean
If this property is TRUE
, the window will display a menubar unless it is shown by the desktop shell. See gtk_application_set_menubar()
.
If FALSE
, the window will not display a menubar, regardless of whether the desktop shell is showing it or not.
Owner: GtkApplicationWindow
Flags: Read / Write / Construct
Default value: FALSE
© 2005–2020 The GNOME Project
Licensed under the GNU Lesser General Public License version 2.1 or later.
https://developer.gnome.org/gtk4/4.0/GtkApplicationWindow.html