GI.Wnck.Objects.Workspace

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

Exported types

newtype Workspace

Memory-managed wrapper type.

Constructors

Workspace (ManagedPtr Workspace)

Instances

Eq Workspace

Defined in GI.Wnck.Objects.Workspace

Methods

(==) :: Workspace -> Workspace -> Bool

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

IsGValue Workspace

Convert Workspace to and from GValue with toGValue and fromGValue.

Defined in GI.Wnck.Objects.Workspace

Methods

toGValue :: Workspace -> IO GValue

fromGValue :: GValue -> IO Workspace

ManagedPtrNewtype Workspace

Defined in GI.Wnck.Objects.Workspace

Methods

toManagedPtr :: Workspace -> ManagedPtr Workspace

TypedObject Workspace

Defined in GI.Wnck.Objects.Workspace

Methods

glibType :: IO GType

GObject Workspace

Defined in GI.Wnck.Objects.Workspace

HasParentTypes Workspace

Defined in GI.Wnck.Objects.Workspace

type ParentTypes Workspace

Defined in GI.Wnck.Objects.Workspace

type ParentTypes Workspace = '[Object]

class (GObject o, IsDescendantOf Workspace o) => IsWorkspace o

Type class for types which can be safely cast to Workspace, for instance with toWorkspace.

Instances

(GObject o, IsDescendantOf Workspace o) => IsWorkspace o

Defined in GI.Wnck.Objects.Workspace

toWorkspace :: (MonadIO m, IsWorkspace o) => o -> m Workspace

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

Methods

Overloaded methods

activate

workspaceActivate

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> Word32

timestamp: the X server timestamp of the user interaction event that caused this call to occur.

-> m ()

Asks the window manager to make space the active workspace. The window manager may decide to refuse the request (to not steal the focus if there is a more recent user activity, for example).

This function existed before 2.10, but the timestamp argument was missing in earlier versions.

Since: 2.10

changeName

workspaceChangeName

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> Text

name: new name for space.

-> m ()

Changes the name of space.

Since: 2.2

getHeight

workspaceGetHeight

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Int32

Returns: the height of space.

Gets the height of space.

Since: 2.4

getLayoutColumn

workspaceGetLayoutColumn

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Int32

Returns: the column of space in the Workspace layout, or -1 on errors.

Gets the column of space in the Workspace layout. The first column has an index of 0 and is always the left column, regardless of the starting corner set for the layout and regardless of the default direction of the environment (i.e., in both Left-To-Right and Right-To-Left environments).

Since: 2.20

getLayoutRow

workspaceGetLayoutRow

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Int32

Returns: the row of space in the Workspace layout, or -1 on errors.

Gets the row of space in the Workspace layout. The first row has an index of 0 and is always the top row, regardless of the starting corner set for the layout.

Since: 2.20

getName

workspaceGetName

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Text

Returns: the name of space.

Gets the human-readable name that should be used to refer to space. If the user has not set a special name, a fallback like "Workspace 3" will be used.

getNeighbor

workspaceGetNeighbor

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> MotionDirection

direction: direction in which to search the neighbor.

-> m Workspace

Returns: the neighbor Workspace of space in the direction direction, or Nothing if no such neighbor Workspace exists. The returned Workspace is owned by libwnck and must not be referenced or unreferenced.

Gets the neighbor Workspace of space in the direction direction.

Since: 2.20

getNumber

workspaceGetNumber

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Int32

Returns: the index of space on its Screen, or -1 on errors.

Gets the index of space on the Screen to which it belongs. The first workspace has an index of 0.

getScreen

workspaceGetScreen

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Screen

Returns: the Screen space is on. The returned Screen is owned by libwnck and must not be referenced or unreferenced.

Gets the Screen space is on.

getViewportX

workspaceGetViewportX

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Int32

Returns: the X coordinate of the viewport in space, or 0 if space does not contain a viewport.

Gets the X coordinate of the viewport in space.

Since: 2.4

getViewportY

workspaceGetViewportY

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Int32

Returns: the Y coordinate of the viewport in space, or 0 if space does not contain a viewport.

Gets the Y coordinate of the viewport in space.

Since: 2.4

getWidth

workspaceGetWidth

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Int32

Returns: the width of space.

Gets the width of space.

Since: 2.4

isVirtual

workspaceIsVirtual

Arguments

:: (HasCallStack, MonadIO m, IsWorkspace a)

=> a

space: a Workspace.

-> m Bool

Returns: True if space contains a viewport, False otherwise.

Gets whether space contains a viewport.

Since: 2.4

Signals

nameChanged

type C_WorkspaceNameChangedCallback = Ptr () -> Ptr () -> IO ()

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

type WorkspaceNameChangedCallback = IO ()

Emitted when the name of space changes.

afterWorkspaceNameChanged :: (IsWorkspace a, MonadIO m) => a -> WorkspaceNameChangedCallback -> m SignalHandlerId

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

after workspace #nameChanged callback

genClosure_WorkspaceNameChanged :: MonadIO m => WorkspaceNameChangedCallback -> m (GClosure C_WorkspaceNameChangedCallback)

Wrap the callback into a GClosure.

mk_WorkspaceNameChangedCallback :: C_WorkspaceNameChangedCallback -> IO (FunPtr C_WorkspaceNameChangedCallback)

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

noWorkspaceNameChangedCallback :: Maybe WorkspaceNameChangedCallback

A convenience synonym for Nothing :: Maybe WorkspaceNameChangedCallback.

onWorkspaceNameChanged :: (IsWorkspace a, MonadIO m) => a -> WorkspaceNameChangedCallback -> m SignalHandlerId

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

on workspace #nameChanged callback

wrap_WorkspaceNameChangedCallback :: WorkspaceNameChangedCallback -> C_WorkspaceNameChangedCallback

Wrap a WorkspaceNameChangedCallback into a C_WorkspaceNameChangedCallback.