kanzi::wayland::CoreShell Class Reference

Wayland Core Shell abstraction. More...

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

Inheritance diagram for kanzi::wayland::CoreShell:

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

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

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

Detailed Description

Wayland Core Shell abstraction.

Note

This shell has been deprecated by Wayland community and is not supported by many compositors. However, this was the original shell available in Wayland and is still the only shell supported on old systems. On modern systems, use XDG shell instead.

See also

XDGShell

Since

Kanzi 3.9.8

Member Typedef Documentation

using kanzi::wayland::CoreShell::InterfaceType = WaylandShell

Generic alias to query the underlying interface type.

Constructor & Destructor Documentation

kanzi::wayland::CoreShell::CoreShell ( wl_shell *  nativeHandle, const WaylandSurface &  waylandSurface  )

explicitnoexcept

Constructor.

Parameters

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

Member Function Documentation

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

noexcept

AbstractWaylandShell::makeFullscreen() implementation.

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

noexcept

AbstractWaylandShell::makeRegular() implementation.

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

noexcept

AbstractWaylandShell::makeMaximized() implementation.

static bool kanzi::wayland::CoreShell::makeMinimized ( )

staticnoexcept

AbstractWaylandShell::makeMinimized() implementation.

bool kanzi::wayland::CoreShell::bringToFront ( ) const

noexcept

AbstractWaylandShell::bringToFront() implementation.

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

staticnoexcept

AbstractWaylandShell::showWindow() implementation.

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

staticnoexcept

AbstractWaylandShell::hideWindow() implementation.

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

noexcept

AbstractWaylandShell::setWindowTitle() implementation.

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

staticnoexcept

AbstractWaylandShell::getWindowTitle() implementation.

bool kanzi::wayland::CoreShell::addListener ( const wl_shell_surface_listener &  listener, void *  data  ) const

noexcept

Adds a listener to the underlying WaylandShellSurface.

Parameters

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

Returns

On success, true, otherwise false.

KZ_NO_DISCARD const WaylandShellSurface& kanzi::wayland::CoreShell::getShellSurface ( ) const

noexcept

Gets the underlying WaylandShellSurface.

Returns

WaylandShellSurface object.

---

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

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