Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Wnck.Objects.ClassGroup

Contents

Exported types
Methods
Signals
- iconChanged
- nameChanged

Description

The ClassGroup struct contains only private fields and should not be directly accessed.

Synopsis

newtype ClassGroup = ClassGroup (ManagedPtr ClassGroup)
class (GObject o, IsDescendantOf ClassGroup o) => IsClassGroup o
toClassGroup :: (MonadIO m, IsClassGroup o) => o -> m ClassGroup
classGroupGet :: (HasCallStack, MonadIO m) => Text -> m ClassGroup
classGroupGetIcon :: (HasCallStack, MonadIO m, IsClassGroup a) => a -> m Pixbuf
classGroupGetIconSurface :: (HasCallStack, MonadIO m, IsClassGroup a) => a -> m Surface
classGroupGetId :: (HasCallStack, MonadIO m, IsClassGroup a) => a -> m Text
classGroupGetMiniIcon :: (HasCallStack, MonadIO m, IsClassGroup a) => a -> m Pixbuf
classGroupGetMiniIconSurface :: (HasCallStack, MonadIO m, IsClassGroup a) => a -> m Surface
classGroupGetName :: (HasCallStack, MonadIO m, IsClassGroup a) => a -> m Text
classGroupGetResClass :: (HasCallStack, MonadIO m, IsClassGroup a) => a -> m Text
classGroupGetWindows :: (HasCallStack, MonadIO m, IsClassGroup a) => a -> m [Window]
type ClassGroupIconChangedCallback = IO ()
afterClassGroupIconChanged :: (IsClassGroup a, MonadIO m) => a -> ((?self :: a) => ClassGroupIconChangedCallback) -> m SignalHandlerId
onClassGroupIconChanged :: (IsClassGroup a, MonadIO m) => a -> ((?self :: a) => ClassGroupIconChangedCallback) -> m SignalHandlerId
type ClassGroupNameChangedCallback = IO ()
afterClassGroupNameChanged :: (IsClassGroup a, MonadIO m) => a -> ((?self :: a) => ClassGroupNameChangedCallback) -> m SignalHandlerId
onClassGroupNameChanged :: (IsClassGroup a, MonadIO m) => a -> ((?self :: a) => ClassGroupNameChangedCallback) -> m SignalHandlerId

Exported types

newtype ClassGroup Source #

Memory-managed wrapper type.

Constructors

ClassGroup (ManagedPtr ClassGroup)

Instances

Instances details

Eq ClassGroup Source #
Instance details Defined in GI.Wnck.Objects.ClassGroup Methods (==) :: ClassGroup -> ClassGroup -> Bool # (/=) :: ClassGroup -> ClassGroup -> Bool #
GObject ClassGroup Source #
Instance details Defined in GI.Wnck.Objects.ClassGroup
ManagedPtrNewtype ClassGroup Source #
Instance details Defined in GI.Wnck.Objects.ClassGroup Methods toManagedPtr :: ClassGroup -> ManagedPtr ClassGroup
TypedObject ClassGroup Source #
Instance details Defined in GI.Wnck.Objects.ClassGroup Methods glibType :: IO GType
HasParentTypes ClassGroup Source #
Instance details Defined in GI.Wnck.Objects.ClassGroup
IsGValue (Maybe ClassGroup) Source #	Convert `ClassGroup` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Wnck.Objects.ClassGroup Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe ClassGroup -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe ClassGroup)
type ParentTypes ClassGroup Source #
Instance details Defined in GI.Wnck.Objects.ClassGroup type ParentTypes ClassGroup = '[Object]

class (GObject o, IsDescendantOf ClassGroup o) => IsClassGroup o Source #

Type class for types which can be safely cast to ClassGroup, for instance with toClassGroup.

Instances

Instances details

(GObject o, IsDescendantOf ClassGroup o) => IsClassGroup o Source #
Instance details Defined in GI.Wnck.Objects.ClassGroup

toClassGroup :: (MonadIO m, IsClassGroup o) => o -> m ClassGroup Source #

Cast to ClassGroup, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

get

classGroupGet Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`id`: identifier name of the sought resource class.
-> m ClassGroup	Returns: the `ClassGroup` corresponding to `id`, or `Nothing` if there is no `ClassGroup` with the specified `id`. The returned `ClassGroup` is owned by libwnck and must not be referenced or unreferenced.

Gets the ClassGroup corresponding to id.

Since: 2.2

getIcon

classGroupGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsClassGroup a)
=> a	`classGroup`: a `ClassGroup`.
-> m Pixbuf	Returns: the icon for `classGroup`. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the icon around.

Deprecated: (Since version 41.0)Use classGroupGetIconSurface instead.

