ext_workspace

type ExtWorkspaceGroupHandleV1 ¶

type ExtWorkspaceGroupHandleV1 struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

ExtWorkspaceGroupHandleV1 : a workspace group assigned to a set of outputs

A ext_workspace_group_handle_v1 object represents a workspace group that is assigned a set of outputs and contains a number of workspaces.

The set of outputs assigned to the workspace group is conveyed to the client via output_enter and output_leave events, and its workspaces are conveyed with workspace events.

For example, a compositor which has a set of workspaces for each output may advertise a workspace group (and its workspaces) per output, whereas a compositor where a workspace spans all outputs may advertise a single workspace group for all outputs.

func NewExtWorkspaceGroupHandleV1(ctx *client.Context) *ExtWorkspaceGroupHandleV1

func (i *ExtWorkspaceGroupHandleV1) CreateWorkspace(workspace string) error

func (i *ExtWorkspaceGroupHandleV1) Destroy() error

func (i *ExtWorkspaceGroupHandleV1) Dispatch(opcode uint32, fd int, data []byte)

func (i *ExtWorkspaceGroupHandleV1) SetCapabilitiesHandler(f ExtWorkspaceGroupHandleV1CapabilitiesHandlerFunc)

func (i *ExtWorkspaceGroupHandleV1) SetOutputEnterHandler(f ExtWorkspaceGroupHandleV1OutputEnterHandlerFunc)

func (i *ExtWorkspaceGroupHandleV1) SetOutputLeaveHandler(f ExtWorkspaceGroupHandleV1OutputLeaveHandlerFunc)

func (i *ExtWorkspaceGroupHandleV1) SetRemovedHandler(f ExtWorkspaceGroupHandleV1RemovedHandlerFunc)

func (i *ExtWorkspaceGroupHandleV1) SetWorkspaceEnterHandler(f ExtWorkspaceGroupHandleV1WorkspaceEnterHandlerFunc)

func (i *ExtWorkspaceGroupHandleV1) SetWorkspaceLeaveHandler(f ExtWorkspaceGroupHandleV1WorkspaceLeaveHandlerFunc)

type ExtWorkspaceGroupHandleV1CapabilitiesEvent ¶

type ExtWorkspaceGroupHandleV1CapabilitiesEvent struct {
	Capabilities uint32
}

ExtWorkspaceGroupHandleV1CapabilitiesEvent : compositor capabilities

This event advertises the capabilities supported by the compositor. If a capability isn't supported, clients should hide or disable the UI elements that expose this functionality. For instance, if the compositor doesn't advertise support for creating workspaces, a button triggering the create_workspace request should not be displayed.

The compositor will ignore requests it doesn't support. For instance, a compositor which doesn't advertise support for creating workspaces will ignore create_workspace requests.

Compositors must send this event once after creation of an ext_workspace_group_handle_v1. When the capabilities change, compositors must send this event again.

type ExtWorkspaceGroupHandleV1CapabilitiesHandlerFunc ¶

type ExtWorkspaceGroupHandleV1CapabilitiesHandlerFunc func(ExtWorkspaceGroupHandleV1CapabilitiesEvent)

type ExtWorkspaceGroupHandleV1GroupCapabilities ¶

type ExtWorkspaceGroupHandleV1GroupCapabilities uint32

const (
	// ExtWorkspaceGroupHandleV1GroupCapabilitiesCreateWorkspace : create_workspace request is available
	ExtWorkspaceGroupHandleV1GroupCapabilitiesCreateWorkspace ExtWorkspaceGroupHandleV1GroupCapabilities = 1
)

func (e ExtWorkspaceGroupHandleV1GroupCapabilities) Name() string

func (e ExtWorkspaceGroupHandleV1GroupCapabilities) String() string

func (e ExtWorkspaceGroupHandleV1GroupCapabilities) Value() string

type ExtWorkspaceGroupHandleV1OutputEnterEvent ¶

type ExtWorkspaceGroupHandleV1OutputEnterEvent struct {
	Output *client.Output
}

ExtWorkspaceGroupHandleV1OutputEnterEvent : output assigned to workspace group

This event is emitted whenever an output is assigned to the workspace group or a new `wl_output` object is bound by the client, which was already assigned to this workspace_group.

type ExtWorkspaceGroupHandleV1OutputEnterHandlerFunc ¶

