Window control
[OpenSpace3D high level 2D library]

Modules
	EdWindow and EdControl resize flags
	EdWindow types flags
Functions
	getEdWindowVisibleState (winstr)
	Get a window visible state.
	setEdWindowCtrl3dEnable (winstr, state)
	Enable or disable 3D view on a window or on its child windows.
	setEdWindowVisible (winstr, state)
	Show or hide a window.
	setEdWindowFocus (winstr)
	Give the keyboard focus on a window.
	setEdWindowTop (winstr)
	Bring a window to the top on the screen.
	setEdWindowTopMost (winstr)
	Bring a window to the top most on the screen.
	setEdWindowName (winstr, name)
	Rename the title of a window.
	getEdWindowToolBarSize (winstr)
	Get the size used by toolbars on a window.
	resizeEdWindowToolBar (winstr, w, h)
	Resize all toolbars on a window.
	dsEdWindowToolBar (winstr, tbstr)
	Destroy a toolbar from a window.
	crEdWindowToolBar (winstr, x, y, w, h, hmargin, vmargin, bgcolor, mode)
	Create a toolbar on a window.
	setEdWindowPosSize (winstr, x, y, w, h)
	Move and resize a window.
	setEdWindowSize (winstr, w, h)
	Resize a window.
	setEdWindowPos (winstr, x, y)
	Move a window.
	setEdWindowPosSizeEx (winstr, x, y, w, h)
	Move and resize a window with global coordinates (window + border + title).
	setEdWindowSizeEx (winstr, w, h)
	Resize a window with global coordinates (window + border + title).
	setEdWindowPosEx (winstr, x, y)
	Move a window with global coordinates (window + border + title).
	setEdVirtualWindowPosSize (winstr, x, y, w, h)
	Move and resize a virtual window.
	setEdVirtualWindowSize (winstr, w, h)
	Resize a virtual window.
	setEdVirtualWindowPos (winstr, x, y)
	Move a virtual window.
	setEdWindowResizeFlags (winstr, flags)
	Change a window resize flags.
	maximizeOrMinimizeEdWindow (winstr, hdecal, vdecal)
	Maximize or minimize a window.
	setEdwindowCbKeyDown (winstr, cbfun)
	Set a window key down callback.
	setEdwindowCbKeyUp (winstr, cbfun)
	Set a window key up callback.
	setEdwindowCbSize (winstr, cbfun)
	Set a window size callback.
	setEdwindowCbMove (winstr, cbfun)
	Set a window move callback.
	setEdwindowCbVirtualMove (winstr, cbfun)
	Set a virtual window move callback.
	setEdwindowCbVirtualSize (winstr, cbfun)
	Set a virtual window size callback.
	setEdwindowCbDestroy (winstr, cbfun)
	Set a window destroy callback.
	setEdwindowCbClose (winstr, cbfun)
	Set a window close callback.
	setEdwindowCbDrop (winstr, cbfun)
	Set a window drop files callback.
	dsEdWindow (winstr)
	Destroy a window.
	setEdwindowCbCursorMove (winstr, cbfun)
	Set a window cursor move callback.
	setEdwindowCbClick (winstr, cbfun)
	Set a window mouse click callback.
	setEdwindowCbUnClick (winstr, cbfun)
	Set a window mouse unclick callback.
	setEdWindowIcon (winstr, file)
	Set a window title bar icon.
	crEdWindow (chan, fatherstr, x, y, w, h, flags, resize, mode, title)
	Create a new window.
	crEdScrollWindow (chan, fatherstr, x, y, w, h, flags, resize, mode, title)
	Create a new scroll window.
	crEdGroupWindow (chan, fatherstr, x, y, w, h, flags, resize, title)
	Create a new group window.
	crEdDialogWindow (chan, fatherstr, x, y, w, h, flags, resize, title)
	Create a new dialog window.
	crEdModalDialogWindow (chan, fatherstr, x, y, w, h, flags, resize, title)
	Create a new modal dialog window.
	crEdPopupWindow (chan, fatherstr, x, y, w, h, flags, resize, title)
	Create a new popup window.
	crEdFrameWindow (chan, fatherstr, x, y, w, h, resize, themestr, title, minimizebuble)
	Create a frame window.
	crEdMainWindow (chan, fatherwin, x, y, w, h, flags, title)
	Create a new main window.
	getEdWindowIsAX (winstr)
	Return if a window is embeded in an activeX.

---

Detailed Description

Window control

---

Function Documentation

getEdWindowVisibleState

(

winstr

)