Gets the icon to be used for classGroup. Since there is no way to properly find the icon, a suboptimal heuristic is used to find it. The icon is the first icon found by looking at all the Application for each Window in classGroup, then at all the Window in classGroup. If no icon was found, a fallback icon is used.

Since: 2.2

getIconSurface

classGroupGetIconSurface Source #

Arguments

:: (HasCallStack, MonadIO m, IsClassGroup a)
=> a	`classGroup`: a `ClassGroup`.
-> m Surface	Returns: the icon-surface for `classGroup`. The caller should unreference the returned <classname>cairo_surface_t</classname> once done with it.

Gets the icon-surface to be used for classGroup. Since there is no way to properly find the icon-surface, the same suboptimal heuristic as the one for classGroupGetIcon is used to find it.

getId

classGroupGetId Source #

Arguments

:: (HasCallStack, MonadIO m, IsClassGroup a)
=> a	`classGroup`: a `ClassGroup`.
-> m Text	Returns: the identifier name of `classGroup`, or an empty string if the group has no identifier name.

Gets the identifier name for classGroup. This is the resource class for classGroup.

Since: 3.2

getMiniIcon

classGroupGetMiniIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsClassGroup a)
=> a	`classGroup`: a `ClassGroup`.
-> m Pixbuf	Returns: the mini-icon for `classGroup`. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the mini-icon around.

Deprecated: (Since version 41.0)Use classGroupGetMiniIconSurface instead.

Gets the mini-icon to be used for classGroup. Since there is no way to properly find the mini-icon, the same suboptimal heuristic as the one for classGroupGetIcon is used to find it.

Since: 2.2

getMiniIconSurface

classGroupGetMiniIconSurface Source #

Arguments

:: (HasCallStack, MonadIO m, IsClassGroup a)
=> a	`classGroup`: a `ClassGroup`.
-> m Surface	Returns: the mini-icon-surface for `classGroup`. The caller should unreference the returned <classname>cairo_surface_t</classname> once done with it.

Gets the mini-icon-surface to be used for classGroup. Since there is no way to properly find the mini-icon-surface, the same suboptimal heuristic as the one for classGroupGetIcon is used to find it.

getName

classGroupGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsClassGroup a)
=> a	`classGroup`: a `ClassGroup`.
-> m Text	Returns: an human-readable name for `classGroup`.

Gets an human-readable name for classGroup. Since there is no way to properly find this name, a suboptimal heuristic is used to find it. The name is the name of all Application for each Window in classGroup if they all have the same name. If all Application don't have the same name, the name is the name of all Window in classGroup if they all have the same name. If all Window don't have the same name, the resource class name is used.

Since: 2.2

getResClass

classGroupGetResClass Source #

Arguments

:: (HasCallStack, MonadIO m, IsClassGroup a)
=> a	`classGroup`: a `ClassGroup`.
-> m Text	Returns: the resource class name of `classGroup`, or an empty string if the group has no resource class name.

Deprecated: (Since version 3.2)Use classGroupGetId instead.

Gets the resource class name for classGroup.

Since: 2.2

getWindows

classGroupGetWindows Source #

Arguments

:: (HasCallStack, MonadIO m, IsClassGroup a)
=> a	`classGroup`: a `ClassGroup`.
-> m [Window]	Returns: the list of `Window` grouped in `classGroup`, or `Nothing` if the group contains no window. The list should not be modified nor freed, as it is owned by `classGroup`.

Gets the list of Window that are grouped in classGroup.

Since: 2.2

Signals

iconChanged

type ClassGroupIconChangedCallback = IO () Source #

Emitted when the icon of classGroup changes.

afterClassGroupIconChanged :: (IsClassGroup a, MonadIO m) => a -> ((?self :: a) => ClassGroupIconChangedCallback) -> m SignalHandlerId Source #

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

after classGroup #iconChanged 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.

onClassGroupIconChanged :: (IsClassGroup a, MonadIO m) => a -> ((?self :: a) => ClassGroupIconChangedCallback) -> m SignalHandlerId Source #

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

on classGroup #iconChanged callback

nameChanged

type ClassGroupNameChangedCallback = IO () Source #

Emitted when the name of classGroup changes.

afterClassGroupNameChanged :: (IsClassGroup a, MonadIO m) => a -> ((?self :: a) => ClassGroupNameChangedCallback) -> m SignalHandlerId Source #

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

after classGroup #nameChanged 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.

onClassGroupNameChanged :: (IsClassGroup a, MonadIO m) => a -> ((?self :: a) => ClassGroupNameChangedCallback) -> m SignalHandlerId Source #

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

on classGroup #nameChanged callback

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

get

getIcon

getIconSurface

getId

getMiniIcon

getMiniIconSurface

getName

getResClass

getWindows

Signals

iconChanged

nameChanged