Libxfce4windowing.WorkspaceGroup¶

Implementations:: None

Methods¶

	`create_workspace` (name)
	`get_active_workspace` ()
	`get_capabilities` ()
	`get_monitors` ()
	`get_workspace_count` ()
	`get_workspace_manager` ()
	`list_workspaces` ()
	`move_viewport` (x, y)
	`set_layout` (rows, columns)

Virtual Methods¶

None

Properties¶

Name	Type	Flags	Short Description
`active-workspace`	`Libxfce4windowing.Workspace`	r	active-workspace
`monitors`	`int`	r	monitors
`screen`	`Libxfce4windowing.Screen`	r/w/co	screen
`workspace-manager`	`Libxfce4windowing.WorkspaceManager`	r/w/co	workspace-manager
`workspaces`	`int`	r	workspaces

Signals¶

Name	Short Description
`active-workspace-changed`	Emitted when the active workspace of group changes.
`capabilities-changed`	Emitted when capabilities have changed on group.
`monitor-added`	Emitted when group is added to a new monitor.
`monitor-removed`	Emitted when group is removed from a monitor.
`monitors-changed`	Emitted when group moves to a new set of monitors.
`viewports-changed`	Emitted when group's viewport coordinates have changed.
`workspace-added`	Emitted when workspace joins group.
`workspace-removed`	Emitted when workspace leaves group.

Fields¶

None

Class Details¶

class Libxfce4windowing.WorkspaceGroup¶

Bases:: GObject.GInterface
Structure:: Libxfce4windowing.WorkspaceGroupIface

create_workspace(name)¶

Parameters:: name (str) – a name for the new workspace.
Raises:: GLib.Error
Returns:: True if workspace creation succeeded, False otherwise. If False, and error is non-None, an error will be returned that must be freed using GLib.Error.free().
Return type:: bool

Attempts to create a new workspace on self. Typically, the new workspace will be appended to the existing list of workspaces.

On failure, error (if provided) will be set to a description of the error that occurred.

get_active_workspace()¶

Returns:: an Libxfce4windowing.Workspace, or None if there is no active workspace.
Return type:: Libxfce4windowing.Workspace or None

Gets the active workspace on self, if there is one.

get_capabilities()¶

Returns:: an Libxfce4windowing.WorkspaceGroupCapabilities bitfield.
Return type:: Libxfce4windowing.WorkspaceGroupCapabilities

Returns a bitfield describing operations allowed on this self.

get_monitors()¶

Returns:: A list of Libxfce4windowing.Monitor, or None if self is not displayed on any monitors. The list and its contents are owned by self.
Return type:: [Libxfce4windowing.Monitor] or None

Lists the physical monitors that this workspace group displays on.

get_workspace_count()¶

Returns:: an unsigned integer describing the number of workspaces.
Return type:: int

Fetches the number of workspaces in self.

get_workspace_manager()¶

Returns:: a Libxfce4windowing.WorkspaceManager, owned by self.
Return type:: object

Fetches the Libxfce4windowing.WorkspaceManager instance that owns self.

list_workspaces()¶

Returns:: the list of Libxfce4windowing.Workspace in self, or None if there are no workspaces. The list and its contents are owned by self.
Return type:: [Libxfce4windowing.Workspace] or None

Lists the workspaces in self.

move_viewport(x, y)¶

Parameters:

x (int) – a coordinate in the horizontal direction.
y (int) – a coordinate in the vertical direction.

Raises:

GLib.Error

Returns:

True if moving the workspace group succeeded, False otherwise. If False, and error is non-None, an error will be returned that must be freed using GLib.Error.free().

Return type:

bool

Moves the workspace group to a new location, and possibly a new monitor.

On failure, error (if provided) will be set to a description of the error that occurred.

set_layout(rows, columns)¶

Parameters:

rows (int) – the new numbers of rows.
columns (int) – the new number of columns.

Raises:

GLib.Error

Returns:

True if changing the layout of self succeede, False otherwise. If False, and error is non-None, an error will be returned that must be freed using GLib.Error.free().

Return type:

bool

Sets the layout of self to rows by columns.

Note that this will not change the number of workspaces if the new layout implies a larger number of workspaces than currently exists.

On failure, error (if provided) will be set to a description of the error that occurred.

Signal Details¶

Libxfce4windowing.WorkspaceGroup.signals.active_workspace_changed(workspace_group, previously_active_workspace)¶

Signal Name:

active-workspace-changed

Flags:

RUN_LAST

Parameters:

workspace_group (Libxfce4windowing.WorkspaceGroup) – The object which received the signal
previously_active_workspace (Libxfce4windowing.Workspace or None) – the previously active Libxfce4windowing.Workspace, or None.

Emitted when the active workspace of group changes.

Libxfce4windowing.WorkspaceGroup.signals.capabilities_changed(workspace_group, changed_mask, new_capabilities)¶

Signal Name:

capabilities-changed

Flags:

RUN_LAST

Parameters:

workspace_group (Libxfce4windowing.WorkspaceGroup) – The object which received the signal
changed_mask (Libxfce4windowing.WorkspaceGroupCapabilities) – a bitfield representing the capabilities that have changed.
new_capabilities (Libxfce4windowing.WorkspaceGroupCapabilities) – a bitfield of the new capabilities.

Emitted when capabilities have changed on group.

Libxfce4windowing.WorkspaceGroup.signals.monitor_added(workspace_group, monitor)¶

Signal Name:

monitor-added

Flags:

RUN_LAST

Parameters:

workspace_group (Libxfce4windowing.WorkspaceGroup) – The object which received the signal
monitor (Libxfce4windowing.Monitor) – a Libxfce4windowing.Monitor.

Emitted when group is added to a new monitor.

Libxfce4windowing.WorkspaceGroup.signals.monitor_removed(workspace_group, monitor)¶

Signal Name:

monitor-removed

Flags:

RUN_LAST

Parameters:

workspace_group (Libxfce4windowing.WorkspaceGroup) – The object which received the signal
monitor (Libxfce4windowing.Monitor) – a Libxfce4windowing.Monitor.

Emitted when group is removed from a monitor.

Libxfce4windowing.WorkspaceGroup.signals.monitors_changed(workspace_group)¶

Signal Name:: monitors-changed
Flags:: RUN_LAST
Parameters:: workspace_group (Libxfce4windowing.WorkspaceGroup) – The object which received the signal

Emitted when group moves to a new set of monitors.

Libxfce4windowing.WorkspaceGroup.signals.viewports_changed(workspace_group)¶

Signal Name:: viewports-changed
Flags:: RUN_LAST
Parameters:: workspace_group (Libxfce4windowing.WorkspaceGroup) – The object which received the signal