type ExtWorkspaceGroupHandleV1OutputEnterHandlerFunc func(ExtWorkspaceGroupHandleV1OutputEnterEvent)

type ExtWorkspaceGroupHandleV1OutputLeaveEvent ¶

type ExtWorkspaceGroupHandleV1OutputLeaveEvent struct {
	Output *client.Output
}

ExtWorkspaceGroupHandleV1OutputLeaveEvent : output removed from workspace group

This event is emitted whenever an output is removed from the workspace group.

type ExtWorkspaceGroupHandleV1OutputLeaveHandlerFunc ¶

type ExtWorkspaceGroupHandleV1OutputLeaveHandlerFunc func(ExtWorkspaceGroupHandleV1OutputLeaveEvent)

type ExtWorkspaceGroupHandleV1RemovedEvent ¶

type ExtWorkspaceGroupHandleV1RemovedEvent struct{}

ExtWorkspaceGroupHandleV1RemovedEvent : this workspace group has been removed

This event is send when the group associated with the ext_workspace_group_handle_v1 has been removed. After sending this request the compositor will immediately consider the object inert. Any requests will be ignored except the destroy request. It is guaranteed there won't be any more events referencing this ext_workspace_group_handle_v1.

The compositor must remove all workspaces belonging to a workspace group via a workspace_leave event before removing the workspace group.

type ExtWorkspaceGroupHandleV1RemovedHandlerFunc ¶

type ExtWorkspaceGroupHandleV1RemovedHandlerFunc func(ExtWorkspaceGroupHandleV1RemovedEvent)

type ExtWorkspaceGroupHandleV1WorkspaceEnterEvent ¶

type ExtWorkspaceGroupHandleV1WorkspaceEnterEvent struct {
	Workspace *ExtWorkspaceHandleV1
}

ExtWorkspaceGroupHandleV1WorkspaceEnterEvent : workspace added to workspace group

This event is emitted whenever a workspace is assigned to this group. A workspace may only ever be assigned to a single group at a single point in time, but can be re-assigned during it's lifetime.

type ExtWorkspaceGroupHandleV1WorkspaceEnterHandlerFunc ¶

type ExtWorkspaceGroupHandleV1WorkspaceEnterHandlerFunc func(ExtWorkspaceGroupHandleV1WorkspaceEnterEvent)

type ExtWorkspaceGroupHandleV1WorkspaceLeaveEvent ¶

type ExtWorkspaceGroupHandleV1WorkspaceLeaveEvent struct {
	Workspace *ExtWorkspaceHandleV1
}

ExtWorkspaceGroupHandleV1WorkspaceLeaveEvent : workspace removed from workspace group

This event is emitted whenever a workspace is removed from this group.

type ExtWorkspaceGroupHandleV1WorkspaceLeaveHandlerFunc ¶

type ExtWorkspaceGroupHandleV1WorkspaceLeaveHandlerFunc func(ExtWorkspaceGroupHandleV1WorkspaceLeaveEvent)

type ExtWorkspaceHandleV1 ¶

type ExtWorkspaceHandleV1 struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

ExtWorkspaceHandleV1 : a workspace handing a group of surfaces

A ext_workspace_handle_v1 object represents a workspace that handles a group of surfaces.

Each workspace has: - a name, conveyed to the client with the name event - potentially an id conveyed with the id event - a list of states, conveyed to the client with the state event - and optionally a set of coordinates, conveyed to the client with the coordinates event

The client may request that the compositor activate or deactivate the workspace.

Each workspace can belong to only a single workspace group. Depending on the compositor policy, there might be workspaces with the same name in different workspace groups, but these workspaces are still separate (e.g. one of them might be active while the other is not).

func NewExtWorkspaceHandleV1(ctx *client.Context) *ExtWorkspaceHandleV1

func (i *ExtWorkspaceHandleV1) Activate() error

func (i *ExtWorkspaceHandleV1) Assign(workspaceGroup *ExtWorkspaceGroupHandleV1) error

func (i *ExtWorkspaceHandleV1) Deactivate() error

func (i *ExtWorkspaceHandleV1) Destroy() error

func (i *ExtWorkspaceHandleV1) Dispatch(opcode uint32, fd int, data []byte)

func (i *ExtWorkspaceHandleV1) Remove() error

func (i *ExtWorkspaceHandleV1) SetCapabilitiesHandler(f ExtWorkspaceHandleV1CapabilitiesHandlerFunc)

