KWin
Loading...
Searching...
No Matches
Signals | Public Member Functions | Static Public Member Functions | Friends | List of all members
KWin::XdgSurfaceInterface Class Reference

#include <xdgshell.h>

Inheritance diagram for KWin::XdgSurfaceInterface:

Signals

void aboutToBeDestroyed ()
 
void configureAcknowledged (quint32 serial)
 
void windowGeometryChanged (const QRect &rect)
 
void resetOccurred ()
 

Public Member Functions

 XdgSurfaceInterface (XdgShellInterface *shell, SurfaceInterface *surface, ::wl_resource *resource)
 
 ~XdgSurfaceInterface () override
 
XdgToplevelInterfacetoplevel () const
 
XdgPopupInterfacepopup () const
 
XdgShellInterfaceshell () const
 
SurfaceInterfacesurface () const
 
bool isConfigured () const
 
QRect windowGeometry () const
 

Static Public Member Functions

static XdgSurfaceInterfaceget (::wl_resource *resource)
 

Friends

class XdgSurfaceInterfacePrivate
 

Detailed Description

The XdgSurfaceInterface class provides a base set of functionality required to construct user interface elements.

XdgSurfaceInterface corresponds to the Wayland interface xdg_surface.

Definition at line 121 of file xdgshell.h.

Constructor & Destructor Documentation

◆ XdgSurfaceInterface()

KWin::XdgSurfaceInterface::XdgSurfaceInterface ( XdgShellInterface * shell,
SurfaceInterface * surface,
::wl_resource * resource )

Constructs an XdgSurfaceInterface for the given shell and surface.

Definition at line 277 of file xdgshell.cpp.

◆ ~XdgSurfaceInterface()

KWin::XdgSurfaceInterface::~XdgSurfaceInterface ( )
override

Destructs the XdgSurfaceInterface object.

Definition at line 285 of file xdgshell.cpp.

Member Function Documentation

◆ aboutToBeDestroyed

void KWin::XdgSurfaceInterface::aboutToBeDestroyed ( )
signal

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

◆ configureAcknowledged

void KWin::XdgSurfaceInterface::configureAcknowledged ( quint32 serial)
signal

This signal is emitted when a configure event with serial serial has been acknowledged.

◆ get()

XdgSurfaceInterface * KWin::XdgSurfaceInterface::get ( ::wl_resource * resource)
static

Returns the XdgSurfaceInterface for the specified wayland resource object resource.

Definition at line 324 of file xdgshell.cpp.

◆ isConfigured()

bool KWin::XdgSurfaceInterface::isConfigured ( ) const

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

Definition at line 314 of file xdgshell.cpp.

◆ popup()

XdgPopupInterface * KWin::XdgSurfaceInterface::popup ( ) const

Returns the XdgPopupInterface associated with this XdgSurfaceInterface.

This method will return null if no xdg_popup object is associated with this surface.

Definition at line 299 of file xdgshell.cpp.

◆ resetOccurred

void KWin::XdgSurfaceInterface::resetOccurred ( )
signal

This signal is emitted when the surface has been unmapped and its state has been reset.

◆ shell()

XdgShellInterface * KWin::XdgSurfaceInterface::shell ( ) const

Returns the XdgShellInterface associated with this XdgSurfaceInterface.

Definition at line 304 of file xdgshell.cpp.

◆ surface()

SurfaceInterface * KWin::XdgSurfaceInterface::surface ( ) const

Returns the SurfaceInterface assigned to this XdgSurfaceInterface.

Definition at line 309 of file xdgshell.cpp.

◆ toplevel()

XdgToplevelInterface * KWin::XdgSurfaceInterface::toplevel ( ) const

Returns the XdgToplevelInterface associated with this XdgSurfaceInterface.

This method will return null if no xdg_toplevel object is associated with this surface.

Definition at line 294 of file xdgshell.cpp.

◆ windowGeometry()

QRect KWin::XdgSurfaceInterface::windowGeometry ( ) const

Returns the window geometry of the XdgSurfaceInterface.

This method will return an invalid QRect if the window geometry is not set by the client.

Definition at line 319 of file xdgshell.cpp.

◆ windowGeometryChanged

void KWin::XdgSurfaceInterface::windowGeometryChanged ( const QRect & rect)
signal

This signal is emitted when the window geometry has been changed.

Friends And Related Symbol Documentation

◆ XdgSurfaceInterfacePrivate

friend class XdgSurfaceInterfacePrivate
friend

Definition at line 199 of file xdgshell.h.


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