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 GtkBuildable interface supports a custom <accel-groups> element, which supports any number of <group> elements representing the AccelGroup objects you want to add to your window (synonymous with windowAddAccelGroup.

An example of a UI definition fragment with accel groups: > >class="GtkWindow" > accel-groups > name="accelgroup1"/ > /accel-groups >/object > >... > >class="GtkAccelGroup" id="accelgroup1"/

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

CSS nodes

plain code

window.background
├── decoration
├── <titlebar child>.titlebar [.default-decoration]
╰── <child>

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

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: .tiled, .maximized, .fullscreen. Specialized types of window often add their own discriminating style classes, such as .popup or .tooltip.

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

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

IsGValue Window

Convert Window to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.Window

Methods

toGValue :: Window -> IO GValue

fromGValue :: GValue -> IO Window

GObject Window

Defined in GI.Gtk.Objects.Window

Methods

gobjectType :: IO GType

HasParentTypes Window

Defined in GI.Gtk.Objects.Window

type ParentTypes Window

Defined in GI.Gtk.Objects.Window

type ParentTypes Window = '[Bin, Container, Widget, Object, ImplementorIface, Buildable, Root]

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.

noWindow :: Maybe Window

A convenience alias for Nothing :: Maybe Window.

Methods

Overloaded methods

activateKey

windowActivateKey

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> EventKey

event: a EventKey

-> m Bool

Returns: True if a mnemonic or accelerator was found and activated.

Activates mnemonics and accelerators for this Window. This is normally called by the default key_press_event handler for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.

addAccelGroup

windowAddAccelGroup

Arguments

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

=> a

window: window to attach accelerator group to

-> b

accelGroup: a AccelGroup

-> m ()

Associate accelGroup with window, such that calling accelGroupsActivate on window will activate accelerators in accelGroup.

addMnemonic

windowAddMnemonic

Arguments

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

=> a

window: a Window

-> Word32

keyval: the mnemonic

-> b

target: the widget that gets activated by the mnemonic

-> m ()

Adds a mnemonic to this window.

beginMoveDrag

windowBeginMoveDrag

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Int32

button: mouse button that initiated the drag

-> Int32

x: X position where the user clicked to initiate the drag, in window coordinates

-> Int32

y: Y position where the user clicked to initiate the drag

-> Word32

timestamp: timestamp from the click event that initiated the drag

-> m ()

Starts moving a window. This function is used if an application has window movement grips.

beginResizeDrag

windowBeginResizeDrag

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> SurfaceEdge

edge: position of the resize control

-> Int32

button: mouse button that initiated the drag

-> Int32

x: X position where the user clicked to initiate the drag, in window coordinates

-> Int32

y: Y position where the user clicked to initiate the drag

-> Word32

timestamp: timestamp from the click event that initiated the drag

-> m ()

Starts resizing a window. This function is used if an application has window resizing controls.

close

windowClose

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m ()

Requests that the window is closed, similar to what happens when a window manager close button is clicked.

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

deiconify

windowDeiconify

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m ()

Asks to deiconify (i.e. unminimize) the specified window. Note that you shouldn’t assume the window is definitely deiconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch])) could iconify it again before your code which assumes deiconification gets to run.

You can track iconification via the Surface::state property.

fullscreen

windowFullscreen

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m ()

Asks to place window in the fullscreen state. Note that you shouldn’t assume the window is definitely full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up fullscreen. Just don’t write code that crashes if not.

You can track iconification via the Surface::state property

fullscreenOnMonitor

windowFullscreenOnMonitor

Arguments

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

=> a

window: a Window

-> b

monitor: which monitor to go fullscreen on

-> m ()

Asks to place window in the fullscreen state. Note that you shouldn't assume the window is definitely full screen afterward.

You can track iconification via the Surface::state property

getAcceptFocus

windowGetAcceptFocus

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

Returns: True if window should receive the input focus

Gets the value set by windowSetAcceptFocus.

getApplication

windowGetApplication

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m (Maybe Application)

Returns: a Application, or Nothing

Gets the Application associated with the window (if any).

getAttachedTo

windowGetAttachedTo

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m (Maybe Widget)

Returns: the widget where the window is attached, or Nothing if the window is not attached to any widget.

Fetches the attach widget for this window. See windowSetAttachedTo.

getDecorated

windowGetDecorated

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

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

