GI.Gtk.Objects.Window

A GtkWindow is a toplevel window which can contain other widgets.

Windows normally have decorations that are under the control of the windowing system and allow the user to manipulate the window (resize it, move it, close it,...).

GtkWindow as GtkBuildable

The GtkWindow implementation of the Buildable interface supports setting a child as the titlebar by specifying “titlebar” as the “type” attribute of a <child> element.

CSS nodes

window.background [.csd / .solid-csd / .ssd] [.maximized / .fullscreen / .tiled]
├── <child>
╰── <titlebar child>.titlebar [.default-decoration]

GtkWindow has a main CSS node with name window and style class .background.

Style classes that are typically used with the main CSS node are .csd (when client-side decorations are in use), .solid-csd (for client-side decorations without invisible borders), .ssd (used by mutter when rendering server-side decorations). GtkWindow also represents window states with the following style classes on the main node: .maximized, .fullscreen, .tiled (when supported, also .tiled-top, .tiled-left, .tiled-right, .tiled-bottom).

GtkWindow subclasses often add their own discriminating style classes, such as .dialog, .popup or .tooltip.

Generally, some CSS properties don't make sense on the toplevel window node, such as margins or padding. When client-side decorations without invisible borders are in use (i.e. the .solid-csd style class is added to the main window node), the CSS border of the toplevel window is used for resize drags. In the .csd case, the shadow area outside of the window can be used to resize it.

GtkWindow adds the .titlebar and .default-decoration style classes to the widget that is added as a titlebar child.

Accessibility

GtkWindow uses the AccessibleRoleWindow role.

Actions

GtkWindow defines a set of built-in actions:

• default.activate: Activate the default widget.
• window.minimize: Minimize the window.
• window.toggle-maximized: Maximize or restore the window.
• window.close: Close the window.

Exported types

newtype Window

Memory-managed wrapper type.

Constructors

Window (ManagedPtr Window)

Instances

Eq Window

Defined in GI.Gtk.Objects.Window

Methods

(==) :: Window -> Window -> Bool

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

GObject Window

Defined in GI.Gtk.Objects.Window

ManagedPtrNewtype Window

Defined in GI.Gtk.Objects.Window

Methods

toManagedPtr :: Window -> ManagedPtr Window

TypedObject Window

Defined in GI.Gtk.Objects.Window

Methods

glibType :: IO GType

HasParentTypes Window

Defined in GI.Gtk.Objects.Window

IsGValue (Maybe Window)

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

Defined in GI.Gtk.Objects.Window

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Window

Defined in GI.Gtk.Objects.Window

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

class (GObject o, IsDescendantOf Window o) => IsWindow o

Type class for types which can be safely cast to Window, for instance with toWindow.

Instances

(GObject o, IsDescendantOf Window o) => IsWindow o

Defined in GI.Gtk.Objects.Window

toWindow :: (MonadIO m, IsWindow o) => o -> m Window

Cast to Window, 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

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, close, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, destroy, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, fullscreen, fullscreenOnMonitor, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasGroup, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isActive, isAncestor, isDrawable, isFloating, isFocus, isFullscreen, isMaximized, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, maximize, measure, minimize, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, present, presentWithTime, queueAllocate, queueDraw, queueResize, realize, ref, refSink, 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, 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, getHexpand, getHexpandSet, getHideOnClose, getIconName, 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, 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, setHexpand, setHexpandSet, setHideOnClose, setIconName, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMnemonicsVisible, setModal, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setResizable, setSensitive, setSizeRequest, setStartupId, setStateFlags, setTitle, setTitlebar, setTooltipMarkup, setTooltipText, setTransientFor, setValign, setVexpand, setVexpandSet, setVisible.

close

windowClose

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m ()

Requests that the window is closed.

This is similar to what happens when a window manager close button is clicked.

This function can be used with close buttons in custom titlebars.

destroy

windowDestroy

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: The window to destroy

