Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Wnck.Objects.Tasklist

Contents

Exported types
Methods
Signals
- taskEnterNotify
- taskLeaveNotify

Description

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

Synopsis

newtype Tasklist = Tasklist (ManagedPtr Tasklist)
class (GObject o, IsDescendantOf Tasklist o) => IsTasklist o
toTasklist :: (MonadIO m, IsTasklist o) => o -> m Tasklist
noTasklist :: Maybe Tasklist
tasklistGetScrollEnabled :: (HasCallStack, MonadIO m, IsTasklist a) => a -> m Bool
tasklistGetSizeHintList :: (HasCallStack, MonadIO m, IsTasklist a) => a -> Int32 -> m Int32
tasklistNew :: (HasCallStack, MonadIO m) => m Tasklist
tasklistSetButtonRelief :: (HasCallStack, MonadIO m, IsTasklist a) => a -> ReliefStyle -> m ()
tasklistSetGrouping :: (HasCallStack, MonadIO m, IsTasklist a) => a -> TasklistGroupingType -> m ()
tasklistSetGroupingLimit :: (HasCallStack, MonadIO m, IsTasklist a) => a -> Int32 -> m ()
tasklistSetIncludeAllWorkspaces :: (HasCallStack, MonadIO m, IsTasklist a) => a -> Bool -> m ()
tasklistSetMiddleClickClose :: (HasCallStack, MonadIO m, IsTasklist a) => a -> Bool -> m ()
tasklistSetOrientation :: (HasCallStack, MonadIO m, IsTasklist a) => a -> Orientation -> m ()
tasklistSetScrollEnabled :: (HasCallStack, MonadIO m, IsTasklist a) => a -> Bool -> m ()
tasklistSetSwitchWorkspaceOnUnminimize :: (HasCallStack, MonadIO m, IsTasklist a) => a -> Bool -> m ()
type C_TasklistTaskEnterNotifyCallback = Ptr () -> Ptr () -> Ptr () -> IO ()
type TasklistTaskEnterNotifyCallback = Ptr () -> IO ()
afterTasklistTaskEnterNotify :: (IsTasklist a, MonadIO m) => a -> TasklistTaskEnterNotifyCallback -> m SignalHandlerId
genClosure_TasklistTaskEnterNotify :: MonadIO m => TasklistTaskEnterNotifyCallback -> m (GClosure C_TasklistTaskEnterNotifyCallback)
mk_TasklistTaskEnterNotifyCallback :: C_TasklistTaskEnterNotifyCallback -> IO (FunPtr C_TasklistTaskEnterNotifyCallback)
noTasklistTaskEnterNotifyCallback :: Maybe TasklistTaskEnterNotifyCallback
onTasklistTaskEnterNotify :: (IsTasklist a, MonadIO m) => a -> TasklistTaskEnterNotifyCallback -> m SignalHandlerId
wrap_TasklistTaskEnterNotifyCallback :: TasklistTaskEnterNotifyCallback -> C_TasklistTaskEnterNotifyCallback
type C_TasklistTaskLeaveNotifyCallback = Ptr () -> Ptr () -> Ptr () -> IO ()
type TasklistTaskLeaveNotifyCallback = Ptr () -> IO ()
afterTasklistTaskLeaveNotify :: (IsTasklist a, MonadIO m) => a -> TasklistTaskLeaveNotifyCallback -> m SignalHandlerId
genClosure_TasklistTaskLeaveNotify :: MonadIO m => TasklistTaskLeaveNotifyCallback -> m (GClosure C_TasklistTaskLeaveNotifyCallback)
mk_TasklistTaskLeaveNotifyCallback :: C_TasklistTaskLeaveNotifyCallback -> IO (FunPtr C_TasklistTaskLeaveNotifyCallback)
noTasklistTaskLeaveNotifyCallback :: Maybe TasklistTaskLeaveNotifyCallback
onTasklistTaskLeaveNotify :: (IsTasklist a, MonadIO m) => a -> TasklistTaskLeaveNotifyCallback -> m SignalHandlerId
wrap_TasklistTaskLeaveNotifyCallback :: TasklistTaskLeaveNotifyCallback -> C_TasklistTaskLeaveNotifyCallback