Returns whether the window has been set to have decorations such as a title bar via windowSetDecorated.

getDefaultIconName

windowGetDefaultIconName

Arguments

:: (HasCallStack, MonadIO m)

=> m Text

Returns: the fallback icon name for windows

Returns the fallback icon name for windows that has been set with windowSetDefaultIconName. The returned string is owned by GTK+ and should not be modified. It is only valid until the next call to windowSetDefaultIconName.

getDefaultSize

windowGetDefaultSize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m (Int32, Int32)

Gets the default size of the window. A value of -1 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 Window

-> m (Maybe Widget)

Returns: the default widget, or Nothing if there is none.

Returns the default widget for window. See gtk_window_set_default() for more details.

getDeletable

windowGetDeletable

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> 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 via windowSetDeletable.

getDestroyWithParent

windowGetDestroyWithParent

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> 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. See gtk_window_set_destroy_with_parent ().

getFocus

windowGetFocus

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m (Maybe Widget)

Returns: the currently focused widget, or Nothing if there is none.

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.

getFocusOnMap

windowGetFocusOnMap

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

Returns: True if window should receive the input focus when mapped.

Gets the value set by windowSetFocusOnMap.

getFocusVisible

windowGetFocusVisible

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

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

Gets the value of the Window:focus-visible property.

getGroup

windowGetGroup

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window, or Nothing

-> m WindowGroup

Returns: the WindowGroup for a window or the default group

Returns the group for window or the default group, if window is Nothing or if window does not have an explicit window group.

getHideOnClose

windowGetHideOnClose

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> 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 Window

-> m (Maybe Text)

Returns: the icon name or Nothing if the window has no themed icon

Returns the name of the themed icon for the window, see windowSetIconName.

getMnemonicModifier

windowGetMnemonicModifier

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m [ModifierType]

Returns: the modifier mask used to activate mnemonics on this window.

Returns the mnemonic modifier for this window. See windowSetMnemonicModifier.

getMnemonicsVisible

windowGetMnemonicsVisible

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

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

Gets the value of the Window:mnemonics-visible property.

getModal

windowGetModal

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

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

Returns whether the window is modal. See windowSetModal.

getResizable

windowGetResizable

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

Returns: True if the user can resize the window

Gets the value set by windowSetResizable.

getSize

windowGetSize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m (Int32, Int32)

Obtains the current size of window.

If window is not visible on screen, this function return the size GTK+ will suggest to the [window manager][gtk-X11-arch] for the initial window size (but this is not reliably the same as the size the window manager will actually select). See: windowSetDefaultSize.

Depending on the windowing system and the window manager constraints, the size returned by this function may not match the size set using windowResize; additionally, since windowResize may be implemented as an asynchronous operation, GTK+ cannot guarantee in any way that this code:

C code

 GtkWindow *window = GTK_WINDOW (gtk_window_new (GTK_WINDOW_TOPLEVEL));
 int width = 500;
 int height = 300;
 gtk_window_resize (window, width, height);

 int new_width, new_height;
 gtk_window_get_size (window, &new_width, &new_height);

will result in new_width and new_height matching width and height, respectively.

This function will return the logical size of the Window, excluding the widgets used in client side decorations; there is, however, no guarantee that the result will be completely accurate because client side decoration may include widgets that depend on the user preferences and that may not be visibile at the time you call this function.

The dimensions returned by this function are suitable for being stored across sessions; use windowSetDefaultSize to restore them when before showing the window.

To avoid potential race conditions, you should only call this function in response to a size change notification, for instance inside a handler for the sizeAllocate signal, or inside a handler for the Widget::configure-event signal:

C code

static void
on_size_allocate (GtkWidget *widget,
                  const GtkAllocation *allocation,
                  int baseline)
{
  int new_width, new_height;

  gtk_window_get_size (GTK_WINDOW (widget), &new_width, &new_height);

  // ...
}

Note that, if you connect to the sizeAllocate signal, you should not use the dimensions of the GtkAllocation passed to the signal handler, as the allocation may contain client side decorations added by GTK+, depending on the windowing system in use.

