KWin::LayerSurfaceV1Interface Class Reference

#include <layershell_v1.h>

Inheritance diagram for KWin::LayerSurfaceV1Interface:

Public Types
enum	Layer { BackgroundLayer , BottomLayer , TopLayer , OverlayLayer }

Signals
void	aboutToBeDestroyed ()
void	configureAcknowledged (quint32 serial)
void	acceptsFocusChanged ()
void	layerChanged ()
void	anchorChanged ()
void	desiredSizeChanged ()
void	exclusiveZoneChanged ()
void	marginsChanged ()

Public Member Functions
	LayerSurfaceV1Interface (LayerShellV1Interface *shell, SurfaceInterface *surface, OutputInterface *output, Layer layer, const QString &scope, wl_resource *resource)
	~LayerSurfaceV1Interface () override
bool	isCommitted () const
SurfaceInterface *	surface () const
Qt::Edges	anchor () const
QSize	desiredSize () const
Layer	layer () const
bool	acceptsFocus () const
QMargins	margins () const
int	leftMargin () const
int	rightMargin () const
int	topMargin () const
int	bottomMargin () const
int	exclusiveZone () const
Qt::Edge	exclusiveEdge () const
OutputInterface *	output () const
QString	scope () const
quint32	sendConfigure (const QSize &size)
void	sendClosed ()

Static Public Member Functions
static SurfaceRole *	role ()

Detailed Description

The LayerSurfaceV1Interface class represents a desktop shell surface, e.g. panel, etc.

The LayerSurfaceV1Interface corresponds to the Wayland interface zwlr_layer_surface_v1.

Definition at line 58 of file layershell_v1.h.

Member Enumeration Documentation

Layer

enum KWin::LayerSurfaceV1Interface::Layer

Enumerator
BackgroundLayer
BottomLayer
TopLayer
OverlayLayer

Definition at line 63 of file layershell_v1.h.

Constructor & Destructor Documentation

LayerSurfaceV1Interface()

KWin::LayerSurfaceV1Interface::LayerSurfaceV1Interface	(	LayerShellV1Interface *	shell,
		SurfaceInterface *	surface,
		OutputInterface *	output,
		Layer	layer,
		const QString &	scope,
		wl_resource *	resource )

Definition at line 393 of file layershell_v1.cpp.

~LayerSurfaceV1Interface()

KWin::LayerSurfaceV1Interface::~LayerSurfaceV1Interface ( )

override

Definition at line 410 of file layershell_v1.cpp.

Member Function Documentation

aboutToBeDestroyed

void KWin::LayerSurfaceV1Interface::aboutToBeDestroyed ( )

signal

acceptsFocus()

bool KWin::LayerSurfaceV1Interface::acceptsFocus

(

)

const

Returns true if the surface accepts keyboard input; otherwise returns false.

Definition at line 440 of file layershell_v1.cpp.

acceptsFocusChanged

void KWin::LayerSurfaceV1Interface::acceptsFocusChanged ( )

signal

anchor()

Qt::Edges KWin::LayerSurfaceV1Interface::anchor

(

)

const

Returns the anchor point relative to which the surface will be positioned. If no edges have been specified, the center of the screen is assumed to be the anchor point.

Definition at line 430 of file layershell_v1.cpp.

anchorChanged

void KWin::LayerSurfaceV1Interface::anchorChanged ( )

signal

bottomMargin()

int KWin::LayerSurfaceV1Interface::bottomMargin

(

)

const

Returns the value of the bottom margin. This is equivalent to calling margins().bottom().

Definition at line 470 of file layershell_v1.cpp.

configureAcknowledged

void KWin::LayerSurfaceV1Interface::configureAcknowledged ( quint32 serial )

signal

desiredSize()

QSize KWin::LayerSurfaceV1Interface::desiredSize

(

)

const

Returns the desired size for this layer shell surface, in the surface-local coordinates.

Definition at line 435 of file layershell_v1.cpp.

desiredSizeChanged

