kzs_window.h File Reference

Window handling. More...

#include <kanzi/core.ui/coreui_api.hpp>
#include <kanzi/core/legacy/debug/kzs_error.hpp>
#include <kanzi/core/legacy/kzs_types.hpp>
#include <kanzi/core.ui/platform/windowing/common/window_properties.hpp>
#include <kanzi/core.ui/platform/windowing/common/kzs_native_handles.h>

Functions
kzsError	kzsWindowCreate (const struct KzsDesktop *desktop, const struct KzsDisplay *display, const struct kanzi::NativeWindowProperties *windowPropertiesRequested, const struct KzsSurfaceConfiguration *configuration, struct KzsWindow **out_window)
	Creates a window and returns it.
kzsError	kzsWindowCreateFromNative (struct KzsWindowNative *windowNative, struct KzsWindow **out_window)
	Creates a window with a previously created native window.
kzsError	kzsWindowCreateWrapper (NativeWindowHandle windowHandle, const struct KzsDesktop *desktop, struct KzsWindow **out_window)
	Creates a window from a native handle.
kzsError	kzsWindowDelete (struct KzsWindow *window)
	Deletes a window.
kzUint	kzsWindowGetCurrentHeight (const struct KzsWindow *window)
	Gets the height of the window.
kzUint	kzsWindowGetCurrentWidth (const struct KzsWindow *window)
	Gets the width of the window.
struct KzsWindowNative *	kzsWindowGetNative (const struct KzsWindow *window)
	Gets the native window.
NativeInputHandle	kzsWindowGetNativeInputHandle (const struct KzsWindow *window)
	Gets the associated native input handle.
NativeWindowHandle	kzsWindowGetNativeWindowHandle (const struct KzsWindow *window)
	Gets the associated native window handle.
void	kzsWindowLogProperties (const struct KzsWindow *window)
	Outputs the properties of the window to the log.
kzsError	kzsWindowNativeCreate (const struct KzsDesktop *desktop, const struct KzsDisplay *display, const struct kanzi::NativeWindowProperties *windowPropertiesRequested, const struct KzsSurfaceConfiguration *surfaceConfiguration, struct kanzi::NativeWindowProperties *out_windowProperties, struct KzsWindowNative **out_windowNative)
	Creates a native window.
kzsError	kzsWindowNativeCreateWrapper (NativeWindowHandle windowHandle, const struct KzsDesktop *desktop, struct kanzi::NativeWindowProperties *out_windowProperties, struct KzsWindowNative **out_windowNative)
	Creates a native window from a native handle.
kzsError	kzsWindowNativeDelete (struct KzsWindowNative *windowNative)
	Deletes a native window.
kzUint	kzsWindowNativeGetCurrentHeight (const struct KzsWindowNative *windowNative)
	Gets the height of the window.
kzUint	kzsWindowNativeGetCurrentWidth (const struct KzsWindowNative *windowNative)
	Gets the width of the window.
NativeInputHandle	kzsWindowNativeGetNativeInputHandle (const struct KzsWindowNative *windowNative)
	Gets the associated native input handle.
NativeWindowHandle	kzsWindowNativeGetNativeWindowHandle (const struct KzsWindowNative *windowNative)
	Gets the associated native window handle.
kzsError	kzsWindowNativeInitialize (struct KzsWindowNative *windowNative, struct KzsWindow *window)
	Initializes window.
kzsError	kzsWindowNativeResize (struct KzsWindowNative *windowNative, kzUint width, kzUint height)
	Resizes the window, if applicable and supported by the platform.
kzsError	kzsWindowNativeSetOrder (const struct KzsWindowNative *windowNative, kzInt order)
	Sets the window Z order, if supported by the platform.
kzsError	kzsWindowNativeSetPositionAbsolute (const struct KzsWindowNative *windowNative, kzUint x, kzUint y)
	Sets the absolute position the window, if supported by the platform.
kzsError	kzsWindowNativeSetTitle (const struct KzsWindowNative *windowNative, kzString titleText)
	Sets the title bar string for the window, if supported by the platform.
kzsError	kzsWindowNativeShow (struct KzsWindowNative *windowNative)
	Makes newly created window visible.
kzsError	kzsWindowResize (struct KzsWindow *window, kzUint width, kzUint height)
	Resizes the window, if applicable and supported by the platform.
kzsError	kzsWindowSetPositionAbsolute (const struct KzsWindow *window, kzUint x, kzUint y)
	Sets the absolute position the window, if supported by the platform.
kzsError	kzsWindowSetTitle (const struct KzsWindow *window, kzString titleText)
	Sets the title bar string for the window, if supported by the platform.
kzsError	kzsWindowShow (struct KzsWindow *window)
	Makes newly created window visible.

Detailed Description

Window handling.

Copyright 2008-2017 by Rightware. All rights reserved.

Function Documentation

kzsWindowCreateFromNative()

kzsError kzsWindowCreateFromNative	(	struct KzsWindowNative *	windowNative,
		struct KzsWindow **	out_window )

Creates a window with a previously created native window.

Takes ownership of the native window.

kzsWindowCreate()

kzsError kzsWindowCreate	(	const struct KzsDesktop *	desktop,
		const struct KzsDisplay *	display,
		const struct kanzi::NativeWindowProperties *	windowPropertiesRequested,
		const struct KzsSurfaceConfiguration *	configuration,
		struct KzsWindow **	out_window )