If you are getting a window size in order to position the window on the screen, you should, instead, simply set the window’s semantic type with windowSetTypeHint, which allows the window manager to e.g. center dialogs. Also, if you set the transient parent of dialogs with windowSetTransientFor window managers will often center the dialog over its parent window. It's much preferred to let the window manager handle these cases rather than doing it yourself, because all apps will behave consistently and according to user or system preferences, if the window manager handles it. Also, the window manager can take into account the size of the window decorations and border that it may add, and of which GTK+ has no knowledge. Additionally, positioning windows in global screen coordinates may not be allowed by the windowing system. For more information, see: windowSetPosition.

getTitle

windowGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m (Maybe Text)

Returns: the title of the window, or Nothing if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed.

Retrieves the title of the window. See windowSetTitle.

getTitlebar

windowGetTitlebar

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m (Maybe Widget)

Returns: the custom titlebar, or Nothing

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 Window

-> m (Maybe Window)

Returns: the transient parent for this window, or Nothing if no transient parent has been set.

Fetches the transient parent for this window. See windowSetTransientFor.

getTypeHint

windowGetTypeHint

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m SurfaceTypeHint

Returns: the type hint for window.

Gets the type hint for this window. See windowSetTypeHint.

getWindowType

windowGetWindowType

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m WindowType

Returns: the type of the window

Gets the type of the window. See WindowType.

hasGroup

windowHasGroup

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

Returns: True if window has an explicit window group.

Returns whether window has an explicit window group.

iconify

windowIconify

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m ()

Asks to iconify (i.e. minimize) the specified window. Note that you shouldn’t assume the window is definitely iconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could deiconify it again, or there may not be a window manager in which case iconification isn’t possible, etc. But normally the window will end up iconified. Just don’t write code that crashes if not.

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

You can track iconification via the Surface::state property.

isActive

windowIsActive

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

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

