gi-gtk3-3.0.44: Gtk 3.x bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Objects.ApplicationWindow

Contents

- Exported types
- Methods
  - getHelpOverlay
  - getId
  - getShowMenubar
  - new
  - setHelpOverlay
  - setShowMenubar
- Properties
  - showMenubar

Description

`ApplicationWindow` is a `Window` subclass that offers some extra functionality for better integration with `Application` features. Notably, it can handle both the application menu as well as the menubar. See `applicationSetAppMenu` and `applicationSetMenubar`.

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 `MenuModel`.

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

As with `Application`, 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 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. 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 `ApplicationWindow` 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.

## A GtkApplicationWindow with a menubar

### C code

    GtkApplication *app = gtk_application_new ("org.gtk.test", 0);

    GtkBuilder *builder = gtk_builder_new_from_string (
        "<interface>"
        "  <menu id='menubar'>"
        "    <submenu label='_Edit'>"
        "      <item label='_Copy' action='win.copy'/>"
        "      <item label='_Paste' action='win.paste'/>"
        "    </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);

## Handling fallback yourself

A simple example

The XML format understood by `Builder` for `MenuModel` consists of a toplevel `<menu>` element, which contains one or more `<item>` elements. Each `<item>` element contains `<attribute>` and `<link>` elements with a mandatory name attribute. `<link>` elements have the same content model as `<menu>`. Instead of `<link name="submenu>` or `<link name="section">`, you can use `<submenu>` or `<section>` elements.

Attribute values can be translated using gettext, like other `Builder` content. `<attribute>` elements can be marked for translation with a `translatable="yes"` attribute. It is also possible to specify message context and translator comments, using the context and comments attributes. To make use of this, the `Builder` must have been given the gettext domain to use.

The following attributes are used when constructing menu items: * "label": a user-visible string to display * "action": the prefixed name of the action to trigger * "target": the parameter to use when activating the action * "icon" and "verb-icon": names of icons that may be displayed * "submenu-action": name of an action that may be used to determine if a submenu can be opened * "hidden-when": a string used to determine when the item will be hidden. Possible values include "action-disabled", "action-missing", "macos-menubar".

The following attributes are used when constructing sections: * "label": a user-visible string to use as section heading * "display-hint": a string used to determine special formatting for the section. Possible values include "horizontal-buttons". * "text-direction": a string used to determine the `TextDirection` to use when "display-hint" is set to "horizontal-buttons". Possible values include "rtl", "ltr", and "none".

The following attributes are used when constructing submenus: * "label": a user-visible string to display * "icon": icon name to display

Synopsis

- newtype ApplicationWindow = ApplicationWindow (ManagedPtr ApplicationWindow)
- class (GObject o, IsDescendantOf ApplicationWindow o) => IsApplicationWindow o
- toApplicationWindow :: (MonadIO m, IsApplicationWindow o) => o -> m ApplicationWindow
- applicationWindowGetHelpOverlay :: (HasCallStack, MonadIO m, IsApplicationWindow a) => a -> m (Maybe ShortcutsWindow)
- applicationWindowGetId :: (HasCallStack, MonadIO m, IsApplicationWindow a) => a -> m Word32
- applicationWindowGetShowMenubar :: (HasCallStack, MonadIO m, IsApplicationWindow a) => a -> m Bool
- applicationWindowNew :: (HasCallStack, MonadIO m, IsApplication a) => a -> m ApplicationWindow
- applicationWindowSetHelpOverlay :: (HasCallStack, MonadIO m, IsApplicationWindow a, IsShortcutsWindow b) => a -> Maybe b -> m ()
- applicationWindowSetShowMenubar :: (HasCallStack, MonadIO m, IsApplicationWindow a) => a -> Bool -> m ()
- constructApplicationWindowShowMenubar :: (IsApplicationWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> m Bool
- setApplicationWindowShowMenubar :: (MonadIO m, IsApplicationWindow o) => o -> Bool -> m ()

# Exported types

newtype ApplicationWindow Source #

Memory-managed wrapper type.

Constructors

ApplicationWindow (ManagedPtr ApplicationWindow) |

#### Instances

Instances details

Eq ApplicationWindow Source # |
Instance details Defined in GI.Gtk.Objects.ApplicationWindow Methods (==) :: ApplicationWindow -> ApplicationWindow -> Bool Source # (/=) :: ApplicationWindow -> ApplicationWindow -> Bool Source #
GObject ApplicationWindow Source # |
Instance details Defined in GI.Gtk.Objects.ApplicationWindow
ManagedPtrNewtype ApplicationWindow Source # |
Instance details Defined in GI.Gtk.Objects.ApplicationWindow Methods toManagedPtr :: ApplicationWindow -> ManagedPtr ApplicationWindow Source #
TypedObject ApplicationWindow Source # |
Instance details Defined in GI.Gtk.Objects.ApplicationWindow Methods glibType :: IO GType Source #
HasParentTypes ApplicationWindow Source # |
Instance details Defined in GI.Gtk.Objects.ApplicationWindow
IsGValue (Maybe ApplicationWindow) Source # | Convert `ApplicationWindow` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.ApplicationWindow Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe ApplicationWindow -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe ApplicationWindow) Source #
type ParentTypes ApplicationWindow Source # |
Instance details Defined in GI.Gtk.Objects.ApplicationWindow type ParentTypes ApplicationWindow = '[Window, Bin, Container, Widget, Object, ImplementorIface, ActionGroup, ActionMap, Buildable]

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

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

#### Instances

Instances details

(GObject o, IsDescendantOf ApplicationWindow o) => IsApplicationWindow o Source # |
Instance details Defined in GI.Gtk.Objects.ApplicationWindow

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

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

Expand

#### Methods

actionAdded, actionEnabledChanged, actionRemoved, actionStateChanged, activate, activateAction, activateDefault, activateFocus, activateKey, add, addAccelGroup, addAccelerator, addAction, addActionEntries, addChild, addDeviceEvents, addEvents, addMnemonic, addMnemonicLabel, addTickCallback, beginMoveDrag, beginResizeDrag, bindProperty, bindPropertyFull, canActivateAccel, changeActionState, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, close, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, deiconify, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, fullscreen, fullscreenOnMonitor, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasAction, hasDefault, hasFocus, hasGrab, hasGroup, hasRcStyle, hasScreen, hasToplevelFocus, hasVisibleFocus, hide, hideOnDelete, iconify, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isActive, isAncestor, isComposited, isDrawable, isFloating, isFocus, isMaximized, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listActions, listMnemonicLabels, lookupAction, map, maximize, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, move, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parseGeometry, parserFinished, path, present, presentWithTime, propagateDraw, propagateKeyEvent, queryAction, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelGroup, removeAccelerator, removeAction, removeActionEntries, removeMnemonic, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, reshowWithInitialSize, resize, resizeChildren, resizeGripIsVisible, resizeToGeometry, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, stick, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unfullscreen, unmap, unmaximize, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, unstick, watchClosure.

#### Getters

getAcceptFocus, getAccessible, getActionEnabled, getActionGroup, getActionParameterType, getActionState, getActionStateHint, getActionStateType, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getApplication, getAttachedTo, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDecorated, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocus, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusOnMap, getFocusVadjustment, getFocusVisible, getFontMap, getFontOptions, getFrameClock, getGravity, getGroup, getHalign, getHasResizeGrip, getHasTooltip, getHasWindow, getHelpOverlay, getHexpand, getHexpandSet, getHideTitlebarWhenMaximized, getIcon, getIconList, getIconName, getId, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getMnemonicModifier, getMnemonicsVisible, getModal, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPosition, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizable, getResizeGripArea, getResizeMode, getRole, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getShowMenubar, getSize, getSizeRequest, getSkipPagerHint, getSkipTaskbarHint, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTitle, getTitlebar, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getTransientFor, getTypeHint, getUrgencyHint, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow, getWindowType.

#### Setters

setAccelPath, setAcceptFocus, setAllocation, setAppPaintable, setApplication, setAttachedTo, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDecorated, setDefault, setDefaultGeometry, setDefaultSize, setDeletable, setDestroyWithParent, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocus, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusOnMap, setFocusVadjustment, setFocusVisible, setFontMap, setFontOptions, setGeometryHints, setGravity, setHalign, setHasResizeGrip, setHasTooltip, setHasUserRefCount, setHasWindow, setHelpOverlay, setHexpand, setHexpandSet, setHideTitlebarWhenMaximized, setIcon, setIconFromFile, setIconList, setIconName, setKeepAbove, setKeepBelow, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMnemonicModifier, setMnemonicsVisible, setModal, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setPosition, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizable, setResizeMode, setRole, setScreen, setSensitive, setShowMenubar, setSizeRequest, setSkipPagerHint, setSkipTaskbarHint, setStartupId, setState, setStateFlags, setStyle, setSupportMultidevice, setTitle, setTitlebar, setTooltipMarkup, setTooltipText, setTooltipWindow, setTransientFor, setTypeHint, setUrgencyHint, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow, setWmclass.

## getHelpOverlay

applicationWindowGetHelpOverlay Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a) |
=> a | `window`: a `ApplicationWindow`
-> m (Maybe ShortcutsWindow) | Returns: the help overlay associated with `window`, or `Nothing`

Gets the `ShortcutsWindow` that has been set up with a prior call to `applicationWindowSetHelpOverlay`.

Since: 3.20

## getId

applicationWindowGetId Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a) |
=> a | `window`: a `ApplicationWindow`
-> m Word32 | Returns: the unique ID for `window`, or `0` if the window has not yet been added to a `Application`

Returns the unique ID of the window. If the window has not yet been added to a `Application`, returns `0`.

Since: 3.6

## getShowMenubar

applicationWindowGetShowMenubar Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a) |
=> a | `window`: a `ApplicationWindow`
-> 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.

Since: 3.4

## new

applicationWindowNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a) |
=> a | `application`: a `Application`
-> m ApplicationWindow | Returns: a newly created `ApplicationWindow`

Creates a new `ApplicationWindow`.

Since: 3.4

## setHelpOverlay

applicationWindowSetHelpOverlay Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a, IsShortcutsWindow b) |
=> a | `window`: a `ApplicationWindow`
-> Maybe b | `helpOverlay`: a `ShortcutsWindow`
-> m () |

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 resposibility for destroying `helpOverlay`.

Since: 3.20

## setShowMenubar

applicationWindowSetShowMenubar Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplicationWindow a) |
=> a | `window`: a `ApplicationWindow`
-> 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.

Since: 3.4

# Properties

## showMenubar

If this property is `True`, the window will display a menubar that includes the app menu and menubar, unless these are shown by the desktop shell. See `applicationSetAppMenu` and `applicationSetMenubar`.

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

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

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 Source #

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 () Source #

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

    set applicationWindow [ #showMenubar := value ]