mirror of https://github.com/texmacs/doc.git
More documentation for widgets
This commit is contained in:
Miguel de Benito
parent
ad6a1646d1
commit
374226e6b7
|
|
@ -0,0 +1,54 @@
|
|||
<TeXmacs|1.0.7.15>
|
||||
|
||||
<style|tmdoc>
|
||||
|
||||
<\body>
|
||||
<tmdoc-title|Containers, glue, refresh and cia.>
|
||||
|
||||
<section|Container widgets>
|
||||
|
||||
<scm|centered>
|
||||
|
||||
<\scm>
|
||||
aligned
|
||||
</scm>
|
||||
|
||||
<scm|hlist>
|
||||
|
||||
<scm|vlist>
|
||||
|
||||
<scm|padded>
|
||||
|
||||
<section|Glue widgets>
|
||||
|
||||
From the definitions...
|
||||
|
||||
<\verbatim>
|
||||
((== x '---) '$---)
|
||||
|
||||
((== x '===) (gui-make '(glue #f #f 0 5)))
|
||||
|
||||
((== x '======) (gui-make '(glue #f #f 0 15)))
|
||||
|
||||
((== x '/) '$/)
|
||||
|
||||
((== x '//) (gui-make '(glue #f #f 5 0)))
|
||||
|
||||
((== x '///) (gui-make '(glue #f #f 15 0)))
|
||||
|
||||
((== x '\<gtr\>\<gtr\>) (gui-make '(glue #t #f 5 0)))
|
||||
|
||||
((== x '\<gtr\>\<gtr\>\<gtr\>) (gui-make '(glue #t #f 15 0)))
|
||||
|
||||
((== x (string-\<gtr\>symbol "\|")) '$/)
|
||||
</verbatim>
|
||||
|
||||
<section|Refresh widgets>
|
||||
|
||||
Refresh widgets reevaluate their contents every time a command is
|
||||
executed...
|
||||
|
||||
<section|Other topics>
|
||||
|
||||
\;
|
||||
</body>
|
||||
|
|
@ -0,0 +1,335 @@
|
|||
<TeXmacs|1.0.7.15>
|
||||
|
||||
<style|tmdoc>
|
||||
|
||||
<\body>
|
||||
<tmdoc-title|An introduction to widgets, dialogs and forms>
|
||||
|
||||
<section|Widgets><label|sec:widgets>
|
||||
|
||||
In <TeXmacs> you create visual interfaces using <em|widgets>. This word
|
||||
means either the basic building blocks you have at your disposal, like
|
||||
buttons, popup lists, etc. or the collections of those into dialogs, menus
|
||||
or whatever. This rather loose concept might be confusing, especially when
|
||||
we refer to what usually are know as dialogs as widgets, but it makes sense
|
||||
because all sorts of widgets can be aggregated to build more complicated
|
||||
ones as well.<\footnote>
|
||||
If you miss some particular ``building block'' from your OS, you might
|
||||
see whether it's feasible as an aggregation of simpler ones or try and
|
||||
play with the UI interface code in C++ (but you'll have to add it for
|
||||
every supported platform!).
|
||||
</footnote>
|
||||
|
||||
A complete reference with all the available widgets is
|
||||
<hlink|here|scheme-gui-reference.en.tm>, some more examples are here and
|
||||
here.
|
||||
|
||||
To create a widget, you'll want to use <scm|tm-widget> to define a new one.
|
||||
The call to this function uses its particular syntax, with many keywords
|
||||
for the creation of widgets. You can see the whole list of keywords in the
|
||||
table <scm|gui-make-table> inside <hlink|menu-define.scm|$TEXMACS_PATH/progs/kernel/gui/menu-define.scm>,
|
||||
but we'll start with some buttons.\
|
||||
|
||||
<subsection|Buttons and labels>
|
||||
|
||||
Execute the following two lines to get the unavoidable example and leave
|
||||
your mouse over the ``Hello'' button.
|
||||
|
||||
<\session|scheme|default>
|
||||
<\input|Scheme] >
|
||||
(tm-widget (example1) ("Hello" "world!"))
|
||||
</input>
|
||||
|
||||
<\input|Scheme] >
|
||||
(top-window example1 "A first try")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
As you can see, buttons are implicitly created by simply writing a list
|
||||
with the button's title and a tooltip to be displayed when the user hovers
|
||||
over the button. A bit confusing, and also ugly, because this is intended
|
||||
for <with|font-shape|italic|toolbar> buttons. What you probably want is
|
||||
this:
|
||||
|
||||
<\session|scheme|default>
|
||||
<\input|Scheme] >
|
||||
(tm-widget (example2) (explicit-buttons ("Hello" (noop))))
|
||||
</input>
|
||||
|
||||
<\input|Scheme] >
|
||||
(top-window example2 "A nicer button")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
The second argument is now a <scheme> command to be executed when the user
|
||||
clicks the button, in this case a no-operation, or <scm|(noop)>. Try
|
||||
changing it for <scm|(display "World")> or anything that suits you.
|
||||
|
||||
The next step is to add some text next to the button, i.e. a label. This is
|
||||
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
|
||||
<inactive|<hlink|container widget|scheme-gui-.en.tm>>, such as <scm|hlist>:
|
||||
|
||||
<\session|scheme|default>
|
||||
<\unfolded-io|Scheme] >
|
||||
(tm-widget (example3)
|
||||
|
||||
\ \ (hlist\
|
||||
|
||||
\ \ \ \ (text "Hello")\
|
||||
|
||||
\ \ \ \ (explicit-buttons ("world" (display "!\\n")))))
|
||||
<|unfolded-io>
|
||||
\;
|
||||
</unfolded-io>
|
||||
|
||||
<\input|Scheme] >
|
||||
(top-window example3 "Some text")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
That was nice, but as you see, the two widgets are packed together until
|
||||
you resize the window. We need to explicitly tell <TeXmacs> to insert some
|
||||
space between them:
|
||||
|
||||
<\session|scheme|default>
|
||||
<\unfolded-io|Scheme] >
|
||||
(tm-widget (example3)
|
||||
|
||||
\ \ (hlist\
|
||||
|
||||
\ \ \ \ (text "Hello")
|
||||
|
||||
\ \ \ \ \<gtr\>\<gtr\>\<gtr\>
|
||||
|
||||
\ \ \ \ (explicit-buttons ("world" (display "!\\n")))))
|
||||
<|unfolded-io>
|
||||
\;
|
||||
</unfolded-io>
|
||||
|
||||
<\input|Scheme] >
|
||||
(top-window example3 "Some text")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
The special symbol <scm|\<gtr\>\<gtr\>\<gtr\>> is just one of the
|
||||
predefined <hlink|glue widgets|scheme-gui-glue.en.tm>.\
|
||||
|
||||
<section|User dialogs><label|sec:dialogs>
|
||||
|
||||
Let's see how you create a dialog. To get started here is one little
|
||||
example taken from <hlink|menu-test.scm|$TEXMACS_PATH/progs/kernel/gui/menu-test.scm>:
|
||||
|
||||
<\session|scheme|default>
|
||||
<\unfolded-io|Scheme] >
|
||||
(tm-widget (widget1)
|
||||
|
||||
\ \ (centered
|
||||
|
||||
\ \ \ \ (aligned
|
||||
|
||||
\ \ \ \ \ \ (item (text "First:")
|
||||
|
||||
\ \ \ \ \ \ \ \ (toggle (display* "First " answer "\\n") #f))
|
||||
|
||||
\ \ \ \ \ \ (item (text "Second:")
|
||||
|
||||
\ \ \ \ \ \ \ \ (toggle (display* "Second " answer "\\n") #f)))))
|
||||
<|unfolded-io>
|
||||
\;
|
||||
</unfolded-io>
|
||||
</session>
|
||||
|
||||
The keyword <scm|centered> is clear, but <scm|aligned> not so much: it
|
||||
builds two column tables, with each row of type <scm|item>. As you can see,
|
||||
each <scm|item> takes two arguments, which can be of
|
||||
<with|font-shape|italic|any> type.
|
||||
|
||||
The <scm|toggle> is another example of a widget which triggers a <scheme>
|
||||
command whenever it's clicked, or toggled in this case. The second argument
|
||||
stands for the default state of the <scm|toggle>.
|
||||
|
||||
Again, in order to display this you create a <scm|top-window> and give it a
|
||||
title.
|
||||
|
||||
<\session|scheme|default>
|
||||
<\input|Scheme] >
|
||||
(top-window widget1 "Two toggle widgets")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
You'll notice that the created window is too small and the title is not
|
||||
wholly displayed. You can force it to be of a certain size using
|
||||
<scm|resize>:
|
||||
|
||||
<\session|scheme|default>
|
||||
<\unfolded-io|Scheme] >
|
||||
(tm-widget (widget1)
|
||||
|
||||
\ \ (centered
|
||||
|
||||
\ \ \ \ (resize "500px" "200px"
|
||||
|
||||
\ \ \ \ \ \ (aligned
|
||||
|
||||
\ \ \ \ \ \ \ \ (item (text "First:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (toggle (display* "First " answer "\\n") #f))
|
||||
|
||||
\ \ \ \ \ \ \ \ (item (text "Second:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (toggle (display* "Second " answer "\\n") #f))))))
|
||||
<|unfolded-io>
|
||||
\;
|
||||
</unfolded-io>
|
||||
|
||||
<\input|Scheme] >
|
||||
(top-window widget1 "A bigger window")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
<with|color|red|This should of course work! ALSO: what is resize with two
|
||||
lists as first arguments?>
|
||||
|
||||
<scm|resize> is one of the several available container or <hlink|content
|
||||
management widgets|scheme-gui-container.en.tm>.
|
||||
|
||||
If you want to add the usual buttons you use <scm|bottom-buttons> like in
|
||||
the following example. Notice that the widget now accepts one parameter
|
||||
<scm|cmd> which will be called when the user clicks the ``Ok'' button.
|
||||
|
||||
<\session|scheme|default>
|
||||
<\unfolded-io|Scheme] >
|
||||
(tm-widget (widget1-buttons cmd)
|
||||
|
||||
\ \ (centered
|
||||
|
||||
\ \ \ \ (aligned
|
||||
|
||||
\ \ \ \ \ \ (item (text "First:")
|
||||
|
||||
\ \ \ \ \ \ \ \ (toggle (display* "First " answer "\\n") #f))
|
||||
|
||||
\ \ \ \ \ \ (item (text "Second:")
|
||||
|
||||
\ \ \ \ \ \ \ \ (toggle (display* "Second " answer "\\n") #f))))
|
||||
|
||||
\ \ (bottom-buttons \<gtr\>\<gtr\> ("Ok" (cmd "Ok"))))
|
||||
<|unfolded-io>
|
||||
\;
|
||||
</unfolded-io>
|
||||
</session>
|
||||
|
||||
Since the widget now needs an argument, we must use another function to
|
||||
display it, namely <scm|dialogue-window>, which will also close the window
|
||||
after the button has been clicked.
|
||||
|
||||
<\session|scheme|default>
|
||||
<\input|Scheme] >
|
||||
(dialogue-window widget1-buttons (lambda (arg) (display* arg "\\n"))
|
||||
"Two toggles")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
That special at the bottom <scm|\<gtr\>\<gtr\>> inserts as before
|
||||
whitespace, but it stretches and aligns the <scm|bottom-buttons> to the
|
||||
right (<with|color|red|right?>). This is just another example of a
|
||||
<with|font-shape|italic|glue widget>, of which there are more described
|
||||
<hlink|here|scheme-gui-glue.en.tm>.
|
||||
|
||||
As you can see, the approach we've shown has a shortcoming: there's no way
|
||||
to access all the values of the different widgets in your dialog at the
|
||||
same time. Of course you can use the function <scm|cmd> passed to your
|
||||
widget to perform some computations, but in case you need to retrieve or
|
||||
store complicated data, what you need is a form (See
|
||||
<reference|sec:forms>).
|
||||
|
||||
<section|Forms><label|sec:forms>
|
||||
|
||||
As explained in <reference|interface:dialogs> the available widgets can be
|
||||
used to create menu items and dialog windows, but you may want to create
|
||||
more complex dialogs to perform more complicated tasks. Forms provide one
|
||||
mechanism to do this. They allow you to define multiple named fields of
|
||||
several types, whose values are stored in a hash table You can retrieve and
|
||||
return the values of this hash when the user clicks a button using the
|
||||
functions <scm|form-fields> and <scm|form-values>.
|
||||
|
||||
In the following example you can see that the syntax is pretty much the
|
||||
same as for regular widgets, but you must prefix the keywords with
|
||||
<scm|form-> :
|
||||
|
||||
<\session|scheme|default>
|
||||
<\folded-io|Scheme] >
|
||||
(tm-widget (form3 cmd)
|
||||
|
||||
\ \ (resize "500px" "500px"
|
||||
|
||||
\ \ \ \ (padded
|
||||
|
||||
\ \ \ \ \ \ (form "Test"
|
||||
|
||||
\ \ \ \ \ \ \ \ (aligned
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item (text "Input:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ (form-input "fieldname1" "string" '("one")
|
||||
"1w"))
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item === ===)
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item (text "Enum:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ (form-enum "fieldname2" '("one" "two" "three")
|
||||
"two" "1w"))
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item === ===)
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item (text "Choice:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ (form-choice "fieldname3" '("one" "two"
|
||||
"three") "one"))
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item === ===)
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item (text "Choices:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ (form-choices "fieldname4"\
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ '("one" "two"
|
||||
"three")\
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ '("one" "two"))))
|
||||
|
||||
\ \ \ \ \ \ \ \ (bottom-buttons
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ ("Cancel" (cmd "cancel")) \<gtr\>\<gtr\>
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ ("Ok"
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ (display* (form-fields) " -\<gtr\> "
|
||||
(form-values) "\\n")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ (cmd "ok")))))))
|
||||
<|folded-io>
|
||||
((guile-user) (guile-user))
|
||||
</folded-io>
|
||||
|
||||
<\input|Scheme] >
|
||||
(dialogue-window form3 (lambda (x) (display* x "\\n")) "Test of form3")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
A complete list of the widgets you can embed in a form is in the table
|
||||
<scm|gui-make-table> inside <hlink|menu-define.scm|$TEXMACS_PATH/progs/kernel/gui/menu-define.scm>.
|
||||
|
||||
\;
|
||||
|
||||
<tmdoc-copyright|2012|the <TeXmacs> team.>
|
||||
|
||||
<tmdoc-license|Permission is granted to copy, distribute and/or modify
|
||||
this\ndocument under the terms of the GNU Free Documentation License,
|
||||
Version 1.1 or\nany later version published by the Free Software
|
||||
Foundation; with no Invariant\nSections, with no Front-Cover Texts, and
|
||||
with no Back-Cover Texts. A copy of\nthe license is included in the section
|
||||
entitled "GNU Free Documentation License".>
|
||||
</body>
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
<TeXmacs|1.0.7.15>
|
||||
|
||||
<style|tmdoc>
|
||||
|
||||
<\body>
|
||||
<tmdoc-title|Widgets reference guide>
|
||||
|
||||
This should be a comprehensive list of all the widgets available to the
|
||||
user.
|
||||
|
||||
\;
|
||||
|
||||
<tmdoc-copyright|2012|the <TeXmacs> team.>
|
||||
|
||||
<tmdoc-license|Permission is granted to copy, distribute and/or modify
|
||||
this\ndocument under the terms of the GNU Free Documentation License,
|
||||
Version 1.1 or\nany later version published by the Free Software
|
||||
Foundation; with no Invariant\nSections, with no Front-Cover Texts, and
|
||||
with no Back-Cover Texts. A copy of\nthe license is included in the section
|
||||
entitled "GNU Free Documentation License".>
|
||||
</body>
|
||||
|
|
@ -1,224 +1,49 @@
|
|||
<TeXmacs|1.0.7.14>
|
||||
<TeXmacs|1.0.7.15>
|
||||
|
||||
<style|tmdoc>
|
||||
|
||||
<\body>
|
||||
<tmdoc-title|Creating new interface items>
|
||||
<tmdoc-title|Extending the graphical user interface>
|
||||
|
||||
Most of the user interface to <TeXmacs> is dynamically created from within
|
||||
the interpreted scheme code. Imagine you want to implement some feature
|
||||
which requires interaction with the user. One possible approach is to use
|
||||
the facility <scm|interactive>, which will either popoup a dialog or ask in
|
||||
the footer bar, based in metadata you provide inside your <scm|tm-define>'d
|
||||
function. See <with|color|red|here> for more on this topic. However,
|
||||
automatically generated stuff is not always the best approach, so you might
|
||||
want to explicitly design your interface placing it inside a complicated
|
||||
dialog.
|
||||
the interpreted scheme code. New menus and buttons can be added, or the
|
||||
existing ones reused and rearranged, even the main editor can be embedded
|
||||
anywhere.
|
||||
|
||||
<section|User dialogs><label|interface:dialogs>
|
||||
Imagine you want to implement some feature which requires interaction with
|
||||
the user. One possible approach is to use the facility <scm|interactive>,
|
||||
which according to the user's preferences will either popoup a dialog or
|
||||
ask in the footer bar, based in metadata you provide inside your
|
||||
<scm|tm-define>'d function. See <with|color|red|here> for more on this
|
||||
topic. However, automatically generated stuff is not always the best
|
||||
approach, so you might want to explicitly design your interface placing it
|
||||
inside a complicated dialog. The following sections should help with that.
|
||||
|
||||
In <TeXmacs> you create visual interfaces using <em|widgets>. This word
|
||||
means either the basic building blocks you have at your disposal, like
|
||||
buttons, popup lists, etc. or the collections of those into dialogs, menus
|
||||
or whatever. The latter can be aggregated to build more complicated ones as
|
||||
well.<\footnote>
|
||||
If you miss some particular ``building block'' from your OS, you might
|
||||
see whether it's feasible as an aggregation of simpler ones or try and
|
||||
play with the UI interface code in C++ (but you'll have to add it for
|
||||
every supported platform!).
|
||||
</footnote>
|
||||
<\traverse>
|
||||
<branch|An introduction to widgets, dialogs and
|
||||
forms.|scheme-gui-intro.en.tm>
|
||||
|
||||
Let's see how you create a dialog. First you'll want to use <scm|tm-widget>
|
||||
to define a new widget. The call to this function uses its particular
|
||||
syntax, with many keywords for the creation of widgets. You can see the
|
||||
whole list in the table <scm|gui-make-table> inside
|
||||
<hlink|menu-define.scm|$TEXMACS_PATH/progs/kernel/gui/menu-define.scm>.
|
||||
Here is one little example taken from <hlink|menu-test.scm|$TEXMACS_PATH/progs/kernel/gui/menu-test.scm>:
|
||||
<branch|Containers, glue and refresh widgets and other advanced
|
||||
topics.|scheme-gui-advanced.en.tm>
|
||||
|
||||
<\session|scheme|default>
|
||||
<\unfolded-io|Scheme] >
|
||||
(tm-widget (widget1)
|
||||
|
||||
\ \ (centered
|
||||
|
||||
\ \ \ \ (aligned
|
||||
|
||||
\ \ \ \ \ \ (item (text "First:")
|
||||
|
||||
\ \ \ \ \ \ \ \ (toggle (display* "First " answer "\\n") #f))
|
||||
|
||||
\ \ \ \ \ \ (item (text "Second:")
|
||||
|
||||
\ \ \ \ \ \ \ \ (toggle (display* "Second " answer "\\n") #f)))))
|
||||
<|unfolded-io>
|
||||
\;
|
||||
</unfolded-io>
|
||||
</session>
|
||||
|
||||
In order to display this you create a <scm|top-window> and give it a title.
|
||||
|
||||
<\session|scheme|default>
|
||||
<\input|Scheme] >
|
||||
(top-window widget1 "Two toggle widgets")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
You'll notice that the created window is too small and the title is not
|
||||
wholly displayed. You can force it to be of a certain size using
|
||||
<scm|resize>:
|
||||
|
||||
<\session|scheme|default>
|
||||
<\unfolded-io|Scheme] >
|
||||
(tm-widget (widget1)
|
||||
|
||||
\ \ (centered
|
||||
|
||||
\ \ \ \ (resize "500px" "200px"
|
||||
|
||||
\ \ \ \ \ \ (aligned
|
||||
|
||||
\ \ \ \ \ \ \ \ (item (text "First:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (toggle (display* "First " answer "\\n") #f))
|
||||
|
||||
\ \ \ \ \ \ \ \ (item (text "Second:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (toggle (display* "Second " answer "\\n") #f))))))
|
||||
<|unfolded-io>
|
||||
((guile-user) (kernel gui menu-test))
|
||||
</unfolded-io>
|
||||
|
||||
<\input|Scheme] >
|
||||
(top-window widget1 "A bigger window")
|
||||
</input>
|
||||
|
||||
<\input|Scheme] >
|
||||
\;
|
||||
</input>
|
||||
</session>
|
||||
|
||||
<with|color|red|This should of course work!>
|
||||
|
||||
If you want to add the usual buttons you use <scm|bottom-buttons> like in
|
||||
the following example. Notice the widget now accepts one parameter
|
||||
<scm|cmd> which will be called when the user clicks the ``Ok'' button. This
|
||||
will also automatically close the window.\
|
||||
|
||||
<\session|scheme|default>
|
||||
<\unfolded-io|Scheme] >
|
||||
(tm-widget (form2 cmd)
|
||||
|
||||
\ \ (centered
|
||||
|
||||
\ \ \ \ (aligned
|
||||
|
||||
\ \ \ \ \ \ (item (text "First:")
|
||||
|
||||
\ \ \ \ \ \ \ \ (toggle (display* "First " answer "\\n") #f))
|
||||
|
||||
\ \ \ \ \ \ (item (text "Second:")
|
||||
|
||||
\ \ \ \ \ \ \ \ (toggle (display* "Second " answer "\\n") #f))))
|
||||
|
||||
\ \ (bottom-buttons \<gtr\>\<gtr\> ("Ok" (cmd "Ok"))))
|
||||
<|unfolded-io>
|
||||
\;
|
||||
</unfolded-io>
|
||||
</session>
|
||||
|
||||
Since the widget now needs an argument, we must use another function to
|
||||
display it, namely <scm|dialogue-window>, like this:
|
||||
|
||||
<\session|scheme|default>
|
||||
<\input|Scheme] >
|
||||
(dialogue-window form2 (lambda (arg) (display* arg "\\n")) "Two
|
||||
toggles")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
As you can see, this approach has a shortcoming: there's no way to access
|
||||
all the values of the different widgets in your dialog at the same time. Of
|
||||
course you can use the function <scm|cmd> passed to your widget to perform
|
||||
some computations, but in case you need to retrieve or store complicated
|
||||
data, what you need is a form (See <reference|interface:forms>).
|
||||
|
||||
<section|Forms><label|interface:forms>
|
||||
|
||||
As explained in <reference|interface:dialogs> the available widgets can be
|
||||
used to create menu items and dialog windows, but you may want to create
|
||||
more complex dialogs to perform more complicated tasks. Forms provide one
|
||||
mechanism to do this. They allow you to define multiple named fields of
|
||||
several types, whose values are stored in a <with|color|red|hash table>.
|
||||
You can retrieve and return the values of this hash when the user clicks a
|
||||
button using the functions <scm|form-fields> and <scm|form-values>.
|
||||
|
||||
In the following example you can see that the syntax is pretty much the
|
||||
same as for regular widgets, but you must prefix your widgets with
|
||||
<scm|form-> :
|
||||
|
||||
<\session|scheme|default>
|
||||
<\folded-io|Scheme] >
|
||||
(tm-widget (form3 cmd)
|
||||
|
||||
\ \ (resize "500px" "500px"
|
||||
|
||||
\ \ \ \ (padded
|
||||
|
||||
\ \ \ \ \ \ (form "Test"
|
||||
|
||||
\ \ \ \ \ \ \ \ (aligned
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item (text "Input:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ (form-input "fieldname1" "string" '("one")
|
||||
"1w"))
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item === ===)
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item (text "Enum:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ (form-enum "fieldname2" '("one" "two" "three")
|
||||
"two" "1w"))
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item === ===)
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item (text "Choice:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ (form-choice "fieldname3" '("one" "two"
|
||||
"three") "one"))
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item === ===)
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ (item (text "Choices:")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ (form-choices "fieldname4"\
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ '("one" "two"
|
||||
"three")\
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ '("one" "two"))))
|
||||
|
||||
\ \ \ \ \ \ \ \ (bottom-buttons
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ ("Cancel" (cmd "cancel")) \<gtr\>\<gtr\>
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ ("Ok"
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ (display* (form-fields) " -\<gtr\> "
|
||||
(form-values) "\\n")
|
||||
|
||||
\ \ \ \ \ \ \ \ \ \ \ (cmd "ok")))))))
|
||||
<|folded-io>
|
||||
((guile-user) (guile-user))
|
||||
</folded-io>
|
||||
|
||||
<\input|Scheme] >
|
||||
(dialogue-window form3 (lambda (x) (display* x "\\n")) "Test of form3")
|
||||
</input>
|
||||
</session>
|
||||
|
||||
A complete list of the widgets you can embed in a form is in the table
|
||||
<scm|gui-make-table> inside <hlink|menu-define.scm|$TEXMACS_PATH/progs/kernel/gui/menu-define.scm>.
|
||||
<branch|Complete reference guide of all available
|
||||
widgets.|scheme-gui-reference.en.tm>
|
||||
</traverse>
|
||||
|
||||
\;
|
||||
</body>
|
||||
|
||||
<tmdoc-copyright|2012|the <TeXmacs> team.>
|
||||
|
||||
<tmdoc-license|Permission is granted to copy, distribute and/or modify
|
||||
this\ndocument under the terms of the GNU Free Documentation License,
|
||||
Version 1.1 or\nany later version published by the Free Software
|
||||
Foundation; with no Invariant\nSections, with no Front-Cover Texts, and
|
||||
with no Back-Cover Texts. A copy of\nthe license is included in the section
|
||||
entitled "GNU Free Documentation License".>
|
||||
</body>
|
||||
|
||||
<\initial>
|
||||
<\collection>
|
||||
<associate|preamble|false>
|
||||
</collection>
|
||||
</initial>
|
||||
Loading…
Reference in New Issue