Returns whether the window is part of the current active toplevel. (That is, the toplevel 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.

isMaximized

windowIsMaximized

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

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

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 Window

-> m ()

Asks to maximize window, so that it becomes full-screen. Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don’t write code that crashes if not.

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 iconification via the Surface::state property or by listening to notifications on the Window:is-maximized property.

mnemonicActivate

windowMnemonicActivate

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Word32

keyval: the mnemonic

-> [ModifierType]

modifier: the modifiers

-> m Bool

Returns: True if the activation is done.

Activates the targets associated with the mnemonic.

new

windowNew

Arguments

:: (HasCallStack, MonadIO m)

=> WindowType

type: type of window

-> m Window

Returns: a new Window.

Creates a new Window, which is a toplevel window that can contain other widgets. Nearly always, the type of the window should be GTK_WINDOW_TOPLEVEL. If you’re implementing something like a popup menu from scratch (which is a bad idea, just use Menu), you might use GTK_WINDOW_POPUP. GTK_WINDOW_POPUP is not for dialogs, though in some other toolkits dialogs are called “popups”. In GTK+, GTK_WINDOW_POPUP means a pop-up menu or pop-up tooltip. On X11, popup windows are not controlled by the [window manager][gtk-X11-arch].

If you simply want an undecorated window (no window borders), use windowSetDecorated, don’t use GTK_WINDOW_POPUP.

All top-level windows created by windowNew are stored in an internal top-level window list. This list can be obtained from windowListToplevels. Due to Gtk+ keeping a reference to the window internally, windowNew does not return a reference to the caller.

To delete a Window, call widgetDestroy.

present

windowPresent

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> 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 Window

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

propagateKeyEvent

windowPropagateKeyEvent

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> EventKey

event: a EventKey

-> m Bool

Returns: True if a widget in the focus chain handled the event.

Propagate a key press or release event to the focus widget and up the focus container chain until a widget handles event. This is normally called by the default key_press_event and key_release_event handlers for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.

removeAccelGroup

windowRemoveAccelGroup

Arguments

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

=> a

window: a Window

-> b

accelGroup: a AccelGroup

-> m ()

Reverses the effects of windowAddAccelGroup.

removeMnemonic

windowRemoveMnemonic

Arguments

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

=> a

window: a Window

-> Word32

keyval: the mnemonic

-> b

target: the widget that gets activated by the mnemonic

-> m ()

Removes a mnemonic from this window.

resize

windowResize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Int32

width: width in pixels to resize the window to

-> Int32

height: height in pixels to resize the window to

-> m ()

Resizes the window as if the user had done so, obeying geometry constraints. The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call widgetSetSizeRequest to set the window's request to a smaller value.

If windowResize is called before showing a window for the first time, it overrides any default size set with windowSetDefaultSize.

Windows may not be resized smaller than 1 by 1 pixels.

When using client side decorations, GTK+ will do its best to adjust the given size so that the resulting window size matches the requested size without the title bar, borders and shadows added for the client side decorations, but there is no guarantee that the result will be totally accurate because these widgets added for client side decorations depend on the theme and may not be realized or visible at the time windowResize is issued.

If the GtkWindow has a titlebar widget (see windowSetTitlebar), then typically, windowResize will compensate for the height of the titlebar widget only if the height is known when the resulting GtkWindow configuration is issued. For example, if new widgets are added after the GtkWindow configuration and cause the titlebar widget to grow in height, this will result in a window content smaller that specified by windowResize and not a larger window.

setAcceptFocus

windowSetAcceptFocus

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Bool

setting: True to let this window receive input focus

-> m ()

Windows may set a hint asking the desktop environment not to receive the input focus. This function sets this hint.

setApplication

windowSetApplication

Arguments

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

=> a

window: a Window

-> Maybe b

application: a Application, or Nothing to unset

-> m ()

Sets or unsets the Application 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.

setAttachedTo

windowSetAttachedTo

Arguments

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

=> a

window: a Window

-> Maybe b

attachWidget: a Widget, or Nothing

-> m ()

Marks window as attached to attachWidget. This creates a logical binding between the window and the widget it belongs to, which is used by GTK+ to propagate information such as styling or accessibility to window as if it was a children of attachWidget.

Examples of places where specifying this relation is useful are for instance a Menu created by a ComboBox, a completion popup window created by Entry or a typeahead search entry created by TreeView.

Note that this function should not be confused with windowSetTransientFor, which specifies a window manager relation between two toplevels instead.

Passing Nothing for attachWidget detaches the window.

setAutoStartupNotification

windowSetAutoStartupNotification

Arguments

:: (HasCallStack, MonadIO m)

=> Bool

setting: True to automatically do startup notification

-> m ()

By default, after showing the first Window, GTK+ calls gdk_notify_startup_complete(). 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.

setDecorated

windowSetDecorated

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Bool

setting: True to decorate the window

-> m ()

By default, windows are decorated with a title bar, resize controls, etc. Some [window managers][gtk-X11-arch] 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 for windows that haven't had gtk_window_set_icon_list() called on them from a named themed icon, see windowSetIconName.

setDefaultSize

windowSetDefaultSize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

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

For some uses, windowResize is a more appropriate function. windowResize changes the current size of the window, rather than the size to be used on initial display. windowResize always affects the window itself, not the geometry widget.

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 windowGetSize. 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 Window

-> Maybe b

defaultWidget: widget to be the default, or Nothing to unset the default widget for the toplevel

-> m ()

The default widget is the widget that’s activated when the user presses Enter in a dialog (for example). This function sets or unsets the default widget for a Window.

setDeletable

windowSetDeletable

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Bool

setting: True to decorate the window as deletable

-> m ()

By default, windows have a close button in the window frame. Some [window managers][gtk-X11-arch] 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 Window

-> 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're associated with, for example.

setDisplay

windowSetDisplay

Arguments

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

=> a

window: a Window.

-> b

display: a Display.

-> m ()

Sets the Display 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 Window

-> Maybe b

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

-> m ()

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.

setFocusOnMap

windowSetFocusOnMap

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Bool

setting: True to let this window receive input focus on map

-> m ()

Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped. This function sets this hint.

setFocusVisible

windowSetFocusVisible

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Bool

setting: the new value

-> m ()

Sets the Window:focus-visible property.

setHasUserRefCount

windowSetHasUserRefCount

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Bool

setting: the new value

-> m ()

Tells GTK+ whether to drop its extra reference to the window when widgetDestroy is called.

This function is only exported for the benefit of language bindings which may need to keep the window alive until their wrapper object is garbage collected. There is no justification for ever calling this function in an application.

setHideOnClose

windowSetHideOnClose

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> 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 Window

-> 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][interactive-debugging], which offers access to the widget hierarchy of the application and to useful debugging tools.

setKeepAbove

windowSetKeepAbove

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Bool

setting: whether to keep window above other windows

-> m ()