-> m ()

Drop the internal reference GTK holds on toplevel windows.

fullscreen

windowFullscreen

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m ()

Asks to place window in the fullscreen state.

Note that you shouldn’t assume the window is definitely fullscreen afterward, because other entities (e.g. the user or window manager unfullscreen it again, and not all window managers honor requests to fullscreen windows.

You can track the result of this operation via the Toplevel:state property, or by listening to notifications of the Window:fullscreened property.

fullscreenOnMonitor

windowFullscreenOnMonitor

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsMonitor b)

=> a

window: a GtkWindow

-> b

monitor: which monitor to go fullscreen on

-> m ()

Asks to place window in the fullscreen state on the given monitor.

Note that you shouldn't assume the window is definitely fullscreen afterward, or that the windowing system allows fullscreen windows on any given monitor.

You can track the result of this operation via the Toplevel:state property, or by listening to notifications of the Window:fullscreened property.

getApplication

windowGetApplication

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m (Maybe Application)

Returns: a GtkApplication

Gets the GtkApplication associated with the window.

getChild

windowGetChild

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m (Maybe Widget)

Returns: the child widget of window

Gets the child widget of window.

getDecorated

windowGetDecorated

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if the window has been set to have decorations

Returns whether the window has been set to have decorations.

getDefaultIconName

windowGetDefaultIconName

Arguments

:: (HasCallStack, MonadIO m)

=> m (Maybe Text)

Returns: the fallback icon name for windows

Returns the fallback icon name for windows.

The returned string is owned by GTK and should not be modified. It is only valid until the next call to [funcgtk.Window.set_default_icon_name].

getDefaultSize

windowGetDefaultSize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m (Int32, Int32)

Gets the default size of the window.

A value of 0 for the width or height indicates that a default size has not been explicitly set for that dimension, so the “natural” size of the window will be used.

getDefaultWidget

windowGetDefaultWidget

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m (Maybe Widget)

Returns: the default widget

Returns the default widget for window.

getDeletable

windowGetDeletable

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if the window has been set to have a close button

Returns whether the window has been set to have a close button.

getDestroyWithParent

windowGetDestroyWithParent

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if the window will be destroyed with its transient parent.

Returns whether the window will be destroyed with its transient parent.

getFocus

windowGetFocus

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m (Maybe Widget)

Returns: the currently focused widget

Retrieves the current focused widget within the window.

Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then gtk_widget_has_focus (widget) will not be True for the widget.

getFocusVisible

windowGetFocusVisible

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if “focus rectangles” are supposed to be visible in this window.

Gets whether “focus rectangles” are supposed to be visible.

getGroup

windowGetGroup

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m WindowGroup

Returns: the GtkWindowGroup for a window or the default group

Returns the group for window.

If the window has no group, then the default group is returned.

getHandleMenubarAccel

windowGetHandleMenubarAccel

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if the window handles F10

Returns whether this window reacts to F10 key presses by activating a menubar it contains.

Since: 4.2

getHideOnClose

windowGetHideOnClose

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if the window will be hidden

Returns whether the window will be hidden when the close button is clicked.

getIconName

windowGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m (Maybe Text)

Returns: the icon name

Returns the name of the themed icon for the window.

getMnemonicsVisible

windowGetMnemonicsVisible

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if mnemonics are supposed to be visible in this window.

Gets whether mnemonics are supposed to be visible.

getModal

windowGetModal

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if the window is set to be modal and establishes a grab when shown

Returns whether the window is modal.

getResizable

windowGetResizable

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if the user can resize the window

Gets the value set by windowSetResizable.

getTitle

windowGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m (Maybe Text)

Returns: the title of the window

Retrieves the title of the window.

getTitlebar

windowGetTitlebar

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m (Maybe Widget)

Returns: the custom titlebar

Returns the custom titlebar that has been set with windowSetTitlebar.

getToplevels

windowGetToplevels

Arguments