Exported types

newtype Tasklist Source #

Memory-managed wrapper type.

Constructors

Tasklist (ManagedPtr Tasklist)

Instances

GObject Tasklist Source #
Instance details Defined in GI.Wnck.Objects.Tasklist Methods gobjectType :: IO GType
HasParentTypes Tasklist Source #
Instance details Defined in GI.Wnck.Objects.Tasklist
type ParentTypes Tasklist Source #
Instance details Defined in GI.Wnck.Objects.Tasklist type ParentTypes Tasklist = Container ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': ([] :: [Type])))))

class (GObject o, IsDescendantOf Tasklist o) => IsTasklist o Source #

Type class for types which can be safely cast to Tasklist, for instance with toTasklist.

Instances

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

toTasklist :: (MonadIO m, IsTasklist o) => o -> m Tasklist Source #

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

noTasklist :: Maybe Tasklist Source #

A convenience alias for Nothing :: Maybe Tasklist.

Methods

getScrollEnabled

tasklistGetScrollEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> m Bool

Gets the scroll behavior of the tasklist.

Since: 3.24.0

getSizeHintList

tasklistGetSizeHintList Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> Int32	`nElements`: return location for the number of elements in the array returned by this function. This number should always be pair.
-> m Int32	Returns: a list of size hints that can be used to allocate an appropriate size for `tasklist`.

Since a Tasklist does not have a fixed size (Window can be grouped when needed, for example), the standard size request mechanism in GTK+ is not enough to announce what sizes can be used by tasklist. The size hints mechanism is a solution for this. See panel_applet_set_size_hints() for more information.

new

tasklistNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m Tasklist	Returns: a newly created `Tasklist`.

Creates a new Tasklist. The Tasklist will list Window of the Screen it is on.

setButtonRelief

tasklistSetButtonRelief Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> ReliefStyle	`relief`: a relief type.
-> m ()

Sets the relief type of the buttons in tasklist to relief. The main use of this function is proper integration of Tasklist in panels with non-system backgrounds.

Since: 2.12

setGrouping

tasklistSetGrouping Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> TasklistGroupingType	`grouping`: a grouping policy.
-> m ()

Sets the grouping policy for tasklist to grouping.

setGroupingLimit

tasklistSetGroupingLimit Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> Int32	`limit`: a size in pixels.
-> m ()

Sets the maximum size of buttons in tasklist before tasklist tries to group Window in the same Application in only one button. This limit is valid only when the grouping policy of tasklist is TasklistGroupingTypeAutoGroup.

setIncludeAllWorkspaces

tasklistSetIncludeAllWorkspaces Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> Bool	`includeAllWorkspaces`: whether to display `Window` from all `Workspace` in `tasklist`.
-> m ()

Sets tasklist to display Window from all Workspace or not, according to includeAllWorkspaces.

Note that if the active Workspace has a viewport and if includeAllWorkspaces is False, then only the Window visible in the viewport are displayed in tasklist. The rationale for this is that the viewport is generally used to implement workspace-like behavior. A side-effect of this is that, when using multiple Workspace with viewport, it is not possible to show all Window from a Workspace (even those that are not visible in the viewport) in tasklist without showing all Window from all Workspace.

setMiddleClickClose

tasklistSetMiddleClickClose Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> Bool	`middleClickClose`: whether to close windows with middle click on button.
-> m ()

Sets tasklist to close windows with mouse middle click on button, according to middleClickClose.

Since: 3.4.6

setOrientation

tasklistSetOrientation Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> Orientation	`orient`: a GtkOrientation.
-> m ()

Set the orientation of the tasklist to match orient. This function can be used to integrate a Tasklist in vertical panels.

Since: 3.4.6

setScrollEnabled

tasklistSetScrollEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> Bool	`scrollEnabled`: a boolean.
-> m ()

Sets the scroll behavior of the tasklist. When set to True, a scroll event over the tasklist will change the current window accordingly.

Since: 3.24.0

setSwitchWorkspaceOnUnminimize

tasklistSetSwitchWorkspaceOnUnminimize Source #

Arguments

:: (HasCallStack, MonadIO m, IsTasklist a)
=> a	`tasklist`: a `Tasklist`.
-> Bool	`switchWorkspaceOnUnminimize`: whether to activate the `Workspace` a `Window` is on when unminimizing it.
-> m ()

Sets tasklist to activate or not the Workspace a Window is on when unminimizing it, according to switchWorkspaceOnUnminimize.

FIXME: does it still work?

Signals

taskEnterNotify

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

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

type TasklistTaskEnterNotifyCallback Source #

Arguments

= Ptr ()	`windows`: the `List` with all the `Window` belonging to the task.
-> IO ()

Emitted when the task is entered.

afterTasklistTaskEnterNotify :: (IsTasklist a, MonadIO m) => a -> TasklistTaskEnterNotifyCallback -> m SignalHandlerId Source #

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

after tasklist #taskEnterNotify callback

genClosure_TasklistTaskEnterNotify :: MonadIO m => TasklistTaskEnterNotifyCallback -> m (GClosure C_TasklistTaskEnterNotifyCallback) Source #

Wrap the callback into a GClosure.

mk_TasklistTaskEnterNotifyCallback :: C_TasklistTaskEnterNotifyCallback -> IO (FunPtr C_TasklistTaskEnterNotifyCallback) Source #

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

noTasklistTaskEnterNotifyCallback :: Maybe TasklistTaskEnterNotifyCallback Source #

A convenience synonym for Nothing :: Maybe TasklistTaskEnterNotifyCallback.

onTasklistTaskEnterNotify :: (IsTasklist a, MonadIO m) => a -> TasklistTaskEnterNotifyCallback -> m SignalHandlerId Source #

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

on tasklist #taskEnterNotify callback

wrap_TasklistTaskEnterNotifyCallback :: TasklistTaskEnterNotifyCallback -> C_TasklistTaskEnterNotifyCallback Source #

Wrap a TasklistTaskEnterNotifyCallback into a C_TasklistTaskEnterNotifyCallback.

taskLeaveNotify

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

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

type TasklistTaskLeaveNotifyCallback Source #

Arguments

= Ptr ()	`windows`: the `List` with all the `Window` belonging to the task.
-> IO ()

Emitted when the task is entered.

afterTasklistTaskLeaveNotify :: (IsTasklist a, MonadIO m) => a -> TasklistTaskLeaveNotifyCallback -> m SignalHandlerId Source #

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

after tasklist #taskLeaveNotify callback

genClosure_TasklistTaskLeaveNotify :: MonadIO m => TasklistTaskLeaveNotifyCallback -> m (GClosure C_TasklistTaskLeaveNotifyCallback) Source #

Wrap the callback into a GClosure.

mk_TasklistTaskLeaveNotifyCallback :: C_TasklistTaskLeaveNotifyCallback -> IO (FunPtr C_TasklistTaskLeaveNotifyCallback) Source #

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

noTasklistTaskLeaveNotifyCallback :: Maybe TasklistTaskLeaveNotifyCallback Source #

A convenience synonym for Nothing :: Maybe TasklistTaskLeaveNotifyCallback.

onTasklistTaskLeaveNotify :: (IsTasklist a, MonadIO m) => a -> TasklistTaskLeaveNotifyCallback -> m SignalHandlerId Source #

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

on tasklist #taskLeaveNotify callback

wrap_TasklistTaskLeaveNotifyCallback :: TasklistTaskLeaveNotifyCallback -> C_TasklistTaskLeaveNotifyCallback Source #

Wrap a TasklistTaskLeaveNotifyCallback into a C_TasklistTaskLeaveNotifyCallback.