xdg

package
v0.0.0-...-451b853 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 17, 2021 License: BSD-2-Clause Imports: 2 Imported by: 0

Documentation

Overview

Package xdg contains

Index

Constants

View Source 
const (
	WmBaseErrorRole                = 0
	WmBaseErrorDefunctSurfaces     = 1
	WmBaseErrorNotTheTopmostPopup  = 2
	WmBaseErrorInvalidPopupParent  = 3
	WmBaseErrorInvalidSurfaceState = 4
	WmBaseErrorInvalidPositioner   = 5
)
View Source 
const (
	PositionerAnchorNone        = 0
	PositionerAnchorTop         = 1
	PositionerAnchorBottom      = 2
	PositionerAnchorLeft        = 3
	PositionerAnchorRight       = 4
	PositionerAnchorTopLeft     = 5
	PositionerAnchorBottomLeft  = 6
	PositionerAnchorTopRight    = 7
	PositionerAnchorBottomRight = 8
)
View Source 
const (
	PositionerGravityNone        = 0
	PositionerGravityTop         = 1
	PositionerGravityBottom      = 2
	PositionerGravityLeft        = 3
	PositionerGravityRight       = 4
	PositionerGravityTopLeft     = 5
	PositionerGravityBottomLeft  = 6
	PositionerGravityTopRight    = 7
	PositionerGravityBottomRight = 8
)
View Source 
const (
	PositionerConstraintAdjustmentNone    = 0
	PositionerConstraintAdjustmentSlideX  = 1
	PositionerConstraintAdjustmentSlideY  = 2
	PositionerConstraintAdjustmentFlipX   = 4
	PositionerConstraintAdjustmentFlipY   = 8
	PositionerConstraintAdjustmentResizeX = 16
	PositionerConstraintAdjustmentResizeY = 32
)
View Source 
const (
	SurfaceErrorNotConstructed     = 1
	SurfaceErrorAlreadyConstructed = 2
	SurfaceErrorUnconfiguredBuffer = 3
)
View Source 
const (
	ToplevelResizeEdgeNone        = 0
	ToplevelResizeEdgeTop         = 1
	ToplevelResizeEdgeBottom      = 2
	ToplevelResizeEdgeLeft        = 4
	ToplevelResizeEdgeTopLeft     = 5
	ToplevelResizeEdgeBottomLeft  = 6
	ToplevelResizeEdgeRight       = 8
	ToplevelResizeEdgeTopRight    = 9
	ToplevelResizeEdgeBottomRight = 10
)
View Source 
const (
	ToplevelStateMaximized   = 1
	ToplevelStateFullscreen  = 2
	ToplevelStateResizing    = 3
	ToplevelStateActivated   = 4
	ToplevelStateTiledLeft   = 5
	ToplevelStateTiledRight  = 6
	ToplevelStateTiledTop    = 7
	ToplevelStateTiledBottom = 8
)
View Source 
const (
	PopupErrorInvalidGrab = 0
)
View Source 
const (
	PositionerErrorInvalidInput = 0
)

Variables

This section is empty.

Functions

This section is empty.

Types 

type Popup struct {
	wl.BaseProxy
	// contains filtered or unexported fields
}

func NewPopup 

func NewPopup(ctx *wl.Context) *Popup

func (*Popup) AddConfigureHandler 

func (p *Popup) AddConfigureHandler(h PopupConfigureHandler)

func (*Popup) AddPopupDoneHandler 

func (p *Popup) AddPopupDoneHandler(h PopupPopupDoneHandler)

func (*Popup) AddRepositionedHandler 

func (p *Popup) AddRepositionedHandler(h PopupRepositionedHandler)

func (*Popup) Destroy 

func (p *Popup) Destroy() error

Destroy will remove xdg_popup interface.

This destroys the popup. Explicitly destroying the xdg_popup object will also dismiss the popup, and unmap the surface.

If this xdg_popup is not the "topmost" popup, a protocol error will be sent.

func (*Popup) Dispatch 

func (p *Popup) Dispatch(event *wl.Event)

func (*Popup) Grab 

func (p *Popup) Grab(seat *wl.Seat, serial uint32) error

Grab will make the popup take an explicit grab.