:: (HasCallStack, MonadIO m)

=> m ListModel

Returns: the list of toplevel widgets

Returns a list of all existing toplevel windows.

If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets or add new ones, be aware that the list of toplevels will change and emit the "items-changed" signal.

getTransientFor

windowGetTransientFor

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m (Maybe Window)

Returns: the transient parent for this window

Fetches the transient parent for this window.

hasGroup

windowHasGroup

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if window has an explicit window group.

Returns whether window has an explicit window group.

isActive

windowIsActive

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: True if the window part of the current active window.

Returns whether the window is part of the current active toplevel.

The active toplevel is the window receiving keystrokes.

The return value is True if the window is active toplevel itself. You might use this function if you wanted to draw a widget differently in an active window from a widget in an inactive window.

isFullscreen

windowIsFullscreen

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: whether the window has a fullscreen state.

Retrieves the current fullscreen state of window.

Note that since fullscreening is ultimately handled by the window manager and happens asynchronously to an application request, you shouldn’t assume the return value of this function changing immediately (or at all), as an effect of calling windowFullscreen or windowUnfullscreen.

If the window isn't yet mapped, the value returned will whether the initial requested state is fullscreen.

isMaximized

windowIsMaximized

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m Bool

Returns: whether the window has a maximized state.

Retrieves the current maximized state of window.

Note that since maximization is ultimately handled by the window manager and happens asynchronously to an application request, you shouldn’t assume the return value of this function changing immediately (or at all), as an effect of calling windowMaximize or windowUnmaximize.

If the window isn't yet mapped, the value returned will whether the initial requested state is maximized.

listToplevels

windowListToplevels

Arguments

:: (HasCallStack, MonadIO m)

=> m [Widget]

Returns: list of toplevel widgets

Returns a list of all existing toplevel windows.

The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and then unref all the widgets afterwards.

maximize

windowMaximize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m ()

Asks to maximize window, so that it fills the screen.

Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager could unmaximize it again, and not all window managers support maximization.

It’s permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially.

You can track the result of this operation via the Toplevel:state property, or by listening to notifications on the Window:maximized property.

minimize

windowMinimize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m ()

Asks to minimize the specified window.

Note that you shouldn’t assume the window is definitely minimized afterward, because the windowing system might not support this functionality; other entities (e.g. the user or the window manager could unminimize it again, or there may not be a window manager in which case minimization isn’t possible, etc.

It’s permitted to call this function before showing a window, in which case the window will be minimized before it ever appears onscreen.

You can track result of this operation via the Toplevel:state property.

new

windowNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Window

Returns: a new GtkWindow.

Creates a new GtkWindow.

To get an undecorated window (no window borders), use windowSetDecorated.

All top-level windows created by windowNew are stored in an internal top-level window list. This list can be obtained from [funcgtk.Window.list_toplevels]. Due to GTK keeping a reference to the window internally, windowNew does not return a reference to the caller.

To delete a GtkWindow, call windowDestroy.

present

windowPresent

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m ()

Presents a window to the user.

This function should not be used as when it is called, it is too late to gather a valid timestamp to allow focus stealing prevention to work correctly.

presentWithTime

windowPresentWithTime

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Word32

timestamp: the timestamp of the user interaction (typically a button or key press event) which triggered this call

-> m ()

Presents a window to the user.

This may mean raising the window in the stacking order, unminimizing it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user’s platform, window manager, and preferences.

If window is hidden, this function calls widgetShow as well.

This function should be used when the user tries to open a window that’s already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use windowPresent to move the already-open dialog where the user can see it.

Presents a window to the user in response to a user interaction. The timestamp should be gathered when the window was requested to be shown (when clicking a link for example), rather than once the window is ready to be shown.

setApplication

windowSetApplication

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsApplication b)

=> a

window: a GtkWindow

-> Maybe b

application: a GtkApplication, or Nothing to unset

-> m ()

