Class representing XDG toplevel methods. More...

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

Inheritance diagram for kanzi::wayland::XdgToplevelMethods:

Public Member Functions
void	setFullscreenOnDefaultDisplay () const noexcept
	Sets the toplevel as full-screen on the default display.

void	setId (string_view id) const noexcept
	Sets the application ID.

void	setMaximizedOnDefaultDisplay () const noexcept
	Sets the toplevel as maximized on the default display.

void	setMinimizedOnDefaultDisplay () const noexcept
	Sets the toplevel as minimized on the default display.

void	setTitle (string_view title) const noexcept
	Sets the window title.

void	unsetFullscreenOnDefaultDisplay () const noexcept
	Unsets the toplevel as full-screen on the default display.

void	unsetMaximizedOnDefaultDisplay () const noexcept
	Unsets the toplevel as maximized on the default display.

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
	XdgToplevelMethods () noexcept=default
	Constructor.

	XdgToplevelMethods (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 XdgToplevelMethods	create (const XdgSurface &xdgSurface) noexcept
	Creates an XdgToplevel from a given XdgSurface.

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 XDG toplevel methods.

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

See also: XdgToplevel

Since: Kanzi 3.9.8; Kanzi 4.0.0 XdgToplevel is now a safe wrapper around XdgToplevelMethods.

Constructor & Destructor Documentation

◆ XdgToplevelMethods() [1/2]

kanzi::wayland::XdgToplevelMethods::XdgToplevelMethods ( )

explicitprotecteddefaultnoexcept

Constructor.

◆ XdgToplevelMethods() [2/2]

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

explicitprotectednoexcept

Constructor.

Parameters

handle Native handle.

Member Function Documentation

◆ setFullscreenOnDefaultDisplay()

void kanzi::wayland::XdgToplevelMethods::setFullscreenOnDefaultDisplay ( ) const

noexcept

Sets the toplevel as full-screen on the default display.

◆ unsetFullscreenOnDefaultDisplay()

void kanzi::wayland::XdgToplevelMethods::unsetFullscreenOnDefaultDisplay ( ) const

noexcept

Unsets the toplevel as full-screen on the default display.

◆ setMaximizedOnDefaultDisplay()

void kanzi::wayland::XdgToplevelMethods::setMaximizedOnDefaultDisplay ( ) const

noexcept

Sets the toplevel as maximized on the default display.

◆ unsetMaximizedOnDefaultDisplay()

void kanzi::wayland::XdgToplevelMethods::unsetMaximizedOnDefaultDisplay ( ) const

noexcept

Unsets the toplevel as maximized on the default display.

◆ setMinimizedOnDefaultDisplay()

void kanzi::wayland::XdgToplevelMethods::setMinimizedOnDefaultDisplay ( ) const

noexcept

Sets the toplevel as minimized on the default display.

◆ setTitle()

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

noexcept

Sets the window title.

Parameters

title Title to set.

◆ setId()

void kanzi::wayland::XdgToplevelMethods::setId ( string_view id ) const

noexcept

Sets the application ID.

Parameters

id	Application ID to set.

Since: Kanzi 4.0.0

◆ create()

static KZ_NO_DISCARD XdgToplevelMethods kanzi::wayland::XdgToplevelMethods::create ( const XdgSurface & xdgSurface )

staticprotectednoexcept

Creates an XdgToplevel from a given XdgSurface.

Parameters

xdgSurface Xdg surface to construct XdgToplevel from.

Returns: Created XdgToplevel.

Since: Kanzi 4.0.0

Member Data Documentation

◆ s_nativeInterface

const wl_interface kanzi::wayland::XdgToplevelMethods::s_nativeInterface

static

Represents the underlying native interface.

◆ s_maxVersion

const uint32_t kanzi::wayland::XdgToplevelMethods::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/xdg/wayland_xdg_toplevel.hpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XdgToplevelMethods() [1/2]

◆ XdgToplevelMethods() [2/2]

Member Function Documentation

◆ setFullscreenOnDefaultDisplay()

◆ unsetFullscreenOnDefaultDisplay()

◆ setMaximizedOnDefaultDisplay()

◆ unsetMaximizedOnDefaultDisplay()

◆ setMinimizedOnDefaultDisplay()

◆ setTitle()

◆ setId()

◆ create()

Member Data Documentation

◆ s_nativeInterface

◆ s_maxVersion