kanzi::wayland::XDGShell Class Reference

Wayland XDG Shell abstraction. More...

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

Inheritance diagram for kanzi::wayland::XDGShell:

Public Types
using	InterfaceType
	Generic alias to query the underlying interface type.

Public Member Functions
bool	addListener (const xdg_surface_listener &listener, void *data) const noexcept
	Adds a listener to the underlying XDGSurface.
bool	addListener (const xdg_toplevel_listener &listener, void *data) const noexcept
	Adds a listener to the underlying XDGToplevel.
bool	addListener (const xdg_wm_base_listener &listener, void *data) const noexcept
	Adds a listener to the underlying XDGWMBase.
KZ_NO_DISCARD const XDGSurface &	getXDGSurface () const noexcept
	Gets the underlying XDGSurface.
KZ_NO_DISCARD const XDGToplevel &	getXDGToplevel () const noexcept
	Gets the underlying XDGToplevel.
bool	makeFullscreen () const noexcept
	AbstractWaylandShell::makeFullscreen() implementation.
bool	makeMaximized () const noexcept
	AbstractWaylandShell::makeMaximized() implementation.
bool	makeMinimized () const noexcept
	AbstractWaylandShell::makeMinimized() implementation.
bool	makeRegular () const noexcept
	AbstractWaylandShell::makeRegular() implementation.
bool	setWindowTitle (string_view title) const noexcept
	AbstractWaylandShell::setWindowTitle() implementation.
	XDGShell (xdg_wm_base *nativeHandle, const WaylandSurface &waylandSurface) noexcept
	Constructor.
Public Member Functions inherited from kanzi::wayland::AbstractWaylandShell< XDGShell >
bool	bringToFront () const noexcept
	Displays the window on top of all other windows.
KZ_NO_DISCARD optional< string >	getWindowTitle () noexcept
	Gets the current window title.
bool	hideWindow () noexcept
	Hides the window.
bool	makeFullscreen () const noexcept
	Enters the full-screen mode.
bool	makeMaximized () const noexcept
	Resizes the window to take up the entire screen.
bool	makeMinimized () noexcept
	Minimizes the window.
bool	makeRegular () const noexcept
	Exits the full-screen mode.
bool	setWindowTitle (string_view title) const noexcept
	Sets the window title.
bool	showWindow () noexcept
	Shows the hidden window.

Static Public Member Functions
static bool	bringToFront () noexcept
	AbstractWaylandShell::bringToFront() implementation.
static KZ_NO_DISCARD optional< string >	getWindowTitle () noexcept
	AbstractWaylandShell::getWindowTitle() implementation.
static bool	hideWindow () noexcept
	AbstractWaylandShell::hideWindow() implementation.
static bool	showWindow () noexcept
	AbstractWaylandShell::showWindow() implementation.

Detailed Description

Wayland XDG Shell abstraction.

Note

This shell is the successor of the deprecated CoreShell.

Since

Kanzi 3.9.8

Member Typedef Documentation

InterfaceType

using kanzi::wayland::XDGShell::InterfaceType

Generic alias to query the underlying interface type.

Constructor & Destructor Documentation

XDGShell()

kanzi::wayland::XDGShell::XDGShell ( xdg_wm_base * nativeHandle, const WaylandSurface & waylandSurface )

explicitnoexcept

Constructor.

Parameters

nativeHandle	Native handle provided by Wayland.
waylandSurface	Associated Wayland surface.

Member Function Documentation

makeFullscreen()

bool kanzi::wayland::XDGShell::makeFullscreen ( ) const

noexcept

AbstractWaylandShell::makeFullscreen() implementation.

makeRegular()

bool kanzi::wayland::XDGShell::makeRegular ( ) const

noexcept

AbstractWaylandShell::makeRegular() implementation.

makeMaximized()

bool kanzi::wayland::XDGShell::makeMaximized ( ) const

noexcept

AbstractWaylandShell::makeMaximized() implementation.

makeMinimized()

bool kanzi::wayland::XDGShell::makeMinimized ( ) const

noexcept

AbstractWaylandShell::makeMinimized() implementation.

bringToFront()

static bool kanzi::wayland::XDGShell::bringToFront ( )

staticnoexcept

AbstractWaylandShell::bringToFront() implementation.

showWindow()

static bool kanzi::wayland::XDGShell::showWindow ( )

staticnoexcept

AbstractWaylandShell::showWindow() implementation.

hideWindow()

static bool kanzi::wayland::XDGShell::hideWindow ( )

staticnoexcept

AbstractWaylandShell::hideWindow() implementation.

setWindowTitle()

bool kanzi::wayland::XDGShell::setWindowTitle ( string_view title ) const

noexcept

AbstractWaylandShell::setWindowTitle() implementation.

getWindowTitle()

static KZ_NO_DISCARD optional< string > kanzi::wayland::XDGShell::getWindowTitle ( )

staticnoexcept

AbstractWaylandShell::getWindowTitle() implementation.

getXDGToplevel()

KZ_NO_DISCARD const XDGToplevel & kanzi::wayland::XDGShell::getXDGToplevel ( ) const

noexcept

Gets the underlying XDGToplevel.

Returns

XDGToplevel object.

getXDGSurface()

KZ_NO_DISCARD const XDGSurface & kanzi::wayland::XDGShell::getXDGSurface ( ) const

noexcept

Gets the underlying XDGSurface.

Returns

XDGSurface object.

addListener() [1/3]

bool kanzi::wayland::XDGShell::addListener ( const xdg_toplevel_listener & listener, void * data ) const

noexcept

Adds a listener to the underlying XDGToplevel.

Parameters

listener	Listener to attach.
data	Data pointer to receive when the listener is called.

Returns

On success, true, otherwise false.

addListener() [2/3]

bool kanzi::wayland::XDGShell::addListener ( const xdg_surface_listener & listener, void * data ) const

noexcept

Adds a listener to the underlying XDGSurface.

Parameters

listener	Listener to attach.
data	Data pointer to receive when the listener is called.

Returns

On success, true, otherwise false.

addListener() [3/3]

bool kanzi::wayland::XDGShell::addListener ( const xdg_wm_base_listener & listener, void * data ) const

noexcept

Adds a listener to the underlying XDGWMBase.

Parameters

listener	Listener to attach.
data	Data pointer to receive when the listener is called.

Returns

On success, true, otherwise false.

---

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

• kanzi/core.ui/platform/windowing_ng/wayland/shells/xdg/wayland_xdg_shell.hpp