texmacs
/
doc
mirror of https://github.com/texmacs/doc.git
1
0
Fork 0
Code

Added documentation for preferences api.

This commit is contained in:
Miguel de Benito 2012-09-11 15:22:56 +00:00
parent b4723d04bb
commit a243a4be18
2 changed files with 82 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
devel/scheme/gui/scheme-gui-intro.en.tm
View File

@ -72,7 +72,7 @@
done with the <scm|text> keyword, as in <scm|(text "Hello")>, but in order
to have both widgets sit side by side, you'll need a container widget as
described in "<hlink|Containers, glue, refresh and
cia.|scheme-gui-advanced.en.tm>", such as <scm|hlist>:
co.|scheme-gui-advanced.en.tm>", such as <scm|hlist>:
<\session|scheme|default>
<\unfolded-io|Scheme] >
@ -118,7 +118,7 @@
The special symbol <scm|\<gtr\>\<gtr\>\<gtr\>> is just one of the
predefined glue widgets described in "<hlink|Containers, glue, refresh and
cia.|scheme-gui-advanced.en.tm>".
co.|scheme-gui-advanced.en.tm>".
<tmdoc-copyright|2012|the <TeXmacs> team.>

82
devel/scheme/utils/utils-preferences.en.tm
View File

@ -1,13 +1,91 @@
<TeXmacs|1.0.5.2>
<TeXmacs|1.0.7.16>
<style|tmdoc>
<\body>
<tmdoc-title|User preferences>
Preferences are used to store any information you need to keep across
different runs of <TeXmacs>, like window position and size, active menu
bars, etc. Internally they are stored in the users home directory as a
<scheme> list of items like <scm|("name" value)> which therefore has in
principle no structure. However, a good practice to avoid conflicts is to
prefix your options by the name of the plugin or module you are creating,
like in <scm|"gui:help-window-position">.
The first step in defining a new preference is adding it with
<scm|define-preferences> and assigning a call-back function to handle
changes in the preference. This is important for instance in menus, where a
click on an item simply sets some preference to some value and it's up to
the call-back to actually take the necessary actions.
\;
<tmdoc-copyright|2005|Joris van der Hoeven>
<\explain>
<scm|(define-preferences <scm-arg|list>)><explain-synopsis|define new
preferences with defaults and call-backs>
<|explain>
Each element of <scm-arg|list> is of the form <scm|("somename" value
notify-procedure)> where <scm|notify-procedure> is a procedure taking two
arguments like this:
<scm|(define (notify-procedure property-name value) (do-things))>
<\folded-documentation>
Example
<|folded-documentation>
<\session|scheme|default>
<\input|Scheme] >
(define (notify-test pref value)
\ \ (display* "Hey! " pref " changed to " value)(newline))
</input>
<\input|Scheme] >
(define-preferences ("test:pref" #f notify-test))
</input>
<\unfolded-io|Scheme] >
(get-preference "test:pref")
<|unfolded-io>
#f
</unfolded-io>
<\input|Scheme] >
(set-preference "test:pref" #t)
</input>
<\input|Scheme] >
\;
</input>
</session>
</folded-documentation>
</explain>
<\explain>
<scm|(set-preference <scm-arg|name> <scm-arg|value>)><explain-synopsis|set
user preference>
<|explain>
Save preference <scm|name> with value <scm|value>. Then call the
call-back associated to this preference, as defined in
<scm|define-preferences>.
</explain>
<\explain>
<scm|(reset-preference <scm-arg|name>)><explain-synopsis|delete user
preference>
<|explain>
Deletes preference <scm|name> from the user preferences.
</explain>
<\explain>
<scm|(get-preference <scm-arg|name>)><explain-synopsis|get user
preference>
<|explain>
Returns the value of preference <scm|name>.
</explain>
<tmdoc-copyright|2012|>
<tmdoc-license|Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version 1.1