GI.Gtk.Objects.ApplicationWindow

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 Settings:gtkShellShowsAppMenu and Settings:gtkShellShowsMenubar 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 ApplicationWindow:showMenubar 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: applicationSetMenubar.

A GtkApplicationWindow with a menubar

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

c code

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

Exported types

newtype ApplicationWindow

Memory-managed wrapper type.

Constructors

ApplicationWindow (ManagedPtr ApplicationWindow)

Instances

Eq ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

Methods

(==) :: ApplicationWindow -> ApplicationWindow -> Bool

(/=) :: ApplicationWindow -> ApplicationWindow -> Bool

GObject ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

ManagedPtrNewtype ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

Methods

toManagedPtr :: ApplicationWindow -> ManagedPtr ApplicationWindow

TypedObject ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

Methods

glibType :: IO GType

HasParentTypes ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

IsGValue (Maybe ApplicationWindow)

Convert ApplicationWindow to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.ApplicationWindow

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ApplicationWindow -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ApplicationWindow)

type ParentTypes ApplicationWindow

Defined in GI.Gtk.Objects.ApplicationWindow

type ParentTypes ApplicationWindow = '[Window, Widget, Object, ActionGroup, ActionMap, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager]

class (GObject o, IsDescendantOf ApplicationWindow o) => IsApplicationWindow o

Type class for types which can be safely cast to ApplicationWindow, for instance with toApplicationWindow.

Instances

(GObject o, IsDescendantOf ApplicationWindow o) => IsApplicationWindow o

Defined in GI.Gtk.Objects.ApplicationWindow

toApplicationWindow :: (MonadIO m, IsApplicationWindow o) => o -> m ApplicationWindow

Cast to ApplicationWindow, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

actionAdded, actionEnabledChanged, actionRemoved, actionSetEnabled, actionStateChanged, activate, activateAction, activateDefault, addAction, addActionEntries, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, changeActionState, childFocus, close, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, destroy, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, fullscreen, fullscreenOnMonitor, getv, grabFocus, hasAction, hasCssClass, hasDefault, hasFocus, hasGroup, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isActive, isAncestor, isDrawable, isFloating, isFocus, isFullscreen, isMaximized, isSensitive, isVisible, keynavFailed, listActions, listMnemonicLabels, lookupAction, map, maximize, measure, minimize, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, present, presentWithTime, queryAction, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeAction, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unfullscreen, unmap, unmaximize, unminimize, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getActionEnabled, getActionParameterType, getActionState, getActionStateHint, getActionStateType, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getApplication, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDecorated, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getDirection, getDisplay, getFirstChild, getFocus, getFocusChild, getFocusOnClick, getFocusVisible, getFocusable, getFontMap, getFontOptions, getFrameClock, getGroup, getHalign, getHandleMenubarAccel, getHasTooltip, getHeight, getHelpOverlay, getHexpand, getHexpandSet, getHideOnClose, getIconName, getId, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMnemonicsVisible, getModal, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRenderer, getRequestMode, getResizable, getRoot, getScaleFactor, getSensitive, getSettings, getShowMenubar, getSize, getSizeRequest, getStateFlags, getStyleContext, getSurface, getSurfaceTransform, getTemplateChild, getTitle, getTitlebar, getTooltipMarkup, getTooltipText, getTransientFor, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setApplication, setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDecorated, setDefaultSize, setDefaultWidget, setDeletable, setDestroyWithParent, setDirection, setDisplay, setFocus, setFocusChild, setFocusOnClick, setFocusVisible, setFocusable, setFontMap, setFontOptions, setHalign, setHandleMenubarAccel, setHasTooltip, setHelpOverlay, setHexpand, setHexpandSet, setHideOnClose, setIconName, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMnemonicsVisible, setModal, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setResizable, setSensitive, setShowMenubar, setSizeRequest, setStartupId, setStateFlags, setTitle, setTitlebar, setTooltipMarkup, setTooltipText, setTransientFor, setValign, setVexpand, setVexpandSet, setVisible.

getHelpOverlay

applicationWindowGetHelpOverlay

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a)

=> a

window: a GtkApplicationWindow

-> m (Maybe ShortcutsWindow)

Returns: the help overlay associated with window

Gets the GtkShortcutsWindow that is associated with window.

See applicationWindowSetHelpOverlay.

getId

applicationWindowGetId

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a)

=> a

window: a GtkApplicationWindow

-> m Word32

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

Returns the unique ID of the window.

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

getShowMenubar

applicationWindowGetShowMenubar

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a)

=> a

window: a GtkApplicationWindow

-> m Bool

Returns: True if window will display a menubar when needed

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

new

applicationWindowNew

Arguments

:: (HasCallStack, MonadIO m, IsApplication a)

=> a

application: a GtkApplication

-> m ApplicationWindow

Returns: a newly created GtkApplicationWindow

Creates a new GtkApplicationWindow.

setHelpOverlay

applicationWindowSetHelpOverlay

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a, IsShortcutsWindow b)

=> a

window: a GtkApplicationWindow

-> Maybe b

helpOverlay: a GtkShortcutsWindow

-> m ()

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 helpOverlay.

setShowMenubar

applicationWindowSetShowMenubar

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a)

=> a

window: a GtkApplicationWindow

-> Bool

showMenubar: whether to show a menubar when needed

-> m ()

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

Properties

showMenubar

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

See applicationSetMenubar.

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

constructApplicationWindowShowMenubar :: (IsApplicationWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “show-menubar” property. This is rarely needed directly, but it is used by new.

getApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> m Bool

Get the value of the “show-menubar” property. When overloading is enabled, this is equivalent to

get applicationWindow #showMenubar

setApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> Bool -> m ()

Set the value of the “show-menubar” property. When overloading is enabled, this is equivalent to

set applicationWindow [ #showMenubar := value ]