This request makes the created popup take an explicit grab. An explicit grab will be dismissed when the user dismisses the popup, or when the client destroys the xdg_popup. This can be done by the user clicking outside the surface, using the keyboard, or even locking the screen through closing the lid or a timeout.

If the compositor denies the grab, the popup will be immediately dismissed.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The serial number of the event should be passed as 'serial'.

The parent of a grabbing popup must either be an xdg_toplevel surface or another xdg_popup with an explicit grab. If the parent is another xdg_popup it means that the popups are nested, with this popup now being the topmost popup.

Nested popups must be destroyed in the reverse order they were created in, e.g. the only popup you are allowed to destroy at all times is the topmost one.

When compositors choose to dismiss a popup, they may dismiss every nested grabbing popup as well. When a compositor dismisses popups, it will follow the same dismissing order as required from the client.

The parent of a grabbing popup must either be another xdg_popup with an active explicit grab, or an xdg_popup or xdg_toplevel, if there are no explicit grabs already taken.

If the topmost grabbing popup is destroyed, the grab will be returned to the parent of the popup, if that parent previously had an explicit grab.

If the parent is a grabbing popup which has already been dismissed, this popup will be immediately dismissed. If the parent is a popup that did not take an explicit grab, an error will be raised.

During a popup grab, the client owning the grab will receive pointer and touch events for all their surfaces as normal (similar to an "owner-events" grab in X11 parlance), while the top most grabbing popup will always have keyboard focus.

func (*Popup) RemoveConfigureHandler 

func (p *Popup) RemoveConfigureHandler(h PopupConfigureHandler)

func (*Popup) RemovePopupDoneHandler 

func (p *Popup) RemovePopupDoneHandler(h PopupPopupDoneHandler)

func (*Popup) RemoveRepositionedHandler 

func (p *Popup) RemoveRepositionedHandler(h PopupRepositionedHandler)

func (*Popup) Reposition 

func (p *Popup) Reposition(positioner *Positioner, token uint32) error

Reposition will recalculate the popup's location.

Reposition an already-mapped popup. The popup will be placed given the details in the passed xdg_positioner object, and a xdg_popup.repositioned followed by xdg_popup.configure and xdg_surface.configure will be emitted in response. Any parameters set by the previous positioner will be discarded.

The passed token will be sent in the corresponding xdg_popup.repositioned event. The new popup position will not take effect until the corresponding configure event is acknowledged by the client. See xdg_popup.repositioned for details. The token itself is opaque, and has no other special meaning.

If multiple reposition requests are sent, the compositor may skip all but the last one.

If the popup is repositioned in response to a configure event for its parent, the client should send an xdg_positioner.set_parent_configure and possibly an xdg_positioner.set_parent_size request to allow the compositor to properly constrain the popup.

If the popup is repositioned together with a parent that is being resized, but not in response to a configure event, the client should send an xdg_positioner.set_parent_size request.

type PopupConfigureEvent 

type PopupConfigureEvent struct {
	X      int32
	Y      int32
	Width  int32
	Height int32
}

type PopupConfigureHandler 

type PopupConfigureHandler interface {
	HandlePopupConfigure(PopupConfigureEvent)
}

type PopupPopupDoneEvent 

type PopupPopupDoneEvent struct{}

type PopupPopupDoneHandler 

type PopupPopupDoneHandler interface {
	HandlePopupPopupDone(PopupPopupDoneEvent)
}

type PopupRepositionedEvent 

type PopupRepositionedEvent struct {
	Token uint32
}

type PopupRepositionedHandler 

type PopupRepositionedHandler interface {
	HandlePopupRepositioned(PopupRepositionedEvent)
}

type Positioner 

type Positioner struct {
	wl.BaseProxy
}

func NewPositioner 

func NewPositioner(ctx *wl.Context) *Positioner

func (*Positioner) Destroy 

func (p *Positioner) Destroy() error

Destroy will destroy the xdg_positioner object.

Notify the compositor that the xdg_positioner will no longer be used.

func (*Positioner) SetAnchor 

func (p *Positioner) SetAnchor(anchor uint32) error

SetAnchor will set anchor rectangle anchor.

