Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::wayland::AbstractWaylandShell< T > Class Template Reference

Represents a Wayland shell class interface boilerplate. More...

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

Public Member Functions

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...
 

Detailed Description

template<typename T>
class kanzi::wayland::AbstractWaylandShell< T >

Represents a Wayland shell class interface boilerplate.

Uses CRTP pattern. The user is encouraged to derive from it and pass itself as a template parameter.

Template Parameters
TCRTP derived class.
Since
Kanzi 3.9.8

Member Function Documentation

template<typename T>
bool kanzi::wayland::AbstractWaylandShell< T >::makeFullscreen ( ) const
inlinenoexcept

Enters the full-screen mode.

See also
WindowedGraphicsOutput::makeFullscreen()
Returns
On success, true, otherwise false.
template<typename T>
bool kanzi::wayland::AbstractWaylandShell< T >::makeRegular ( ) const
inlinenoexcept

Exits the full-screen mode.

See also
WindowedGraphicsOutput::makeRegular()
Returns
On success, true, otherwise false.
template<typename T>
bool kanzi::wayland::AbstractWaylandShell< T >::makeMaximized ( ) const
inlinenoexcept

Resizes the window to take up the entire screen.

See also
WindowedGraphicsOutput::makeMaximized()
Returns
On success, true, otherwise false.
template<typename T>
bool kanzi::wayland::AbstractWaylandShell< T >::makeMinimized ( )
inlinenoexcept

Minimizes the window.

See also
WindowedGraphicsOutput::makeMinimized()
Returns
On success, true, otherwise false.
template<typename T>
bool kanzi::wayland::AbstractWaylandShell< T >::bringToFront ( ) const
inlinenoexcept

Displays the window on top of all other windows.

See also
WindowedGraphicsOutput::bringToFront()
Returns
On success, true, otherwise false.
template<typename T>
bool kanzi::wayland::AbstractWaylandShell< T >::showWindow ( )
inlinenoexcept

Shows the hidden window.

See also
WindowedGraphicsOutput::showWindow()
Returns
On success, true, otherwise false.
template<typename T>
bool kanzi::wayland::AbstractWaylandShell< T >::hideWindow ( )
inlinenoexcept

Hides the window.

See also
WindowedGraphicsOutput::hideWindow()
Returns
On success, true, otherwise false.
template<typename T>
bool kanzi::wayland::AbstractWaylandShell< T >::setWindowTitle ( string_view  title) const
inlinenoexcept

Sets the window title.

See also
WindowedGraphicsOutput::setWindowTitle()
Parameters
titleText to set as the window title.
Returns
On success, true, otherwise false.
template<typename T>
KZ_NO_DISCARD optional<string> kanzi::wayland::AbstractWaylandShell< T >::getWindowTitle ( )
inlinenoexcept

Gets the current window title.

Returns
On success, the current window title, on failure nullopt.

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