Creates a window and returns it.

kzsWindowCreateWrapper()

kzsError kzsWindowCreateWrapper	(	NativeWindowHandle	windowHandle,
		const struct KzsDesktop *	desktop,
		struct KzsWindow **	out_window )

Creates a window from a native handle.

kzsWindowDelete()

kzsError kzsWindowDelete

(

struct KzsWindow *

window

)

Deletes a window.

kzsWindowResize()

kzsError kzsWindowResize	(	struct KzsWindow *	window,
		kzUint	width,
		kzUint	height )

Resizes the window, if applicable and supported by the platform.

kzsWindowSetPositionAbsolute()

kzsError kzsWindowSetPositionAbsolute	(	const struct KzsWindow *	window,
		kzUint	x,
		kzUint	y )

Sets the absolute position the window, if supported by the platform.

kzsWindowShow()

kzsError kzsWindowShow

(

struct KzsWindow *

window

)

Makes newly created window visible.

kzsWindowSetTitle()

kzsError kzsWindowSetTitle	(	const struct KzsWindow *	window,
		kzString	titleText )

Sets the title bar string for the window, if supported by the platform.

kzsWindowGetCurrentWidth()

kzUint kzsWindowGetCurrentWidth

(

const struct KzsWindow *

window

)

Gets the width of the window.

kzsWindowGetCurrentHeight()

kzUint kzsWindowGetCurrentHeight

(

const struct KzsWindow *

window

)

Gets the height of the window.

kzsWindowGetNativeInputHandle()

NativeInputHandle kzsWindowGetNativeInputHandle

(

const struct KzsWindow *

window

)

Gets the associated native input handle.

kzsWindowGetNativeWindowHandle()

NativeWindowHandle kzsWindowGetNativeWindowHandle

(

const struct KzsWindow *

window

)

Gets the associated native window handle.

kzsWindowGetNative()

struct KzsWindowNative * kzsWindowGetNative

(

const struct KzsWindow *

window

)

Gets the native window.

kzsWindowNativeCreate()

kzsError kzsWindowNativeCreate	(	const struct KzsDesktop *	desktop,
		const struct KzsDisplay *	display,
		const struct kanzi::NativeWindowProperties *	windowPropertiesRequested,
		const struct KzsSurfaceConfiguration *	surfaceConfiguration,
		struct kanzi::NativeWindowProperties *	out_windowProperties,
		struct KzsWindowNative **	out_windowNative )

Creates a native window.

kzsWindowNativeCreateWrapper()

kzsError kzsWindowNativeCreateWrapper	(	NativeWindowHandle	windowHandle,
		const struct KzsDesktop *	desktop,
		struct kanzi::NativeWindowProperties *	out_windowProperties,
		struct KzsWindowNative **	out_windowNative )

Creates a native window from a native handle.

kzsWindowNativeInitialize()

kzsError kzsWindowNativeInitialize	(	struct KzsWindowNative *	windowNative,
		struct KzsWindow *	window )

Initializes window.

Called after creating window and native window.

kzsWindowNativeDelete()

kzsError kzsWindowNativeDelete

(

struct KzsWindowNative *

windowNative

)

Deletes a native window.

kzsWindowNativeResize()

kzsError kzsWindowNativeResize	(	struct KzsWindowNative *	windowNative,
		kzUint	width,
		kzUint	height )

Resizes the window, if applicable and supported by the platform.

Native implementation.

kzsWindowNativeSetPositionAbsolute()

kzsError kzsWindowNativeSetPositionAbsolute	(	const struct KzsWindowNative *	windowNative,
		kzUint	x,
		kzUint	y )

Sets the absolute position the window, if supported by the platform.

Native implementation.

kzsWindowNativeShow()

kzsError kzsWindowNativeShow

(

struct KzsWindowNative *

windowNative

)

Makes newly created window visible.

kzsWindowNativeSetTitle()

kzsError kzsWindowNativeSetTitle	(	const struct KzsWindowNative *	windowNative,
		kzString	titleText )

Sets the title bar string for the window, if supported by the platform.

Native implementation.

kzsWindowNativeGetCurrentWidth()

kzUint kzsWindowNativeGetCurrentWidth

(

const struct KzsWindowNative *

windowNative

)

Gets the width of the window.

kzsWindowNativeGetCurrentHeight()

kzUint kzsWindowNativeGetCurrentHeight

(

const struct KzsWindowNative *

windowNative

)

Gets the height of the window.

kzsWindowNativeSetOrder()

kzsError kzsWindowNativeSetOrder	(	const struct KzsWindowNative *	windowNative,
		kzInt	order )

Sets the window Z order, if supported by the platform.

kzsWindowLogProperties()

void kzsWindowLogProperties

(

const struct KzsWindow *

window

)

Outputs the properties of the window to the log.

kzsWindowNativeGetNativeInputHandle()

NativeInputHandle kzsWindowNativeGetNativeInputHandle

(

const struct KzsWindowNative *

windowNative

)

Gets the associated native input handle.

kzsWindowNativeGetNativeWindowHandle()

NativeWindowHandle kzsWindowNativeGetNativeWindowHandle

(

const struct KzsWindowNative *

windowNative

)

Gets the associated native window handle.