#include <kanzi/core.ui/graphics/windowed_graphics_output.hpp>

Inheritance diagram for kanzi::WindowedGraphicsOutput:

Public Member Functions
virtual bool	bringToFront () noexcept=0
	Schedules raising the window above other windows. More...

virtual KZ_NO_DISCARD optional< NativeWindowHandle >	getNativeWindowHandle () const noexcept=0
	Gets the associated window handle. More...

virtual KZ_NO_DISCARD optional< unsigned int >	getWindowHeight () const noexcept=0
	Returns the window height. More...

virtual KZ_NO_DISCARD optional< int >	getWindowPositionX () const noexcept=0
	Returns the window x position. More...

virtual KZ_NO_DISCARD optional< int >	getWindowPositionY () const noexcept=0
	Returns the window y position. More...

virtual KZ_NO_DISCARD optional< string >	getWindowTitle () const noexcept=0
	Returns the window title. More...

virtual KZ_NO_DISCARD optional< unsigned int >	getWindowWidth () const noexcept=0
	Returns the window width. More...

virtual bool	hideWindow () noexcept=0
	Schedules making the window invisible. More...

virtual bool	makeFullscreen () noexcept=0
	Schedules making the window fullscreen. More...

virtual bool	makeMaximized () noexcept=0
	Schedules maximizing the window. More...

virtual bool	makeMinimized () noexcept=0
	Schedules minimizing the window. More...

virtual bool	makeRegular () noexcept=0
	Schedules making the window regular. More...

virtual bool	moveWindow (int positionX, int positionY) noexcept=0
	Schedules a window move. More...

virtual bool	resize (unsigned int width, unsigned int height) noexcept=0
	Schedules a resize of the target layout area. More...

virtual bool	resizeWindow (unsigned int width, unsigned int height) noexcept=0
	Schedules a resize of the window. More...

virtual bool	setWindowTitle (string_view title) noexcept=0
	Schedules setting of the window title. More...

virtual bool	showWindow () noexcept=0
	Schedules making the window visible. More...

virtual	~WindowedGraphicsOutput ()=default
	Destructor. More...

Detailed Description

WindowedGraphicsOutput class.

Mixin interface for graphics outputs that implement window concepts, like resizing.

Constructor & Destructor Documentation

◆ ~WindowedGraphicsOutput()

virtual kanzi::WindowedGraphicsOutput::~WindowedGraphicsOutput ( )

virtualdefault

Destructor.

Member Function Documentation

◆ resize()

virtual bool kanzi::WindowedGraphicsOutput::resize	(	unsigned int	width,
		unsigned int	height
	)

pure virtualnoexcept

Schedules a resize of the target layout area.

This operation takes effect at an implementation defined point. Check the return value of GraphicsOutput::getWidth() and GraphicsOutput::getHeight() for success.

Note: This may affect the window size as returned by getWindowWidth() and getWindowHeight().

Parameters

width	New target layout area width in pixels.
height	New target layout area height in pixels.

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ setWindowTitle()

virtual bool kanzi::WindowedGraphicsOutput::setWindowTitle ( string_view title )

pure virtualnoexcept

Schedules setting of the window title.

This operation takes effect at an implementation defined point. Check the return value of getWindowTitle() for success.

Parameters

title New window title.

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ getWindowTitle()

virtual KZ_NO_DISCARD optional<string> kanzi::WindowedGraphicsOutput::getWindowTitle ( ) const

pure virtualnoexcept

Returns the window title.

Returns: The window title, or nullopt on error.

Implemented in kanzi::LegacyGraphicsOutput.

◆ resizeWindow()

virtual bool kanzi::WindowedGraphicsOutput::resizeWindow	(	unsigned int	width,
		unsigned int	height
	)

pure virtualnoexcept

Schedules a resize of the window.

This operation takes effect at an implementation defined point. Check the return values of getWindowWidth() and getWindowHeight() for success.

Note: This may affect the target layout area as retuned by GraphicsOutput::getWidth() and GraphicsOutput::getHeight().

Parameters

width	New window width in implementation defined units.
height	New window height in implementation defined units.

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ getWindowWidth()

virtual KZ_NO_DISCARD optional<unsigned int> kanzi::WindowedGraphicsOutput::getWindowWidth ( ) const

pure virtualnoexcept

Returns the window width.

Returns: Window width in implementation defined units, or nullopt on error.

Implemented in kanzi::LegacyGraphicsOutput.

◆ getWindowHeight()

virtual KZ_NO_DISCARD optional<unsigned int> kanzi::WindowedGraphicsOutput::getWindowHeight ( ) const

pure virtualnoexcept

Returns the window height.

Returns: Window height in implementation defined units, or nullopt on error.