Get a window visible state.

Prototype: fun [EdWindow] I

Parameters:

EdWindow

: window structure

Returns:

I : 0 for hidden, 1 for visible

setEdWindowCtrl3dEnable	(	winstr	,
		state
	)

Enable or disable 3D view on a window or on its child windows.

Prototype: fun [EdWindow I] I

Parameters:

	EdWindow	: window structure
	I	: new state, 0 for disable, 1 for enable

Returns:

I : 0

setEdWindowVisible	(	winstr	,
		state
	)

Show or hide a window.

Prototype: fun [EdWindow I] I

Parameters:

	EdWindow	: window structure
	I	: new state, 0 for hide, 1 for show

Returns:

I : 0

setEdWindowFocus

(

winstr

)

Give the keyboard focus on a window.

Prototype: fun [EdWindow] I

Parameters:

EdWindow

: window structure to focus

Returns:

I : 0

setEdWindowTop

(

winstr

)

Bring a window to the top on the screen.

Prototype: fun [EdWindow] I

Parameters:

EdWindow

: window structure to put in top

Returns:

I : 0

setEdWindowTopMost

(

winstr

)

Bring a window to the top most on the screen.

Prototype: fun [EdWindow] I

Parameters:

EdWindow

: window structure to put in top

Returns:

I : 0

setEdWindowName	(	winstr	,
		name
	)

Rename the title of a window.

Prototype: fun [EdWindow S] I

Parameters:

	EdWindow	: window structure
	S	: the new title

Returns:

I : 0

getEdWindowToolBarSize

(

winstr

)

Get the size used by toolbars on a window.

Prototype: fun [EdWindow] I

Parameters:

EdWindow

: window structure

Returns:

I : the size used by toolbars

resizeEdWindowToolBar	(	winstr	,
		w	,
		h
	)

Resize all toolbars on a window.

Prototype: fun [EdWindow I I] I

Parameters:

	EdWindow	: window structure
	I	: new toolbar width
	I	: new toolbar height

Returns:

I : 0

dsEdWindowToolBar	(	winstr	,
		tbstr
	)

Destroy a toolbar from a window.

Prototype: fun [EdWindow EdToolBar] I

Parameters:

	EdWindow	: window structure
	EdToolBar	: toolbar to destroy

Returns:

I : 0

crEdWindowToolBar	(	winstr	,
		x	,
		y	,
		w	,
		h	,
		hmargin	,
		vmargin	,
		bgcolor	,
		mode
	)

Create a toolbar on a window.

Private

Prototype: fun [Chn EdWindow I I I I I I I I] EdToolBar

Parameters:

	EdWindow	: window where to put the toolbar
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: horizontal margin between elements
	I	: vertical margin between elements
	I	: toolbar background color
	I	: mode flag (ETB_HORIZONTAL, ETB_VERTICAL)

Returns:

EdToolBar : the new toolbar

setEdWindowPosSize	(	winstr	,
		x	,
		y	,
		w	,
		h
	)

Move and resize a window.

Prototype: fun [EdWindow I I I I] I

Parameters:

	EdWindow	: window structure
	I	: X position
	I	: Y position
	i	: width
	I	: height

Returns:

I : 0

setEdWindowSize	(	winstr	,
		w	,
		h
	)

Resize a window.

Prototype: fun [EdWindow I I] I

Parameters:

	EdWindow	: window structure
	i	: width
	I	: height

Returns:

I : 0

setEdWindowPos	(	winstr	,
		x	,
		y
	)

Move a window.

Prototype: fun [EdWindow I I] I

Parameters:

	EdWindow	: window structure
	I	: X position
	I	: Y position

Returns:

I : 0

setEdWindowPosSizeEx	(	winstr	,
		x	,
		y	,
		w	,
		h
	)

Move and resize a window with global coordinates (window + border + title).

Prototype: fun [EdWindow I I I I] I

Parameters:

	EdWindow	: window structure
	I	: X position
	I	: Y position
	i	: width
	I	: height

Returns:

I : 0

setEdWindowSizeEx	(	winstr	,
		w	,
		h
	)

Resize a window with global coordinates (window + border + title).

Prototype: fun [EdWindow I I] I

Parameters:

	EdWindow	: window structure
	i	: width
	I	: height

Returns:

I : 0

setEdWindowPosEx	(	winstr	,
		x	,
		y
	)

Move a window with global coordinates (window + border + title).

Prototype: fun [EdWindow I I] I

Parameters:

	EdWindow	: window structure
	I	: X position
	I	: Y position

