IUP

Check-in [c17663e4bf]
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.6.0
Files: files | file ages | folders
SHA1: c17663e4bfe94d6540c3a2aee54d12466b1574c9
User & Date: murphy 2015-05-03 22:42:34
Context
2015-05-03
22:43
Updated CHICKEN release information file check-in: 6cbe5a56c8 user: murphy tags: trunk
22:42
Documentation updates check-in: c17663e4bf user: murphy tags: trunk, v1.6.0
22:28
Racket bindings for IUP configuration file support check-in: 29b6ecd883 user: murphy tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

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

<h2>Synopsis</h2>

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

Configuration file support.

<h2>Configuration Component</h2>

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

Creates an application configuration component.

<h3><a id="config-load_"><code><nowiki>(config-load! [handle ihandle?]) → void?</nowiki></code></a></h3>

Determines the location of an application configuration file and loads
its settings into the component.

<h3><a id="config-save_"><code><nowiki>(config-save! [handle ihandle?]) → void?</nowiki></code></a></h3>

Saves the settings from a configuration component into the backing file.

<h2>Configured Dialog Positions</h2>

<h3><a id="config-dialog-show"><code><nowiki>(config-dialog-show [handle ihandle?] [dialog ihandle?] [section string?]) → void?</nowiki></code></a></h3>

Given a configuration component and a dialog, the dialog is shown with
its configured screen position and size as specified in the indicated
configuration section.

<h3><a id="config-dialog-update_"><code><nowiki>(config-dialog-update! [handle ihandle?] [dialog ihandle?] [section string?]) → void?</nowiki></code></a></h3>

Stores the screen position and size of a dialog in the indicated
section of the configuration component.

<h2>Configured Recent Files</h2>

<h3><a id="config-recent-menu"><code><nowiki>(config-recent-menu [handle ihandle?] [max-recent integer?] #:<name> <value> ...) → ihandle?</nowiki></code></a></h3>

Creates a menu that is synchronized with a list of recently used files
maintained in a configuration section. The menu may have an action
callback that is triggered whenever a recently used item is selected.

<h3><a id="config-recent-update_"><code><nowiki>(config-recent-update! [handle ihandle?] [path string?]) → void?</nowiki></code></a></h3>

Updates the list of recently used files, marking the given path as the
most recently used item.

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>[./glcontrols.wiki|glcontrols]</tt>, <tt>[./plot.wiki|plot]</tt>, <tt>[./mglplot.wiki|mglplot]</tt>, <tt>[./pplot.wiki|pplot]</tt>, <tt>[./scintilla.wiki|scintilla]</tt>, <tt>[./web.wiki|web]</tt> and <tt>[./ole.wiki|ole]</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>, <tt>[./web.wiki|web]</tt>, <tt>[./ole.wiki|ole]</tt> and <tt>[./config.wiki|config]</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.