void KWin::LayerSurfaceV1Interface::desiredSizeChanged ( )

signal

exclusiveEdge()

Qt::Edge KWin::LayerSurfaceV1Interface::exclusiveEdge

(

)

const

If the exclusive zone is positive, this function returns the corresponding exclusive anchor edge, otherwise returns a Qt::Edge() value.

Definition at line 480 of file layershell_v1.cpp.

exclusiveZone()

int KWin::LayerSurfaceV1Interface::exclusiveZone

(

)

const

Returns the distance from the anchor edge that should not be occluded.

An exlusive zone of 0 means that the layer surface has to be moved to avoid occluding surfaces with a positive exclusion zone. If the exclusive zone is -1, the layer surface indicates that it doesn't want to be moved to accomodate for other surfaces.

Definition at line 475 of file layershell_v1.cpp.

exclusiveZoneChanged

void KWin::LayerSurfaceV1Interface::exclusiveZoneChanged ( )

signal

isCommitted()

bool KWin::LayerSurfaceV1Interface::isCommitted

(

)

const

Returns true if the initial commit has been performed; otherwise returns false.

Definition at line 420 of file layershell_v1.cpp.

layer()

LayerSurfaceV1Interface::Layer KWin::LayerSurfaceV1Interface::layer

(

)

const

Returns the stacking order layer where this layer surface has to be rendered.

Definition at line 445 of file layershell_v1.cpp.

layerChanged

void KWin::LayerSurfaceV1Interface::layerChanged ( )

signal

leftMargin()

int KWin::LayerSurfaceV1Interface::leftMargin

(

)

const

Returns the value of the left margin. This is equivalent to calling margins().left().

Definition at line 455 of file layershell_v1.cpp.

margins()

QMargins KWin::LayerSurfaceV1Interface::margins

(

)

const

Returns the margins object that indicates the distance between an anchor edge and the corresponding surface edge.

Definition at line 450 of file layershell_v1.cpp.

marginsChanged

void KWin::LayerSurfaceV1Interface::marginsChanged ( )

signal

output()

OutputInterface * KWin::LayerSurfaceV1Interface::output

(

)

const

Returns the output where the surface wants to be displayed. This function can return null, in which case the compositor is free to choose the output where the surface has to be placed.

Definition at line 505 of file layershell_v1.cpp.

rightMargin()

int KWin::LayerSurfaceV1Interface::rightMargin

(

)

const

Returns the value of the right margin. This is equivalent to calling margins().right().

Definition at line 465 of file layershell_v1.cpp.

role()

SurfaceRole * KWin::LayerSurfaceV1Interface::role ( )

static

Definition at line 414 of file layershell_v1.cpp.

scope()

QString KWin::LayerSurfaceV1Interface::scope

(

)

const

Returns the scope of this layer surface. The scope defines the purpose of the surface.

Definition at line 510 of file layershell_v1.cpp.

sendClosed()

void KWin::LayerSurfaceV1Interface::sendClosed

(

)

Sends a closed event to the client. The client should destroy the surface after receiving this event. Further changes to the surface will be ignored.

Definition at line 531 of file layershell_v1.cpp.

sendConfigure()

quint32 KWin::LayerSurfaceV1Interface::sendConfigure

(

const QSize &

size

)

Sends a configure event to the client. size contains the desired size in surface-local coordinates. A size of zero means that the client is free to choose its own dimensions.

See also

configureAcknowledged()

Definition at line 515 of file layershell_v1.cpp.

surface()

SurfaceInterface * KWin::LayerSurfaceV1Interface::surface

(

)

const

Returns the underlying Wayland surface for this layer shell surface.

Definition at line 425 of file layershell_v1.cpp.

topMargin()

int KWin::LayerSurfaceV1Interface::topMargin

(

)

const

Returns the value of the top margin. This is equivalent to calling margins().top().

Definition at line 460 of file layershell_v1.cpp.

---

The documentation for this class was generated from the following files:

• src/wayland/layershell_v1.h
• src/wayland/layershell_v1.cpp