comparison lispref/display.texi @ 60958:85b21e63d5d4

(Standard Faces, Fringe Bitmaps, Customizing Bitmaps): Cleanup previous change. (Face Attributes): Faces earlier in an :inherit list take precedence. (Scroll Bars): Fix description of vertical-scroll-bars. Document frame-current-scroll-bars and window-current-scroll-bars.
author Richard M. Stallman <rms@gnu.org>
date Sat, 26 Mar 2005 02:03:49 +0000
parents 6a1ac5a5fec1
children b130414b9a25
comparison
equal deleted inserted replaced
60957:d7efcbcdef3b 60958:85b21e63d5d4
1693 This face controls the display of menus, both their colors and their 1693 This face controls the display of menus, both their colors and their
1694 font. (This works only on certain systems.) 1694 font. (This works only on certain systems.)
1695 1695
1696 @item fringe 1696 @item fringe
1697 @kindex fringe @r{(face name)} 1697 @kindex fringe @r{(face name)}
1698 This face controls the default colors of window fringes, the thin areas on 1698 This face controls the default colors of window fringes, the thin
1699 either side that are used to display continuation and truncation glyphs. 1699 areas on either side that are used to display continuation and
1700 Other faces used to display bitmaps in the fringe implicitly inherits from 1700 truncation glyphs. Other faces used to display bitmaps in the fringe
1701 this face. 1701 are implicitly merged with this face.
1702 1702
1703 @item minibuffer-prompt 1703 @item minibuffer-prompt
1704 @kindex minibuffer-prompt @r{(face name)} 1704 @kindex minibuffer-prompt @r{(face name)}
1705 @vindex minibuffer-prompt-properties 1705 @vindex minibuffer-prompt-properties
1706 This face is used for the text of minibuffer prompts. By default, 1706 This face is used for the text of minibuffer prompts. By default,
2006 2006
2007 @item :inherit 2007 @item :inherit
2008 The name of a face from which to inherit attributes, or a list of face 2008 The name of a face from which to inherit attributes, or a list of face
2009 names. Attributes from inherited faces are merged into the face like an 2009 names. Attributes from inherited faces are merged into the face like an
2010 underlying face would be, with higher priority than underlying faces. 2010 underlying face would be, with higher priority than underlying faces.
2011 If a list of faces is used, attributes from faces earlier in the list
2012 override those from later faces.
2011 2013
2012 @item :box 2014 @item :box
2013 Whether or not a box should be drawn around characters, its color, the 2015 Whether or not a box should be drawn around characters, its color, the
2014 width of the box lines, and 3D appearance. 2016 width of the box lines, and 3D appearance.
2015 @end table 2017 @end table
2831 The way to display a bitmap in the left or right fringes for a given 2833 The way to display a bitmap in the left or right fringes for a given
2832 line in a window is by specifying the @code{display} property for one 2834 line in a window is by specifying the @code{display} property for one
2833 of the characters that appears in it. Use a display specification of 2835 of the characters that appears in it. Use a display specification of
2834 the form @code{(left-fringe @var{bitmap} [@var{face}])} or 2836 the form @code{(left-fringe @var{bitmap} [@var{face}])} or
2835 @code{(right-fringe @var{bitmap} [@var{face}])} (@pxref{Display 2837 @code{(right-fringe @var{bitmap} [@var{face}])} (@pxref{Display
2836 Property}). Here, @var{bitmap} is a symbol identifying the bitmap 2838 Property}). Here, @var{bitmap} is a symbol identifying the bitmap you
2837 you want, and @var{face} (which is optional) is the name of the face 2839 want, and @var{face} (which is optional) is the name of the face whose
2838 whose colors should be used for displaying the bitmap, instead of the 2840 colors should be used for displaying the bitmap, instead of the
2839 default @code{fringe} face. When specified, @var{face} implicitly 2841 default @code{fringe} face. @var{face} is automatically merged with
2840 inherits from the @code{fringe} face, so normally @var{face} only 2842 the @code{fringe} face, so normally @var{face} need only specify the
2841 specifies the foreground color for the bitmap. 2843 foreground color for the bitmap.
2842 2844
2843 These are the symbols identify the standard fringe bitmaps. 2845 These are the symbols identify the standard fringe bitmaps.
2844 Evaluate @code{(require 'fringe)} to define them. Fringe bitmap 2846 Evaluate @code{(require 'fringe)} to define them. Fringe bitmap
2845 symbols have their own name space. 2847 symbols have their own name space.
2846 2848
2926 @defun set-fringe-bitmap-face bitmap &optional face 2928 @defun set-fringe-bitmap-face bitmap &optional face
2927 This sets the face for the fringe bitmap @var{bitmap} to @var{face}. 2929 This sets the face for the fringe bitmap @var{bitmap} to @var{face}.
2928 If @var{face} is @code{nil}, it selects the @code{fringe} face. The 2930 If @var{face} is @code{nil}, it selects the @code{fringe} face. The
2929 bitmap's face controls the color to draw it in. 2931 bitmap's face controls the color to draw it in.
2930 2932
2931 The @var{face} implicitly inherits from the @code{fringe} face, 2933 @var{face} is merged with the @code{fringe} face, so normally
2932 so normally @var{face} should specifu only the foreground color. 2934 @var{face} should specify only the foreground color.
2933 @end defun 2935 @end defun
2934 2936
2935 @node Overlay Arrow 2937 @node Overlay Arrow
2936 @subsection The Overlay Arrow 2938 @subsection The Overlay Arrow
2937 @cindex overlay arrow 2939 @cindex overlay arrow
2989 2991
2990 @node Scroll Bars 2992 @node Scroll Bars
2991 @section Scroll Bars 2993 @section Scroll Bars
2992 2994
2993 Normally the frame parameter @code{vertical-scroll-bars} controls 2995 Normally the frame parameter @code{vertical-scroll-bars} controls
2994 whether the windows in the frame have vertical scroll bars. A 2996 whether the windows in the frame have vertical scroll bars, and
2995 non-@code{nil} parameter value means they do. The frame parameter 2997 whether they are on the left or right. The frame parameter
2996 @code{scroll-bar-width} specifies how wide they are (@code{nil} 2998 @code{scroll-bar-width} specifies how wide they are (@code{nil}
2997 meaning the default). @xref{Window Frame Parameters}. 2999 meaning the default). @xref{Window Frame Parameters}.
3000
3001 @defun frame-current-scroll-bars &optional frame
3002 This function reports the scroll bar type settings for frame
3003 @var{frame}. The value is a cons cell
3004 @code{(@var{vertical-type} .@: @var{horizontal-type})}, where
3005 @var{vertical-type} is either @code{left}, @code{right}, or @code{nil}
3006 (which means no scroll bar.) @var{horizontal-type} is meant to
3007 specify the horizontal scroll bar type, but since they are not
3008 implemented, it is always @code{nil}.
3009 @end defun
2998 3010
2999 @vindex vertical-scroll-bar 3011 @vindex vertical-scroll-bar
3000 You can enable or disable scroll bars for a particular buffer, 3012 You can enable or disable scroll bars for a particular buffer,
3001 by setting the variable @code{vertical-scroll-bar}. This variable 3013 by setting the variable @code{vertical-scroll-bar}. This variable
3002 automatically becomes buffer-local when set. The possible values are 3014 automatically becomes buffer-local when set. The possible values are
3047 This variable, always local in all buffers, controls whether and where 3059 This variable, always local in all buffers, controls whether and where
3048 to put scroll bars in windows displaying the buffer. The possible values 3060 to put scroll bars in windows displaying the buffer. The possible values
3049 are @code{nil} for no scroll bar, @code{left} to put a scroll bar on 3061 are @code{nil} for no scroll bar, @code{left} to put a scroll bar on
3050 the left, and @code{right} to put a scroll bar on the right. 3062 the left, and @code{right} to put a scroll bar on the right.
3051 @end defvar 3063 @end defvar
3064
3065 @defun window-current-scroll-bars &optional window
3066 This function reports the scroll bar type for window @var{window}.
3067 If @var{window} is omitted or @code{nil}, the selected window is used.
3068 The value is a cons cell
3069 @code{(@var{vertical-type} .@: @var{horizontal-type})}. Unlike
3070 @code{window-scroll-bars}, this reports the scroll bar type actually
3071 used, once frame defaults and @code{scroll-bar-mode} are taken into
3072 account.
3073 @end defun
3052 3074
3053 @defvar scroll-bar-width 3075 @defvar scroll-bar-width
3054 This variable, always local in all buffers, specifies the width of the 3076 This variable, always local in all buffers, specifies the width of the
3055 buffer's scroll bars, measured in pixels. A value of @code{nil} means 3077 buffer's scroll bars, measured in pixels. A value of @code{nil} means
3056 to use the value specified by the frame. 3078 to use the value specified by the frame.