Returns:

I : 0

setEdVirtualWindowPosSize	(	winstr	,
		x	,
		y	,
		w	,
		h
	)

Move and resize a virtual window.

Prototype: fun [EdWindow I I I I] I

Parameters:

	EdWindow	: window structure
	I	: X position
	I	: Y position
	i	: width
	I	: height

Returns:

I : 0

setEdVirtualWindowSize	(	winstr	,
		w	,
		h
	)

Resize a virtual window.

Prototype: fun [EdWindow I I] I

Parameters:

	EdWindow	: window structure
	i	: width
	I	: height

Returns:

I : 0

setEdVirtualWindowPos	(	winstr	,
		x	,
		y
	)

Move a virtual window.

Prototype: fun [EdWindow I I] I

Parameters:

	EdWindow	: window structure
	I	: X position
	I	: Y position

Returns:

I : 0

setEdWindowResizeFlags	(	winstr	,
		flags
	)

Change a window resize flags.

Prototype: fun [EdWindow I] I

Parameters:

	EdWindow	: window structure
	I	: new resize flags

Returns:

I : 0

maximizeOrMinimizeEdWindow	(	winstr	,
		hdecal	,
		vdecal
	)

Maximize or minimize a window.

Prototype: fun [EdWindow I I] I

Parameters:

	EdWindow	: window structure
	I	: X decal
	I	: Y decal

Returns:

I : 0

setEdwindowCbKeyDown	(	winstr	,
		cbfun
	)

Set a window key down callback.

Prototype: fun [EdWindow fun [EdWindow I I] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I I] I : callback EdWindow : window structure I : key I : ascii code

Returns:

I : 0

setEdwindowCbKeyUp	(	winstr	,
		cbfun
	)

Set a window key up callback.

Prototype: fun [EdWindow fun [EdWindow I] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I] I : callback EdWindow : window structure I : key

Returns:

I : 0

setEdwindowCbSize	(	winstr	,
		cbfun
	)

Set a window size callback.

Prototype: fun [EdWindow fun [EdWindow I I] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I I] I : callback EdWindow : window structure I : width I : height

Returns:

I : 0

setEdwindowCbMove	(	winstr	,
		cbfun
	)

Set a window move callback.

Prototype: fun [EdWindow fun [EdWindow I I] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I I] I : callback EdWindow : window structure I : X position I : Y position

Returns:

I : 0

setEdwindowCbVirtualMove	(	winstr	,
		cbfun
	)

Set a virtual window move callback.

Prototype: fun [EdWindow fun [EdWindow I I] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I I] I : callback EdWindow : window structure I : X position I : Y position

Returns:

I : 0

setEdwindowCbVirtualSize	(	winstr	,
		cbfun
	)

Set a virtual window size callback.

Prototype: fun [EdWindow fun [EdWindow I I] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I I] I : callback EdWindow : window structure I : width I : height

Returns:

I : 0

setEdwindowCbDestroy	(	winstr	,
		cbfun
	)

Set a window destroy callback.

Prototype: fun [EdWindow fun [EdWindow] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow] I : callback EdWindow : window structure

Returns:

I : 0

setEdwindowCbClose	(	winstr	,
		cbfun
	)

Set a window close callback.

Prototype: fun [EdWindow fun [EdWindow] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow] I : callback EdWindow : window structure

Returns:

I : 0

setEdwindowCbDrop	(	winstr	,
		cbfun
	)

Set a window drop files callback.

Prototype: fun [EdWindow fun [EdWindow I I [P r1]] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I I [P r1]] I : callback EdWindow : window structure I : X position I : Y position [P r1] : files list

Returns:

I : 0

dsEdWindow

(

winstr

)

Destroy a window.

Prototype: fun [EdWindow] I

Parameters:

EdWindow

: window structure

Returns:

I : 0

setEdwindowCbCursorMove	(	winstr	,
		cbfun
	)

Set a window cursor move callback.

Prototype: fun [EdWindow fun [EdWindow I I I] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I I I] I : callback EdWindow : window structure I : X position I : Y position I : mouse button

Returns:

I : 0

setEdwindowCbClick	(	winstr	,
		cbfun
	)

Set a window mouse click callback.

Prototype: fun [EdWindow fun [EdWindow I I I] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I I I] I : callback EdWindow : window structure I : X position I : Y position I : mouse button

Returns:

I : 0

setEdwindowCbUnClick	(	winstr	,
		cbfun
	)

Set a window mouse unclick callback.