Defines the anchor point for the anchor rectangle. The specified anchor is used derive an anchor point that the child surface will be positioned relative to. If a corner anchor is set (e.g. 'top_left' or 'bottom_right'), the anchor point will be at the specified corner; otherwise, the derived anchor point will be centered on the specified edge, or in the center of the anchor rectangle if no edge is specified.

func (*Positioner) SetAnchorRect 

func (p *Positioner) SetAnchorRect(x, y, width, height int32) error

SetAnchorRect will set the anchor rectangle within the parent surface.

Specify the anchor rectangle within the parent surface that the child surface will be placed relative to. The rectangle is relative to the window geometry as defined by xdg_surface.set_window_geometry of the parent surface.

When the xdg_positioner object is used to position a child surface, the anchor rectangle may not extend outside the window geometry of the positioned child's parent surface.

If a negative size is set the invalid_input error is raised.

func (*Positioner) SetConstraintAdjustment 

func (p *Positioner) SetConstraintAdjustment(constraint_adjustment uint32) error

SetConstraintAdjustment will set the adjustment to be done when constrained.

Specify how the window should be positioned if the originally intended position caused the surface to be constrained, meaning at least partially outside positioning boundaries set by the compositor. The adjustment is set by constructing a bitmask describing the adjustment to be made when the surface is constrained on that axis.

If no bit for one axis is set, the compositor will assume that the child surface should not change its position on that axis when constrained.

If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions.

The default adjustment is none.

func (*Positioner) SetGravity 

func (p *Positioner) SetGravity(gravity uint32) error

SetGravity will set child surface gravity.

Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface. If a corner gravity is specified (e.g. 'bottom_right' or 'top_left'), then the child surface will be placed towards the specified gravity; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified.

func (*Positioner) SetOffset 

func (p *Positioner) SetOffset(x, y int32) error

SetOffset will set surface position offset.

Specify the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface. For example if the anchor of the anchor rectangle is at (x, y), the surface has the gravity bottom|right, and the offset is (ox, oy), the calculated surface position will be (x + ox, y + oy). The offset position of the surface is the one used for constraint testing. See set_constraint_adjustment.

An example use case is placing a popup menu on top of a user interface element, while aligning the user interface element of the parent surface with some user interface element placed somewhere in the popup surface.

func (*Positioner) SetParentConfigure 

func (p *Positioner) SetParentConfigure(serial uint32) error

SetParentConfigure will set parent configure this is a response to.

Set the serial of an xdg_surface.configure event this positioner will be used in response to. The compositor may use this information together with set_parent_size to determine what future state the popup should be constrained using.

func (*Positioner) SetParentSize 

func (p *Positioner) SetParentSize(parent_width, parent_height int32) error

SetParentSize will .

Set the parent window geometry the compositor should use when positioning the popup. The compositor may use this information to determine the future state the popup should be constrained using. If this doesn't match the dimension of the parent the popup is eventually positioned against, the behavior is undefined.

The arguments are given in the surface-local coordinate space.

func (*Positioner) SetReactive 

func (p *Positioner) SetReactive() error

SetReactive will continuously reconstrain the surface.

When set reactive, the surface is reconstrained if the conditions used for constraining changed, e.g. the parent window moved.

If the conditions changed and the popup was reconstrained, an xdg_popup.configure event is sent with updated geometry, followed by an xdg_surface.configure event.

func (*Positioner) SetSize 

func (p *Positioner) SetSize(width, height int32) error

SetSize will set the size of the to-be positioned rectangle.

Set the size of the surface that is to be positioned with the positioner object. The size is in surface-local coordinates and corresponds to the window geometry. See xdg_surface.set_window_geometry.

If a zero or negative size is set the invalid_input error is raised.

type Surface 

type Surface struct {
	wl.BaseProxy
	// contains filtered or unexported fields
}

func NewSurface 

func NewSurface(ctx *wl.Context) *Surface

func (*Surface) AckConfigure 

func (p *Surface) AckConfigure(serial uint32) error

AckConfigure will ack a configure event.

When a configure event is received, if a client commits the surface in response to the configure event, then the client must make an ack_configure request sometime before the commit request, passing along the serial of the configure event.

