aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorMiles Bader2007-12-28 22:26:14 +0000
committerMiles Bader2007-12-28 22:26:14 +0000
commitb17f53abc28496125965f36147b76ea5f6a2b4fb (patch)
tree4293e53692f304327ba689dfeea32d1b0b5bc12a /doc/lispref
parent2e5093251c8e63f4546ffc30182dd4015e9a58fd (diff)
parentea7ac2eb953bf3c30670e60cb00a9fca611b38b7 (diff)
downloademacs-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/ChangeLog11
-rw-r--r--doc/lispref/customize.texi48
-rw-r--r--doc/lispref/frames.texi24
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 @@
12007-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
72007-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
12007-12-14 Martin Rudalics <rudalics@gmx.at> 122007-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
1121two arguments, a widget and a value; it should return non-@code{nil} if 1121two arguments, a widget and a value; it should return non-@code{nil} if
1122the value is acceptable. 1122the value is acceptable.
1123 1123
1124@item :validate @var{function}
1125Specify a validation function for input. @var{function} takes a
1126widget as an argument, and should return @code{nil} if the widget's
1127current value is valid for the widget. Otherwise, it should return
1128the widget containing the invalid data, and set that widget's
1129@code{:error} property to a string explaining the error.
1130
1131In many cases you can use the function @code{widget-children-validate}
1132for 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}
1126Indent this item by @var{columns} columns. The indentation is used for 1136Indent 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
1128buttons, and for editable lists. It affects the whole of the 1138buttons, and for editable lists. It affects the whole of the
1129item except for the first line. 1139item except for the first line.
1130 1140
1131@item :offset @var{columns} 1141@item :offset @var{extra}
1132An integer indicating how many extra spaces to indent the subitems of 1142Indent the subitems of this item @var{extra} columns more than this
1133this item. By default, subitems are indented the same as their parent. 1143item itself. By default, subitems are indented the same as their
1144parent.
1134 1145
1135@item :extra-offset 1146@item :extra-offset @var{n}
1136An integer indicating how many extra spaces to add to this item's 1147Add @var{n} extra spaces to this item's indentation, compared to its
1137indentation, compared to its parent. 1148parent's indentation.
1138 1149
1139@item :notify 1150@item :notify @var{function}
1140A function called each time the item or a subitem is changed. The 1151Call @var{function} each time the item or a subitem is changed. The
1141function is called with two or three arguments. The first argument is 1152function gets two or three arguments. The first argument is the item
1142the item itself, the second argument is the item that was changed, and 1153itself, the second argument is the item that was changed, and the
1143the third argument is the event leading to the change, if any. 1154third argument is the event leading to the change, if any.
1144 1155
1145@item :menu-tag 1156@item :menu-tag @var{tag-string}
1146A tag used in the menu when the widget is used as an option in a 1157Use @var{tag-string} in the menu when the widget is used as an option
1147@code{menu-choice} widget. 1158in a @code{menu-choice} widget.
1148 1159
1149@item :menu-tag-get 1160@item :menu-tag-get
1150A function used for finding the tag when the widget is used as an option 1161A 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}
1153representation of the @code{:value} property if not. 1164representation of the @code{:value} property if not.
1154 1165
1155@item :validate
1156A function which takes a widget as an argument, and return @code{nil}
1157if the widget's current value is valid for the widget. Otherwise, it
1158should return the widget containing the invalid data, and set that
1159widget's @code{:error} property to a string explaining the error.
1160
1161You can use the function @code{widget-children-validate} for this job;
1162it tests that all children of @var{widget} are valid.
1163
1164@item :tab-order 1166@item :tab-order
1165Specify the order in which widgets are traversed with 1167Specify 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
365If a frame has a non-@code{nil} title, it appears in the window system's 365If a frame has a non-@code{nil} title, it appears in the window
366border for the frame, and also in the mode line of windows in that frame 366system's title bar at the top of the frame, and also in the mode line
367if @code{mode-line-frame-identification} uses @samp{%F} 367of 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
369using a window system, and can only display one frame at a time. 369Emacs is not using a window system, and can only display one frame at
370@xref{Frame Titles}. 370a time. @xref{Frame Titles}.
371 371
372@item name 372@item name
373The name of the frame. The frame name serves as a default for the frame 373The 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
463pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.) 463pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.)
464 464
465@item width 465@item width
466The width of the frame contents, in characters. (To get the height in 466The width of the frame contents, in characters. (To get the width in
467pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.) 467pixels, 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
811These functions return the height and width of @var{frame}, measured in 811These functions return the height and width of the main display area
812pixels. If you don't supply @var{frame}, they use the selected frame. 812of @var{frame}, measured in pixels. If you don't supply @var{frame},
813they use the selected frame.
814
815These values include the internal borders, and windows' scroll bars
816and fringes (which belong to individual windows, not to the frame
817itself), but do not include menu bars or tool bars (except when using
818X 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