Classes
class	AbstractDefaultWaylandContext
	Class that represents an interface for Wayland callbacks. More...

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

class	CoreShell
	Wayland Core Shell abstraction. More...

class	DefaultIVIScreenListener
	Default listener for IVIScreen. More...

class	DefaultIVISurfaceListener
	Default listener for IVISurface. More...

class	DefaultIVIWMListener
	Default listener for IVIWM. More...

class	DefaultKeyboardListener
	Default listener for WaylandKeyboard. More...

class	DefaultPointerListener
	Default listener for WaylandPointer. More...

class	DefaultSeatListener
	Default listener for WaylandSeat. More...

class	DefaultTouchListener
	Default listener for WaylandTouch. More...

class	DefaultWaylandEGLGraphicsOutput
	Class that represents the default Wayland EGL graphics output. More...

class	DefaultWaylandEGLGraphicsOutputProperties
	Default properties to use when creating DefaultWaylandEGLGraphicsOutput. More...

class	DefaultWaylandFrameListener
	Default listener for Wayland frame callback. More...

class	DefaultWaylandIVIEGLGraphicsOutput
	Class that represents the default Wayland IVI EGL graphics output. More...

class	DefaultWaylandIVIEGLGraphicsOutputProperties
	Default properties to use when creating DefaultWaylandIVIEGLGraphicsOutput. More...

class	DefaultWaylandOutputListener
	Default listener for WaylandOutput. More...

class	DefaultWaylandRegistryListener
	Default listener for WaylandRegistry. More...

class	DefaultWaylandShellSurfaceListener
	Default listener for WaylandShellSurface. More...

class	DefaultXDGSurfaceListener
	Default listener for XDGSurface. More...

class	DefaultXDGToplevelListener
	Default listener for XDGToplevel. More...

class	DefaultXDGWMBaseListener
	Default listener for XDGWMBase. More...

class	ExitRequestEvent
	Event that represents a request to close the window. More...

class	IVIApplication
	IVI application wrapper class. More...

class	IVILayer
	Represents IVI layer. More...

class	IVILayerProps
	Collection of IVILayer properties. More...

class	IVILayoutManager
	An abstraction class that allows to control IVI layers and surfaces. More...

class	IVIScreen
	IVI screen wrapper class. More...

class	IVIShell
	Wayland IVI Shell abstraction. More...

class	IVISurface
	IVI surface wrapper class. More...

class	IVISurfaceProps
	Collection of IVIWMSurface properties. More...

class	IVIWM
	IVI WM wrapper class. More...

class	IVIWMSurface
	Represents IVI surface from WM point of view. More...

class	KeyboardEnterEvent
	Event that represents keyboard entering the window. More...

class	KeyboardLeaveEvent
	Event that represents keyboard leaving the window. More...

class	KeyEvent
	Event that represents a keyboard key changing state. More...

class	KeyModEvent
	Event that represents the current keyboard modifier state. More...

class	PointerAxisEvent
	Event that represents mouse scroll. More...

class	PointerButtonEvent
	Event that represents mouse button events. More...

class	PointerEnterEvent
	Event that represents mouse entering application window. More...

class	PointerFrameEvent
	Event that groups pointer events together. More...

class	PointerLeaveEvent
	Event that represents mouse leaving application window. More...

class	PointerMotionEvent
	Event that represents mouse movement. More...

class	ShellWrapper
	Helper class that contains a Shell with associated listeners. More...

class	TouchCancelEvent
	Event that represents compositor taking over all touch points. More...

class	TouchDownEvent
	Event that starts a touch point. More...

class	TouchFrameEvent
	Event that groups touch events together. More...

class	TouchMotionEvent
	Event that represents touch point movement. More...

class	TouchUpEvent
	Event that ends a touch point. More...

class	WaylandCallback
	Wayland callback wrapper class. More...

class	WaylandCompositor
	Wayland compositor wrapper class. More...

class	WaylandDisplay
	Wayland display wrapper class. More...

class	WaylandEGLWindow
	Wayland EGL window wrapper class. More...

class	WaylandEventVisitor
	Visitor class that operates on different types of Wayland events. More...

class	WaylandInterface
	Represents a generic Wayland interface handle with managed lifetime. More...

class	WaylandKeyboard
	Wayland keyboard wrapper class. More...

class	WaylandOutput
	Wayland output wrapper class. More...