For instance, for toplevel surfaces the compositor might use this information to move a surface to the top left only when the client has drawn itself for the maximized or fullscreen state.

If the client receives multiple configure events before it can respond to one, it only has to ack the last configure event.

A client is not required to commit immediately after sending an ack_configure request - it may even ack_configure several times before its next surface commit.

A client may send multiple ack_configure requests before committing, but only the last request sent before a commit indicates which configure event the client really is responding to.

func (*Surface) AddConfigureHandler 

func (p *Surface) AddConfigureHandler(h SurfaceConfigureHandler)

func (*Surface) Destroy 

func (p *Surface) Destroy() error

Destroy will destroy the xdg_surface.

Destroy the xdg_surface object. An xdg_surface must only be destroyed after its role object has been destroyed.

func (*Surface) Dispatch 

func (p *Surface) Dispatch(event *wl.Event)

func (*Surface) GetPopup 

func (p *Surface) GetPopup(parent *Surface, positioner *Positioner) (*Popup, error)

GetPopup will assign the xdg_popup surface role.

This creates an xdg_popup object for the given xdg_surface and gives the associated wl_surface the xdg_popup role.

If null is passed as a parent, a parent surface must be specified using some other protocol, before committing the initial state.

See the documentation of xdg_popup for more details about what an xdg_popup is and how it is used.

func (*Surface) GetToplevel 

func (p *Surface) GetToplevel() (*Toplevel, error)

GetToplevel will assign the xdg_toplevel surface role.

This creates an xdg_toplevel object for the given xdg_surface and gives the associated wl_surface the xdg_toplevel role.

See the documentation of xdg_toplevel for more details about what an xdg_toplevel is and how it is used.

func (*Surface) RemoveConfigureHandler 

func (p *Surface) RemoveConfigureHandler(h SurfaceConfigureHandler)

func (*Surface) SetWindowGeometry 

func (p *Surface) SetWindowGeometry(x, y, width, height int32) error

SetWindowGeometry will set the new window geometry.

The window geometry of a surface is its "visible bounds" from the user's perspective. Client-side decorations often have invisible portions like drop-shadows which should be ignored for the purposes of aligning, placing and constraining windows.

The window geometry is double buffered, and will be applied at the time wl_surface.commit of the corresponding wl_surface is called.

When maintaining a position, the compositor should treat the (x, y) coordinate of the window geometry as the top left corner of the window. A client changing the (x, y) window geometry coordinate should in general not alter the position of the window.

Once the window geometry of the surface is set, it is not possible to unset it, and it will remain the same until set_window_geometry is called again, even if a new subsurface or buffer is attached.

If never set, the value is the full bounds of the surface, including any subsurfaces. This updates dynamically on every commit. This unset is meant for extremely simple clients.

The arguments are given in the surface-local coordinate space of the wl_surface associated with this xdg_surface.

The width and height must be greater than zero. Setting an invalid size will raise an error. When applied, the effective window geometry will be the set window geometry clamped to the bounding rectangle of the combined geometry of the surface of the xdg_surface and the associated subsurfaces.

type SurfaceConfigureEvent 

type SurfaceConfigureEvent struct {
	Serial uint32
}

type SurfaceConfigureHandler 

type SurfaceConfigureHandler interface {
	HandleSurfaceConfigure(SurfaceConfigureEvent)
}

type Toplevel 

type Toplevel struct {
	wl.BaseProxy
	// contains filtered or unexported fields
}

func NewToplevel 

func NewToplevel(ctx *wl.Context) *Toplevel

func (*Toplevel) AddCloseHandler 

func (p *Toplevel) AddCloseHandler(h ToplevelCloseHandler)

func (*Toplevel) AddConfigureHandler 

func (p *Toplevel) AddConfigureHandler(h ToplevelConfigureHandler)

func (*Toplevel) Destroy 

func (p *Toplevel) Destroy() error

Destroy will destroy the xdg_toplevel.

This request destroys the role surface and unmaps the surface; see "Unmapping" behavior in interface section for details.

func (*Toplevel) Dispatch 

func (p *Toplevel) Dispatch(event *wl.Event)

func (*Toplevel) Move 

func (p *Toplevel) Move(seat *wl.Seat, serial uint32) error

