IUP

Check-in [02d20dd891]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Documentation updates
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk | v1.4.0
Files: files | file ages | folders
SHA1: 02d20dd89151038996bc4d1ad940df78f38250d5
User & Date: murphy 2015-05-02 15:36:44
Context
2015-05-02
15:38
Updated CHICKEN release information file check-in: bbac5ce817 user: murphy tags: trunk
15:36
Documentation updates check-in: 02d20dd891 user: murphy tags: trunk, v1.4.0
15:27
Corrected argument names of IupFrame constructor check-in: f6c7d65538 user: murphy tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to api/controls.wiki.

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
..
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<h2>Standard Controls</h2>

<h3><a id="canvas"><code><nowiki>(canvas [action (or/c symbol? string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a canvas interface element with an action callback name. The action
is triggered when the canvas needs to be redrawn.

<h3><a id="frame"><code><nowiki>(frame [action (or/c symbol? string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a frame element with a title around a given child.

<h3><a id="tabs"><code><nowiki>(tabs [child ihandle?] ... #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a tabs element with the given children.

<h3><a id="label"><code><nowiki>(label [title (or/c string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a label interface element, which displays a separator, a text or an image.

<h3><a id="link"><code><nowiki>(label [url (or/c string? #f) #f] [title (or/c string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a link interface element, which displays some text like a label and links to a URL.

<h3><a id="button"><code><nowiki>(button [title (or/c string? #f) #f] [action (or/c symbol? string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a button element with the given title and action callback name.

................................................................................
Creates a toggle button element with the given title and action callback name.

<h3><a id="spin"><code><nowiki>(spin #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Create a spin control with two buttons, one with an up arrow and the other with
a down arrow, to be used to increment and decrement values.

<h3><a id="spinbox"><code><nowiki>(spinbox [child (or/c ihandle? #f)] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a box with a spin control around a given child.

<h3><a id="valuator"><code><nowiki>(valuator [type string? "HORIZONTAL"] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a valuator control with the given orientation.








|











|







 







|







18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
..
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<h2>Standard Controls</h2>

<h3><a id="canvas"><code><nowiki>(canvas [action (or/c symbol? string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a canvas interface element with an action callback name. The action
is triggered when the canvas needs to be redrawn.

<h3><a id="frame"><code><nowiki>(frame [child (or/c ihandle? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a frame element with a title around a given child.

<h3><a id="tabs"><code><nowiki>(tabs [child ihandle?] ... #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a tabs element with the given children.

<h3><a id="label"><code><nowiki>(label [title (or/c string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a label interface element, which displays a separator, a text or an image.

<h3><a id="link"><code><nowiki>(link [url (or/c string? #f) #f] [title (or/c string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a link interface element, which displays some text like a label and links to a URL.

<h3><a id="button"><code><nowiki>(button [title (or/c string? #f) #f] [action (or/c symbol? string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a button element with the given title and action callback name.

................................................................................
Creates a toggle button element with the given title and action callback name.

<h3><a id="spin"><code><nowiki>(spin #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Create a spin control with two buttons, one with an up arrow and the other with
a down arrow, to be used to increment and decrement values.

<h3><a id="spinbox"><code><nowiki>(spinbox [child (or/c ihandle? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a box with a spin control around a given child.

<h3><a id="valuator"><code><nowiki>(valuator [type string? "HORIZONTAL"] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a valuator control with the given orientation.

Added api/glcontrols.wiki.



























































































































































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<h1><tt>glcontrols</tt> Module</h1>

<h2>Synopsis</h2>

<table>
	<tr>
		<th>Racket</th>
		<td><code>(require iup/glcontrols)</code></td>
	</tr>
	<tr>
		<th>CHICKEN</th>
		<td><code>(require-extension iup-glcontrols)</code></td>
	</tr>
</table>

Support for controls embedded in an OpenGL canvas. Initializes the IUP
GLCanvas and GLControls libraries when loaded. Re-exports the canvas
management procedures from the <tt>[./glcanvas.wiki|glcanvas]</tt>
module.

<h2>GLCanvasBox and Embedded Controls</h2>

<h3><a id="glcanvasbox"><code><nowiki>(glcanvasbox [child ihandle?] ... #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a new OpenGL canvas with support for child elements. The given
children may be layout containers without visual representation or
instances of the other controls from this module.

<h3><a id="glsubcanvas"><code><nowiki>(glsubcanvas #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a child of an OpenGL canvas box that can be used to draw
custom user interface elements.

<h3><a id="glframe"><code><nowiki>(glframe [child (or/c ihandle? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a frame element with a title around a given child.

<h3><a id="glexpander"><code><nowiki>(glexpander [child (or/c ihandle? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates an expander element that can interactively show or hide a
given child.

<h3><a id="glscrollbox"><code><nowiki>(glscrollbox [child (or/c ihandle? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a scrollable container around a given child.

<h3><a id="glsizebox"><code><nowiki>(glsizebox [child (or/c ihandle? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a resizable container around a given child.

<h3><a id="glseparator"><code><nowiki>(glseparator #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a separator line.

<h3><a id="gllabel"><code><nowiki>(gllabel [title (or/c string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a label interface element, which displays text or an image.

<h3><a id="gllink"><code><nowiki>(gllink [url (or/c string? #f) #f] [title (or/c string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a link interface element, which displays some text like a label and links to a URL.

<h3><a id="glbutton"><code><nowiki>(glbutton [title (or/c string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a button element with the given title.

<h3><a id="gltoggle"><code><nowiki>(gltoggle [title (or/c string? #f) #f] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a toggle button element with the given title.

<h3><a id="glvaluator"><code><nowiki>(glvaluator #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a valuator control.

<h3><a id="glprogress-bar"><code><nowiki>(glprogress-bar #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a progress bar control.

Changes to api/main.wiki.

13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
	</tr>
</table>

This module re-exports most bindings from the <tt>[./base.wiki|base]</tt>,
<tt>[./controls.wiki|controls]</tt> and <tt>[./dialogs.wiki|dialogs]</tt>
modules.

Additional features can be imported from the <tt>[./glcanvas.wiki|glcanvas]</tt>, <tt>[./plot.wiki|plot]</tt>, <tt>[./mglplot.wiki|mglplot]</tt>, <tt>[./pplot.wiki|pplot]</tt>, <tt>[./scintilla.wiki|scintilla]</tt> and <tt>[./web.wiki|web]</tt> modules.

Instead of using this module directly you may instead require the
<tt>[./dynamic.wiki|dynamic]</tt> module to access the GUI library bindings at
runtime iff the library is available.

<h2>Host Specifics</h2>

Under both Racket and CHICKEN, the foreign types and conversion procedures
defined in <tt>[./base.wiki|base]</tt> are not re-exported. Since Racket
provides its own version of <tt>send-url</tt> from <tt>net/url</tt>, the
compatible procedure from <tt>[./base.wiki|base]</tt> is also not re-exported
under Racket.







|












13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
	</tr>
</table>

This module re-exports most bindings from the <tt>[./base.wiki|base]</tt>,
<tt>[./controls.wiki|controls]</tt> and <tt>[./dialogs.wiki|dialogs]</tt>
modules.

Additional features can be imported from the <tt>[./glcanvas.wiki|glcanvas]</tt>, <tt>[./glcontrols.wiki|glcontrols]</tt>, <tt>[./plot.wiki|plot]</tt>, <tt>[./mglplot.wiki|mglplot]</tt>, <tt>[./pplot.wiki|pplot]</tt>, <tt>[./scintilla.wiki|scintilla]</tt> and <tt>[./web.wiki|web]</tt> modules.

Instead of using this module directly you may instead require the
<tt>[./dynamic.wiki|dynamic]</tt> module to access the GUI library bindings at
runtime iff the library is available.

<h2>Host Specifics</h2>

Under both Racket and CHICKEN, the foreign types and conversion procedures
defined in <tt>[./base.wiki|base]</tt> are not re-exported. Since Racket
provides its own version of <tt>send-url</tt> from <tt>net/url</tt>, the
compatible procedure from <tt>[./base.wiki|base]</tt> is also not re-exported
under Racket.