Asks to keep window above, so that it stays on top. Note that you shouldn’t assume the window is definitely above afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it above, and not all window managers support keeping windows above. But normally the window will end kept above. Just don’t write code that crashes if not.

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

You can track iconification via the Surface::state property

Note that, according to the Extended Window Manager Hints Specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

setKeepBelow

windowSetKeepBelow

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Bool

setting: whether to keep window below other windows

-> m ()

Asks to keep window below, so that it stays in bottom. Note that you shouldn’t assume the window is definitely below afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it below, and not all window managers support putting windows below. But normally the window will be kept below. Just don’t write code that crashes if not.

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

You can track iconification via the Surface::state property

Note that, according to the Extended Window Manager Hints Specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

setMnemonicModifier

windowSetMnemonicModifier

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> [ModifierType]

modifier: the modifier mask used to activate mnemonics on this window.

-> m ()

Sets the mnemonic modifier for this window.

setMnemonicsVisible

windowSetMnemonicsVisible

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> Bool

setting: the new value

-> m ()

Sets the Window:mnemonics-visible property.

setModal

windowSetModal

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> 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][gtk-X11-arch] will then disallow lowering the dialog below the parent.

setPosition

windowSetPosition

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window.

-> WindowPosition

position: a position constraint.

-> m ()

Sets a position constraint for this window. If the old or new constraint is WindowPositionCenterAlways, this will also cause the window to be repositioned to satisfy the new constraint.

setResizable

windowSetResizable

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> 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 Window

-> Text

startupId: a string with startup-notification identifier

-> m ()

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 Window

-> Text

title: title of the window

-> m ()

Sets the title of the Window. 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][gtk-X11-arch], 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.

setTitlebar

windowSetTitlebar

Arguments

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

=> a

window: a Window

-> 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 Window

-> Maybe b

parent: parent window, or Nothing

-> m ()

Dialog windows should be set transient for the main application window they were spawned from. This allows [window managers][gtk-X11-arch] to e.g. keep the dialog on top of the main window, or center the dialog over the main window. gtk_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.

This function can also be used to attach a new GTK_WINDOW_POPUP to a GTK_WINDOW_TOPLEVEL parent already mapped on screen so that the GTK_WINDOW_POPUP will be positioned relative to the GTK_WINDOW_TOPLEVEL surface.

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

setTypeHint

windowSetTypeHint

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> SurfaceTypeHint

hint: the window type

-> m ()

By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application.

This function should be called before the window becomes visible.

gtk_dialog_new_with_buttons() and other convenience functions in GTK+ will sometimes call windowSetTypeHint on your behalf.

stick

windowStick

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m ()

Asks to stick window, which means that it will appear on all user desktops. Note that you shouldn’t assume the window is definitely stuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch] could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not.

It’s permitted to call this function before showing a window.

You can track iconification via the Surface::state property.

unfullscreen

windowUnfullscreen

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m ()

Asks to toggle off the fullscreen state for window. Note that you shouldn’t assume the window is definitely not full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don’t write code that crashes if not.

You can track iconification via the Surface::state property

unmaximize

windowUnmaximize

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> 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][gtk-X11-arch]) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don’t write code that crashes if not.

You can track iconification via the Surface::state property

unstick

windowUnstick

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m ()

Asks to unstick window, which means that it will appear on only one of the user’s desktops. Note that you shouldn’t assume the window is definitely unstuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could stick it again. But normally the window will end up stuck. Just don’t write code that crashes if not.

You can track iconification via the Surface::state property.

Properties

acceptFocus

Whether the window should receive the input focus.

constructWindowAcceptFocus :: IsWindow o => Bool -> IO (GValueConstruct o)

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

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

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

get window #acceptFocus

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

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

set window [ #acceptFocus := value ]

application

The Application 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, IsApplication a) => a -> IO (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 ]

attachedTo

The widget to which this window is attached. See windowSetAttachedTo.

Examples of places where specifying this relation is useful are for instance a Menu created by a ComboBox, a completion popup window created by Entry or a typeahead search entry created by TreeView.

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

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

clear #attachedTo

constructWindowAttachedTo :: (IsWindow o, IsWidget a) => a -> IO (GValueConstruct o)

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

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

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

get window #attachedTo

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

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