func (i *ExtWorkspaceHandleV1) SetCoordinatesHandler(f ExtWorkspaceHandleV1CoordinatesHandlerFunc)

func (i *ExtWorkspaceHandleV1) SetIdHandler(f ExtWorkspaceHandleV1IdHandlerFunc)

func (i *ExtWorkspaceHandleV1) SetNameHandler(f ExtWorkspaceHandleV1NameHandlerFunc)

func (i *ExtWorkspaceHandleV1) SetRemovedHandler(f ExtWorkspaceHandleV1RemovedHandlerFunc)

func (i *ExtWorkspaceHandleV1) SetStateHandler(f ExtWorkspaceHandleV1StateHandlerFunc)

type ExtWorkspaceHandleV1CapabilitiesEvent ¶

type ExtWorkspaceHandleV1CapabilitiesEvent struct {
	Capabilities uint32
}

ExtWorkspaceHandleV1CapabilitiesEvent : compositor capabilities

This event advertises the capabilities supported by the compositor. If a capability isn't supported, clients should hide or disable the UI elements that expose this functionality. For instance, if the compositor doesn't advertise support for removing workspaces, a button triggering the remove request should not be displayed.

The compositor will ignore requests it doesn't support. For instance, a compositor which doesn't advertise support for remove will ignore remove requests.

Compositors must send this event once after creation of an ext_workspace_handle_v1 . When the capabilities change, compositors must send this event again.

type ExtWorkspaceHandleV1CapabilitiesHandlerFunc ¶

type ExtWorkspaceHandleV1CapabilitiesHandlerFunc func(ExtWorkspaceHandleV1CapabilitiesEvent)

type ExtWorkspaceHandleV1CoordinatesEvent ¶

type ExtWorkspaceHandleV1CoordinatesEvent struct {
	Coordinates []byte
}

ExtWorkspaceHandleV1CoordinatesEvent : workspace coordinates changed

This event is used to organize workspaces into an N-dimensional grid within a workspace group, and if supported, is emitted immediately after the ext_workspace_handle_v1 is created and whenever the coordinates of the workspace change. Compositors may not send this event if they do not conceptually arrange workspaces in this way. If compositors simply number workspaces, without any geometric interpretation, they may send 1D coordinates, which clients should not interpret as implying any geometry. Sending an empty array means that the compositor no longer orders the workspace geometrically.

Coordinates have an arbitrary number of dimensions N with an uint32 position along each dimension. By convention if N > 1, the first dimension is X, the second Y, the third Z, and so on. The compositor may chose to utilize these events for a more novel workspace layout convention, however. No guarantee is made about the grid being filled or bounded; there may be a workspace at coordinate 1 and another at coordinate 1000 and none in between. Within a workspace group, however, workspaces must have unique coordinates of equal dimensionality.

type ExtWorkspaceHandleV1CoordinatesHandlerFunc ¶

type ExtWorkspaceHandleV1CoordinatesHandlerFunc func(ExtWorkspaceHandleV1CoordinatesEvent)

type ExtWorkspaceHandleV1IdEvent ¶

type ExtWorkspaceHandleV1IdEvent struct {
	Id string
}

ExtWorkspaceHandleV1IdEvent : workspace id

