comparison man/widget.texi @ 371:cc15677e0335 r21-2b1

Import from CVS: tag r21-2b1
author cvs
date Mon, 13 Aug 2007 11:03:08 +0200
parents a4f53d9b3154
children 8626e4521993
comparison
equal deleted inserted replaced
370:bd866891f083 371:cc15677e0335
1 \input texinfo.tex 1 \input texinfo.tex
2 2
3 @c %**start of header 3 @c %**start of header
4 @setfilename ../info/widget.info 4 @setfilename ../info/widget
5 @settitle The Emacs Widget Library 5 @settitle The Emacs Widget Library
6 @iftex 6 @iftex
7 @afourpaper 7 @afourpaper
8 @headings double 8 @headings double
9 @end iftex 9 @end iftex
10 @c %**end of header 10 @c %**end of header
11
12 @ifinfo
13 @dircategory XEmacs Editor
14 @direntry
15 * Widgets: (widget). The Emacs Widget Library.
16 @end direntry
17 @end ifinfo
18 11
19 @node Top, Introduction, (dir), (dir) 12 @node Top, Introduction, (dir), (dir)
20 @comment node-name, next, previous, up 13 @comment node-name, next, previous, up
21 @top The Emacs Widget Library 14 @top The Emacs Widget Library
22 15
92 The advantages for a programmer of using the @code{widget} package to 85 The advantages for a programmer of using the @code{widget} package to
93 implement forms are: 86 implement forms are:
94 87
95 @enumerate 88 @enumerate
96 @item 89 @item
97 More complex fields than just editable text are supported. 90 More complex field than just editable text are supported.
98 @item 91 @item
99 You can give the user immediate feedback if he enters invalid data in a 92 You can give the user immediate feedback if he enters invalid data in a
100 text field, and sometimes prevent entering invalid data. 93 text field, and sometimes prevent entering invalid data.
101 @item 94 @item
102 You can have fixed sized fields, thus allowing multiple field to be 95 You can have fixed sized fields, thus allowing multiple field to be
428 @example 421 @example
429 NAME ::= (NAME [KEYWORD ARGUMENT]... ARGS) 422 NAME ::= (NAME [KEYWORD ARGUMENT]... ARGS)
430 | NAME 423 | NAME
431 @end example 424 @end example
432 425
433 where @var{name} is a widget name, @var{keyword} is the name of a 426 Where, @var{name} is a widget name, @var{keyword} is the name of a
434 property, @var{argument} is the value of the property, and @var{args} 427 property, @var{argument} is the value of the property, and @var{args}
435 are interpreted in a widget specific way. 428 are interpreted in a widget specific way.
436 429
437 There following keyword arguments that apply to all widgets: 430 There following keyword arguments that apply to all widgets:
438 431
508 @item a symbol 501 @item a symbol
509 The value of the symbol is expanded according to this table. 502 The value of the symbol is expanded according to this table.
510 @end table 503 @end table
511 504
512 @item :doc 505 @item :doc
513 The string inserted by the @samp{%d} or @samp{%h} escape in the format 506 The string inserted by the @samp{%d} escape in the format
514 string. 507 string.
515 508
516 @item :tag 509 @item :tag
517 The string inserted by the @samp{%t} escape in the format 510 The string inserted by the @samp{%t} escape in the format
518 string. 511 string.
720 713
721 The following extra properties are recognized. 714 The following extra properties are recognized.
722 715
723 @table @code 716 @table @code
724 @item :size 717 @item :size
725 The minimum width of the editable field.@* 718 The width of the editable field.@*
726 By default the field will reach to the end of the line. If the 719 By default the field will reach to the end of the line.
727 content is too large, the displayed representation will expand to
728 contain it. The content is not truncated to size.
729 720
730 @item :value-face 721 @item :value-face
731 Face used for highlighting the editable field. Default is 722 Face used for highlighting the editable field. Default is
732 @code{widget-field-face}. 723 @code{widget-field-face}.
733 724
742 which matches everything. 733 which matches everything.
743 734
744 @item :keymap 735 @item :keymap
745 Keymap used in the editable field. The default value is 736 Keymap used in the editable field. The default value is
746 @code{widget-field-keymap}, which allows you to use all the normal 737 @code{widget-field-keymap}, which allows you to use all the normal
747 editing commands, even if the buffer's major mode suppress some of them. 738 editing commands, even if the buffers major mode suppress some of them.
748 Pressing return invokes the function specified by @code{:action}. 739 Pressing return invokes the function specified by @code{:action}.
749 @end table 740 @end table
750 741
751 @node text, menu-choice, editable-field, Basic Types 742 @node text, menu-choice, editable-field, Basic Types
752 @comment node-name, next, previous, up 743 @comment node-name, next, previous, up