set window [ #attachedTo := value ]

decorated

Whether the window should be decorated by the window manager.

constructWindowDecorated :: IsWindow o => Bool -> IO (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

No description available in the introspection data.

constructWindowDefaultHeight :: IsWindow o => Int32 -> IO (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

No description available in the introspection data.

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, IsWidget a) => a -> IO (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

No description available in the introspection data.

constructWindowDefaultWidth :: IsWindow o => Int32 -> IO (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 => Bool -> IO (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

No description available in the introspection data.

constructWindowDestroyWithParent :: IsWindow o => Bool -> IO (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

No description available in the introspection data.

constructWindowDisplay :: (IsWindow o, IsDisplay a) => a -> IO (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 ]

focusOnMap

Whether the window should receive the input focus when mapped.

constructWindowFocusOnMap :: IsWindow o => Bool -> IO (GValueConstruct o)

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

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

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

get window #focusOnMap

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

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

set window [ #focusOnMap := 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 => Bool -> IO (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 ]

hideOnClose

No description available in the introspection data.

constructWindowHideOnClose :: IsWindow o => Bool -> IO (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

The :icon-name property 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 => Text -> IO (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

No description available in the introspection data.

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

isMaximized

No description available in the introspection data.

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

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

get window #isMaximized

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 => Bool -> IO (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

No description available in the introspection data.

constructWindowModal :: IsWindow o => Bool -> IO (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

No description available in the introspection data.

constructWindowResizable :: IsWindow o => Bool -> IO (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

The :startup-id is a write-only property for setting window's startup notification identifier. See windowSetStartupId for more details.

constructWindowStartupId :: IsWindow o => Text -> IO (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

No description available in the introspection data.

constructWindowTitle :: IsWindow o => Text -> IO (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 ]

transientFor

The transient parent of the window. See windowSetTransientFor for more details about transient windows.

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, IsWindow a) => a -> IO (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 ]

type

No description available in the introspection data.

constructWindowType :: IsWindow o => WindowType -> IO (GValueConstruct o)

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

getWindowType :: (MonadIO m, IsWindow o) => o -> m WindowType

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

get window #type

typeHint

No description available in the introspection data.

constructWindowTypeHint :: IsWindow o => SurfaceTypeHint -> IO (GValueConstruct o)

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

getWindowTypeHint :: (MonadIO m, IsWindow o) => o -> m SurfaceTypeHint

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

get window #typeHint

setWindowTypeHint :: (MonadIO m, IsWindow o) => o -> SurfaceTypeHint -> m ()

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

set window [ #typeHint := value ]

windowPosition

No description available in the introspection data.

constructWindowWindowPosition :: IsWindow o => WindowPosition -> IO (GValueConstruct o)

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

getWindowWindowPosition :: (MonadIO m, IsWindow o) => o -> m WindowPosition

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

get window #windowPosition

setWindowWindowPosition :: (MonadIO m, IsWindow o) => o -> WindowPosition -> m ()

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

set window [ #windowPosition := value ]

Signals

activateDefault

type C_WindowActivateDefaultCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type WindowActivateDefaultCallback = IO ()

The activateDefault signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the default widget of window.

afterWindowActivateDefault :: (IsWindow a, MonadIO m) => 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

genClosure_WindowActivateDefault :: MonadIO m => WindowActivateDefaultCallback -> m (GClosure C_WindowActivateDefaultCallback)

Wrap the callback into a GClosure.

mk_WindowActivateDefaultCallback :: C_WindowActivateDefaultCallback -> IO (FunPtr C_WindowActivateDefaultCallback)

Generate a function pointer callable from C code, from a C_WindowActivateDefaultCallback.

noWindowActivateDefaultCallback :: Maybe WindowActivateDefaultCallback

A convenience synonym for Nothing :: Maybe WindowActivateDefaultCallback.

onWindowActivateDefault :: (IsWindow a, MonadIO m) => 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

wrap_WindowActivateDefaultCallback :: WindowActivateDefaultCallback -> C_WindowActivateDefaultCallback

Wrap a WindowActivateDefaultCallback into a C_WindowActivateDefaultCallback.

activateFocus

type C_WindowActivateFocusCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type WindowActivateFocusCallback = IO ()

The activateFocus signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the currently focused widget of window.

afterWindowActivateFocus :: (IsWindow a, MonadIO m) => 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

genClosure_WindowActivateFocus :: MonadIO m => WindowActivateFocusCallback -> m (GClosure C_WindowActivateFocusCallback)

Wrap the callback into a GClosure.

mk_WindowActivateFocusCallback :: C_WindowActivateFocusCallback -> IO (FunPtr C_WindowActivateFocusCallback)

Generate a function pointer callable from C code, from a C_WindowActivateFocusCallback.

noWindowActivateFocusCallback :: Maybe WindowActivateFocusCallback

A convenience synonym for Nothing :: Maybe WindowActivateFocusCallback.

onWindowActivateFocus :: (IsWindow a, MonadIO m) => 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

wrap_WindowActivateFocusCallback :: WindowActivateFocusCallback -> C_WindowActivateFocusCallback

Wrap a WindowActivateFocusCallback into a C_WindowActivateFocusCallback.

closeRequest

type C_WindowCloseRequestCallback = Ptr () -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type WindowCloseRequestCallback

Arguments

 = IO Bool

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

The closeRequest signal is emitted when the user clicks on the close button of the window.

afterWindowCloseRequest :: (IsWindow a, MonadIO m) => 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

genClosure_WindowCloseRequest :: MonadIO m => WindowCloseRequestCallback -> m (GClosure C_WindowCloseRequestCallback)

Wrap the callback into a GClosure.

mk_WindowCloseRequestCallback :: C_WindowCloseRequestCallback -> IO (FunPtr C_WindowCloseRequestCallback)

Generate a function pointer callable from C code, from a C_WindowCloseRequestCallback.

noWindowCloseRequestCallback :: Maybe WindowCloseRequestCallback

A convenience synonym for Nothing :: Maybe WindowCloseRequestCallback.

onWindowCloseRequest :: (IsWindow a, MonadIO m) => 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

wrap_WindowCloseRequestCallback :: WindowCloseRequestCallback -> C_WindowCloseRequestCallback

Wrap a WindowCloseRequestCallback into a C_WindowCloseRequestCallback.

enableDebugging

type C_WindowEnableDebuggingCallback = Ptr () -> CInt -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type WindowEnableDebuggingCallback

Arguments

 = Bool

toggle: toggle the debugger

-> IO Bool

Returns: True if the key binding was handled

The enableDebugging signal is a [keybinding signal][GtkBindingSignal] which gets 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.

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

afterWindowEnableDebugging :: (IsWindow a, MonadIO m) => 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

genClosure_WindowEnableDebugging :: MonadIO m => WindowEnableDebuggingCallback -> m (GClosure C_WindowEnableDebuggingCallback)

Wrap the callback into a GClosure.

mk_WindowEnableDebuggingCallback :: C_WindowEnableDebuggingCallback -> IO (FunPtr C_WindowEnableDebuggingCallback)

Generate a function pointer callable from C code, from a C_WindowEnableDebuggingCallback.

noWindowEnableDebuggingCallback :: Maybe WindowEnableDebuggingCallback

A convenience synonym for Nothing :: Maybe WindowEnableDebuggingCallback.

onWindowEnableDebugging :: (IsWindow a, MonadIO m) => 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

wrap_WindowEnableDebuggingCallback :: WindowEnableDebuggingCallback -> C_WindowEnableDebuggingCallback

Wrap a WindowEnableDebuggingCallback into a C_WindowEnableDebuggingCallback.

keysChanged

type C_WindowKeysChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type WindowKeysChangedCallback = IO ()

The keysChanged signal gets emitted when the set of accelerators or mnemonics that are associated with window changes.

afterWindowKeysChanged :: (IsWindow a, MonadIO m) => 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

genClosure_WindowKeysChanged :: MonadIO m => WindowKeysChangedCallback -> m (GClosure C_WindowKeysChangedCallback)

Wrap the callback into a GClosure.

mk_WindowKeysChangedCallback :: C_WindowKeysChangedCallback -> IO (FunPtr C_WindowKeysChangedCallback)

Generate a function pointer callable from C code, from a C_WindowKeysChangedCallback.

noWindowKeysChangedCallback :: Maybe WindowKeysChangedCallback

A convenience synonym for Nothing :: Maybe WindowKeysChangedCallback.

onWindowKeysChanged :: (IsWindow a, MonadIO m) => 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

wrap_WindowKeysChangedCallback :: WindowKeysChangedCallback -> C_WindowKeysChangedCallback

Wrap a WindowKeysChangedCallback into a C_WindowKeysChangedCallback.