kanzi::wayland::IVIShell Class Reference

Wayland IVI Shell abstraction. More...

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

Inheritance diagram for kanzi::wayland::IVIShell:

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

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

Static Public Member Functions
static bool	bringToFront () noexcept
	AbstractWaylandShell::bringToFront() implementation.
static KZ_NO_DISCARD optional< string >	getWindowTitle () noexcept
	AbstractWaylandShell::getWindowTitle() implementation.
static bool	hideWindow () noexcept
	AbstractWaylandShell::hideWindow() implementation.
static bool	makeFullscreen () noexcept
	AbstractWaylandShell::makeFullscreen() implementation.
static bool	makeMaximized () noexcept
	AbstractWaylandShell::makeMaximized() implementation.
static bool	makeMinimized () noexcept
	AbstractWaylandShell::makeMinimized() implementation.
static bool	makeRegular () noexcept
	AbstractWaylandShell::makeRegular() implementation.
static bool	setWindowTitle (string_view title) noexcept
	AbstractWaylandShell::setWindowTitle() implementation.
static bool	showWindow () noexcept
	AbstractWaylandShell::showWindow() implementation.

Detailed Description

Wayland IVI Shell abstraction.

Since

Kanzi 3.9.8

Member Typedef Documentation

InterfaceType

using kanzi::wayland::IVIShell::InterfaceType

Generic alias to query the underlying interface type.

Constructor & Destructor Documentation

IVIShell()

kanzi::wayland::IVIShell::IVIShell ( ivi_application * nativeHandle, const WaylandSurface & waylandSurface, uint32_t iviId )

explicitnoexcept

Constructor.

Parameters

nativeHandle	Native handle provided by Wayland.
waylandSurface	Associated Wayland surface.
iviId	IVI ID to assign to the created shell.

Member Function Documentation

makeFullscreen()

static bool kanzi::wayland::IVIShell::makeFullscreen ( )

staticnoexcept

AbstractWaylandShell::makeFullscreen() implementation.

makeRegular()

static bool kanzi::wayland::IVIShell::makeRegular ( )

staticnoexcept

AbstractWaylandShell::makeRegular() implementation.

makeMaximized()

static bool kanzi::wayland::IVIShell::makeMaximized ( )

staticnoexcept

AbstractWaylandShell::makeMaximized() implementation.

makeMinimized()

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

staticnoexcept

AbstractWaylandShell::makeMinimized() implementation.

bringToFront()

static bool kanzi::wayland::IVIShell::bringToFront ( )

staticnoexcept

AbstractWaylandShell::bringToFront() implementation.

showWindow()

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

staticnoexcept

AbstractWaylandShell::showWindow() implementation.

hideWindow()

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

staticnoexcept

AbstractWaylandShell::hideWindow() implementation.

setWindowTitle()

static bool kanzi::wayland::IVIShell::setWindowTitle ( string_view title )

staticnoexcept

AbstractWaylandShell::setWindowTitle() implementation.

getWindowTitle()

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

staticnoexcept

AbstractWaylandShell::getWindowTitle() implementation.

addListener()

bool kanzi::wayland::IVIShell::addListener ( const ivi_surface_listener & listener, void * data ) const

noexcept

Adds a listener to the underlying IVISurface.

Parameters

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

Returns

On success, true, otherwise false.

getIVISurface()

KZ_NO_DISCARD const IVISurface & kanzi::wayland::IVIShell::getIVISurface ( ) const

noexcept

Gets the underlying IVISurface.

Returns

IVISurface object.

---

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

• kanzi/core.ui/platform/windowing_ng/wayland/shells/ivi/wayland_ivi_shell.hpp