gi-gtk-4.0.4: Gtk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Gtk.Objects.ApplicationWindow

Description

ApplicationWindow is a Window subclass that offers some extra functionality for better integration with Application features. Notably, it can handle an application menubar. See 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:gtk-shell-shows-app-menu and 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. 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: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 PopoverMenu for information about the XML language used by Builder for menu models.

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

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

GObject ApplicationWindow Source # 
Instance details

Defined in GI.Gtk.Objects.ApplicationWindow

ManagedPtrNewtype ApplicationWindow Source # 
Instance details

Defined in GI.Gtk.Objects.ApplicationWindow

TypedObject ApplicationWindow Source # 
Instance details

Defined in GI.Gtk.Objects.ApplicationWindow

Methods

glibType :: IO GType

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

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

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

type ParentTypes ApplicationWindow Source # 
Instance details

Defined in GI.Gtk.Objects.ApplicationWindow

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

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.

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.

new

applicationWindowNew Source #

Arguments

:: (HasCallStack, MonadIO m, IsApplication a) 
=> a

application: a Application

-> m ApplicationWindow

Returns: a newly created ApplicationWindow

Creates a new ApplicationWindow.

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

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.

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