Class representing Wayland shell_surface methods. More...

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

Inheritance diagram for kanzi::wayland::WaylandShellSurfaceMethods:

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.

Static Public Attributes
static const uint32_t	s_maxVersion
	Represents maximum interface version supported by the Wayland implementation that Kanzi libraries were compiled against.

static const wl_interface	s_nativeInterface
	Represents the underlying native interface.

Protected Member Functions
	WaylandShellSurfaceMethods () noexcept=default
	Constructor.

	WaylandShellSurfaceMethods (const NativeHandleType &handle) noexcept
	Constructor.

Protected Member Functions inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
KZ_NO_DISCARD optional< T >	createOptional () const noexcept
	Creates a kanzi::optional copy of the native handle.

KZ_NO_DISCARD const T	get () const noexcept
	Provides access to stored handle.

KZ_NO_DISCARD T	get () noexcept
	Provides access to stored handle.

KZ_NO_DISCARD const T	getNativeHandle () const noexcept
	Provides access to stored handle.

KZ_NO_DISCARD T	getNativeHandle () noexcept
	Provides access to stored handle.

KZ_NO_DISCARD bool	hasValue () const noexcept
	Checks if a handle is stored.

KZ_NO_DISCARD	operator bool () const noexcept
	Conversion operator to bool.

KZ_NO_DISCARD T &&	operator* () &&noexcept
	Provides access to stored handle via rvalue reference.

KZ_NO_DISCARD T &	operator* () &noexcept
	Provides access to stored handle via reference.

KZ_NO_DISCARD const T &&	operator* () const &&noexcept
	Provides access to stored handle via const rvalue reference.

KZ_NO_DISCARD const T &	operator* () const &noexcept
	Provides access to stored handle via const reference.

OptionalHandle &	operator= (const OptionalHandle &other)=delete
	Copy assignment operator.

OptionalHandle &	operator= (const T &value)
	Copy assignment operator.

OptionalHandle &	operator= (OptionalHandle &&other) noexcept
	Move assignment operator.

OptionalHandle &	operator= (T &&value) noexcept
	Move assignment operator.

	OptionalHandle () noexcept
	Constructor.

	OptionalHandle (const OptionalHandle &other)=delete
	Copy constructor.

	OptionalHandle (const T &nativeHandle) noexcept
	Constructor.

	OptionalHandle (OptionalHandle &&other) noexcept
	Move constructor.

T	release () noexcept
	Releases ownership of a native handle without destroying the resource.

void	reset () noexcept
	Replaces stored handle with sentinel value.

template<typename U , typename = enable_if_t<is_same_v<T, decay_t<U>>>>
void	reset (U &&newHandle) noexcept
	Stores a new handle inside.

void	swap (OptionalHandle &other)
	Swap function.

KZ_NO_DISCARD optional< T >	toOptional () &&noexcept
	Converts OptionalHandle to kanzi::optional.

	~OptionalHandle ()
	Destructor.

Static Protected Member Functions
static KZ_NO_DISCARD WaylandShellSurfaceMethods	create (const WaylandShell &waylandShell, const WaylandSurface &waylandSurface) noexcept
	Creates new WaylandShellSurface.

Static Protected Member Functions inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
static constexpr auto	getDeleter () noexcept
	Gets deleter function.

static constexpr T	getSentinel () noexcept
	Gets sentinel value that can be used to represent invalid handle.

Additional Inherited Members
Protected Types inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
using	HandleType
	Alias for this handle type.

using	NativeHandleType
	Alias for the underlying native handle type.

Protected Attributes inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
FlatOptional< T, sentinel >	m_handle
	Native handle that is managed by this class.

Detailed Description

Class representing Wayland shell_surface methods.

Note: Do not use this class directly. Use WaylandShellSurface instead.

See also: WaylandShellSurface

Since: Kanzi 3.9.8; Kanzi 4.0.0 WaylandShellSurface is now a safe wrapper around WaylandShellSurfaceMethods.

Constructor & Destructor Documentation

◆ WaylandShellSurfaceMethods() [1/2]

kanzi::wayland::WaylandShellSurfaceMethods::WaylandShellSurfaceMethods ( )

explicitprotecteddefaultnoexcept

Constructor.

◆ WaylandShellSurfaceMethods() [2/2]

kanzi::wayland::WaylandShellSurfaceMethods::WaylandShellSurfaceMethods ( const NativeHandleType & handle )

explicitprotectednoexcept

Constructor.

Parameters

handle Native handle.

Member Function Documentation

◆ setTopLevel()

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

noexcept

Maps a surface as a toplevel surface.

◆ setMaximized()

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

noexcept

Resizes a window to take up the entire screen.

◆ setFullscreen()

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

noexcept

Enters the full-screen mode.

◆ setTitle()

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

noexcept

Sets the window title.

Parameters

title Text to set as the window title.

◆ create()

static KZ_NO_DISCARD WaylandShellSurfaceMethods kanzi::wayland::WaylandShellSurfaceMethods::create	(	const WaylandShell &	waylandShell,
		const WaylandSurface &	waylandSurface )

staticprotectednoexcept

Creates new WaylandShellSurface.

Parameters

waylandShell	Wayland shell.
waylandSurface	Wayland surface.

Returns: Created WaylandShellSurface.

Since: Kanzi 4.0.0

Member Data Documentation

◆ s_nativeInterface

const wl_interface kanzi::wayland::WaylandShellSurfaceMethods::s_nativeInterface

static

Represents the underlying native interface.

◆ s_maxVersion

const uint32_t kanzi::wayland::WaylandShellSurfaceMethods::s_maxVersion

static

Represents maximum interface version supported by the Wayland implementation that Kanzi libraries were compiled against.

Defines correct maximum possible interface version based on available events and requests.

Since: Kanzi 4.0.0

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

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WaylandShellSurfaceMethods() [1/2]

◆ WaylandShellSurfaceMethods() [2/2]

Member Function Documentation

◆ setTopLevel()

◆ setMaximized()

◆ setFullscreen()

◆ setTitle()

◆ create()

Member Data Documentation

◆ s_nativeInterface

◆ s_maxVersion