GI.Gtk.Objects.WindowGroup

A WindowGroup restricts the effect of grabs to windows in the same group, thereby making window groups almost behave like separate applications.

A window can be a member in at most one window group at a time. Windows that have not been explicitly assigned to a group are implicitly treated like windows of the default window group.

GtkWindowGroup objects are referenced by each window in the group, so once you have added all windows to a GtkWindowGroup, you can drop the initial reference to the window group with objectUnref. If the windows in the window group are subsequently destroyed, then they will be removed from the window group and drop their references on the window group; when all window have been removed, the window group will be freed.

Exported types

newtype WindowGroup

Constructors

WindowGroup (ManagedPtr WindowGroup)

Instances

GObject WindowGroup

Methods

gobjectType :: WindowGroup -> IO GType

IsObject WindowGroup

IsWindowGroup WindowGroup

class GObject o => IsWindowGroup o

Instances

(GObject a, UnknownAncestorError Constraint WindowGroup a) => IsWindowGroup a

IsWindowGroup WindowGroup

toWindowGroup :: (MonadIO m, IsWindowGroup o) => o -> m WindowGroup

noWindowGroup :: Maybe WindowGroup

Methods

addWindow

windowGroupAddWindow

Arguments

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

=> a

windowGroup: a WindowGroup

-> b

window: the Window to add

-> m ()

Adds a window to a WindowGroup.

getCurrentDeviceGrab

windowGroupGetCurrentDeviceGrab

Arguments

:: (HasCallStack, MonadIO m, IsWindowGroup a, IsDevice b)

=> a

windowGroup: a WindowGroup

-> b

device: a Device

-> m (Maybe Widget)

Returns: The grab widget, or Nothing

Returns the current grab widget for device, or Nothing if none.

Since: 3.0

getCurrentGrab

windowGroupGetCurrentGrab

Arguments

:: (HasCallStack, MonadIO m, IsWindowGroup a)

=> a

windowGroup: a WindowGroup

-> m Widget

Returns: the current grab widget of the group

Gets the current grab widget of the given group, see widgetGrabAdd.

Since: 2.22

listWindows

windowGroupListWindows

Arguments

:: (HasCallStack, MonadIO m, IsWindowGroup a)

=> a

windowGroup: a WindowGroup

-> m [Window]

Returns: A newly-allocated list of windows inside the group.

Returns a list of the GtkWindows that belong to windowGroup.

Since: 2.14

new

windowGroupNew

Arguments

:: (HasCallStack, MonadIO m)

=> m WindowGroup

Returns: a new WindowGroup.

Creates a new WindowGroup object. Grabs added with widgetGrabAdd only affect windows within the same WindowGroup.

removeWindow

windowGroupRemoveWindow

Arguments

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

=> a

windowGroup: a WindowGroup

-> b

window: the Window to remove

-> m ()

Removes a window from a WindowGroup.