KWin::XdgPopupInterface Class Reference

#include <xdgshell.h>

Inheritance diagram for KWin::XdgPopupInterface:

Signals
void	aboutToBeDestroyed ()
void	initializeRequested ()
void	grabRequested (SeatInterface *seat, quint32 serial)
void	repositionRequested (quint32 token)

Public Member Functions
	XdgPopupInterface (XdgSurfaceInterface *surface, SurfaceInterface *parentSurface, const XdgPositioner &positioner, ::wl_resource *resource)
	~XdgPopupInterface () override
XdgShellInterface *	shell () const
SurfaceInterface *	parentSurface () const
XdgSurfaceInterface *	xdgSurface () const
SurfaceInterface *	surface () const
XdgPositioner	positioner () const
bool	isConfigured () const
quint32	sendConfigure (const QRect &rect)
void	sendPopupDone ()
void	sendRepositioned (quint32 token)

Static Public Member Functions
static SurfaceRole *	role ()
static XdgPopupInterface *	get (::wl_resource *resource)

Friends
class	XdgPopupInterfacePrivate

Detailed Description

The XdgPopupInterface class represents a surface that can be used to implement context menus, popovers and other similar short-lived user interface elements.

XdgPopupInterface corresponds to the Wayland interface xdg_popup.

Definition at line 490 of file xdgshell.h.

Constructor & Destructor Documentation

XdgPopupInterface()

KWin::XdgPopupInterface::XdgPopupInterface	(	XdgSurfaceInterface *	surface,
		SurfaceInterface *	parentSurface,
		const XdgPositioner &	positioner,
		::wl_resource *	resource )

Definition at line 759 of file xdgshell.cpp.

~XdgPopupInterface()

KWin::XdgPopupInterface::~XdgPopupInterface ( )

override

Destructs the XdgPopupInterface object.

Definition at line 771 of file xdgshell.cpp.

Member Function Documentation

aboutToBeDestroyed

void KWin::XdgPopupInterface::aboutToBeDestroyed ( )

signal

This signal is emitted when the xdg-popup is about to be destroyed.

get()

XdgPopupInterface * KWin::XdgPopupInterface::get ( ::wl_resource * resource )

static

Returns the XdgPopupInterface for the specified wayland resource object resource.

Definition at line 835 of file xdgshell.cpp.

grabRequested

void KWin::XdgPopupInterface::grabRequested ( SeatInterface * seat, quint32 serial )

signal

initializeRequested

void KWin::XdgPopupInterface::initializeRequested ( )

signal

This signal is emitted when the xdg-popup has commited the initial state and wants to be configured. After initializing the popup, you must send a configure event.

isConfigured()

bool KWin::XdgPopupInterface::isConfigured

(

)

const

Returns true if the popup has been configured; otherwise returns false.

Definition at line 801 of file xdgshell.cpp.

parentSurface()

SurfaceInterface * KWin::XdgPopupInterface::parentSurface

(

)

const

Returns the parent surface for this popup surface. If the initial state hasn't been committed yet, this function may return null.

Definition at line 786 of file xdgshell.cpp.

positioner()

XdgPositioner KWin::XdgPopupInterface::positioner

(

)

const

Returns the XdgPositioner assigned to this XdgPopupInterface.

Definition at line 806 of file xdgshell.cpp.

repositionRequested

void KWin::XdgPopupInterface::repositionRequested ( quint32 token )

signal

role()

SurfaceRole * KWin::XdgPopupInterface::role ( )

static

Definition at line 780 of file xdgshell.cpp.

sendConfigure()

quint32 KWin::XdgPopupInterface::sendConfigure

(

const QRect &

rect

)

Sends a configure event to the client and returns the serial number of the event.

Definition at line 811 of file xdgshell.cpp.

sendPopupDone()

void KWin::XdgPopupInterface::sendPopupDone

(

)

Sends a popup done event to the client.

Definition at line 824 of file xdgshell.cpp.

sendRepositioned()

void KWin::XdgPopupInterface::sendRepositioned

(

quint32

token

)

Sends a popup repositioned event to the client.

Definition at line 829 of file xdgshell.cpp.

shell()

XdgShellInterface * KWin::XdgPopupInterface::shell

(

)

const

surface()

SurfaceInterface * KWin::XdgPopupInterface::surface

(

)

const

Returns the SurfaceInterface associated with the XdgPopupInterface.

Definition at line 796 of file xdgshell.cpp.

xdgSurface()

XdgSurfaceInterface * KWin::XdgPopupInterface::xdgSurface

(

)

const

Returns the XdgSurfaceInterface associated with the XdgPopupInterface.

Definition at line 791 of file xdgshell.cpp.

Friends And Related Symbol Documentation

XdgPopupInterfacePrivate

friend class XdgPopupInterfacePrivate

friend

Definition at line 567 of file xdgshell.h.

---

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

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