@item :data @var{data}
The @code{:data} property specifies the actual contents of the image.
Each image must use either @code{:data} or @code{:file}, but not both.
-However, only certain image types support @code{:data}; for other types,
-you must use @code{:file}.
-
-The formats that support @code{:data} include XBM and XPM.
-Before using @code{:data}, see the section describing the specific
-format you wish to use for further information.
+For most image types, the value of the @code{:data} property should be a
+string containing the image data; we recommend using a unibyte string.
+
+Before using @code{:data}, look for further information in the section
+below describing the specific image format. For some image types,
+@code{:data} may not be supported; for some, it allows other data types;
+for some, @code{:data} alone is not enough, so you need to use other
+image properties along with @code{:data}.
@end table
@node XBM Images
0. The default is the frame's background color.
@end table
- You can specify an XBM image using data within Emacs instead
-of an external file. To do this, don't use @code{:file}; instead,
-use the following three properties (all of them):
+ If you specify an XBM image using data within Emacs instead of an
+external file, use the following three properties (all of them):
@table @code
@item :width @var{width}
The value, @var{height}, specifies the height of the image in pixels.
@item :data @var{data}
-The value, @var{data}, is normally a string or a bool-vector. Either
-way, it must contain enough bits for the area of the image: at least
-@var{width} * @code{height}.
+The value, @var{data}, should normally be a string or a bool-vector.
+Either way, it must contain enough bits for the area of the image: at
+least @var{width} * @code{height} bits.
Alternatively, @var{data} can be a vector of strings or bool-vectors,
each specifying one line of the image.
@subsection XPM Images
@cindex XPM
- To use XPM format, specify @code{xpm} as the image type. These
-additional image properties are meaningful with the @code{xpm} image
-type:
+ To use XPM format, specify @code{xpm} as the image type. The
+additional image property @code{:color-symbols} is also meaningful with
+the @code{xpm} image type:
@table @code
@item :color-symbols @var{symbols}
form @code{(@var{name} . @var{color})}. In each element, @var{name} is
the name of a color as it appears in the image file, and @var{color}
specifies the actual color to use for displaying that name.
-
-@item :data @var{data}
-XPM images can be displayed from data instead of files. In that case,
-use the @code{:data} property instead of the @code{:file} property.
-
-The value @var{data} must be a string containing an XPM image. The
-contents of the string have same format as an external XPM file.
@end table
@node GIF Images
@end example
@end table
+ Displaying Postscript images from Lisp data is not currently
+implemented, but it may be implemented by the time you read this.
+See the @file{etc/NEWS} file to make sure.
+
@node Other Image Types
@subsection Other Image Types
@cindex PBM
For PBM images, specify image type @code{pbm}. Color, gray-scale and
monochromatic images are supported.
- For JPEG images, specify image type @code{jpeg}. There are no
-additional image properties defined.
+ For JPEG images, specify image type @code{jpeg}.
For TIFF images, specify image type @code{tiff}.
Note that this does not tell you whether the display you are using
really supports that color. When using X, you can ask for any defined
color on any kind of display, and you will get some result---typically,
-the best it knows how to do. Here's an approximate way to test whether
-your display supports the color @var{color}:
-
-@example
-(defun x-color-supported-p (color &optional frame)
- (and (color-defined-p color frame)
- (or (x-display-color-p frame)
- (member color '("black" "white"))
- (and (> (x-display-planes frame) 1)
- (equal color "gray")))))
-@end example
+the closest it can do. To determine whether a frame can really display
+a certain color, use @code{color-supported-p} (see below).
+@findex x-color-defined-p
This function used to be called @code{x-color-defined-p},
and that name is still supported as an alias.
@end defun
This function returns a list of the color names that are defined
and supported on frame @var{frame} (default, the selected frame).
+@findex x-defined-colors
This function used to be called @code{x-defined-colors},
and that name is still supported as an alias.
@end defun
+@defun color-supported-p color &optional frame background-p
+@tindex color-supported-p
+This returns @code{t} if @var{frame} can really display the color
+@var{color} (or at least something close to it). If @var{frame} is
+omitted or @code{nil}, the question applies to the selected frame.
+
+Some terminals support a different set of colors for foreground and
+background. If @var{background-p} is non-@code{nil}, that means you are
+asking whether @var{color} can be used as a background; otherwise you
+are asking whether it can be used as a foreground.
+
+The argument @var{color} must be a valid color name.
+@end defun
+
+@defun color-gray-p color &optional frame
+@tindex color-gray-p
+This returns @code{t} if @var{color} is a shade of gray, as defined on
+@var{frame}'s display. If @var{frame} is omitted or @code{nil}, the
+question applies to the selected frame. The argument @var{color} must
+be a valid color name.
+@end defun
+
@defun color-values color &optional frame
@tindex color-values
This function returns a value that describes what @var{color} should
is omitted or @code{nil}, the information is returned for the selected
frame's display.
+@findex x-color-values
This function used to be called @code{x-color-values},
and that name is still supported as an alias.
@end defun
+@defun display-color-p &optional display
+@tindex display-color-p
+@findex x-display-color-p
+This function returns @code{t} if the screen is a color screen.
+It used to be called @code{x-display-color-p}, and that name
+is still supported as an alias.
+@end defun
+
@node Text Terminal Colors
@section Text Terminal Colors
@cindex colors on text-only terminals
principle from 0 to 65535, but in practice the largest value used is
65280.
-@defun tty-define-color name number &optional rgb
-@tindex tty-define-color
+ These functions accept a frame as an optional argument. We hope in
+the future to make Emacs support multiple text-only terminals; then
+this'argument will specify which terminal to operate on (the default
+being the selected frame). At present, though, the @var{frame} argument
+has no effect.
+
+@defun tty-color-define name number &optional rgb frame
+@tindex tty-color-define
This function associates the color name @var{name} with
color number @var{number} on the terminal.
like.
@end defun
-@defun tty-clear-colors
-@tindex tty-clear-colors
+@defun tty-color-clear &optional frame
+@tindex tty-color-clear
This function clears the table of defined colors for a text-only terminal.
@end defun
-@defvar tty-color-alist
+@defun tty-color-alist &optional frame
@tindex tty-color-alist
-This variable holds an alist recording the colors supported by the
-terminal.
+This function returns an alist recording the known colors supported by a
+text-only terminal.
Each element has the form @code{(@var{name} @var{number} . @var{rgb})}
or @code{(@var{name} @var{number})}. Here, @var{name} is the color
name, @var{number} is the number used to specify it to the terminal.
If present, @var{rgb} is an rgb value that says what the color
actually looks like.
-@end defvar
+@end defun
-@defun tty-color-approximate rgb
+@defun tty-color-approximate rgb &optional frame
@tindex tty-color-approximate
-This function finds the closest available color, among those in
-@code{tty-color-alist}, to that described by the rgb value @var{rgb}.
+This function finds the closest color, among the known colors supported
+for @var{frame}'s terminal, to that described by the rgb value
+@var{rgb}.
@end defun
-@defun tty-color-translate color
+@defun tty-color-translate color &optional frame
@tindex tty-color-translate
-This function finds the closest available color, among those in
-@code{tty-color-alist}, to the name @var{color}. If that name
-is not defined, the value is @code{nil}.
+This function finds the closest color to @var{color} among the known
+colors supported for @var{frame}'s terminal. If the name @var{color} is
+not defined, the value is @code{nil}.
-@var{color} can be an X-style @code{#@var{xxxyyyzzz}} specification
-instead of an actual name.
+@var{color} can be an X-style @code{"#@var{xxxyyyzzz}"} specification
+instead of an actual name. The format
+@code{"RGB:@var{xx}/@var{yy}/@var{zz}"} is also supported.
@end defun
@node Resources
This function returns @code{t} if the screen can display shades of gray.
@end defun
-@defun x-display-color-p &optional display
-This function returns @code{t} if the screen is a color screen.
-@end defun
-
@defun x-display-color-cells &optional display
This function returns the number of color cells the screen supports.
@end defun
@defun all-completions string collection &optional predicate nospace
This function returns a list of all possible completions of
-@var{string}. The arguments to this function are the same as those of
-@code{try-completion}.
+@var{string}. The arguments to this function (aside from @var{nospace})
+are the same as those of @code{try-completion}. If @var{nospace} is
+non-@code{nil}, completions that start with a space are ignored unless
+@var{string} also starts with a space.
If @var{collection} is a function, it is called with three arguments:
@var{string}, @var{predicate} and @code{t}; then @code{all-completions}
returns whatever the function returns. @xref{Programmed Completion}.
-If @var{nospace} is non-@code{nil}, completions that start with a space
-are ignored unless @var{string} also starts with a space.
-
Here is an example, using the function @code{test} shown in the
example for @code{try-completion}:
@code{t}. Otherwise, the return value is @code{nil} and point stops at
the buffer boundary or field boundary.
+If @code{inhibit-field-text-motion} is non-@code{nil},
+this function ignores field boundaries.
+
In an interactive call, @var{count} is specified by the numeric prefix
argument.
@end deffn
words. Otherwise, they do not.
@end defvar
+@defvar inhibit-field-text-motion
+@tindex inhibit-field-text-motion
+If this variable is non-@code{nil}, certain motion functions including
+@code{forward-word}, @code{forward-sentence}, and
+@codef{forward-paragraph} ignore field boundaries.
+@end defvar
+
@node Buffer End Motion
@subsection Motion to an End of the Buffer
If this function reaches the end of the buffer (or of the accessible
portion, if narrowing is in effect), it positions point there. No error
is signaled.
-
-This function does not move across a field boundary (@pxref{Fields}),
-unless it moves to another line beyond the one that contains the field
-boundary. If @var{count} is zero, and point starts at a field boundary,
-then point does not move.
@end deffn
@defun line-beginning-position &optional count
If this function reaches the end of the buffer (or of the accessible
portion, if narrowing is in effect), it positions point there. No error
is signaled.
-
-This function does not move across a field boundary, unless it moves to
-another line beyond the one that contains the field boundary. If
-@var{count} is zero, and point starts at a field boundary, then point
-does not move.
@end deffn
@defun line-end-position &optional count
this lookup uses a hashing algorithm and an obarray; see @ref{Creating
Symbols}.)
+ The value cell holds the symbol's value as a variable
+(@pxref{Variables}). That is what you get if you evaluate the symbol as
+a Lisp expression (@pxref{Evaluation}). Any Lisp object is a legitimate
+value. Certain symbols have values that cannot be changed; these
+include @code{nil} and @code{t}, and any symbol whose name starts with
+@samp{:} (those are called @dfn{keywords}). @xref{Constant Variables}.
+
In normal usage, the function cell usually contains a function
(@pxref{Functions}) or a macro (@pxref{Macros}), as that is what the
Lisp interpreter expects to see there (@pxref{Evaluation}). Keyboard
This function deletes the text of the field specified by @var{pos}.
@end defun
+@deffn beginning-of-line-or-field &optional count
+@tindex beginning-of-line-or-field
+Like @code{beginning-of-line}, except that this function does not move
+across a field boundary (@pxref{Fields}), unless it moves to another
+line beyond the one that contains the field boundary. Therefore, if
+@var{count} is zero, and point is initially at a field boundary, point
+does not move.
+@end deffn
+
+@deffn end-of-line-or-field &optional count
+@tindex end-of-line-or-field
+Like @code{end-of-line}, except that this function does not move
+across a field boundary (@pxref{Fields}), unless it moves to another
+line beyond the one that contains the field boundary.
+@end deffn
+
@defun constrain-to-field new-pos old-pos &optional escape-from-edge only-in-line
@tindex constrain-to-field
This function ``constrains'' @var{new-pos} to the field that