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

Memory-managed wrapper type.

Constructors

WindowGroup (ManagedPtr WindowGroup)

Instances

Eq WindowGroup

Defined in GI.Gtk.Objects.WindowGroup

Methods

(==) :: WindowGroup -> WindowGroup -> Bool

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

GObject WindowGroup

Defined in GI.Gtk.Objects.WindowGroup

ManagedPtrNewtype WindowGroup

Defined in GI.Gtk.Objects.WindowGroup

Methods

toManagedPtr :: WindowGroup -> ManagedPtr WindowGroup

TypedObject WindowGroup

Defined in GI.Gtk.Objects.WindowGroup

Methods

glibType :: IO GType

HasParentTypes WindowGroup

Defined in GI.Gtk.Objects.WindowGroup

IsGValue (Maybe WindowGroup)

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

Defined in GI.Gtk.Objects.WindowGroup

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes WindowGroup

Defined in GI.Gtk.Objects.WindowGroup

type ParentTypes WindowGroup = '[Object]

class (GObject o, IsDescendantOf WindowGroup o) => IsWindowGroup o

Type class for types which can be safely cast to WindowGroup, for instance with toWindowGroup.

Instances

(GObject o, IsDescendantOf WindowGroup o) => IsWindowGroup o

Defined in GI.Gtk.Objects.WindowGroup

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

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

addWindow, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, listWindows, notify, notifyByPspec, ref, refSink, removeWindow, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getCurrentDeviceGrab, getCurrentGrab, getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

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.