Move will start an interactive move.

Start an interactive, user-driven move of the surface.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive move (touch, pointer, etc).

The server may ignore move requests depending on the state of the surface (e.g. fullscreen or maximized), or if the passed serial is no longer valid.

If triggered, the surface will lose the focus of the device (wl_pointer, wl_touch, etc) used for the move. It is up to the compositor to visually indicate that the move is taking place, such as updating a pointer cursor, during the move. There is no guarantee that the device focus will return when the move is completed.

func (*Toplevel) RemoveCloseHandler 

func (p *Toplevel) RemoveCloseHandler(h ToplevelCloseHandler)

func (*Toplevel) RemoveConfigureHandler 

func (p *Toplevel) RemoveConfigureHandler(h ToplevelConfigureHandler)

func (*Toplevel) Resize 

func (p *Toplevel) Resize(seat *wl.Seat, serial, edges uint32) error

Resize will start an interactive resize.

Start a user-driven, interactive resize of the surface.

This request must be used in response to some sort of user action like a button press, key press, or touch down event. The passed serial is used to determine the type of interactive resize (touch, pointer, etc).

The server may ignore resize requests depending on the state of the surface (e.g. fullscreen or maximized).

If triggered, the client will receive configure events with the "resize" state enum value and the expected sizes. See the "resize" enum value for more details about what is required. The client must also acknowledge configure events using "ack_configure". After the resize is completed, the client will receive another "configure" event without the resize state.

If triggered, the surface also will lose the focus of the device (wl_pointer, wl_touch, etc) used for the resize. It is up to the compositor to visually indicate that the resize is taking place, such as updating a pointer cursor, during the resize. There is no guarantee that the device focus will return when the resize is completed.

The edges parameter specifies how the surface should be resized, and is one of the values of the resize_edge enum. The compositor may use this information to update the surface position for example when dragging the top left corner. The compositor may also use this information to adapt its behavior, e.g. choose an appropriate cursor image.

func (*Toplevel) SetAppID 

func (p *Toplevel) SetAppID(app_id string) error

SetAppID will set application ID.

Set an application identifier for the surface.

The app ID identifies the general class of applications to which the surface belongs. The compositor can use this to group multiple surfaces together, or to determine how to launch a new application.

For D-Bus activatable applications, the app ID is used as the D-Bus service name.

The compositor shell will try to group application surfaces together by their app ID. As a best practice, it is suggested to select app ID's that match the basename of the application's .desktop file. For example, "org.freedesktop.FooViewer" where the .desktop file is "org.freedesktop.FooViewer.desktop".

Like other properties, a set_app_id request can be sent after the xdg_toplevel has been mapped to update the property.

See the desktop-entry specification [0] for more details on application identifiers and how they relate to well-known D-Bus names and .desktop files.

[0] http://standards.freedesktop.org/desktop-entry-spec/

func (*Toplevel) SetFullscreen 

func (p *Toplevel) SetFullscreen(output *wl.Output) error

SetFullscreen will set the window as fullscreen on an output.

Make the surface fullscreen.

After requesting that the surface should be fullscreened, the compositor will respond by emitting a configure event. Whether the client is actually put into a fullscreen state is subject to compositor policies. The client must also acknowledge the configure when committing the new content (see ack_configure).

The output passed by the request indicates the client's preference as to which display it should be set fullscreen on. If this value is NULL, it's up to the compositor to choose which display will be used to map this surface.

If the surface doesn't cover the whole output, the compositor will position the surface in the center of the output and compensate with with border fill covering the rest of the output. The content of the border fill is undefined, but should be assumed to be in some way that attempts to blend into the surrounding area (e.g. solid black).

If the fullscreened surface is not opaque, the compositor must make sure that other screen content not part of the same surface tree (made up of subsurfaces, popups or similarly coupled surfaces) are not visible below the fullscreened surface.

func (*Toplevel) SetMaxSize 

func (p *Toplevel) SetMaxSize(width, height int32) error

SetMaxSize will set the maximum size.

Set a maximum size for the window.

The client can specify a maximum size so that the compositor does not try to configure the window beyond this size.

The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry.

Values set in this way are double-buffered. They will get applied on the next commit.