Sets or unsets the GtkApplication associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see applicationHold for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the application to Nothing.

This is equivalent to calling applicationRemoveWindow and/or applicationAddWindow on the old/new applications as relevant.

setAutoStartupNotification

windowSetAutoStartupNotification

Arguments

:: (HasCallStack, MonadIO m)

=> Bool

setting: True to automatically do startup notification

-> m ()

Sets whether the window should request startup notification.

By default, after showing the first GtkWindow, GTK calls displayNotifyStartupComplete. Call this function to disable the automatic startup notification. You might do this if your first window is a splash screen, and you want to delay notification until after your real main window has been shown, for example.

In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main window would automatically result in notification.

setChild

windowSetChild

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)

=> a

window: a GtkWindow

-> Maybe b

child: the child widget

-> m ()

Sets the child widget of window.

setDecorated

windowSetDecorated

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Bool

setting: True to decorate the window

-> m ()

Sets whether the window should be decorated.

By default, windows are decorated with a title bar, resize controls, etc. Some window managers allow GTK to disable these decorations, creating a borderless window. If you set the decorated property to False using this function, GTK will do its best to convince the window manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling widgetShow.

On Windows, this function always works, since there’s no window manager policy involved.

setDefaultIconName

windowSetDefaultIconName

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the name of the themed icon

-> m ()

Sets an icon to be used as fallback.

The fallback icon is used for windows that haven't had windowSetIconName called on them.

setDefaultSize

windowSetDefaultSize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Int32

width: width in pixels, or -1 to unset the default width

-> Int32

height: height in pixels, or -1 to unset the default height

-> m ()

Sets the default size of a window.

If the window’s “natural” size (its size request) is larger than the default, the default will be ignored.

Unlike widgetSetSizeRequest, which sets a size request for a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the “natural” default size (the size request of the window).

The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.

Windows can’t actually be 0x0 in size, they must be at least 1x1, but passing 0 for width and height is OK, resulting in a 1x1 default size.

If you use this function to reestablish a previously saved window size, note that the appropriate size to save is the one returned by windowGetDefaultSize. Using the window allocation directly will not work in all circumstances and can lead to growing or shrinking windows.

setDefaultWidget

windowSetDefaultWidget

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)

=> a

window: a GtkWindow

-> Maybe b

defaultWidget: widget to be the default to unset the default widget for the toplevel

-> m ()

Sets the default widget.

The default widget is the widget that is activated when the user presses Enter in a dialog (for example).

setDeletable

windowSetDeletable

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Bool

setting: True to decorate the window as deletable

-> m ()

Sets whether the window should be deletable.

By default, windows have a close button in the window frame. Some window managers allow GTK to disable this button. If you set the deletable property to False using this function, GTK will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling widgetShow.

On Windows, this function always works, since there’s no window manager policy involved.

setDestroyWithParent

windowSetDestroyWithParent

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Bool

setting: whether to destroy window with its transient parent

-> m ()

If setting is True, then destroying the transient parent of window will also destroy window itself.

This is useful for dialogs that shouldn’t persist beyond the lifetime of the main window they are associated with, for example.

setDisplay

windowSetDisplay

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsDisplay b)

=> a

window: a GtkWindow

-> b

display: a GdkDisplay

-> m ()

Sets the GdkDisplay where the window is displayed.

If the window is already mapped, it will be unmapped, and then remapped on the new display.

setFocus

windowSetFocus

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)

=> a

window: a GtkWindow

-> Maybe b

focus: widget to be the new focus widget, or Nothing to unset any focus widget for the toplevel window.

-> m ()

Sets the focus widget.

If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If focus is Nothing, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use widgetGrabFocus instead of this function.

setFocusVisible

windowSetFocusVisible

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Bool

setting: the new value

-> m ()

Sets whether “focus rectangles” are supposed to be visible.

setHandleMenubarAccel

windowSetHandleMenubarAccel

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Bool

handleMenubarAccel: True to make window handle F10