If this event is emitted, it will be send immediately after the ext_workspace_handle_v1 is created or when an id is assigned to a workspace (at most once during it's lifetime).

An id will never change during the lifetime of the `ext_workspace_handle_v1` and is guaranteed to be unique during it's lifetime.

Ids are not human-readable and shouldn't be displayed, use `name` for that purpose.

Compositors are expected to only send ids for workspaces likely stable across multiple sessions and can be used by clients to store preferences for workspaces. Workspaces without ids should be considered temporary and any data associated with them should be deleted once the respective object is lost.

type ExtWorkspaceHandleV1IdHandlerFunc ¶

type ExtWorkspaceHandleV1IdHandlerFunc func(ExtWorkspaceHandleV1IdEvent)

type ExtWorkspaceHandleV1NameEvent ¶

type ExtWorkspaceHandleV1NameEvent struct {
	Name string
}

ExtWorkspaceHandleV1NameEvent : workspace name changed

This event is emitted immediately after the ext_workspace_handle_v1 is created and whenever the name of the workspace changes.

A name is meant to be human-readable and can be displayed to a user. Unlike the id it is neither stable nor unique.

type ExtWorkspaceHandleV1NameHandlerFunc ¶

type ExtWorkspaceHandleV1NameHandlerFunc func(ExtWorkspaceHandleV1NameEvent)

type ExtWorkspaceHandleV1RemovedEvent ¶

type ExtWorkspaceHandleV1RemovedEvent struct{}

ExtWorkspaceHandleV1RemovedEvent : this workspace has been removed

This event is send when the workspace associated with the ext_workspace_handle_v1 has been removed. After sending this request, the compositor will immediately consider the object inert. Any requests will be ignored except the destroy request.

It is guaranteed there won't be any more events referencing this ext_workspace_handle_v1.

The compositor must only remove a workspaces not currently belonging to any workspace_group.

type ExtWorkspaceHandleV1RemovedHandlerFunc ¶

type ExtWorkspaceHandleV1RemovedHandlerFunc func(ExtWorkspaceHandleV1RemovedEvent)

type ExtWorkspaceHandleV1State ¶

type ExtWorkspaceHandleV1State uint32

const (
	// ExtWorkspaceHandleV1StateActive : the workspace is active
	ExtWorkspaceHandleV1StateActive ExtWorkspaceHandleV1State = 1
	// ExtWorkspaceHandleV1StateUrgent : the workspace requests attention
	ExtWorkspaceHandleV1StateUrgent ExtWorkspaceHandleV1State = 2
	ExtWorkspaceHandleV1StateHidden ExtWorkspaceHandleV1State = 4
)

func (e ExtWorkspaceHandleV1State) Name() string

func (e ExtWorkspaceHandleV1State) String() string

func (e ExtWorkspaceHandleV1State) Value() string

type ExtWorkspaceHandleV1StateEvent ¶

type ExtWorkspaceHandleV1StateEvent struct {
	State uint32
}

ExtWorkspaceHandleV1StateEvent : the state of the workspace changed

This event is emitted immediately after the ext_workspace_handle_v1 is created and each time the workspace state changes, either because of a compositor action or because of a request in this protocol.

Missing states convey the opposite meaning, e.g. an unset active bit means the workspace is currently inactive.

type ExtWorkspaceHandleV1StateHandlerFunc ¶

type ExtWorkspaceHandleV1StateHandlerFunc func(ExtWorkspaceHandleV1StateEvent)

type ExtWorkspaceHandleV1WorkspaceCapabilities ¶

type ExtWorkspaceHandleV1WorkspaceCapabilities uint32

const (
	// ExtWorkspaceHandleV1WorkspaceCapabilitiesActivate : activate request is available
	ExtWorkspaceHandleV1WorkspaceCapabilitiesActivate ExtWorkspaceHandleV1WorkspaceCapabilities = 1
	// ExtWorkspaceHandleV1WorkspaceCapabilitiesDeactivate : deactivate request is available
	ExtWorkspaceHandleV1WorkspaceCapabilitiesDeactivate ExtWorkspaceHandleV1WorkspaceCapabilities = 2
	// ExtWorkspaceHandleV1WorkspaceCapabilitiesRemove : remove request is available
	ExtWorkspaceHandleV1WorkspaceCapabilitiesRemove ExtWorkspaceHandleV1WorkspaceCapabilities = 4
	// ExtWorkspaceHandleV1WorkspaceCapabilitiesAssign : assign request is available
	ExtWorkspaceHandleV1WorkspaceCapabilitiesAssign ExtWorkspaceHandleV1WorkspaceCapabilities = 8
)

func (e ExtWorkspaceHandleV1WorkspaceCapabilities) Name() string

func (e ExtWorkspaceHandleV1WorkspaceCapabilities) String() string

func (e ExtWorkspaceHandleV1WorkspaceCapabilities) Value() string

type ExtWorkspaceManagerV1 ¶

type ExtWorkspaceManagerV1 struct {
	client.BaseProxy
	// contains filtered or unexported fields
}

ExtWorkspaceManagerV1 : list and control workspaces

Workspaces, also called virtual desktops, are groups of surfaces. A compositor with a concept of workspaces may only show some such groups of surfaces (those of 'active' workspaces) at a time. 'Activating' a workspace is a request for the compositor to display that workspace's surfaces as normal, whereas the compositor may hide or otherwise de-emphasise surfaces that are associated only with 'inactive' workspaces. Workspaces are grouped by which sets of outputs they correspond to, and may contain surfaces only from those outputs. In this way, it is possible for each output to have its own set of workspaces, or for all outputs (or any other arbitrary grouping) to share workspaces. Compositors may optionally conceptually arrange each group of workspaces in an N-dimensional grid.

The purpose of this protocol is to enable the creation of taskbars and docks by providing them with a list of workspaces and their properties, and allowing them to activate and deactivate workspaces.

After a client binds the ext_workspace_manager_v1, each workspace will be sent via the workspace event.

func NewExtWorkspaceManagerV1(ctx *client.Context) *ExtWorkspaceManagerV1

func (i *ExtWorkspaceManagerV1) Commit() error

func (i *ExtWorkspaceManagerV1) Destroy() error

func (i *ExtWorkspaceManagerV1) Dispatch(opcode uint32, fd int, data []byte)

func (i *ExtWorkspaceManagerV1) SetDoneHandler(f ExtWorkspaceManagerV1DoneHandlerFunc)

func (i *ExtWorkspaceManagerV1) SetFinishedHandler(f ExtWorkspaceManagerV1FinishedHandlerFunc)

func (i *ExtWorkspaceManagerV1) SetWorkspaceGroupHandler(f ExtWorkspaceManagerV1WorkspaceGroupHandlerFunc)

func (i *ExtWorkspaceManagerV1) SetWorkspaceHandler(f ExtWorkspaceManagerV1WorkspaceHandlerFunc)

func (i *ExtWorkspaceManagerV1) Stop() error

type ExtWorkspaceManagerV1DoneEvent ¶

type ExtWorkspaceManagerV1DoneEvent struct{}

ExtWorkspaceManagerV1DoneEvent : all information about the workspaces and workspace groups has been sent

This event is sent after all changes in all workspaces and workspace groups have been sent.

This allows changes to one or more ext_workspace_group_handle_v1 properties and ext_workspace_handle_v1 properties to be seen as atomic, even if they happen via multiple events. In particular, an output moving from one workspace group to another sends an output_enter event and an output_leave event to the two ext_workspace_group_handle_v1 objects in question. The compositor sends the done event only after updating the output information in both workspace groups.

type ExtWorkspaceManagerV1DoneHandlerFunc ¶

type ExtWorkspaceManagerV1DoneHandlerFunc func(ExtWorkspaceManagerV1DoneEvent)

type ExtWorkspaceManagerV1FinishedEvent ¶

type ExtWorkspaceManagerV1FinishedEvent struct{}

ExtWorkspaceManagerV1FinishedEvent : the compositor has finished with the workspace_manager

This event indicates that the compositor is done sending events to the ext_workspace_manager_v1. The server will destroy the object immediately after sending this request.

type ExtWorkspaceManagerV1FinishedHandlerFunc ¶

type ExtWorkspaceManagerV1FinishedHandlerFunc func(ExtWorkspaceManagerV1FinishedEvent)

type ExtWorkspaceManagerV1WorkspaceEvent ¶

type ExtWorkspaceManagerV1WorkspaceEvent struct {
	Workspace *ExtWorkspaceHandleV1
}

ExtWorkspaceManagerV1WorkspaceEvent : workspace has been created

This event is emitted whenever a new workspace has been created.

All initial details of the workspace (name, coordinates, state) will be sent immediately after this event via the corresponding events in ext_workspace_handle_v1.

Workspaces start off unassigned to any workspace group.

type ExtWorkspaceManagerV1WorkspaceGroupEvent ¶

type ExtWorkspaceManagerV1WorkspaceGroupEvent struct {
	WorkspaceGroup *ExtWorkspaceGroupHandleV1
}

ExtWorkspaceManagerV1WorkspaceGroupEvent : a workspace group has been created

This event is emitted whenever a new workspace group has been created.

All initial details of the workspace group (outputs) will be sent immediately after this event via the corresponding events in ext_workspace_group_handle_v1 and ext_workspace_handle_v1.

type ExtWorkspaceManagerV1WorkspaceGroupHandlerFunc ¶

type ExtWorkspaceManagerV1WorkspaceGroupHandlerFunc func(ExtWorkspaceManagerV1WorkspaceGroupEvent)

type ExtWorkspaceManagerV1WorkspaceHandlerFunc ¶

type ExtWorkspaceManagerV1WorkspaceHandlerFunc func(ExtWorkspaceManagerV1WorkspaceEvent)