aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Love2000-01-05 23:24:32 +0000
committerDave Love2000-01-05 23:24:32 +0000
commit54438eb5036d254ea1d00555a408b01a6687f55c (patch)
tree33d4357f8d0d1b1143163132a92ceff1dc2c5eb2
parente7f961bc4bd3a39a44d2d104c9a58ad90040d18a (diff)
downloademacs-54438eb5036d254ea1d00555a408b01a6687f55c.tar.gz
emacs-54438eb5036d254ea1d00555a408b01a6687f55c.zip
English fixes.
-rw-r--r--man/widget.texi90
1 files changed, 44 insertions, 46 deletions
diff --git a/man/widget.texi b/man/widget.texi
index aa7897395a7..02e531e2834 100644
--- a/man/widget.texi
+++ b/man/widget.texi
@@ -19,8 +19,6 @@
19@comment node-name, next, previous, up 19@comment node-name, next, previous, up
20@top The Emacs Widget Library 20@top The Emacs Widget Library
21 21
22Version: 1.9914
23
24@menu 22@menu
25* Introduction:: 23* Introduction::
26* User Interface:: 24* User Interface::
@@ -468,7 +466,7 @@ The text inside will be displayed with the face specified by
468@code{:sample-face}. 466@code{:sample-face}.
469 467
470@item %v 468@item %v
471This will be replaces with the buffer representation of the widgets 469This will be replaced with the buffer representation of the widget's
472value. What this is depends on the widget type. 470value. What this is depends on the widget type.
473 471
474@item %d 472@item %d
@@ -562,8 +560,8 @@ and returning non-nil if the widget can represent the specified value.
562 560
563@item :validate 561@item :validate
564A function which takes a widget as an argument, and return nil if the 562A function which takes a widget as an argument, and return nil if the
565widgets current value is valid for the widget. Otherwise, it should 563widget's current value is valid for the widget. Otherwise it should
566return the widget containing the invalid data, and set that widgets 564return the widget containing the invalid data, and set that widget's
567@code{:error} property to a string explaining the error. 565@code{:error} property to a string explaining the error.
568 566
569The following predefined function can be used: 567The following predefined function can be used:
@@ -679,7 +677,7 @@ Syntax:
679TYPE ::= (info-link [KEYWORD ARGUMENT]... ADDRESS) 677TYPE ::= (info-link [KEYWORD ARGUMENT]... ADDRESS)
680@end example 678@end example
681 679
682When this link is invoked, the build-in info browser is started on 680When this link is invoked, the built-in info browser is started on
683@var{address}. 681@var{address}.
684 682
685@node push-button, editable-field, info-link, Basic Types 683@node push-button, editable-field, info-link, Basic Types
@@ -766,10 +764,10 @@ Syntax:
766TYPE ::= (menu-choice [KEYWORD ARGUMENT]... TYPE ... ) 764TYPE ::= (menu-choice [KEYWORD ARGUMENT]... TYPE ... )
767@end example 765@end example
768 766
769The @var{type} arguments represents each possible choice. The widgets 767The @var{type} argument represents each possible choice. The widget's
770value of will be the value of the chosen @var{type} argument. This 768value will be that of the chosen @var{type} argument. This widget will
771widget will match any value that matches at least one of the specified 769match any value matching at least one of the specified @var{type}
772@var{type} arguments. 770arguments.
773 771
774@table @code 772@table @code
775@item :void 773@item :void
@@ -801,10 +799,10 @@ Syntax:
801TYPE ::= (radio-button-choice [KEYWORD ARGUMENT]... TYPE ... ) 799TYPE ::= (radio-button-choice [KEYWORD ARGUMENT]... TYPE ... )
802@end example 800@end example
803 801
804The @var{type} arguments represents each possible choice. The widgets 802The @var{type} argument represents each possible choice. The widget's
805value of will be the value of the chosen @var{type} argument. This 803value will be that of the chosen @var{type} argument. This widget will
806widget will match any value that matches at least one of the specified 804match any value matching at least one of the specified @var{type}
807@var{type} arguments. 805arguments.
808 806
809The following extra properties are recognized. 807The following extra properties are recognized.
810 808
@@ -891,8 +889,8 @@ Syntax:
891TYPE ::= (toggle [KEYWORD ARGUMENT]...) 889TYPE ::= (toggle [KEYWORD ARGUMENT]...)
892@end example 890@end example
893 891
894The widget has two possible states, `on' and `off', which corresponds to 892The widget has two possible states, `on' and `off', which correspond to
895a @code{t} or @code{nil} value. 893a @code{t} or @code{nil} value respectively.
896 894
897The following extra properties are recognized. 895The following extra properties are recognized.
898 896
@@ -932,10 +930,10 @@ Syntax:
932TYPE ::= (checklist [KEYWORD ARGUMENT]... TYPE ... ) 930TYPE ::= (checklist [KEYWORD ARGUMENT]... TYPE ... )
933@end example 931@end example
934 932
935The @var{type} arguments represents each checklist item. The widgets 933The @var{type} arguments represents each checklist item. The widget's
936value of will be a list containing the value of each ticked @var{type} 934value will be a list containing the values of all ticked @var{type}
937argument. The checklist widget will match a list whose elements all 935arguments. The checklist widget will match a list whose elements all
938matches at least one of the specified @var{type} arguments. 936match at least one of the specified @var{type} arguments.
939 937
940The following extra properties are recognized. 938The following extra properties are recognized.
941 939
@@ -953,11 +951,11 @@ Insert a literal @samp{%}.
953@end table 951@end table
954 952
955@item :greedy 953@item :greedy
956Usually, a checklist will only match if the items are in the exact 954Usually a checklist will only match if the items are in the exact
957sequence given in the specification. By setting @code{:greedy} to 955sequence given in the specification. By setting @code{:greedy} to
958non-nil, it will allow the items to come in any sequence. However, if 956non-nil, it will allow the items to come in any sequence. However, if
959you extract the value they will be in the sequence given in the 957you extract the value they will be in the sequence given in the
960checklist. I.e. the original sequence is forgotten. 958checklist. I.e. the original sequence is forgotten.
961 959
962@item button-args 960@item button-args
963A list of keywords to pass to the checkboxes. Useful for setting 961A list of keywords to pass to the checkboxes. Useful for setting
@@ -1238,13 +1236,13 @@ The value of a widget of this type will either have the form
1238@samp{(file t)} or @code{(file string string)}. 1236@samp{(file t)} or @code{(file string string)}.
1239 1237
1240This concept of inline is probably hard to understand. It was certainly 1238This concept of inline is probably hard to understand. It was certainly
1241hard to implement so instead of confuse you more by trying to explain it 1239hard to implement so instead of confusing you more by trying to explain
1242here, I'll just suggest you meditate over it for a while. 1240it here, I'll just suggest you meditate over it for a while.
1243 1241
1244@deffn Widget choice 1242@deffn Widget choice
1245Allows you to edit a sexp which may have one of fixed set of types. It 1243Allows you to edit a sexp which may have one of a fixed set of types.
1246is currently implemented with the @code{choice-menu} basic widget, and 1244It is currently implemented with the @code{choice-menu} basic widget,
1247has a similar syntax. 1245and has a similar syntax.
1248@end deffn 1246@end deffn
1249 1247
1250@deffn Widget set 1248@deffn Widget set
@@ -1328,9 +1326,9 @@ You can query or set the state with the following code:
1328(widget-apply @var{widget} :activate) 1326(widget-apply @var{widget} :activate)
1329@end lisp 1327@end lisp
1330 1328
1331A widget is inactive if itself, or any of its ancestors (found by 1329A widget is inactive if it, or any of its ancestors (found by
1332following the @code{:parent} link) have been deactivated. To make sure 1330following the @code{:parent} link), have been deactivated. To make sure
1333a widget is really active, you must therefore activate both itself, and 1331a widget is really active, you must therefore activate both it and
1334all its ancestors. 1332all its ancestors.
1335 1333
1336@lisp 1334@lisp
@@ -1340,12 +1338,12 @@ all its ancestors.
1340@end lisp 1338@end lisp
1341 1339
1342You can check if a widget has been made inactive by examining the value 1340You can check if a widget has been made inactive by examining the value
1343of @code{:inactive} keyword. If this is non-nil, the widget itself has 1341of the @code{:inactive} keyword. If this is non-nil, the widget itself
1344been deactivated. This is different from using the @code{:active} 1342has been deactivated. This is different from using the @code{:active}
1345keyword, in that the later tell you if the widget @strong{or} any of its 1343keyword, in that the latter tells you if the widget @strong{or} any of
1346ancestors have been deactivated. Do not attempt to set the 1344its ancestors have been deactivated. Do not attempt to set the
1347@code{:inactive} keyword directly. Use the @code{:activate} 1345@code{:inactive} keyword directly. Use the @code{:activate}
1348@code{:deactivated} keywords instead. 1346@code{:deactivate} keywords instead.
1349 1347
1350 1348
1351@node Defining New Widgets, Widget Browser, Widget Properties, Top 1349@node Defining New Widgets, Widget Browser, Widget Properties, Top
@@ -1354,7 +1352,7 @@ ancestors have been deactivated. Do not attempt to set the
1354 1352
1355You can define specialized widgets with @code{define-widget}. It allows 1353You can define specialized widgets with @code{define-widget}. It allows
1356you to create a shorthand for more complex widgets, including specifying 1354you to create a shorthand for more complex widgets, including specifying
1357component widgets and default new default values for the keyword 1355component widgets and new default values for the keyword
1358arguments. 1356arguments.
1359 1357
1360@defun widget-define name class doc &rest args 1358@defun widget-define name class doc &rest args
@@ -1382,8 +1380,8 @@ create identical widgets:
1382 1380
1383@end defun 1381@end defun
1384 1382
1385Using @code{widget-define} does just store the definition of the widget 1383Using @code{widget-define} just stores the definition of the widget type
1386type in the @code{widget-type} property of @var{name}, which is what 1384in the @code{widget-type} property of @var{name}, which is what
1387@code{widget-create} uses. 1385@code{widget-create} uses.
1388 1386
1389If you just want to specify defaults for keywords with no complex 1387If you just want to specify defaults for keywords with no complex
@@ -1396,7 +1394,7 @@ widgets:
1396Function to convert a widget type before creating a widget of that 1394Function to convert a widget type before creating a widget of that
1397type. It takes a widget type as an argument, and returns the converted 1395type. It takes a widget type as an argument, and returns the converted
1398widget type. When a widget is created, this function is called for the 1396widget type. When a widget is created, this function is called for the
1399widget type and all the widgets parent types, most derived first. 1397widget type and all the widget's parent types, most derived first.
1400 1398
1401The following predefined functions can be used here: 1399The following predefined functions can be used here:
1402 1400
@@ -1424,8 +1422,8 @@ when the widget is created, and on any value set later with
1424 1422
1425@item :create 1423@item :create
1426Function to create a widget from scratch. The function takes one 1424Function to create a widget from scratch. The function takes one
1427argument, a widget type, and create a widget of that type, insert it in 1425argument, a widget type, and creates a widget of that type, inserts it
1428the buffer, and return a widget object. 1426in the buffer, and returns a widget object.
1429 1427
1430@item :delete 1428@item :delete
1431Function to delete a widget. The function takes one argument, a widget, 1429Function to delete a widget. The function takes one argument, a widget,
@@ -1433,14 +1431,14 @@ and should remove all traces of the widget from the buffer.
1433 1431
1434@item :value-create 1432@item :value-create
1435Function to expand the @samp{%v} escape in the format string. It will 1433Function to expand the @samp{%v} escape in the format string. It will
1436be called with the widget as its argument. Should 1434be called with the widget as its argument and should insert a
1437insert a representation of the widgets value in the buffer. 1435representation of the widget's value in the buffer.
1438 1436
1439@item :value-delete 1437@item :value-delete
1440Should remove the representation of the widgets value from the buffer. 1438Should remove the representation of the widget's value from the buffer.
1441It will be called with the widget as its argument. It doesn't have to 1439It will be called with the widget as its argument. It doesn't have to
1442remove the text, but it should release markers and delete nested widgets 1440remove the text, but it should release markers and delete nested widgets
1443if such has been used. 1441if such have been used.
1444 1442
1445The following predefined function can be used here: 1443The following predefined function can be used here:
1446 1444
@@ -1483,7 +1481,7 @@ Function to prompt for a value in the minibuffer. The function should
1483take four arguments, @var{widget}, @var{prompt}, @var{value}, and 1481take four arguments, @var{widget}, @var{prompt}, @var{value}, and
1484@var{unbound} and should return a value for widget entered by the user. 1482@var{unbound} and should return a value for widget entered by the user.
1485@var{prompt} is the prompt to use. @var{value} is the default value to 1483@var{prompt} is the prompt to use. @var{value} is the default value to
1486use, unless @var{unbound} is non-nil in which case there are no default 1484use, unless @var{unbound} is non-nil, in which case there is no default
1487value. The function should read the value using the method most natural 1485value. The function should read the value using the method most natural
1488for this widget, and does not have to check that it matches. 1486for this widget, and does not have to check that it matches.
1489@end table 1487@end table