The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations.

Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way.

The client should not rely on the compositor to obey the maximum size. The compositor may decide to ignore the values set by the client and request a larger size.

If never set, or a value of zero in the request, means that the client has no expected maximum size in the given dimension. As a result, a client wishing to reset the maximum size to an unspecified state can use zero for width and height in the request.

Requesting a maximum size to be smaller than the minimum size of a surface is illegal and will result in a protocol error.

The width and height must be greater than or equal to zero. Using strictly negative values for width and height will result in a protocol error.

func (*Toplevel) SetMaximized 

func (p *Toplevel) SetMaximized() error

SetMaximized will maximize the window.

Maximize the surface.

After requesting that the surface should be maximized, the compositor will respond by emitting a configure event. Whether this configure actually sets the window maximized is subject to compositor policies. The client must then update its content, drawing in the configured state. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to decide how and where to maximize the surface, for example which output and what region of the screen should be used.

If the surface was already maximized, the compositor will still emit a configure event with the "maximized" state.

If the surface is in a fullscreen state, this request has no direct effect. It may alter the state the surface is returned to when unmaximized unless overridden by the compositor.

func (*Toplevel) SetMinSize 

func (p *Toplevel) SetMinSize(width, height int32) error

SetMinSize will set the minimum size.

Set a minimum size for the window.

The client can specify a minimum size so that the compositor does not try to configure the window below this size.

The width and height arguments are in window geometry coordinates. See xdg_surface.set_window_geometry.

Values set in this way are double-buffered. They will get applied on the next commit.

The compositor can use this information to allow or disallow different states like maximize or fullscreen and draw accurate animations.

Similarly, a tiling window manager may use this information to place and resize client windows in a more effective way.

The client should not rely on the compositor to obey the minimum size. The compositor may decide to ignore the values set by the client and request a smaller size.

If never set, or a value of zero in the request, means that the client has no expected minimum size in the given dimension. As a result, a client wishing to reset the minimum size to an unspecified state can use zero for width and height in the request.

Requesting a minimum size to be larger than the maximum size of a surface is illegal and will result in a protocol error.

The width and height must be greater than or equal to zero. Using strictly negative values for width and height will result in a protocol error.

func (*Toplevel) SetMinimized 

func (p *Toplevel) SetMinimized() error

SetMinimized will set the window as minimized.

Request that the compositor minimize your surface. There is no way to know if the surface is currently minimized, nor is there any way to unset minimization on this surface.

If you are looking to throttle redrawing when minimized, please instead use the wl_surface.frame event for this, as this will also work with live previews on windows in Alt-Tab, Expose or similar compositor features.

func (*Toplevel) SetParent 

func (p *Toplevel) SetParent(parent *Toplevel) error

SetParent will set the parent of this surface.

Set the "parent" of this surface. This surface should be stacked above the parent surface and all other ancestor surfaces.

Parent windows should be set on dialogs, toolboxes, or other "auxiliary" surfaces, so that the parent is raised when the dialog is raised.

Setting a null parent for a child window removes any parent-child relationship for the child. Setting a null parent for a window which currently has no parent is a no-op.

If the parent is unmapped then its children are managed as though the parent of the now-unmapped parent has become the parent of this surface. If no parent exists for the now-unmapped parent then the children are managed as though they have no parent surface.

func (*Toplevel) SetTitle 

func (p *Toplevel) SetTitle(title string) error

SetTitle will set surface title.

Set a short title for the surface.

This string may be used to identify the surface in a task bar, window list, or other user interface elements provided by the compositor.

The string must be encoded in UTF-8.

func (*Toplevel) ShowWindowMenu 

func (p *Toplevel) ShowWindowMenu(seat *wl.Seat, serial uint32, x, y int32) error

ShowWindowMenu will show the window menu.

Clients implementing client-side decorations might want to show a context menu when right-clicking on the decorations, giving the user a menu that they can use to maximize or minimize the window.

This request asks the compositor to pop up such a window menu at the given position, relative to the local surface coordinates of the parent surface. There are no guarantees as to what menu items the window menu contains.

This request must be used in response to some sort of user action like a button press, key press, or touch down event.

func (*Toplevel) UnsetFullscreen 

