KWin::XdgShellInterface Class Reference

#include <xdgshell.h>

Inheritance diagram for KWin::XdgShellInterface:

Signals
void	toplevelCreated (XdgToplevelInterface *toplevel)
void	popupCreated (XdgPopupInterface *popup)
void	pongReceived (quint32 serial)
void	pingTimeout (quint32 serial)
void	pingDelayed (quint32 serial)

Public Member Functions
	XdgShellInterface (Display *display, QObject *parent=nullptr)
	~XdgShellInterface () override
Display *	display () const
quint32	ping (XdgSurfaceInterface *surface)
std::chrono::milliseconds	pingTimeoutInterval () const
void	setPingTimeoutInterval (std::chrono::milliseconds pingTimeout)

Friends
class	XdgShellInterfacePrivate

Detailed Description

The XdgShellInterface class represents an extension for destrop-style user interfaces.

The XdgShellInterface class provides a way for a client to extend a regular Wayland surface with functionality required to construct user interface elements, e.g. toplevel windows or menus.

XdgShellInterface corresponds to the WaylandInterface xdg_wm_base.

Definition at line 44 of file xdgshell.h.

Constructor & Destructor Documentation

XdgShellInterface()

KWin::XdgShellInterface::XdgShellInterface	(	Display *	display,
		QObject *	parent = nullptr )

Constructs an XdgShellInterface object with the given wayland display display.

Definition at line 108 of file xdgshell.cpp.

~XdgShellInterface()

KWin::XdgShellInterface::~XdgShellInterface ( )

override

Destructs the XdgShellInterface object.

Definition at line 116 of file xdgshell.cpp.

Member Function Documentation

display()

Display * KWin::XdgShellInterface::display

(

)

const

Returns the wayland display of the XdgShellInterface.

Definition at line 120 of file xdgshell.cpp.

ping()

quint32 KWin::XdgShellInterface::ping

(

XdgSurfaceInterface *

surface

)

Sends a ping event to the client with the given xdg-surface surface. If the client replies to the event within a reasonable amount of time, pongReceived signal will be emitted.

Definition at line 125 of file xdgshell.cpp.

pingDelayed

void KWin::XdgShellInterface::pingDelayed ( quint32 serial )

signal

This signal is emitted when the client has not responded to a ping event with serial serial within a reasonable amount of time.

pingTimeout

void KWin::XdgShellInterface::pingTimeout ( quint32 serial )

signal

Todo

Drop this signal.

This signal is emitted when the client has not responded to a ping event with serial serial within a reasonable amount of time and the compositor gave up on it.

pingTimeoutInterval()

std::chrono::milliseconds KWin::XdgShellInterface::pingTimeoutInterval

(

)

const

Returns the ping timeout.

Definition at line 138 of file xdgshell.cpp.

pongReceived

void KWin::XdgShellInterface::pongReceived ( quint32 serial )

signal

This signal is emitted when the client has responded to a ping event with serial serial.

popupCreated

void KWin::XdgShellInterface::popupCreated ( XdgPopupInterface * popup )

signal

This signal is emitted when a new XdgPopupInterface object is created.

setPingTimeoutInterval()

void KWin::XdgShellInterface::setPingTimeoutInterval

(

std::chrono::milliseconds

pingTimeout

)

Set the ping timeout.

Definition at line 143 of file xdgshell.cpp.

toplevelCreated

void KWin::XdgShellInterface::toplevelCreated ( XdgToplevelInterface * toplevel )

signal

This signal is emitted when a new XdgToplevelInterface object is created.

Friends And Related Symbol Documentation

XdgShellInterfacePrivate

friend class XdgShellInterfacePrivate

friend

Definition at line 112 of file xdgshell.h.

---

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

• src/wayland/xdgshell.h
• src/wayland/xdgshell.cpp