Prototype: fun [EdWindow fun [EdWindow I I I] I] I

Parameters:

	EdWindow	: window structure
	fun	[EdWindow I I I] I : callback EdWindow : window structure I : X position I : Y position I : mouse button

Returns:

I : 0

setEdWindowIcon	(	winstr	,
		file
	)

Set a window title bar icon.

Prototype: fun [EdWindow S] EdWindow

Parameters:

	EdWindow	: window structure
	S	: icon file path in scol partition

Returns:

EdWindow : same window structure

crEdWindow	(	chan	,
		fatherstr	,
		x	,
		y	,
		w	,
		h	,
		flags	,
		resize	,
		mode	,
		title
	)

Create a new window.

Prototype: fun [Chn EdWindow I I I I I I I S] EdWindow

Parameters:

	Chn	: channel
	EdWindow	: mother window structure
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: window flags
	I	: resize flags
	I	: window type flags
	S	: window title

Returns:

EdWindow : new window structure

crEdScrollWindow	(	chan	,
		fatherstr	,
		x	,
		y	,
		w	,
		h	,
		flags	,
		resize	,
		mode	,
		title
	)

Create a new scroll window.

Prototype: fun [Chn EdWindow I I I I I I I S] EdWindow

Parameters:

	Chn	: channel
	EdWindow	: mother window structure
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: window flags
	I	: resize flags
	I	: window type flags
	S	: window title

Returns:

EdWindow : new scroll window structure

crEdGroupWindow	(	chan	,
		fatherstr	,
		x	,
		y	,
		w	,
		h	,
		flags	,
		resize	,
		title
	)

Create a new group window.

Prototype: fun [Chn EdWindow I I I I I I S] EdWindow

Parameters:

	Chn	: channel
	EdWindow	: mother window structure
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: window flags
	I	: resize flags
	S	: window title

Returns:

EdWindow : new group window structure

crEdDialogWindow	(	chan	,
		fatherstr	,
		x	,
		y	,
		w	,
		h	,
		flags	,
		resize	,
		title
	)

Create a new dialog window.

Prototype: fun [Chn EdWindow I I I I I I S] EdWindow

Parameters:

	Chn	: channel
	EdWindow	: mother window structure
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: window flags
	I	: resize flags
	S	: window title

Returns:

EdWindow : new dialog window structure

crEdModalDialogWindow	(	chan	,
		fatherstr	,
		x	,
		y	,
		w	,
		h	,
		flags	,
		resize	,
		title
	)

Create a new modal dialog window.

Prototype: fun [Chn EdWindow I I I I I I S] EdWindow

Parameters:

	Chn	: channel
	EdWindow	: mother window structure
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: window flags
	I	: resize flags
	S	: window title

Returns:

EdWindow : new modal dialog window structure

crEdPopupWindow	(	chan	,
		fatherstr	,
		x	,
		y	,
		w	,
		h	,
		flags	,
		resize	,
		title
	)

Create a new popup window.

Prototype: fun [Chn EdWindow I I I I I I S] EdWindow

Parameters:

	Chn	: channel
	EdWindow	: mother window structure
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: window flags
	I	: resize flags
	S	: window title

Returns:

EdWindow : new popup window structure

crEdFrameWindow	(	chan	,
		fatherstr	,
		x	,
		y	,
		w	,
		h	,
		resize	,
		themestr	,
		title	,
		minimizebuble
	)

Create a frame window.

Prototype: fun [Chn EdWindow I I I I I EdTheme S S] EdWindow

Parameters:

	Chn	: channel
	EdWindow	: mother window structure
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: resize flags
	EdTheme	: theme structure to use
	S	: window title
	S	: minimize/maximize tooltip text

Returns:

EdWindow : new frame window structure

crEdMainWindow	(	chan	,
		fatherwin	,
		x	,
		y	,
		w	,
		h	,
		flags	,
		title
	)

Create a new main window.

Automaticaly included in the activeX window if available

Prototype: fun [Chn EdWindow I I I I I S] EdWindow

Parameters:

	Chn	: channel
	EdWindow	: mother window structure
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: window flags
	S	: window title

Returns:

EdWindow : new popup window structure

getEdWindowIsAX

(

winstr

)

Return if a window is embeded in an activeX.

Prototype: fun [EdWindow] I

Parameters:

	Chn	: channel
	EdWindow	: mother window structure
	I	: X position
	I	: Y position
	I	: width
	I	: height
	I	: window flags
	S	: window title

Returns:

I : 0 if not embeded, 1 if embeded