-> m ()

Sets whether this window should react to F10 key presses by activating a menubar it contains.

Since: 4.2

setHideOnClose

windowSetHideOnClose

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Bool

setting: whether to hide the window when it is closed

-> m ()

If setting is True, then clicking the close button on the window will not destroy it, but only hide it.

setIconName

windowSetIconName

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Maybe Text

name: the name of the themed icon

-> m ()

Sets the icon for the window from a named themed icon.

See the docs for IconTheme for more details. On some platforms, the window icon is not used at all.

Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM.

setInteractiveDebugging

windowSetInteractiveDebugging

Arguments

:: (HasCallStack, MonadIO m)

=> Bool

enable: True to enable interactive debugging

-> m ()

Opens or closes the interactive debugger.

The debugger offers access to the widget hierarchy of the application and to useful debugging tools.

setMnemonicsVisible

windowSetMnemonicsVisible

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Bool

setting: the new value

-> m ()

Sets whether mnemonics are supposed to be visible.

setModal

windowSetModal

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Bool

modal: whether the window is modal

-> m ()

Sets a window modal or non-modal.

Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use windowSetTransientFor to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.

setResizable

windowSetResizable

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Bool

resizable: True if the user can resize this window

-> m ()

Sets whether the user can resize a window.

Windows are user resizable by default.

setStartupId

windowSetStartupId

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Text

startupId: a string with startup-notification identifier

-> m ()

Sets the startup notification ID.

Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying GdkSurface.

Normally, startup identifier is managed automatically and you should only use this function in special cases like transferring focus from other processes. You should use this function before calling windowPresent or any equivalent function generating a window map event.

This function is only useful on X11, not with other GTK targets.

setTitle

windowSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> Maybe Text

title: title of the window

-> m ()

Sets the title of the GtkWindow.

The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the window manager so exactly how the title appears to users may vary according to a user’s exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example.

Passing Nothing does the same as setting the title to an empty string.

setTitlebar

windowSetTitlebar

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)

=> a

window: a GtkWindow

-> Maybe b

titlebar: the widget to use as titlebar

-> m ()

Sets a custom titlebar for window.

A typical widget used here is HeaderBar, as it provides various features expected of a titlebar while allowing the addition of child widgets to it.

If you set a custom titlebar, GTK will do its best to convince the window manager not to put its own titlebar on the window. Depending on the system, this function may not work for a window that is already visible, so you set the titlebar before calling widgetShow.

setTransientFor

windowSetTransientFor

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWindow b)

=> a

window: a GtkWindow

-> Maybe b

parent: parent window

-> m ()

Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. Dialog.new_with_buttons() and other convenience functions in GTK will sometimes call windowSetTransientFor on your behalf.

Passing Nothing for parent unsets the current transient window.

On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X.

unfullscreen

windowUnfullscreen

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m ()

Asks to remove the fullscreen state for window, and return to its previous state.

