aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
authorGlenn Morris2012-12-22 11:57:35 -0800
committerGlenn Morris2012-12-22 11:57:35 -0800
commitc047952bc6cedd6c456ba9d4dc69992d7015bf79 (patch)
tree35f3b58503c676097a337fb1ff1778ad23e15a86 /doc/misc
parent563a450c01499bf444e5c8fc5f314abb1b0325fa (diff)
downloademacs-c047952bc6cedd6c456ba9d4dc69992d7015bf79.tar.gz
emacs-c047952bc6cedd6c456ba9d4dc69992d7015bf79.zip
Remove hand-written node pointers in doc/misc/widget.texi
Fix up sectioning
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/ChangeLog2
-rw-r--r--doc/misc/widget.texi169
2 files changed, 69 insertions, 102 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog
index 4ced0e00009..d262c3830b4 100644
--- a/doc/misc/ChangeLog
+++ b/doc/misc/ChangeLog
@@ -2,7 +2,7 @@
2 2
3 * ada-mode.texi, ebrowse.texi, ediff.texi, ert.texi, eshell.texi: 3 * ada-mode.texi, ebrowse.texi, ediff.texi, ert.texi, eshell.texi:
4 * eudc.texi, idlwave.texi, rcirc.texi, remember.texi, ses.texi: 4 * eudc.texi, idlwave.texi, rcirc.texi, remember.texi, ses.texi:
5 * speedbar.texi, vip.texi: Nuke hand-written node pointers. 5 * speedbar.texi, vip.texi, widget.texi: Nuke hand-written node pointers.
6 6
7 * Makefile.in (gfdl): New variable. Use throughout where 7 * Makefile.in (gfdl): New variable. Use throughout where
8 appropriate so that targets depend on doclicense.texi. 8 appropriate so that targets depend on doclicense.texi.
diff --git a/doc/misc/widget.texi b/doc/misc/widget.texi
index d5514fc936c..4b920875b2c 100644
--- a/doc/misc/widget.texi
+++ b/doc/misc/widget.texi
@@ -31,8 +31,7 @@ modify this GNU manual.''
31 31
32@contents 32@contents
33 33
34@node Top, Introduction, (dir), (dir) 34@node Top
35@comment node-name, next, previous, up
36@top The Emacs Widget Library 35@top The Emacs Widget Library
37 36
38@insertcopying 37@insertcopying
@@ -54,9 +53,8 @@ modify this GNU manual.''
54* Index:: 53* Index::
55@end menu 54@end menu
56 55
57@node Introduction, User Interface, Top, Top 56@node Introduction
58@comment node-name, next, previous, up 57@chapter Introduction
59@section Introduction
60 58
61Most graphical user interface toolkits provide a number of standard 59Most graphical user interface toolkits provide a number of standard
62user interface controls (sometimes known as `widgets' or `gadgets'). 60user interface controls (sometimes known as `widgets' or `gadgets').
@@ -135,9 +133,8 @@ extended to use the GUI features. This means that your code using the
135widget library will also use the new graphic features automatically. 133widget library will also use the new graphic features automatically.
136@end enumerate 134@end enumerate
137 135
138@node User Interface, Programming Example, Introduction, Top 136@node User Interface
139@comment node-name, next, previous, up 137@chapter User Interface
140@section User Interface
141 138
142A form consists of read only text for documentation and some fields, 139A form consists of read only text for documentation and some fields,
143where each field contains two parts, a tag and a value. The tags are 140where each field contains two parts, a tag and a value. The tags are
@@ -183,7 +180,7 @@ The top level widgets in this example are tagged @samp{Name},
183within a form, namely editing the editable text fields and activating 180within a form, namely editing the editable text fields and activating
184the buttons. 181the buttons.
185 182
186@subsection Editable Text Fields 183@section Editable Text Fields
187 184
188In the example, the value for the @samp{Name} is most likely displayed 185In the example, the value for the @samp{Name} is most likely displayed
189in an editable text field, and so are values for each of the members of 186in an editable text field, and so are values for each of the members of
@@ -220,7 +217,7 @@ The editing text fields are highlighted with the
220Face used for other editing fields. 217Face used for other editing fields.
221@end deffn 218@end deffn
222 219
223@subsection Buttons 220@section Buttons
224 221
225@cindex widget buttons 222@cindex widget buttons
226@cindex button widgets 223@cindex button widgets
@@ -291,7 +288,7 @@ Face used for highlighting a button when the mouse pointer moves across
291it. 288it.
292@end defopt 289@end defopt
293 290
294@subsection Navigation 291@section Navigation
295 292
296You can use all the normal Emacs commands to move around in a form 293You can use all the normal Emacs commands to move around in a form
297buffer, plus you will have these additional commands: 294buffer, plus you will have these additional commands:
@@ -308,9 +305,8 @@ Move point @var{count} buttons or editing fields backward.
308@end deffn 305@end deffn
309@end table 306@end table
310 307
311@node Programming Example, Setting Up the Buffer, User Interface, Top 308@node Programming Example
312@comment node-name, next, previous, up 309@chapter Programming Example
313@section Programming Example
314 310
315@cindex widgets, programming example 311@cindex widgets, programming example
316@cindex example of using widgets 312@cindex example of using widgets
@@ -406,9 +402,8 @@ Interface}).
406 (widget-setup)) 402 (widget-setup))
407@end lisp 403@end lisp
408 404
409@node Setting Up the Buffer, Basic Types, Programming Example, Top 405@node Setting Up the Buffer
410@comment node-name, next, previous, up 406@chapter Setting Up the Buffer
411@section Setting Up the Buffer
412 407
413Widgets are created with @code{widget-create}, which returns a 408Widgets are created with @code{widget-create}, which returns a
414@dfn{widget} object. This object can be queried and manipulated by 409@dfn{widget} object. This object can be queried and manipulated by
@@ -460,9 +455,8 @@ Keymap used by @code{widget-button-press} and @code{widget-button-click}
460when not on a button. By default this is @code{global-map}. 455when not on a button. By default this is @code{global-map}.
461@end defvar 456@end defvar
462 457
463@node Basic Types, Sexp Types, Setting Up the Buffer, Top 458@node Basic Types
464@comment node-name, next, previous, up 459@chapter Basic Types
465@section Basic Types
466 460
467This is the general syntax of a type specification: 461This is the general syntax of a type specification:
468 462
@@ -703,9 +697,8 @@ If non-@code{nil}, allow glyphs to appear on displays where they are supported.
703* group:: 697* group::
704@end menu 698@end menu
705 699
706@node link, url-link, Basic Types, Basic Types 700@node link
707@comment node-name, next, previous, up 701@section The @code{link} Widget
708@subsection The @code{link} Widget
709@findex link@r{ widget} 702@findex link@r{ widget}
710 703
711Syntax: 704Syntax:
@@ -728,9 +721,8 @@ String to prefix links.
728String to suffix links. 721String to suffix links.
729@end defopt 722@end defopt
730 723
731@node url-link, info-link, link, Basic Types 724@node url-link
732@comment node-name, next, previous, up 725@section The @code{url-link} Widget
733@subsection The @code{url-link} Widget
734@findex url-link@r{ widget} 726@findex url-link@r{ widget}
735 727
736Syntax: 728Syntax:
@@ -743,9 +735,8 @@ Syntax:
743When this link is invoked, the @acronym{WWW} browser specified by 735When this link is invoked, the @acronym{WWW} browser specified by
744@code{browse-url-browser-function} will be called with @var{url}. 736@code{browse-url-browser-function} will be called with @var{url}.
745 737
746@node info-link, push-button, url-link, Basic Types 738@node info-link
747@comment node-name, next, previous, up 739@section The @code{info-link} Widget
748@subsection The @code{info-link} Widget
749@findex info-link@r{ widget} 740@findex info-link@r{ widget}
750 741
751Syntax: 742Syntax:
@@ -757,9 +748,8 @@ Syntax:
757When this link is invoked, the built-in Info reader is started on 748When this link is invoked, the built-in Info reader is started on
758@var{address}. 749@var{address}.
759 750
760@node push-button, editable-field, info-link, Basic Types 751@node push-button
761@comment node-name, next, previous, up 752@section The @code{push-button} Widget
762@subsection The @code{push-button} Widget
763@findex push-button@r{ widget} 753@findex push-button@r{ widget}
764 754
765Syntax: 755Syntax:
@@ -782,9 +772,8 @@ String to prefix push buttons.
782String to suffix push buttons. 772String to suffix push buttons.
783@end defopt 773@end defopt
784 774
785@node editable-field, text, push-button, Basic Types 775@node editable-field
786@comment node-name, next, previous, up 776@section The @code{editable-field} Widget
787@subsection The @code{editable-field} Widget
788@findex editable-field@r{ widget} 777@findex editable-field@r{ widget}
789 778
790Syntax: 779Syntax:
@@ -832,9 +821,8 @@ them. Pressing @key{RET} invokes the function specified by
832@code{:action}. 821@code{:action}.
833@end table 822@end table
834 823
835@node text, menu-choice, editable-field, Basic Types 824@node text
836@comment node-name, next, previous, up 825@section The @code{text} Widget
837@subsection The @code{text} Widget
838@findex text@r{ widget} 826@findex text@r{ widget}
839 827
840@vindex widget-text-keymap 828@vindex widget-text-keymap
@@ -842,9 +830,8 @@ This is just like @code{editable-field}, but intended for multiline text
842fields. The default @code{:keymap} is @code{widget-text-keymap}, which 830fields. The default @code{:keymap} is @code{widget-text-keymap}, which
843does not rebind the @key{RET} key. 831does not rebind the @key{RET} key.
844 832
845@node menu-choice, radio-button-choice, text, Basic Types 833@node menu-choice
846@comment node-name, next, previous, up 834@section The @code{menu-choice} Widget
847@subsection The @code{menu-choice} Widget
848@findex menu-choice@r{ widget} 835@findex menu-choice@r{ widget}
849 836
850Syntax: 837Syntax:
@@ -883,9 +870,8 @@ The current chosen type.
883The list of types. 870The list of types.
884@end table 871@end table
885 872
886@node radio-button-choice, item, menu-choice, Basic Types 873@node radio-button-choice
887@comment node-name, next, previous, up 874@section The @code{radio-button-choice} Widget
888@subsection The @code{radio-button-choice} Widget
889@findex radio-button-choice@r{ widget} 875@findex radio-button-choice@r{ widget}
890 876
891Syntax: 877Syntax:
@@ -950,9 +936,8 @@ Please note that such items added after the @code{radio-button-choice}
950widget has been created will @strong{not} be properly destructed when 936widget has been created will @strong{not} be properly destructed when
951you call @code{widget-delete}. 937you call @code{widget-delete}.
952 938
953@node item, choice-item, radio-button-choice, Basic Types 939@node item
954@comment node-name, next, previous, up 940@section The @code{item} Widget
955@subsection The @code{item} Widget
956@findex item@r{ widget} 941@findex item@r{ widget}
957 942
958Syntax: 943Syntax:
@@ -965,9 +950,8 @@ The @var{value}, if present, is used to initialize the @code{:value}
965property. The value should be a string, which will be inserted in the 950property. The value should be a string, which will be inserted in the
966buffer. This widget will only match the specified value. 951buffer. This widget will only match the specified value.
967 952
968@node choice-item, toggle, item, Basic Types 953@node choice-item
969@comment node-name, next, previous, up 954@section The @code{choice-item} Widget
970@subsection The @code{choice-item} Widget
971@findex choice-item@r{ widget} 955@findex choice-item@r{ widget}
972 956
973Syntax: 957Syntax:
@@ -982,9 +966,8 @@ buffer as a button. Activating the button of a @code{choice-item} is
982equivalent to activating the parent widget. This widget will only match 966equivalent to activating the parent widget. This widget will only match
983the specified value. 967the specified value.
984 968
985@node toggle, checkbox, choice-item, Basic Types 969@node toggle
986@comment node-name, next, previous, up 970@section The @code{toggle} Widget
987@subsection The @code{toggle} Widget
988@findex toggle@r{ widget} 971@findex toggle@r{ widget}
989 972
990Syntax: 973Syntax:
@@ -1015,9 +998,8 @@ Name of a glyph to be used instead of the @samp{:off} text string, on
1015emacsen that supports this. 998emacsen that supports this.
1016@end table 999@end table
1017 1000
1018@node checkbox, checklist, toggle, Basic Types 1001@node checkbox
1019@comment node-name, next, previous, up 1002@section The @code{checkbox} Widget
1020@subsection The @code{checkbox} Widget
1021@findex checkbox@r{ widget} 1003@findex checkbox@r{ widget}
1022 1004
1023This widget has two possible states, @samp{selected} and 1005This widget has two possible states, @samp{selected} and
@@ -1029,9 +1011,8 @@ Syntax:
1029@var{type} ::= (checkbox [@var{keyword} @var{argument}]...) 1011@var{type} ::= (checkbox [@var{keyword} @var{argument}]...)
1030@end example 1012@end example
1031 1013
1032@node checklist, editable-list, checkbox, Basic Types 1014@node checklist
1033@comment node-name, next, previous, up 1015@section The @code{checklist} Widget
1034@subsection The @code{checklist} Widget
1035@findex checklist@r{ widget} 1016@findex checklist@r{ widget}
1036 1017
1037Syntax: 1018Syntax:
@@ -1087,9 +1068,8 @@ The widgets representing each type.
1087The list of types. 1068The list of types.
1088@end table 1069@end table
1089 1070
1090@node editable-list, group, checklist, Basic Types 1071@node editable-list
1091@comment node-name, next, previous, up 1072@section The @code{editable-list} Widget
1092@subsection The @code{editable-list} Widget
1093@findex editable-list@r{ widget} 1073@findex editable-list@r{ widget}
1094 1074
1095Syntax: 1075Syntax:
@@ -1145,9 +1125,8 @@ The widgets representing the elements of the list.
1145List whose @sc{car} is the type of the list elements. 1125List whose @sc{car} is the type of the list elements.
1146@end table 1126@end table
1147 1127
1148@node group, , editable-list, Basic Types 1128@node group
1149@comment node-name, next, previous, up 1129@section The @code{group} Widget
1150@subsection The @code{group} Widget
1151@findex group@r{ widget} 1130@findex group@r{ widget}
1152 1131
1153This widget simply group other widgets together. 1132This widget simply group other widgets together.
@@ -1160,9 +1139,8 @@ Syntax:
1160 1139
1161The value is a list, with one member for each @var{type}. 1140The value is a list, with one member for each @var{type}.
1162 1141
1163@node Sexp Types, Widget Properties, Basic Types, Top 1142@node Sexp Types
1164@comment 1143@chapter Sexp Types
1165@section Sexp Types
1166@cindex sexp types 1144@cindex sexp types
1167 1145
1168A number of widgets for editing @dfn{s-expressions} (Lisp types), sexp 1146A number of widgets for editing @dfn{s-expressions} (Lisp types), sexp
@@ -1176,9 +1154,8 @@ categories described in this section.
1176* composite:: 1154* composite::
1177@end menu 1155@end menu
1178 1156
1179@node constants, generic, Sexp Types, Sexp Types 1157@node constants
1180@comment node-name, next, previous, up 1158@section The Constant Widgets
1181@subsection The Constant Widgets
1182@cindex constant widgets 1159@cindex constant widgets
1183 1160
1184The @code{const} widget can contain any Lisp expression, but the user is 1161The @code{const} widget can contain any Lisp expression, but the user is
@@ -1213,9 +1190,8 @@ An immutable symbol that is bound as a variable.
1213An immutable symbol that is bound as a function. 1190An immutable symbol that is bound as a function.
1214@end deffn 1191@end deffn
1215 1192
1216@node generic, atoms, constants, Sexp Types 1193@node generic
1217@comment node-name, next, previous, up 1194@section Generic Sexp Widget
1218@subsection Generic Sexp Widget
1219@cindex generic sexp widget 1195@cindex generic sexp widget
1220 1196
1221The @code{sexp} widget can contain any Lisp expression, and allows the 1197The @code{sexp} widget can contain any Lisp expression, and allows the
@@ -1235,9 +1211,8 @@ The @code{sexp} widget takes the same keyword arguments as the
1235@code{editable-field} widget. @xref{editable-field}. 1211@code{editable-field} widget. @xref{editable-field}.
1236@end deffn 1212@end deffn
1237 1213
1238@node atoms, composite, generic, Sexp Types 1214@node atoms
1239@comment node-name, next, previous, up 1215@section Atomic Sexp Widgets
1240@subsection Atomic Sexp Widgets
1241@cindex atomic sexp widget 1216@cindex atomic sexp widget
1242 1217
1243The atoms are s-expressions that do not consist of other s-expressions. 1218The atoms are s-expressions that do not consist of other s-expressions.
@@ -1313,9 +1288,8 @@ either @code{nil} meaning false, or non-@code{nil} meaning true.
1313@end deffn 1288@end deffn
1314 1289
1315 1290
1316@node composite, , atoms, Sexp Types 1291@node composite
1317@comment node-name, next, previous, up 1292@section Composite Sexp Widgets
1318@subsection Composite Sexp Widgets
1319@cindex composite sexp widgets 1293@cindex composite sexp widgets
1320 1294
1321The syntax for the composite widget construct is: 1295The syntax for the composite widget construct is:
@@ -1415,9 +1389,8 @@ Specifies a list of any number of elements that fit a certain type.
1415@end example 1389@end example
1416@end deffn 1390@end deffn
1417 1391
1418@node Widget Properties, Defining New Widgets, Sexp Types, Top 1392@node Widget Properties
1419@comment node-name, next, previous, up 1393@chapter Properties
1420@section Properties
1421@cindex properties of widgets 1394@cindex properties of widgets
1422@cindex widget properties 1395@cindex widget properties
1423 1396
@@ -1510,9 +1483,8 @@ its ancestors have been deactivated. Do not attempt to set the
1510@code{:deactivate} keywords instead. 1483@code{:deactivate} keywords instead.
1511 1484
1512 1485
1513@node Defining New Widgets, Widget Browser, Widget Properties, Top 1486@node Defining New Widgets
1514@comment node-name, next, previous, up 1487@chapter Defining New Widgets
1515@section Defining New Widgets
1516@cindex new widgets 1488@cindex new widgets
1517@cindex defining new widgets 1489@cindex defining new widgets
1518 1490
@@ -1695,9 +1667,8 @@ It provides most of the functionality that is referred to as ``by
1695default'' in this text. 1667default'' in this text.
1696@end deffn 1668@end deffn
1697 1669
1698@node Widget Browser, Widget Minor Mode, Defining New Widgets, Top 1670@node Widget Browser
1699@comment node-name, next, previous, up 1671@chapter Widget Browser
1700@section Widget Browser
1701@cindex widget browser 1672@cindex widget browser
1702 1673
1703There is a separate package to browse widgets. This is intended to help 1674There is a separate package to browse widgets. This is intended to help
@@ -1720,9 +1691,8 @@ Create a widget browser for the widget at @var{pos}.
1720When called interactively, use the position of point. 1691When called interactively, use the position of point.
1721@end deffn 1692@end deffn
1722 1693
1723@node Widget Minor Mode, Utilities, Widget Browser, Top 1694@node Widget Minor Mode
1724@comment node-name, next, previous, up 1695@chapter Widget Minor Mode
1725@section Widget Minor Mode
1726@cindex widget minor mode 1696@cindex widget minor mode
1727 1697
1728There is a minor mode for manipulating widgets in major modes that 1698There is a minor mode for manipulating widgets in major modes that
@@ -1738,9 +1708,8 @@ With arg, turn widget mode on if and only if arg is positive.
1738Keymap used in @code{widget-minor-mode}. 1708Keymap used in @code{widget-minor-mode}.
1739@end defvar 1709@end defvar
1740 1710
1741@node Utilities, Widget Wishlist, Widget Minor Mode, Top 1711@node Utilities
1742@comment node-name, next, previous, up 1712@chapter Utilities
1743@section Utilities.
1744@cindex utility functions for widgets 1713@cindex utility functions for widgets
1745 1714
1746@defun widget-prompt-value widget prompt [ value unbound ] 1715@defun widget-prompt-value widget prompt [ value unbound ]
@@ -1754,9 +1723,8 @@ Get the item which @var{widget} is assumed to toggle.
1754This is only meaningful for radio buttons or checkboxes in a list. 1723This is only meaningful for radio buttons or checkboxes in a list.
1755@end defun 1724@end defun
1756 1725
1757@node Widget Wishlist, GNU Free Documentation License, Utilities, Top 1726@node Widget Wishlist
1758@comment node-name, next, previous, up 1727@chapter Wishlist
1759@section Wishlist
1760@cindex todo 1728@cindex todo
1761 1729
1762@itemize @bullet 1730@itemize @bullet
@@ -1813,12 +1781,11 @@ See @code{TeX-printer-list} for an explanation.
1813Add a @code{mailto} widget. 1781Add a @code{mailto} widget.
1814@end itemize 1782@end itemize
1815 1783
1816@node GNU Free Documentation License, Index, Widget Wishlist, Top 1784@node GNU Free Documentation License
1817@appendix GNU Free Documentation License 1785@appendix GNU Free Documentation License
1818@include doclicense.texi 1786@include doclicense.texi
1819 1787
1820@node Index, , GNU Free Documentation License, Top 1788@node Index
1821@comment node-name, next, previous, up
1822@unnumbered Index 1789@unnumbered Index
1823 1790
1824This is an alphabetical listing of all concepts, functions, commands, 1791This is an alphabetical listing of all concepts, functions, commands,