kanzi::wayland::WaylandShellSurface Class Reference

Wayland shell surface wrapper class. More...

#include <kanzi/core.ui/platform/windowing_ng/wayland/shells/core/wayland_shell_surface.hpp>

Inheritance diagram for kanzi::wayland::WaylandShellSurface:

Public Member Functions
void	setFullscreen () const noexcept
	Enters the full-screen mode.
void	setMaximized () const noexcept
	Resizes a window to take up the entire screen.
void	setTitle (string_view title) const noexcept
	Sets the window title.
void	setTopLevel () const noexcept
	Maps a surface as a toplevel surface.
	WaylandShellSurface (const WaylandShell &waylandShell, const WaylandSurface &waylandSurface) noexcept
	Constructor.
	WaylandShellSurface (wl_shell_surface *shellSurfaceHandle) noexcept
	Constructor.
Public Member Functions inherited from kanzi::wayland::WaylandInterface< WaylandShellSurface, wl_shell_surface, wl_shell_surface_listener >
bool	addListener (enable_if_t<!is_same< L, void >::value, const L & > listener, void *data) const noexcept
	Adds a listener to Wayland object.
KZ_NO_DISCARD unsigned int	askVersion () const noexcept
	Requests compositor which interface version we use.
KZ_NO_DISCARD wl_shell_surface *	getNativeHandle () const noexcept
	Gets the underlying native handle.

Static Public Attributes
static const wl_interface	s_nativeInterface
	Represents the underlying native interface.

Additional Inherited Members
Public Types inherited from kanzi::wayland::WaylandInterface< WaylandShellSurface, wl_shell_surface, wl_shell_surface_listener >
using	ListenerType
	Generic alias to query for appropriate listener type.
Static Public Member Functions inherited from kanzi::wayland::WaylandInterface< WaylandShellSurface, wl_shell_surface, wl_shell_surface_listener >
static KZ_NO_DISCARD unsigned int	askVersion (wl_shell_surface *handle) noexcept
	Requests compositor which interface version we use.

Detailed Description

Wayland shell surface wrapper class.

Since

Kanzi 3.9.8

Constructor & Destructor Documentation

WaylandShellSurface() [1/2]

kanzi::wayland::WaylandShellSurface::WaylandShellSurface ( wl_shell_surface * shellSurfaceHandle )

explicitnoexcept

Constructor.

Parameters

shellSurfaceHandle

Native Wayland handle.

WaylandShellSurface() [2/2]

kanzi::wayland::WaylandShellSurface::WaylandShellSurface ( const WaylandShell & waylandShell, const WaylandSurface & waylandSurface )

explicitnoexcept

Constructor.

Parameters

waylandShell	Wayland shell.
waylandSurface	Wayland surface.

Member Function Documentation

setTopLevel()

void kanzi::wayland::WaylandShellSurface::setTopLevel ( ) const

noexcept

Maps a surface as a toplevel surface.

setMaximized()

void kanzi::wayland::WaylandShellSurface::setMaximized ( ) const

noexcept

Resizes a window to take up the entire screen.

setFullscreen()

void kanzi::wayland::WaylandShellSurface::setFullscreen ( ) const

noexcept

Enters the full-screen mode.

setTitle()

void kanzi::wayland::WaylandShellSurface::setTitle ( string_view title ) const

noexcept

Sets the window title.

Parameters

title

Text to set as the window title.

Returns

On success, true, otherwise false.

Member Data Documentation

s_nativeInterface

const wl_interface kanzi::wayland::WaylandShellSurface::s_nativeInterface

static

Represents the underlying native interface.

---

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

• kanzi/core.ui/platform/windowing_ng/wayland/shells/core/wayland_shell_surface.hpp