class	WaylandPointer
	Wayland pointer wrapper class. More...

class	WaylandRegistry
	Wayland registry wrapper class. More...

class	WaylandSeat
	Represents a Wayland seat and abstracts the underlying capabilities. More...

class	WaylandShell
	Wayland shell wrapper class. More...

class	WaylandShellSurface
	Wayland shell surface wrapper class. More...

class	WaylandSurface
	Wayland surface wrapper class. More...

class	WaylandTouch
	Wayland touch wrapper class. More...

class	XDGPositioner
	XDG positioner wrapper class. More...

class	XDGShell
	Wayland XDG Shell abstraction. More...

class	XDGSurface
	XDG surface wrapper class. More...

class	XDGToplevel
	XDG toplevel wrapper class. More...

class	XDGWMBase
	XDG WM base wrapper class. More...

Typedefs
using	DefaultCoreShellWrapper = ShellWrapper< CoreShell, DefaultWaylandShellSurfaceListener >
	Alias for CoreShell with all default listeners. More...

using	DefaultIVIShellWrapper = ShellWrapper< IVIShell, DefaultIVISurfaceListener >
	Alias for IVIShell with all default listeners. More...

using	DefaultXDGShellWrapper = ShellWrapper< XDGShell, DefaultXDGWMBaseListener, DefaultXDGToplevelListener, DefaultXDGSurfaceListener >
	Alias for XDGShell with all default listeners. More...

template<typename T >
using	NativeHandleType = decltype(kanzi::declval< T >().getNativeHandle())
	Represents the underlying native handle type. More...

using	ShellWrapperVariant = variant< DefaultCoreShellWrapper, DefaultXDGShellWrapper, DefaultIVIShellWrapper >
	Alias for a variant of all default shells. More...

using	WaylandEvent = variant< KeyboardEnterEvent, KeyboardLeaveEvent, KeyEvent, KeyModEvent, PointerEnterEvent, PointerLeaveEvent, PointerButtonEvent, PointerAxisEvent, PointerMotionEvent, PointerFrameEvent, TouchDownEvent, TouchUpEvent, TouchMotionEvent, TouchCancelEvent, TouchFrameEvent, ExitRequestEvent >
	Alias that contains all Wayland events. More...

Enumerations
enum	WaylandInputMode { WaylandInputMode::Retained, WaylandInputMode::Immediate }
	Enumerator that represents Wayland input mode. More...

enum	WaylandShellType { WaylandShellType::Core, WaylandShellType::XDG, WaylandShellType::IVI }
	Enumerator that represents Wayland shells available in Kanzi. More...

Functions
KZ_NO_DISCARD KeyModifier	getWaylandKeyModifiers (unsigned int modsDepressed, unsigned int modsLatched, unsigned int modsLocked) noexcept
	Gets the currently active key modifiers. More...

template<typename T >
span< T >	makeSpanOverWlArray (wl_array *wlArray)
	Creates a kanzi::span over wl_array. More...

KZ_NO_DISCARD WaylandShellType	parseShellType (string_view shellTypeStr) noexcept
	Converts the text containing the shell type to the corresponding enumerator value. More...

KZ_NO_DISCARD WaylandInputMode	parseWaylandInputMode (string_view inputModeStr) noexcept
	Converts the text containing the Wayland input mode to the corresponding enumerator value. More...

KZ_NO_DISCARD string	shellTypeToString (WaylandShellType shellType) noexcept
	Converts the shell type from an enumerator value to string. More...

KZ_NO_DISCARD string	waylandInputModeToString (WaylandInputMode waylandInputMode) noexcept
	Converts the Wayland input mode from an enumerator value to string. More...

KZ_NO_DISCARD LogicalKey	waylandKeyToLogicalKey (unsigned int keyCode) noexcept
	Maps the native Wayland key to a logical key used by Kanzi. More...

Typedef Documentation

using kanzi::wayland::DefaultCoreShellWrapper = typedef ShellWrapper<CoreShell, DefaultWaylandShellSurfaceListener>

Alias for CoreShell with all default listeners.

using kanzi::wayland::DefaultXDGShellWrapper = typedef ShellWrapper<XDGShell, DefaultXDGWMBaseListener, DefaultXDGToplevelListener, DefaultXDGSurfaceListener>

Alias for XDGShell with all default listeners.

