gi-wnck-3.0.4: Wnck bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Wnck.Objects.ClassGroup

Contents

Description

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

Synopsis

Exported types

newtype ClassGroup Source #

Memory-managed wrapper type.

Constructors

ClassGroup (ManagedPtr ClassGroup) 
Instances
GObject ClassGroup Source # 
Instance details

Defined in GI.Wnck.Objects.ClassGroup

Methods

gobjectType :: IO GType

HasParentTypes ClassGroup Source # 
Instance details

Defined in GI.Wnck.Objects.ClassGroup

type ParentTypes ClassGroup Source # 
Instance details

Defined in GI.Wnck.Objects.ClassGroup

type ParentTypes ClassGroup = Object ': ([] :: [Type])

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

noClassGroup :: Maybe ClassGroup Source #

A convenience alias for Nothing :: Maybe ClassGroup.

Methods

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.

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

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.

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

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 C_ClassGroupIconChangedCallback = Ptr () -> Ptr () -> IO () Source #

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

type ClassGroupIconChangedCallback = IO () Source #

Emitted when the icon of classGroup changes.

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

Connect a signal handler for the “icon-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after classGroup #iconChanged callback

genClosure_ClassGroupIconChanged :: MonadIO m => ClassGroupIconChangedCallback -> m (GClosure C_ClassGroupIconChangedCallback) Source #

Wrap the callback into a GClosure.

mk_ClassGroupIconChangedCallback :: C_ClassGroupIconChangedCallback -> IO (FunPtr C_ClassGroupIconChangedCallback) Source #

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

noClassGroupIconChangedCallback :: Maybe ClassGroupIconChangedCallback Source #

A convenience synonym for Nothing :: Maybe ClassGroupIconChangedCallback.

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

Connect a signal handler for the “icon-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on classGroup #iconChanged callback

wrap_ClassGroupIconChangedCallback :: ClassGroupIconChangedCallback -> C_ClassGroupIconChangedCallback Source #

Wrap a ClassGroupIconChangedCallback into a C_ClassGroupIconChangedCallback.

nameChanged

type C_ClassGroupNameChangedCallback = Ptr () -> Ptr () -> IO () Source #

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

type ClassGroupNameChangedCallback = IO () Source #

Emitted when the name of classGroup changes.

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

Connect a signal handler for the “name-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after classGroup #nameChanged callback

genClosure_ClassGroupNameChanged :: MonadIO m => ClassGroupNameChangedCallback -> m (GClosure C_ClassGroupNameChangedCallback) Source #

Wrap the callback into a GClosure.

mk_ClassGroupNameChangedCallback :: C_ClassGroupNameChangedCallback -> IO (FunPtr C_ClassGroupNameChangedCallback) Source #

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

noClassGroupNameChangedCallback :: Maybe ClassGroupNameChangedCallback Source #

A convenience synonym for Nothing :: Maybe ClassGroupNameChangedCallback.

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

Connect a signal handler for the “name-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on classGroup #nameChanged callback

wrap_ClassGroupNameChangedCallback :: ClassGroupNameChangedCallback -> C_ClassGroupNameChangedCallback Source #

Wrap a ClassGroupNameChangedCallback into a C_ClassGroupNameChangedCallback.