Kanzi  3.9.8
Kanzi Engine C++ API
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:
[legend]

Public Member Functions

void setFullscreen () const noexcept
 Enters the full-screen mode. More...
 
void setMaximized () const noexcept
 Resizes a window to take up the entire screen. More...
 
void setTitle (string_view title) const noexcept
 Sets the window title. More...
 
void setTopLevel () const noexcept
 Maps a surface as a toplevel surface. More...
 
 WaylandShellSurface (wl_shell_surface *shellSurfaceHandle) noexcept
 Constructor. More...
 
 WaylandShellSurface (const WaylandShell &waylandShell, const WaylandSurface &waylandSurface) noexcept
 Constructor. More...
 
- 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. More...
 
KZ_NO_DISCARD unsigned int askVersion () const noexcept
 Requests compositor which interface version we use. More...
 
KZ_NO_DISCARD wl_shell_surface * getNativeHandle () const noexcept
 Gets the underlying native handle. More...
 

Static Public Attributes

static const wl_interface s_nativeInterface
 Represents the underlying native interface. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::wayland::WaylandInterface< WaylandShellSurface, wl_shell_surface, wl_shell_surface_listener >
using ListenerType = wl_shell_surface_listener
 Generic alias to query for appropriate listener type. More...
 
- 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. More...
 

Detailed Description

Wayland shell surface wrapper class.

Since
Kanzi 3.9.8

Constructor & Destructor Documentation

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

Constructor.

Parameters
shellSurfaceHandleNative Wayland handle.
kanzi::wayland::WaylandShellSurface::WaylandShellSurface ( const WaylandShell waylandShell,
const WaylandSurface waylandSurface 
)
explicitnoexcept

Constructor.

Parameters
waylandShellWayland shell.
waylandSurfaceWayland surface.

Member Function Documentation

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

Maps a surface as a toplevel surface.

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

Resizes a window to take up the entire screen.

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

Enters the full-screen mode.

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

Sets the window title.

Parameters
titleText to set as the window title.
Returns
On success, true, otherwise false.

Member Data Documentation

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: