changeset 39197:f56fa34012c0

(Mouse Position): Document mouse-position-function. (Display Feature Testing): Document display-images-p. (Window Frame Parameters): Document the cursor-type variable.
author Eli Zaretskii <eliz@gnu.org>
date Sat, 08 Sep 2001 17:42:16 +0000
parents 4e9db7a710f8
children 634358ff84a4
files lispref/frames.texi
diffstat 1 files changed, 20 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/frames.texi	Sat Sep 08 17:41:41 2001 +0000
+++ b/lispref/frames.texi	Sat Sep 08 17:42:16 2001 +0000
@@ -491,6 +491,7 @@
 in this frame.  Its value is @code{color}, @code{grayscale} or
 @code{mono}.
 
+@vindex cursor-type
 @item cursor-type
 The way to display the cursor.  The legitimate values are @code{bar},
 @code{box}, and @code{(bar . @var{width})}.  The symbol @code{box}
@@ -499,6 +500,11 @@
 between characters as the cursor.  @code{(bar . @var{width})} specifies
 a bar @var{width} pixels wide.
 
+The buffer-local variable @code{cursor-type} overrides the value of
+the @code{cursor-type} frame parameter, and can in addition have
+values @code{t} (use the cursor specified for the frame) and
+@code{nil} (don't display a cursor).
+
 @item border-width
 The width in pixels of the window border.
 
@@ -1141,6 +1147,13 @@
 the top left corner of the inside of @var{frame}.
 @end defun
 
+@defvar mouse-position-function
+If non-nil, the value of this variable is a function applied to the
+normal result of @code{mouse-position}.  This abnormal hook exists for
+the benefit of packages like XTerm-mouse which need to do mouse
+handling at the Lisp level.
+@end defvar
+
 @defun set-mouse-position frame x y
 This function @dfn{warps the mouse} to position @var{x}, @var{y} in
 frame @var{frame}.  The arguments @var{x} and @var{y} are integers,
@@ -1648,6 +1661,13 @@
 supported in some other cases.
 @end defun
 
+@defun display-images-p &optional display
+This function returns @code{t} if @var{display} can display images.
+Windowed displays normally can display images, but some systems can
+lack the necessary support for that.  If images aren't supported, the
+tool bar cannot be displayed.
+@end defun
+
 @defun display-screens &optional display
 @tindex display-screens
 This function returns the number of screens associated with the display.