Project

General

Profile

OpenSpace3D libs
OpenSpace 3D libraries for plugITs and OS3D developer

Modules

 EdWindow and EdControl resize flags
 
 EdWindow types flags
 

Functions

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

Detailed Description

Window control

Function Documentation

◆ getEdWindowVisibleState()

getEdWindowVisibleState ( winstr  )

Get a window visible state.

Prototype: fun [EdWindow] I

Parameters
EdWindow: window structure
Returns
I : 0 for hidden, 1 for visible

◆ setEdWindowCtrl3dEnable()

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()

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()

setEdWindowFocus ( winstr  )

Give the keyboard focus on a window.

Prototype: fun [EdWindow] I

Parameters
EdWindow: window structure to focus
Returns
I : 0

◆ setEdWindowTop()

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()

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()

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

◆ setEdWindowMinimumSize()

setEdWindowMinimumSize ( winstr  ,
,
 
)

Set the minimum window size.

Prototype: fun [EdWindow I I] I

Parameters
EdWindow: window structure
I: minimum width
I: minimum height
Returns
I : 0

◆ setEdWindowMaximumSize()

setEdWindowMaximumSize ( winstr  ,
,
 
)

Set the maximum window size.

Prototype: fun [EdWindow I I] I

Parameters
EdWindow: window structure
I: maximum width
I: maximum height
Returns
I : 0

◆ getEdWindowToolBarSize()

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()

resizeEdWindowToolBar ( winstr  ,
winw  ,
winh  ,
,
 
)

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()

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()

crEdWindowToolBar ( winstr  ,
,
,
,
,
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()

setEdWindowPosSize ( winstr  ,
,
,
,
 
)

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()

setEdWindowSize ( winstr  ,
,
 
)

Resize a window.

Prototype: fun [EdWindow I I] I

Parameters
EdWindow: window structure
i: width
I: height
Returns
I : 0

◆ setEdWindowPos()

setEdWindowPos ( winstr  ,
,
 
)

Move a window.

Prototype: fun [EdWindow I I] I

Parameters
EdWindow: window structure
I: X position
I: Y position
Returns
I : 0

◆ setEdWindowPosSizeEx()

setEdWindowPosSizeEx ( winstr  ,
,
,
,
 
)

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()

setEdWindowSizeEx ( winstr  ,
,
 
)

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()

setEdWindowPosEx ( winstr  ,
,
 
)

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()

setEdVirtualWindowPosSize ( winstr  ,
,
,
,
 
)

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()

setEdVirtualWindowSize ( winstr  ,
,
 
)

Resize a virtual window.

Prototype: fun [EdWindow I I] I

Parameters
EdWindow: window structure
i: width
I: height
Returns
I : 0

◆ setEdVirtualWindowPos()

setEdVirtualWindowPos ( winstr  ,
,
 
)

Move a virtual window.

Prototype: fun [EdWindow I I] I

Parameters
EdWindow: window structure
I: X position
I: Y position
Returns
I : 0

◆ setEdWindowResizeFlags()

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()

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()

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()

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
Returns
I : 0

◆ setEdwindowCbSize()

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()

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()

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()

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()

setEdwindowCbDestroy ( winstr  ,
cbfun   
)

Set a window destroy callback.

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

Parameters
EdWindow: window structure
fun[EdWindow] I : callback
Returns
I : 0

◆ setEdwindowCbClose()

setEdwindowCbClose ( winstr  ,
cbfun   
)

Set a window close callback.

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

Parameters
EdWindow: window structure
fun[EdWindow] I : callback
Returns
I : 0

◆ setEdwindowCbDrop()

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()

dsEdWindow ( winstr  )

Destroy a window.

Prototype: fun [EdWindow] I

Parameters
EdWindow: window structure
Returns
I : 0

◆ dsEdWindow2()

dsEdWindow2 ( winstr  )

Destroy a window but not the children.

Prototype: fun [EdWindow] I

Parameters
EdWindow: window structure
Returns
I : 0

◆ setEdwindowCbCursorMove()

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()

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()

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()

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

◆ setEdWindowBackgroundColor()

setEdWindowBackgroundColor ( winstr  ,
color   
)

Set a window background color.

Prototype: fun [EdWindow I] EdWindow

Parameters
EdWindow: window structure
I: the new background color
Returns
EdWindow : same window structure

◆ crEdWindow()

crEdWindow ( chan  ,
fatherstr  ,
,
,
,
,
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()

crEdScrollWindow ( chan  ,
fatherstr  ,
,
,
,
,
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()

crEdGroupWindow ( chan  ,
fatherstr  ,
,
,
,
,
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()

crEdDialogWindow ( chan  ,
fatherstr  ,
,
,
,
,
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()

crEdModalDialogWindow ( chan  ,
fatherstr  ,
,
,
,
,
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()

crEdPopupWindow ( chan  ,
fatherstr  ,
,
,
,
,
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()

crEdFrameWindow ( chan  ,
fatherstr  ,
,
,
,
,
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()

crEdMainWindow ( chan  ,
fatherwin  ,
,
,
,
,
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()

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