IUP

Check-in [4693332543]
Login

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

Overview
Comment:Documentation update
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 4693332543cff3c4db5f7b9d7991eeb741961fad
User & Date: murphy 2015-05-01 17:13:32
Context
2015-05-01
22:49
Corrected label constructor argument name check-in: 6c01896816 user: murphy tags: trunk
17:13
Documentation update check-in: 4693332543 user: murphy tags: trunk
17:08
Make mgllabel title argument optional check-in: 6d25af7227 user: murphy tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to api/controls.wiki.

26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

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 [action (or/c symbol? 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="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.








|







26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

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="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.

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>[./pplot.wiki|pplot]</tt>, <tt>[./plot.wiki|plot]</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>[./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.

Added api/mglplot.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
<h1><tt>mglplot</tt> Module</h1>

<h2>Synopsis</h2>

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

Plotting support. Initializes the IUP MglPlot library when loaded.

<h2>MglPlot Control</h2>

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

Creates a plotting canvas.

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

<h2>Plotting Functions</h2>

<h3><a id="call-with-mglplot"><code><nowiki>(call-with-mglplot [handle ihandle?] [proc (-> ihandle? any)] #:dimension [dimension integer? 2]) → any</nowiki></code></a></h3>

Calls the given procedure with the given plotting canvas handle and ensures
that the canvas is ready to receive data of the given dimension. Returns
whatever the given procedure returns.

<h3><a id="mglplot-add_"><code><nowiki>(mglplot-add! [handle ihandle?] [x (or/c string? real?)] [y real?] [z (or/c real? #f) #f] [sample-index (or/c integer? #f) #f] [index (or/c integer? #f) #f]) → void?</nowiki></code></a></h3>

Adds a sample to the given plotting canvas. Whether <code>x</code>
must be a string or a real number depends on the setting of the
<code>dimension</code> argument to the <code><a
href="#call-with-mglplot">call-with-mglplot</a></code> invocation that
created the dataset: One-dimensional data sets can be labeled with
strings while two- and three-dimensional data sets consist of numeric
tuples.

If <code>sample-index</code> is <code>#f</code>, the sample is appended to the
dataset and the call to <code>mglplot-add!</code> must be within the dynamic
context of a call to <code><a href="#call-with-mglplot">call-with-mglplot</a></code>.

If <code>sample-index</code> is a number, the sample is inserted into the
dataset before the given sample index. The call to <code>mglplot-add!</code>
does not have to be within the dynamic context of a call to
<code><a href="#call-with-mglplot">call-with-mglplot</a></code> in this case.
The dataset to which the new sample should be added may be specified explicitly
by its index through the <code>index</code> argument. If the <code>index</code>
argument is false, the current dataset of the plotting canvas is used.

<h2>Auxiliary Functions</h2>

<h3><a id="mglplot-x_y_z-_pixel-x_y"><code><nowiki>(mglplot-x/y/z->pixel-x/y [handle ihandle?] [x real?] [y real?] [z real? 0.0]) → (values integer? integer?)</nowiki></code></a></h3>

Transforms plot coordinates into pixel coordinates.

<h3><a id="mglplot-paint-to"><code><nowiki>(mglplot-paint-to [handle ihandle?] [format string?] [file string?] [width integer? 0] [height integer? 0] [dpi integer? 0]) → void?</nowiki></code></a></h3>

Paints the plot's contents into an image file. The format should be
either <code>"EPS"</code> or <code>"SVG"</code>. If the width, height
and resolution are not specified, the same values as for the on-screen
representation of the plot are used.