diff options
author | Richard M. Stallman <rms@gnu.org> | 2007-12-23 16:45:02 +0000 |
---|---|---|
committer | Richard M. Stallman <rms@gnu.org> | 2007-12-23 16:45:02 +0000 |
commit | 6293fc3eff721d3a5d52608f6d7077a626e4efb3 (patch) | |
tree | 5a86ca2f33e6a21335b445232e5665c9f3e0bd8b /lispref/customize.texi | |
parent | ebdf87f71ce921be9d8fa09dc22259520a382e2a (diff) | |
download | emacs-6293fc3eff721d3a5d52608f6d7077a626e4efb3.tar.gz |
(Type Keywords): Uncomment :validate and clarify it.
Improve some of the commented-out keywords' text too.
Diffstat (limited to 'lispref/customize.texi')
-rw-r--r-- | lispref/customize.texi | 48 |
1 files changed, 25 insertions, 23 deletions
diff --git a/lispref/customize.texi b/lispref/customize.texi index fede33bd046..feb72387e4f 100644 --- a/lispref/customize.texi +++ b/lispref/customize.texi @@ -1113,6 +1113,16 @@ corresponding value, @var{function}, should be a function that accepts two arguments, a widget and a value; it should return non-@code{nil} if the value is acceptable. +@item :validate @var{function} +Specify a validation function for input. @var{function} takes a +widget as an argument, and should return @code{nil} if the widget's +current value is valid for the widget. Otherwise, it should return +the widget containing the invalid data, and set that widget's +@code{:error} property to a string explaining the error. + +In many cases you can use the function @code{widget-children-validate} +for this job; it tests that all children of @var{widget} are valid. + @ignore @item :indent @var{columns} Indent this item by @var{columns} columns. The indentation is used for @@ -1120,23 +1130,24 @@ Indent this item by @var{columns} columns. The indentation is used for buttons, and for editable lists. It affects the whole of the item except for the first line. -@item :offset @var{columns} -An integer indicating how many extra spaces to indent the subitems of -this item. By default, subitems are indented the same as their parent. +@item :offset @var{extra} +Indent the subitems of this item @var{extra} columns more than this +item itself. By default, subitems are indented the same as their +parent. -@item :extra-offset -An integer indicating how many extra spaces to add to this item's -indentation, compared to its parent. +@item :extra-offset @var{n} +Add @var{n} extra spaces to this item's indentation, compared to its +parent's indentation. -@item :notify -A function called each time the item or a subitem is changed. The -function is called with two or three arguments. The first argument is -the item itself, the second argument is the item that was changed, and -the third argument is the event leading to the change, if any. +@item :notify @var{function} +Call @var{function} each time the item or a subitem is changed. The +function gets two or three arguments. The first argument is the item +itself, the second argument is the item that was changed, and the +third argument is the event leading to the change, if any. -@item :menu-tag -A tag used in the menu when the widget is used as an option in a -@code{menu-choice} widget. +@item :menu-tag @var{tag-string} +Use @var{tag-string} in the menu when the widget is used as an option +in a @code{menu-choice} widget. @item :menu-tag-get A function used for finding the tag when the widget is used as an option @@ -1144,15 +1155,6 @@ in a @code{menu-choice} widget. By default, the tag used will be either the @code{:menu-tag} or @code{:tag} property if present, or the @code{princ} representation of the @code{:value} property if not. -@item :validate -A function which takes a widget as an argument, and return @code{nil} -if the widget's current value is valid for the widget. Otherwise, it -should return the widget containing the invalid data, and set that -widget's @code{:error} property to a string explaining the error. - -You can use the function @code{widget-children-validate} for this job; -it tests that all children of @var{widget} are valid. - @item :tab-order Specify the order in which widgets are traversed with @code{widget-forward} or @code{widget-backward}. This is only partially |