diff options
| author | Miles Bader | 2007-12-28 22:26:14 +0000 |
|---|---|---|
| committer | Miles Bader | 2007-12-28 22:26:14 +0000 |
| commit | b17f53abc28496125965f36147b76ea5f6a2b4fb (patch) | |
| tree | 4293e53692f304327ba689dfeea32d1b0b5bc12a /doc/lispref | |
| parent | 2e5093251c8e63f4546ffc30182dd4015e9a58fd (diff) | |
| parent | ea7ac2eb953bf3c30670e60cb00a9fca611b38b7 (diff) | |
| download | emacs-b17f53abc28496125965f36147b76ea5f6a2b4fb.tar.gz emacs-b17f53abc28496125965f36147b76ea5f6a2b4fb.zip | |
Merge from emacs--rel--22
Revision: emacs@sv.gnu.org/emacs--devo--0--patch-966
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/ChangeLog | 11 | ||||
| -rw-r--r-- | doc/lispref/customize.texi | 48 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 24 |
3 files changed, 51 insertions, 32 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index bfeb88f7830..50399b0120e 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,14 @@ | |||
| 1 | 2007-12-28 Richard Stallman <rms@gnu.org> | ||
| 2 | |||
| 3 | * frames.texi (Size Parameters): Fix typo. | ||
| 4 | (Basic Parameters): For `title', refer to title bar. | ||
| 5 | (Size and Position): Explain meaning of frame pixel width and height. | ||
| 6 | |||
| 7 | 2007-12-23 Richard Stallman <rms@gnu.org> | ||
| 8 | |||
| 9 | * customize.texi (Type Keywords): Uncomment :validate and clarify it. | ||
| 10 | Improve some of the commented-out keywords' text too. | ||
| 11 | |||
| 1 | 2007-12-14 Martin Rudalics <rudalics@gmx.at> | 12 | 2007-12-14 Martin Rudalics <rudalics@gmx.at> |
| 2 | 13 | ||
| 3 | * nonascii.texi (Encoding and I/O): Reword to avoid saying | 14 | * nonascii.texi (Encoding and I/O): Reword to avoid saying |
diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index b97ce20fc22..d971d5b6db2 100644 --- a/doc/lispref/customize.texi +++ b/doc/lispref/customize.texi | |||
| @@ -1121,6 +1121,16 @@ corresponding value, @var{function}, should be a function that accepts | |||
| 1121 | two arguments, a widget and a value; it should return non-@code{nil} if | 1121 | two arguments, a widget and a value; it should return non-@code{nil} if |
| 1122 | the value is acceptable. | 1122 | the value is acceptable. |
| 1123 | 1123 | ||
| 1124 | @item :validate @var{function} | ||
| 1125 | Specify a validation function for input. @var{function} takes a | ||
| 1126 | widget as an argument, and should return @code{nil} if the widget's | ||
| 1127 | current value is valid for the widget. Otherwise, it should return | ||
| 1128 | the widget containing the invalid data, and set that widget's | ||
| 1129 | @code{:error} property to a string explaining the error. | ||
| 1130 | |||
| 1131 | In many cases you can use the function @code{widget-children-validate} | ||
| 1132 | for this job; it tests that all children of @var{widget} are valid. | ||
| 1133 | |||
| 1124 | @ignore | 1134 | @ignore |
| 1125 | @item :indent @var{columns} | 1135 | @item :indent @var{columns} |
| 1126 | Indent this item by @var{columns} columns. The indentation is used for | 1136 | Indent this item by @var{columns} columns. The indentation is used for |
| @@ -1128,23 +1138,24 @@ Indent this item by @var{columns} columns. The indentation is used for | |||
| 1128 | buttons, and for editable lists. It affects the whole of the | 1138 | buttons, and for editable lists. It affects the whole of the |
| 1129 | item except for the first line. | 1139 | item except for the first line. |
| 1130 | 1140 | ||
| 1131 | @item :offset @var{columns} | 1141 | @item :offset @var{extra} |
| 1132 | An integer indicating how many extra spaces to indent the subitems of | 1142 | Indent the subitems of this item @var{extra} columns more than this |
| 1133 | this item. By default, subitems are indented the same as their parent. | 1143 | item itself. By default, subitems are indented the same as their |
| 1144 | parent. | ||
| 1134 | 1145 | ||
| 1135 | @item :extra-offset | 1146 | @item :extra-offset @var{n} |
| 1136 | An integer indicating how many extra spaces to add to this item's | 1147 | Add @var{n} extra spaces to this item's indentation, compared to its |
| 1137 | indentation, compared to its parent. | 1148 | parent's indentation. |
| 1138 | 1149 | ||
| 1139 | @item :notify | 1150 | @item :notify @var{function} |
| 1140 | A function called each time the item or a subitem is changed. The | 1151 | Call @var{function} each time the item or a subitem is changed. The |
| 1141 | function is called with two or three arguments. The first argument is | 1152 | function gets two or three arguments. The first argument is the item |
| 1142 | the item itself, the second argument is the item that was changed, and | 1153 | itself, the second argument is the item that was changed, and the |
| 1143 | the third argument is the event leading to the change, if any. | 1154 | third argument is the event leading to the change, if any. |
| 1144 | 1155 | ||
| 1145 | @item :menu-tag | 1156 | @item :menu-tag @var{tag-string} |
| 1146 | A tag used in the menu when the widget is used as an option in a | 1157 | Use @var{tag-string} in the menu when the widget is used as an option |
| 1147 | @code{menu-choice} widget. | 1158 | in a @code{menu-choice} widget. |
| 1148 | 1159 | ||
| 1149 | @item :menu-tag-get | 1160 | @item :menu-tag-get |
| 1150 | A function used for finding the tag when the widget is used as an option | 1161 | A function used for finding the tag when the widget is used as an option |
| @@ -1152,15 +1163,6 @@ in a @code{menu-choice} widget. By default, the tag used will be either the | |||
| 1152 | @code{:menu-tag} or @code{:tag} property if present, or the @code{princ} | 1163 | @code{:menu-tag} or @code{:tag} property if present, or the @code{princ} |
| 1153 | representation of the @code{:value} property if not. | 1164 | representation of the @code{:value} property if not. |
| 1154 | 1165 | ||
| 1155 | @item :validate | ||
| 1156 | A function which takes a widget as an argument, and return @code{nil} | ||
| 1157 | if the widget's current value is valid for the widget. Otherwise, it | ||
| 1158 | should return the widget containing the invalid data, and set that | ||
| 1159 | widget's @code{:error} property to a string explaining the error. | ||
| 1160 | |||
| 1161 | You can use the function @code{widget-children-validate} for this job; | ||
| 1162 | it tests that all children of @var{widget} are valid. | ||
| 1163 | |||
| 1164 | @item :tab-order | 1166 | @item :tab-order |
| 1165 | Specify the order in which widgets are traversed with | 1167 | Specify the order in which widgets are traversed with |
| 1166 | @code{widget-forward} or @code{widget-backward}. This is only partially | 1168 | @code{widget-forward} or @code{widget-backward}. This is only partially |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index cd29d44ab76..ab9a6e8291c 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -362,12 +362,12 @@ in this frame. Its value is @code{color}, @code{grayscale} or | |||
| 362 | @code{mono}. | 362 | @code{mono}. |
| 363 | 363 | ||
| 364 | @item title | 364 | @item title |
| 365 | If a frame has a non-@code{nil} title, it appears in the window system's | 365 | If a frame has a non-@code{nil} title, it appears in the window |
| 366 | border for the frame, and also in the mode line of windows in that frame | 366 | system's title bar at the top of the frame, and also in the mode line |
| 367 | if @code{mode-line-frame-identification} uses @samp{%F} | 367 | of windows in that frame if @code{mode-line-frame-identification} uses |
| 368 | (@pxref{%-Constructs}). This is normally the case when Emacs is not | 368 | @samp{%F} (@pxref{%-Constructs}). This is normally the case when |
| 369 | using a window system, and can only display one frame at a time. | 369 | Emacs is not using a window system, and can only display one frame at |
| 370 | @xref{Frame Titles}. | 370 | a time. @xref{Frame Titles}. |
| 371 | 371 | ||
| 372 | @item name | 372 | @item name |
| 373 | The name of the frame. The frame name serves as a default for the frame | 373 | The name of the frame. The frame name serves as a default for the frame |
| @@ -463,7 +463,7 @@ The height of the frame contents, in characters. (To get the height in | |||
| 463 | pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.) | 463 | pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.) |
| 464 | 464 | ||
| 465 | @item width | 465 | @item width |
| 466 | The width of the frame contents, in characters. (To get the height in | 466 | The width of the frame contents, in characters. (To get the width in |
| 467 | pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.) | 467 | pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.) |
| 468 | 468 | ||
| 469 | @item user-size | 469 | @item user-size |
| @@ -808,8 +808,14 @@ of the frame is normally the same as the size of the terminal screen. | |||
| 808 | 808 | ||
| 809 | @defun frame-pixel-height &optional frame | 809 | @defun frame-pixel-height &optional frame |
| 810 | @defunx frame-pixel-width &optional frame | 810 | @defunx frame-pixel-width &optional frame |
| 811 | These functions return the height and width of @var{frame}, measured in | 811 | These functions return the height and width of the main display area |
| 812 | pixels. If you don't supply @var{frame}, they use the selected frame. | 812 | of @var{frame}, measured in pixels. If you don't supply @var{frame}, |
| 813 | they use the selected frame. | ||
| 814 | |||
| 815 | These values include the internal borders, and windows' scroll bars | ||
| 816 | and fringes (which belong to individual windows, not to the frame | ||
| 817 | itself), but do not include menu bars or tool bars (except when using | ||
| 818 | X without an X toolkit). | ||
| 813 | @end defun | 819 | @end defun |
| 814 | 820 | ||
| 815 | @defun frame-char-height &optional frame | 821 | @defun frame-char-height &optional frame |