Note that you shouldn’t assume the window is definitely not fullscreen afterward, because other entities (e.g. the user or window manager could fullscreen it again, and not all window managers honor requests to unfullscreen windows; normally the window will end up restored to its normal state. Just don’t write code that crashes if not.

You can track the result of this operation via the Toplevel:state property, or by listening to notifications of the Window:fullscreened property.

unmaximize

windowUnmaximize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m ()

Asks to unmaximize window.

Note that you shouldn’t assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager maximize it again, and not all window managers honor requests to unmaximize.

You can track the result of this operation via the Toplevel:state property, or by listening to notifications on the Window:maximized property.

unminimize

windowUnminimize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a GtkWindow

-> m ()

Asks to unminimize the specified window.

Note that you shouldn’t assume the window is definitely unminimized afterward, because the windowing system might not support this functionality; other entities (e.g. the user or the window manager could minimize it again, or there may not be a window manager in which case minimization isn’t possible, etc.

You can track result of this operation via the Toplevel:state property.

Properties

application

The GtkApplication associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see applicationHold for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to Nothing.

clearWindowApplication :: (MonadIO m, IsWindow o) => o -> m ()

Set the value of the “application” property to Nothing. When overloading is enabled, this is equivalent to

clear #application

constructWindowApplication :: (IsWindow o, MonadIO m, IsApplication a) => a -> m (GValueConstruct o)

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

getWindowApplication :: (MonadIO m, IsWindow o) => o -> m (Maybe Application)

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

get window #application

setWindowApplication :: (MonadIO m, IsWindow o, IsApplication a) => o -> a -> m ()

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

set window [ #application := value ]

child

The child widget.

clearWindowChild :: (MonadIO m, IsWindow o) => o -> m ()

Set the value of the “child” property to Nothing. When overloading is enabled, this is equivalent to

clear #child

constructWindowChild :: (IsWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getWindowChild :: (MonadIO m, IsWindow o) => o -> m (Maybe Widget)

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

get window #child

setWindowChild :: (MonadIO m, IsWindow o, IsWidget a) => o -> a -> m ()

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

set window [ #child := value ]

decorated

Whether the window should have a frame (also known as *decorations*).

constructWindowDecorated :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowDecorated :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #decorated

setWindowDecorated :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

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

set window [ #decorated := value ]

defaultHeight

The default height of the window.

constructWindowDefaultHeight :: (IsWindow o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getWindowDefaultHeight :: (MonadIO m, IsWindow o) => o -> m Int32

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

get window #defaultHeight

setWindowDefaultHeight :: (MonadIO m, IsWindow o) => o -> Int32 -> m ()

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

set window [ #defaultHeight := value ]

defaultWidget

The default widget.

clearWindowDefaultWidget :: (MonadIO m, IsWindow o) => o -> m ()

Set the value of the “default-widget” property to Nothing. When overloading is enabled, this is equivalent to

clear #defaultWidget

constructWindowDefaultWidget :: (IsWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getWindowDefaultWidget :: (MonadIO m, IsWindow o) => o -> m (Maybe Widget)

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

get window #defaultWidget

setWindowDefaultWidget :: (MonadIO m, IsWindow o, IsWidget a) => o -> a -> m ()

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

set window [ #defaultWidget := value ]

defaultWidth

The default width of the window.

constructWindowDefaultWidth :: (IsWindow o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getWindowDefaultWidth :: (MonadIO m, IsWindow o) => o -> m Int32

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

get window #defaultWidth

setWindowDefaultWidth :: (MonadIO m, IsWindow o) => o -> Int32 -> m ()

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

set window [ #defaultWidth := value ]

deletable

Whether the window frame should have a close button.

constructWindowDeletable :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowDeletable :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #deletable

setWindowDeletable :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

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

set window [ #deletable := value ]

destroyWithParent

If this window should be destroyed when the parent is destroyed.

constructWindowDestroyWithParent :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowDestroyWithParent :: (MonadIO m, IsWindow o) => o -> m Bool

Get the value of the “destroy-with-parent” property. When overloading is enabled, this is equivalent to

get window #destroyWithParent

setWindowDestroyWithParent :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

Set the value of the “destroy-with-parent” property. When overloading is enabled, this is equivalent to

set window [ #destroyWithParent := value ]

display

The display that will display this window.

constructWindowDisplay :: (IsWindow o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o)

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

getWindowDisplay :: (MonadIO m, IsWindow o) => o -> m (Maybe Display)

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

get window #display

setWindowDisplay :: (MonadIO m, IsWindow o, IsDisplay a) => o -> a -> m ()

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

set window [ #display := value ]

focusVisible

Whether 'focus rectangles' are currently visible in this window.

This property is maintained by GTK based on user input and should not be set by applications.

constructWindowFocusVisible :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowFocusVisible :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #focusVisible

setWindowFocusVisible :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

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

set window [ #focusVisible := value ]

focusWidget

The focus widget.

clearWindowFocusWidget :: (MonadIO m, IsWindow o) => o -> m ()

Set the value of the “focus-widget” property to Nothing. When overloading is enabled, this is equivalent to

clear #focusWidget

constructWindowFocusWidget :: (IsWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getWindowFocusWidget :: (MonadIO m, IsWindow o) => o -> m (Maybe Widget)

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

get window #focusWidget

setWindowFocusWidget :: (MonadIO m, IsWindow o, IsWidget a) => o -> a -> m ()

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

set window [ #focusWidget := value ]

fullscreened

Whether the window is fullscreen.

Setting this property is the equivalent of calling windowFullscreen or windowUnfullscreen; either operation is asynchronous, which means you will need to connect to the notify signal in order to know whether the operation was successful.

constructWindowFullscreened :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowFullscreened :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #fullscreened

setWindowFullscreened :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

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

set window [ #fullscreened := value ]

handleMenubarAccel

Whether the window frame should handle F10 for activating menubars.

Since: 4.2

constructWindowHandleMenubarAccel :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowHandleMenubarAccel :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #handleMenubarAccel

setWindowHandleMenubarAccel :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

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

set window [ #handleMenubarAccel := value ]

hideOnClose

If this window should be hidden when the users clicks the close button.

constructWindowHideOnClose :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowHideOnClose :: (MonadIO m, IsWindow o) => o -> m Bool

Get the value of the “hide-on-close” property. When overloading is enabled, this is equivalent to

get window #hideOnClose

setWindowHideOnClose :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

Set the value of the “hide-on-close” property. When overloading is enabled, this is equivalent to

set window [ #hideOnClose := value ]

iconName

Specifies the name of the themed icon to use as the window icon.

See IconTheme for more details.

clearWindowIconName :: (MonadIO m, IsWindow o) => o -> m ()

Set the value of the “icon-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #iconName

constructWindowIconName :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o)

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

getWindowIconName :: (MonadIO m, IsWindow o) => o -> m (Maybe Text)

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

get window #iconName

setWindowIconName :: (MonadIO m, IsWindow o) => o -> Text -> m ()

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

set window [ #iconName := value ]

isActive

Whether the toplevel is the currently active window.

getWindowIsActive :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #isActive

maximized

Whether the window is maximized.

Setting this property is the equivalent of calling windowMaximize or windowUnmaximize; either operation is asynchronous, which means you will need to connect to the notify signal in order to know whether the operation was successful.

constructWindowMaximized :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowMaximized :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #maximized

setWindowMaximized :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

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

set window [ #maximized := value ]

mnemonicsVisible

Whether mnemonics are currently visible in this window.

This property is maintained by GTK based on user input, and should not be set by applications.

constructWindowMnemonicsVisible :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowMnemonicsVisible :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #mnemonicsVisible

setWindowMnemonicsVisible :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

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

set window [ #mnemonicsVisible := value ]

modal

If True, the window is modal.

constructWindowModal :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowModal :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #modal

setWindowModal :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

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

set window [ #modal := value ]

resizable

If True, users can resize the window.

constructWindowResizable :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getWindowResizable :: (MonadIO m, IsWindow o) => o -> m Bool

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

get window #resizable

setWindowResizable :: (MonadIO m, IsWindow o) => o -> Bool -> m ()

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

set window [ #resizable := value ]

startupId

A write-only property for setting window's startup notification identifier.

constructWindowStartupId :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o)

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

setWindowStartupId :: (MonadIO m, IsWindow o) => o -> Text -> m ()

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

set window [ #startupId := value ]

title

The title of the window.

clearWindowTitle :: (MonadIO m, IsWindow o) => o -> m ()

Set the value of the “title” property to Nothing. When overloading is enabled, this is equivalent to

clear #title

constructWindowTitle :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o)

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

getWindowTitle :: (MonadIO m, IsWindow o) => o -> m (Maybe Text)

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

get window #title

setWindowTitle :: (MonadIO m, IsWindow o) => o -> Text -> m ()

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

set window [ #title := value ]

titlebar

The titlebar widget.

Since: 4.6

clearWindowTitlebar :: (MonadIO m, IsWindow o) => o -> m ()

Set the value of the “titlebar” property to Nothing. When overloading is enabled, this is equivalent to

clear #titlebar

constructWindowTitlebar :: (IsWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getWindowTitlebar :: (MonadIO m, IsWindow o) => o -> m (Maybe Widget)

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

get window #titlebar

setWindowTitlebar :: (MonadIO m, IsWindow o, IsWidget a) => o -> a -> m ()

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

set window [ #titlebar := value ]

transientFor

The transient parent of the window.

clearWindowTransientFor :: (MonadIO m, IsWindow o) => o -> m ()

Set the value of the “transient-for” property to Nothing. When overloading is enabled, this is equivalent to

clear #transientFor

constructWindowTransientFor :: (IsWindow o, MonadIO m, IsWindow a) => a -> m (GValueConstruct o)

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

getWindowTransientFor :: (MonadIO m, IsWindow o) => o -> m (Maybe Window)

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

get window #transientFor

setWindowTransientFor :: (MonadIO m, IsWindow o, IsWindow a) => o -> a -> m ()

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

set window [ #transientFor := value ]

Signals

activateDefault

type WindowActivateDefaultCallback = IO ()

Emitted when the user activates the default widget of window.

This is a keybinding signal.

afterWindowActivateDefault :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateDefaultCallback) -> m SignalHandlerId

Connect a signal handler for the activateDefault signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #activateDefault callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowActivateDefault :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateDefaultCallback) -> m SignalHandlerId

Connect a signal handler for the activateDefault signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #activateDefault callback

activateFocus

type WindowActivateFocusCallback = IO ()

Emitted when the user activates the currently focused widget of window.

This is a keybinding signal.

afterWindowActivateFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateFocusCallback) -> m SignalHandlerId

Connect a signal handler for the activateFocus signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #activateFocus callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowActivateFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateFocusCallback) -> m SignalHandlerId

Connect a signal handler for the activateFocus signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #activateFocus callback

closeRequest

type WindowCloseRequestCallback

Arguments

 = IO Bool

Returns: True to stop other handlers from being invoked for the signal

Emitted when the user clicks on the close button of the window.

afterWindowCloseRequest :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowCloseRequestCallback) -> m SignalHandlerId

Connect a signal handler for the closeRequest signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #closeRequest callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowCloseRequest :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowCloseRequestCallback) -> m SignalHandlerId

Connect a signal handler for the closeRequest signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #closeRequest callback

enableDebugging

type WindowEnableDebuggingCallback

Arguments

 = Bool

toggle: toggle the debugger

-> IO Bool

Returns: True if the key binding was handled

Emitted when the user enables or disables interactive debugging.

When toggle is True, interactive debugging is toggled on or off, when it is False, the debugger will be pointed at the widget under the pointer.

This is a keybinding signal.

The default bindings for this signal are Ctrl-Shift-I and Ctrl-Shift-D.

afterWindowEnableDebugging :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowEnableDebuggingCallback) -> m SignalHandlerId

Connect a signal handler for the enableDebugging signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #enableDebugging callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowEnableDebugging :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowEnableDebuggingCallback) -> m SignalHandlerId

Connect a signal handler for the enableDebugging signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #enableDebugging callback

keysChanged

type WindowKeysChangedCallback = IO ()

emitted when the set of accelerators or mnemonics that are associated with window changes.

afterWindowKeysChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowKeysChangedCallback) -> m SignalHandlerId

Connect a signal handler for the keysChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #keysChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowKeysChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowKeysChangedCallback) -> m SignalHandlerId

Connect a signal handler for the keysChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #keysChanged callback