func (p *Toplevel) UnsetFullscreen() error

UnsetFullscreen will unset the window as fullscreen.

Make the surface no longer fullscreen.

After requesting that the surface should be unfullscreened, the compositor will respond by emitting a configure event. Whether this actually removes the fullscreen state of the client is subject to compositor policies.

Making a surface unfullscreen sets states for the surface based on the following: * the state(s) it may have had before becoming fullscreen * any state(s) decided by the compositor * any state(s) requested by the client while the surface was fullscreen

The compositor may include the previous window geometry dimensions in the configure event, if applicable.

The client must also acknowledge the configure when committing the new content (see ack_configure).

func (*Toplevel) UnsetMaximized 

func (p *Toplevel) UnsetMaximized() error

UnsetMaximized will unmaximize the window.

Unmaximize the surface.

After requesting that the surface should be unmaximized, the compositor will respond by emitting a configure event. Whether this actually un-maximizes the window is subject to compositor policies. If available and applicable, the compositor will include the window geometry dimensions the window had prior to being maximized in the configure event. The client must then update its content, drawing it in the configured state. The client must also acknowledge the configure when committing the new content (see ack_configure).

It is up to the compositor to position the surface after it was unmaximized; usually the position the surface had before maximizing, if applicable.

If the surface was already not maximized, the compositor will still emit a configure event without the "maximized" state.

If the surface is in a fullscreen state, this request has no direct effect. It may alter the state the surface is returned to when unmaximized unless overridden by the compositor.

type ToplevelCloseEvent 

type ToplevelCloseEvent struct{}

type ToplevelCloseHandler 

type ToplevelCloseHandler interface {
	HandleToplevelClose(ToplevelCloseEvent)
}

type ToplevelConfigureEvent 

type ToplevelConfigureEvent struct {
	Width  int32
	Height int32
	States []int32
}

type ToplevelConfigureHandler 

type ToplevelConfigureHandler interface {
	HandleToplevelConfigure(ToplevelConfigureEvent)
}

type WmBase 

type WmBase struct {
	wl.BaseProxy
	// contains filtered or unexported fields
}

func NewWmBase 

func NewWmBase(ctx *wl.Context) *WmBase

func (*WmBase) AddPingHandler 

func (p *WmBase) AddPingHandler(h WmBasePingHandler)

func (*WmBase) CreatePositioner 

func (p *WmBase) CreatePositioner() (*Positioner, error)

CreatePositioner will create a positioner object.

Create a positioner object. A positioner object is used to position surfaces relative to some parent surface. See the interface description and xdg_surface.get_popup for details.

func (*WmBase) Destroy 

func (p *WmBase) Destroy() error

Destroy will destroy xdg_wm_base.

Destroy this xdg_wm_base object.

Destroying a bound xdg_wm_base object while there are surfaces still alive created by this xdg_wm_base object instance is illegal and will result in a protocol error.

func (*WmBase) Dispatch 

func (p *WmBase) Dispatch(event *wl.Event)

func (*WmBase) GetXdgSurface 

func (p *WmBase) GetXdgSurface(surface *wl.Surface) (*Surface, error)

GetXdgSurface will create a shell surface from a surface.

This creates an xdg_surface for the given surface. While xdg_surface itself is not a role, the corresponding surface may only be assigned a role extending xdg_surface, such as xdg_toplevel or xdg_popup.

This creates an xdg_surface for the given surface. An xdg_surface is used as basis to define a role to a given surface, such as xdg_toplevel or xdg_popup. It also manages functionality shared between xdg_surface based surface roles.

See the documentation of xdg_surface for more details about what an xdg_surface is and how it is used.

func (*WmBase) Pong 

func (p *WmBase) Pong(serial uint32) error

Pong will respond to a ping event.

A client must respond to a ping event with a pong request or the client may be deemed unresponsive. See xdg_wm_base.ping.

func (*WmBase) RemovePingHandler 

func (p *WmBase) RemovePingHandler(h WmBasePingHandler)

type WmBasePingEvent 

type WmBasePingEvent struct {
	Serial uint32
}

type WmBasePingHandler 

type WmBasePingHandler interface {
	HandleWmBasePing(WmBasePingEvent)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.