Implemented in kanzi::LegacyGraphicsOutput.

◆ moveWindow()

virtual bool kanzi::WindowedGraphicsOutput::moveWindow	(	int	positionX,
		int	positionY
	)

pure virtualnoexcept

Schedules a window move.

This operation takes effect at an implementation defined point. Check the return values of getWindowPositionX() and getWindowPositionY() for success.

Parameters

positionX	New window x position in implementation defined units.
positionY	New window y position in implementation defined units.

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ getWindowPositionX()

virtual KZ_NO_DISCARD optional<int> kanzi::WindowedGraphicsOutput::getWindowPositionX ( ) const

pure virtualnoexcept

Returns the window x position.

Returns: Window x position in implementation defined units, or nullopt on error.

Implemented in kanzi::LegacyGraphicsOutput.

◆ getWindowPositionY()

virtual KZ_NO_DISCARD optional<int> kanzi::WindowedGraphicsOutput::getWindowPositionY ( ) const

pure virtualnoexcept

Returns the window y position.

Returns: Window y position in implementation defined units, or nullopt on error.

Implemented in kanzi::LegacyGraphicsOutput.

◆ makeFullscreen()

virtual bool kanzi::WindowedGraphicsOutput::makeFullscreen ( )

pure virtualnoexcept

Schedules making the window fullscreen.

This operation takes effect at an implementation defined point. The screen that the window will occupy is implementation defined.

Note: This may affect the target layout area as retuned by GraphicsOutput::getWidth() and GraphicsOutput::getHeight() and the window size as returned by getWindowWidth() and getWindowHeight().

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ makeRegular()

virtual bool kanzi::WindowedGraphicsOutput::makeRegular ( )

pure virtualnoexcept

Schedules making the window regular.

Regular windows are neither fullscreen, maximized nor minimized. This operation takes effect at an implementation defined point. The screen that the window will occupy is implementation defined.

Note: This may affect the target layout area as retuned by GraphicsOutput::getWidth() and GraphicsOutput::getHeight() and the window size as returned by getWindowWidth() and getWindowHeight().

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ makeMaximized()

virtual bool kanzi::WindowedGraphicsOutput::makeMaximized ( )

pure virtualnoexcept

Schedules maximizing the window.

The screen that the window will occupy is implementation defined. This operation takes effect at an implementation defined point.

Note: This may affect the target layout area as retuned by GraphicsOutput::getWidth() and GraphicsOutput::getHeight() and the window size as returned by getWindowWidth() and getWindowHeight().

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ makeMinimized()

virtual bool kanzi::WindowedGraphicsOutput::makeMinimized ( )

pure virtualnoexcept

Schedules minimizing the window.

This may include iconifying the window. The screen that the window will occupy is implementation defined. This operation takes effect at an implementation defined point.

Note: This may affect the target layout area as retuned by GraphicsOutput::getWidth() and GraphicsOutput::getHeight() and the window size as returned by getWindowWidth() and getWindowHeight().

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ showWindow()

virtual bool kanzi::WindowedGraphicsOutput::showWindow ( )

pure virtualnoexcept

Schedules making the window visible.

This operation takes effect at an implementation defined point.

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ hideWindow()

virtual bool kanzi::WindowedGraphicsOutput::hideWindow ( )

pure virtualnoexcept

Schedules making the window invisible.

This operation takes effect at an implementation defined point.

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ bringToFront()

virtual bool kanzi::WindowedGraphicsOutput::bringToFront ( )

pure virtualnoexcept

Schedules raising the window above other windows.

This may include focusing the window for input. This operation takes effect at an implementation defined point.

Returns: True, if scheduling the request succeeded.

Implemented in kanzi::LegacyGraphicsOutput.

◆ getNativeWindowHandle()

virtual KZ_NO_DISCARD optional<NativeWindowHandle> kanzi::WindowedGraphicsOutput::getNativeWindowHandle ( ) const

pure virtualnoexcept

Gets the associated window handle.

Returns: Native window handle, or nullopt on error

Implemented in kanzi::LegacyGraphicsOutput.

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

kanzi/core.ui/graphics/windowed_graphics_output.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~WindowedGraphicsOutput()

Member Function Documentation

◆ resize()

◆ setWindowTitle()

◆ getWindowTitle()

◆ resizeWindow()

◆ getWindowWidth()

◆ getWindowHeight()

◆ moveWindow()

◆ getWindowPositionX()

◆ getWindowPositionY()

◆ makeFullscreen()

◆ makeRegular()

◆ makeMaximized()

◆ makeMinimized()

◆ showWindow()

◆ hideWindow()

◆ bringToFront()

◆ getNativeWindowHandle()