using kanzi::wayland::DefaultIVIShellWrapper = typedef ShellWrapper<IVIShell, DefaultIVISurfaceListener>

Alias for IVIShell with all default listeners.

using kanzi::wayland::ShellWrapperVariant = typedef variant< DefaultCoreShellWrapper, DefaultXDGShellWrapper, DefaultIVIShellWrapper>

Alias for a variant of all default shells.

template<typename T >

using kanzi::wayland::NativeHandleType = typedef decltype(kanzi::declval<T>().getNativeHandle())

Represents the underlying native handle type.

Template Parameters

T	Wayland wrapper class.

Since: Kanzi 3.9.8

using kanzi::wayland::WaylandEvent = typedef variant< KeyboardEnterEvent, KeyboardLeaveEvent, KeyEvent, KeyModEvent, PointerEnterEvent, PointerLeaveEvent, PointerButtonEvent, PointerAxisEvent, PointerMotionEvent, PointerFrameEvent, TouchDownEvent, TouchUpEvent, TouchMotionEvent, TouchCancelEvent, TouchFrameEvent, ExitRequestEvent>

Alias that contains all Wayland events.

Since: Kanzi 3.9.8

Enumeration Type Documentation

enum kanzi::wayland::WaylandShellType

strong

Enumerator that represents Wayland shells available in Kanzi.

Since: Kanzi 3.9.8

Enumerator

Core

The original Wayland shell.

See also: CoreShell

XDG

XDG shell.

See also: XDGShell

IVI

IVI shell.

See also: IVIShell

enum kanzi::wayland::WaylandInputMode

strong

Enumerator that represents Wayland input mode.

Since: Kanzi 3.9.9

Enumerator
Retained	Collects events until `frame()` event is received from compositor, then processes them all at once.
Immediate	Processes events immediately and ignores `frame()` event.

Function Documentation

KZ_NO_DISCARD LogicalKey kanzi::wayland::waylandKeyToLogicalKey ( unsigned int keyCode )

noexcept

Maps the native Wayland key to a logical key used by Kanzi.

Parameters

keyCode Wayland key code.

Returns: Logical key used by Kanzi.

Since: Kanzi 3.9.8

KZ_NO_DISCARD KeyModifier kanzi::wayland::getWaylandKeyModifiers	(	unsigned int	modsDepressed,
		unsigned int	modsLatched,
		unsigned int	modsLocked
	)

noexcept

Gets the currently active key modifiers.

Parameters

modsDepressed	Depressed keys mask.
modsLatched	Latched keys mask.
modsLocked	Locked keys mask.

Returns: Currently active key modifiers.

Since: Kanzi 3.9.8

KZ_NO_DISCARD WaylandShellType kanzi::wayland::parseShellType ( string_view shellTypeStr )

noexcept

Converts the text containing the shell type to the corresponding enumerator value.

Parameters

shellTypeStr String representation of shell type.

Returns: Wayland shell enumerator value.

Since: Kanzi 3.9.8

KZ_NO_DISCARD string kanzi::wayland::shellTypeToString ( WaylandShellType shellType )

noexcept

Converts the shell type from an enumerator value to string.

Parameters

shellType Wayland shell enumerator value.

Returns: String representation of the shell type.

Since: Kanzi 3.9.8

KZ_NO_DISCARD WaylandInputMode kanzi::wayland::parseWaylandInputMode ( string_view inputModeStr )

noexcept

Converts the text containing the Wayland input mode to the corresponding enumerator value.

Parameters

inputModeStr String representation of Wayland input mode.

Returns: Wayland input mode enumerator value.

Since: Kanzi 3.9.9

KZ_NO_DISCARD string kanzi::wayland::waylandInputModeToString ( WaylandInputMode waylandInputMode )

noexcept

Converts the Wayland input mode from an enumerator value to string.

Parameters

waylandInputMode Wayland input mode enumerator value.

Returns: String representation of the Wayland input mode.

Since: Kanzi 3.9.9

template<typename T >

span<T> kanzi::wayland::makeSpanOverWlArray ( wl_array * wlArray )

Creates a kanzi::span over wl_array.

Template Parameters

T	Element type.

Parameters

wlArray Wayland array.

Returns: Span that wraps underlying wl_array.

Since: Kanzi 3.9.8

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

Enumeration Type Documentation

Function Documentation