annotate doc/lispref/frames.texi @ 102918:f166876b8717

* keymaps.texi (Tool Bar): Mention that some platforms do not support multi-line toolbars. Suggested by Stephen Eglen. * frames.texi (Layout Parameters): Mention that Nextstep also allows only one tool-bar line. Suggested by Stephen Eglen.
author Chong Yidong <cyd@stupidchicken.com>
date Fri, 10 Apr 2009 02:12:01 +0000
parents a447859a557b
children cfd0f4bd9e6e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
100974
cb5d2387102c Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 100720
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
84116
0ba80d073e27 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84068
diff changeset
6 @setfilename ../../info/frames
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @node Frames, Positions, Windows, Top
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @chapter Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @cindex frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
11 A @dfn{frame} is a screen object that contains one or more Emacs
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
12 windows (@pxref{Windows}). It is the kind of object called a
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
13 ``window'' in the terminology of graphical environments; but we can't
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
14 call it a ``window'' here, because Emacs uses that word in a different
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
15 way. In Emacs Lisp, a @dfn{frame object} is a Lisp object that
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
16 represents a frame on the screen. @xref{Frame Type}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 A frame initially contains a single main window and/or a minibuffer
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 window; you can subdivide the main window vertically or horizontally
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
20 into smaller windows. @xref{Splitting Windows}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
22 @cindex terminal
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
23 A @dfn{terminal} is a display device capable of displaying one or
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
24 more Emacs frames. In Emacs Lisp, a @dfn{terminal object} is a Lisp
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
25 object that represents a terminal. @xref{Terminal Type}.
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
26
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 @cindex terminal frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 @cindex window frame
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
29 There are two classes of terminals: text-only terminals and
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
30 graphical terminals. Text-only terminals are non-graphics-capable
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
31 display devices, including ``terminal emulators'' such as xterm. On
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
32 text-only terminals, each frame occupies the entire terminal screen;
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
33 although you can create additional frames and switch between them,
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
34 only one frame can be shown at any given time. We refer to frames on
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
35 text-only terminals as @dfn{terminal frames}. Graphical terminals, on
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
36 the other hand, are graphics-capable windowing systems, such as the X
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
37 Window System. On a graphical terminal, Emacs can display multiple
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
38 frames simultaneously. We refer to such frames as @dfn{window
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
39 frames}.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
40
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
41 On GNU and Unix systems, you can create additional frames on any
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
42 available terminal, within a single Emacs session, regardless of
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
43 whether Emacs was started on a text-only or graphical terminal. Emacs
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
44 can display on both graphical and text-only terminals simultaneously.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
45 This comes in handy, for instance, when you connect to the same
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
46 session from several remote locations. @xref{Multiple Terminals}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 @defun framep object
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 This predicate returns a non-@code{nil} value if @var{object} is a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 frame, and @code{nil} otherwise. For a frame, the value indicates which
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 kind of display the frame uses:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 @item x
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 The frame is displayed in an X window.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 @item t
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 A terminal frame on a character display.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 @item w32
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 The frame is displayed on MS-Windows 9X/NT.
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
60 @item ns
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
61 The frame is displayed on a GNUstep or Macintosh Cocoa display.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 @item pc
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 The frame is displayed on an MS-DOS terminal.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
67 @defun frame-terminal &optional frame
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
68 This function returns the terminal object that displays @var{frame}.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
69 If @var{frame} is @code{nil} or unspecified, it defaults to the
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
70 selected frame.
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
71 @end defun
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
72
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
73 @defun terminal-live-p object
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
74 This predicate returns a non-@code{nil} value if @var{object} is a
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
75 terminal that is alive (i.e.@: was not deleted), and @code{nil}
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
76 otherwise. For live terminals, the return value indicates what kind
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
77 of frames are displayed on that terminal; the list of possible values
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
78 is the same as for @code{framep} above.
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
79 @end defun
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
80
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 @menu
100720
87e287e416fe (Multiple Terminals, Low-level Terminal)
Eli Zaretskii <eliz@gnu.org>
parents: 99763
diff changeset
82 * Creating Frames:: Creating additional frames.
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
83 * Multiple Terminals:: Displaying on several different devices.
100720
87e287e416fe (Multiple Terminals, Low-level Terminal)
Eli Zaretskii <eliz@gnu.org>
parents: 99763
diff changeset
84 * Frame Parameters:: Controlling frame size, position, font, etc.
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
85 * Terminal Parameters:: Parameters common for all frames on terminal.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 * Frame Titles:: Automatic updating of frame titles.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 * Deleting Frames:: Frames last until explicitly deleted.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 * Finding All Frames:: How to examine all existing frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 * Frames and Windows:: A frame contains windows;
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 display of text always works through windows.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 * Minibuffers and Frames:: How a frame finds the minibuffer to use.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 * Input Focus:: Specifying the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 * Visibility of Frames:: Frames may be visible or invisible, or icons.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 * Raising and Lowering:: Raising a frame makes it hide other windows;
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 lowering it makes the others hide it.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 * Frame Configurations:: Saving the state of all frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 * Mouse Tracking:: Getting events that say when the mouse moves.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 * Mouse Position:: Asking where the mouse is, or moving it.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 * Pop-Up Menus:: Displaying a menu for the user to select from.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 * Dialog Boxes:: Displaying a box to ask yes or no.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 * Pointer Shape:: Specifying the shape of the mouse pointer.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 * Window System Selections:: Transferring text to and from other X clients.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 * Drag and Drop:: Internals of Drag-and-Drop implementation.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 * Color Names:: Getting the definitions of color names.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 * Text Terminal Colors:: Defining colors for text-only terminals.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 * Resources:: Getting resource values from the server.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 * Display Feature Testing:: Determining the features of a terminal.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108 @end menu
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 @node Creating Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 @section Creating Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 To create a new frame, call the function @code{make-frame}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 @defun make-frame &optional alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 This function creates and returns a new frame, displaying the current
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
117 buffer.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
118
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
119 The @var{alist} argument is an alist that specifies frame parameters
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
120 for the new frame. @xref{Frame Parameters}. If you specify the
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
121 @code{terminal} parameter in @var{alist}, the new frame is created on
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
122 that terminal. Otherwise, if you specify the @code{window-system}
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
123 frame parameter in @var{alist}, that determines whether the frame
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
124 should be displayed on a text-only or graphical terminal.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
125 @xref{Window Systems}. If neither is specified, the new frame is
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
126 created in the same terminal as the selected frame.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
127
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
128 Any parameters not mentioned in @var{alist} default to the values in
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
129 the alist @code{default-frame-alist} (@pxref{Initial Parameters});
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
130 parameters not specified there default from the X resources or its
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
131 equivalent on your operating system (@pxref{X Resources,, X Resources,
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
132 emacs, The GNU Emacs Manual}). After the frame is created, Emacs
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
133 applies any parameters listed in @code{frame-inherited-parameters}
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
134 (see below) and not present in the argument, taking the values from
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
135 the frame that was selected when @code{make-frame} was called.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 This function itself does not make the new frame the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 @xref{Input Focus}. The previously selected frame remains selected.
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
139 On graphical terminals, however, the windowing system may select the
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
140 new frame for its own reasons.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 @defvar before-make-frame-hook
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
144 A normal hook run by @code{make-frame} before it creates the frame.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 @defvar after-make-frame-functions
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 An abnormal hook run by @code{make-frame} after it creates the frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 Each function in @code{after-make-frame-functions} receives one argument, the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 frame just created.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152
98737
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
153 @defvar frame-inherited-parameters
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
154 This variable specifies the list of frame parameters that a newly
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
155 created frame inherits from the currently selected frame. For each
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
156 parameter (a symbol) that is an element in the list and is not present
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
157 in the argument to @code{make-frame}, the function sets the value of
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
158 that parameter in the created frame to its value in the selected
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
159 frame.
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
160 @end defvar
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
161
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
162 @node Multiple Terminals
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
163 @section Multiple Terminals
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
164 @cindex multiple terminals
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
165 @cindex multi-tty
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 @cindex multiple X displays
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 @cindex displays, multiple
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
169 Emacs represents each terminal, whether graphical or text-only, as a
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
170 @dfn{terminal object} data type (@pxref{Terminal Type}). On GNU and
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
171 Unix systems, Emacs can use multiple terminals simultaneously in each
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
172 session. On other systems, it can only use a single terminal. Each
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
173 terminal object has the following attributes:
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
174
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
175 @itemize @bullet
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
176 @item
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
177 The name of the device used by the terminal (e.g., @samp{:0.0} or
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
178 @file{/dev/tty}).
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
179
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
180 @item
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
181 The terminal and keyboard coding systems used on the terminal.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
182 @xref{Terminal I/O Encoding}.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
183
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
184 @item
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
185 The kind of display associated with the terminal. This is the symbol
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
186 returned by the function @code{terminal-live-p} (i.e., @code{x},
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
187 @code{t}, @code{w32}, @code{ns}, or @code{pc}). @xref{Frames}.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
188
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
189 @item
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
190 A list of terminal parameters. @xref{Terminal Parameters}.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
191 @end itemize
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
192
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
193 There is no primitive for creating terminal objects. Emacs creates
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
194 them as needed, such as when you call @code{make-frame-on-display}
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
195 (which is described below).
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
196
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
197 @defun terminal-name &optional terminal
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
198 This function returns the file name of the device used by
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
199 @var{terminal}. If @var{terminal} is omitted or @code{nil}, it
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
200 defaults to the selected frame's terminal. @var{terminal} can also be
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
201 a frame, meaning that frame's terminal.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
202 @end defun
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
203
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
204 @defun terminal-list
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
205 This function returns a list of all terminal objects currently in use.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
206 @end defun
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
207
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
208 @defun get-device-terminal device
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
209 This function returns a terminal whose device name is given by
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
210 @var{device}. If @var{device} is a string, it can be either the file
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
211 name of a terminal device, or the name of an X display of the form
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
212 @samp{@var{host}:@var{server}.@var{screen}}. If @var{device} is a
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
213 frame, this function returns that frame's terminal; @code{nil} means
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
214 the selected frame. Finally, if @var{device} is a terminal object
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
215 that represents a live terminal, that terminal is returned. The
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
216 function signals an error if its argument is none of the above.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
217 @end defun
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
218
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
219 @defun delete-terminal &optional terminal force
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
220 This function deletes all frames on @var{terminal} and frees the
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
221 resources used by it. It runs the abnormal hook
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
222 @code{delete-terminal-functions}, passing @var{terminal} as the
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
223 argument to each function.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
224
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
225 If @var{terminal} is omitted or @code{nil}, it defaults to the
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
226 selected frame's terminal. @var{terminal} can also be a frame,
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
227 meaning that frame's terminal.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
228
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
229 Normally, this function signals an error if you attempt to delete the
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
230 sole active terminal, but if @var{force} is non-@code{nil}, you are
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
231 allowed to do so. Emacs automatically calls this function when the
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
232 last frame on a terminal is deleted (@pxref{Deleting Frames}).
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
233 @end defun
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
234
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
235 @defvar delete-terminal-functions
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
236 An abnormal hook run by @code{delete-terminal}. Each function
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
237 receives one argument, the @var{terminal} argument passed to
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
238 @code{delete-terminal}. Due to technical details, the functions may
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
239 be called either just before the terminal is deleted, or just
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
240 afterwards.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
241 @end defvar
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
242
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
243 @cindex terminal-local variables
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 A few Lisp variables are @dfn{terminal-local}; that is, they have a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245 separate binding for each terminal. The binding in effect at any time
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 is the one for the terminal that the currently selected frame belongs
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 to. These variables include @code{default-minibuffer-frame},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 @code{defining-kbd-macro}, @code{last-kbd-macro}, and
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
249 @code{system-key-alist}. They are always terminal-local, and can
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
250 never be buffer-local (@pxref{Buffer-Local Variables}).
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
251
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
252 On GNU and Unix systems, each X display is a separate graphical
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
253 terminal. When Emacs is started from within the X window system, it
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
254 uses the X display chosen with the @code{DISPLAY} environment
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
255 variable, or with the @samp{--display} option. @xref{Initial
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
256 Options,,, emacs, The GNU Emacs Manual}. Emacs can connect to other X
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
257 displays via the command @code{make-frame-on-display}. Each X display
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
258 has its own selected frame and its own minibuffer windows; however,
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
259 only one of those frames is ``@emph{the} selected frame'' at any given
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
260 moment (@pxref{Input Focus}). Emacs can even connect to other
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
261 text-only terminals, by interacting with the @command{emacsclient}
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
262 program. @xref{Emacs Server,,, emacs, The GNU Emacs Manual}.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
263
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
264 A single X server can handle more than one display. Each X display
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
265 has a three-part name, @samp{@var{host}:@var{server}.@var{screen}}.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
266 The first two parts, @var{host} and @var{server}, identify the X
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
267 server; the third part, @var{screen}, identifies a screen number on
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
268 that X server. When you use two or more screens belonging to one
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
269 server, Emacs knows by the similarity in their names that they share a
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
270 single keyboard.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
271
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
272 On some ``multi-monitor'' setups, a single X display outputs to more
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
273 than one monitor. Currently, there is no way for Emacs to distinguish
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
274 between the different physical monitors.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 @deffn Command make-frame-on-display display &optional parameters
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
277 This function creates and returns a new frame on @var{display}, taking
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
278 the other frame parameters from the alist @var{parameters}.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
279 @var{display} should be the name of an X display (a string).
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
280
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
281 Before creating the frame, this function ensures that Emacs is ``set
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
282 up'' to display graphics. For instance, if Emacs has not processed X
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
283 resources (e.g., if it was started on a text-only terminal), it does
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
284 so at this time. In all other respects, this function behaves like
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
285 @code{make-frame} (@pxref{Creating Frames}).
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 @end deffn
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 @defun x-display-list
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
289 This function returns a list that indicates which X displays Emacs has
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
290 a connection to. The elements of the list are strings, and each one
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
291 is a display name.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 @defun x-open-connection display &optional xrm-string must-succeed
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
295 This function opens a connection to the X display @var{display},
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
296 without creating a frame on that display. Normally, Emacs Lisp
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
297 programs need not call this function, as @code{make-frame-on-display}
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
298 calls it automatically. The only reason for calling it is to check
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
299 whether communication can be established with a given X display.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
300
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
301 The optional argument @var{xrm-string}, if not @code{nil}, is a string
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
302 of resource names and values, in the same format used in the
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
303 @file{.Xresources} file. @xref{X Resources,, X Resources, emacs, The
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
304 GNU Emacs Manual}. These values apply to all Emacs frames created on
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
305 this display, overriding the resource values recorded in the X server.
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
306 Here's an example of what this string might look like:
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 "*BorderWidth: 3\n*InternalBorder: 2\n"
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 If @var{must-succeed} is non-@code{nil}, failure to open the connection
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 terminates Emacs. Otherwise, it is an ordinary Lisp error.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 @defun x-close-connection display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317 This function closes the connection to display @var{display}. Before
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
318 you can do this, you must first delete all the frames that were open
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
319 on that display (@pxref{Deleting Frames}).
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
320 @end defun
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
321
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 @node Frame Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 @section Frame Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 @cindex frame parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 A frame has many parameters that control its appearance and behavior.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 Just what parameters a frame has depends on what display mechanism it
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 uses.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 Frame parameters exist mostly for the sake of window systems. A
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 terminal frame has a few parameters, mostly for compatibility's sake;
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 only the @code{height}, @code{width}, @code{name}, @code{title},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333 @code{menu-bar-lines}, @code{buffer-list} and @code{buffer-predicate}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 parameters do something special. If the terminal supports colors, the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 parameters @code{foreground-color}, @code{background-color},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 @code{background-mode} and @code{display-type} are also meaningful.
99685
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
337 If the terminal supports frame transparency, the parameter
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
338 @code{alpha} is also meaningful.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339
98681
8be1f0e1f72d (Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents: 97043
diff changeset
340 You can use frame parameters to define frame-local bindings for
8be1f0e1f72d (Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents: 97043
diff changeset
341 variables. @xref{Frame-Local Variables}.
8be1f0e1f72d (Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents: 97043
diff changeset
342
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 @menu
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 * Parameter Access:: How to change a frame's parameters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 * Initial Parameters:: Specifying frame parameters when you make a frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 * Window Frame Parameters:: List of frame parameters for window systems.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 * Size and Position:: Changing the size and position of a frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 * Geometry:: Parsing geometry specifications.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 @end menu
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 @node Parameter Access
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 @subsection Access to Frame Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 These functions let you read and change the parameter values of a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 @defun frame-parameter frame parameter
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 This function returns the value of the parameter @var{parameter} (a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 symbol) of @var{frame}. If @var{frame} is @code{nil}, it returns the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 selected frame's parameter. If @var{frame} has no setting for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 @var{parameter}, this function returns @code{nil}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 @defun frame-parameters &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 The function @code{frame-parameters} returns an alist listing all the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 parameters of @var{frame} and their values. If @var{frame} is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 @code{nil} or omitted, this returns the selected frame's parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 @defun modify-frame-parameters frame alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 This function alters the parameters of frame @var{frame} based on the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 elements of @var{alist}. Each element of @var{alist} has the form
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 @code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 parameter. If you don't mention a parameter in @var{alist}, its value
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 doesn't change. If @var{frame} is @code{nil}, it defaults to the selected
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 frame.
98681
8be1f0e1f72d (Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents: 97043
diff changeset
377
8be1f0e1f72d (Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents: 97043
diff changeset
378 You can use this function to define frame-local bindings for
8be1f0e1f72d (Frames): Mention multiple tty frames.
Eli Zaretskii <eliz@gnu.org>
parents: 97043
diff changeset
379 variables, see @ref{Frame-Local Variables}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381
98737
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
382 @defun set-frame-parameter frame parm value
98755
9fdc192b2742 (Creating Frames): Fix typo in last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98737
diff changeset
383 This function sets the frame parameter @var{parm} to the specified
98737
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
384 @var{value}. If @var{frame} is @code{nil}, it defaults to the
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
385 selected frame.
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
386 @end defun
40fea3019362 (Creating Frames): Document frame-inherited-parameters.
Eli Zaretskii <eliz@gnu.org>
parents: 98681
diff changeset
387
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 @defun modify-all-frames-parameters alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 This function alters the frame parameters of all existing frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 according to @var{alist}, then modifies @code{default-frame-alist}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 (and, if necessary, @code{initial-frame-alist}) to apply the same
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 parameter values to frames that will be created henceforth.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 @node Initial Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 @subsection Initial Frame Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 You can specify the parameters for the initial startup frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 by setting @code{initial-frame-alist} in your init file (@pxref{Init File}).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 @defvar initial-frame-alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 This variable's value is an alist of parameter values used when creating
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 the initial window frame. You can set this variable to specify the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 appearance of the initial frame without altering subsequent frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 Each element has the form:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 (@var{parameter} . @var{value})
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 Emacs creates the initial frame before it reads your init
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 file. After reading that file, Emacs checks @code{initial-frame-alist},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 and applies the parameter settings in the altered value to the already
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 created initial frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 If these settings affect the frame geometry and appearance, you'll see
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 the frame appear with the wrong ones and then change to the specified
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 ones. If that bothers you, you can specify the same geometry and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 appearance with X resources; those do take effect before the frame is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 created. @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 X resource settings typically apply to all frames. If you want to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 specify some X resources solely for the sake of the initial frame, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 you don't want them to apply to subsequent frames, here's how to achieve
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 this. Specify parameters in @code{default-frame-alist} to override the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 X resources for subsequent frames; then, to prevent these from affecting
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 the initial frame, specify the same parameters in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 @code{initial-frame-alist} with values that match the X resources.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 If these parameters specify a separate minibuffer-only frame with
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 @code{(minibuffer . nil)}, and you have not created one, Emacs creates
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 one for you.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 @defvar minibuffer-frame-alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 This variable's value is an alist of parameter values used when creating
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 an initial minibuffer-only frame---if such a frame is needed, according
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 to the parameters for the main initial frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 @defvar default-frame-alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 This is an alist specifying default values of frame parameters for all
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 Emacs frames---the first frame, and subsequent frames. When using the X
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 Window System, you can get the same results by means of X resources
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 in many cases.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 Setting this variable does not affect existing frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
450 Functions that display a buffer in a separate frame can override the
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
451 default parameters by supplying their own parameters. @xref{Definition
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
452 of special-display-frame-alist}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 If you use options that specify window appearance when you invoke Emacs,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 they take effect by adding elements to @code{default-frame-alist}. One
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 exception is @samp{-geometry}, which adds the specified position to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457 @code{initial-frame-alist} instead. @xref{Emacs Invocation,, Command
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 Line Arguments for Emacs Invocation, emacs, The GNU Emacs Manual}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 @node Window Frame Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 @subsection Window Frame Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 Just what parameters a frame has depends on what display mechanism
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 it uses. This section describes the parameters that have special
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 meanings on some or all kinds of terminals. Of these, @code{name},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 @code{title}, @code{height}, @code{width}, @code{buffer-list} and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 @code{buffer-predicate} provide meaningful information in terminal
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 frames, and @code{tty-color-mode} is meaningful @emph{only} in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 terminal frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 @menu
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 * Basic Parameters:: Parameters that are fundamental.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 * Position Parameters:: The position of the frame on the screen.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 * Size Parameters:: Frame's size.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 * Layout Parameters:: Size of parts of the frame, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 enabling or disabling some parts.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 * Buffer Parameters:: Which buffers have been or should be shown.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 * Management Parameters:: Communicating with the window manager.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 * Cursor Parameters:: Controlling the cursor appearance.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 * Color Parameters:: Colors of various parts of the frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @end menu
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 @node Basic Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 @subsubsection Basic Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 These frame parameters give the most basic information about the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 frame. @code{title} and @code{name} are meaningful on all terminals.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 @item display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 The display on which to open this frame. It should be a string of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 form @code{"@var{host}:@var{dpy}.@var{screen}"}, just like the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493 @code{DISPLAY} environment variable.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 @item display-type
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 This parameter describes the range of possible colors that can be used
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497 in this frame. Its value is @code{color}, @code{grayscale} or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 @code{mono}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 @item title
87453
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
501 If a frame has a non-@code{nil} title, it appears in the window
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
502 system's title bar at the top of the frame, and also in the mode line
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
503 of windows in that frame if @code{mode-line-frame-identification} uses
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
504 @samp{%F} (@pxref{%-Constructs}). This is normally the case when
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
505 Emacs is not using a window system, and can only display one frame at
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
506 a time. @xref{Frame Titles}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 @item name
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 The name of the frame. The frame name serves as a default for the frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 title, if the @code{title} parameter is unspecified or @code{nil}. If
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 you don't specify a name, Emacs sets the frame name automatically
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 (@pxref{Frame Titles}).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 If you specify the frame name explicitly when you create the frame, the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 name is also used (instead of the name of the Emacs executable) when
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 looking up X resources for the frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 @node Position Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 @subsubsection Position Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 Position parameters' values are normally measured in pixels, but on
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 text-only terminals they count characters or lines instead.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 @item left
92098
0ed1dc9e8852 Fix previous change.
Glenn Morris <rgm@gnu.org>
parents: 92096
diff changeset
527 The position, in pixels, of the left (or right) edge of the frame with
0ed1dc9e8852 Fix previous change.
Glenn Morris <rgm@gnu.org>
parents: 92096
diff changeset
528 respect to the left (or right) edge of the screen. The value may be:
92096
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
529
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
530 @table @asis
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
531 @item an integer
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
532 A positive integer relates the left edge of the frame to the left edge
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
533 of the screen. A negative integer relates the right frame edge to the
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
534 right screen edge.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535
92096
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
536 @item @code{(+ @var{pos})}
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
537 This specifies the position of the left frame edge relative to the left
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
538 screen edge. The integer @var{pos} may be positive or negative; a
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
539 negative value specifies a position outside the screen.
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
540
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
541 @item @code{(- @var{pos})}
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
542 This specifies the position of the right frame edge relative to the right
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
543 screen edge. The integer @var{pos} may be positive or negative; a
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
544 negative value specifies a position outside the screen.
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
545 @end table
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 Some window managers ignore program-specified positions. If you want to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 be sure the position you specify is not ignored, specify a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 non-@code{nil} value for the @code{user-position} parameter as well.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 @item top
92096
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
552 The screen position of the top (or bottom) edge, in pixels, with respect
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
553 to the top (or bottom) edge of the screen. It works just like
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
554 @code{left}, except vertically instead of horizontally.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 @item icon-left
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 The screen position of the left edge @emph{of the frame's icon}, in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 pixels, counting from the left edge of the screen. This takes effect if
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 and when the frame is iconified.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 If you specify a value for this parameter, then you must also specify
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 a value for @code{icon-top} and vice versa. The window manager may
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 ignore these two parameters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 @item icon-top
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 The screen position of the top edge @emph{of the frame's icon}, in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 pixels, counting from the top edge of the screen. This takes effect if
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 and when the frame is iconified.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 @item user-position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 When you create a frame and specify its screen position with the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 @code{left} and @code{top} parameters, use this parameter to say whether
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 the specified position was user-specified (explicitly requested in some
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 way by a human user) or merely program-specified (chosen by a program).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 A non-@code{nil} value says the position was user-specified.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 Window managers generally heed user-specified positions, and some heed
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 program-specified positions too. But many ignore program-specified
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 positions, placing the window in a default fashion or letting the user
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 place it with the mouse. Some window managers, including @code{twm},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 let the user specify whether to obey program-specified positions or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 ignore them.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 When you call @code{make-frame}, you should specify a non-@code{nil}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 value for this parameter if the values of the @code{left} and @code{top}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 parameters represent the user's stated preference; otherwise, use
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 @code{nil}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 @node Size Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591 @subsubsection Size Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 Size parameters' values are normally measured in pixels, but on
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 text-only terminals they count characters or lines instead.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 @item height
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 The height of the frame contents, in characters. (To get the height in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 @item width
87453
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
602 The width of the frame contents, in characters. (To get the width in
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 @item user-size
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606 This does for the size parameters @code{height} and @code{width} what
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 the @code{user-position} parameter (see above) does for the position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 parameters @code{top} and @code{left}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 @item fullscreen
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 Specify that width, height or both shall be set to the size of the screen.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 The value @code{fullwidth} specifies that width shall be the size of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 screen. The value @code{fullheight} specifies that height shall be the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 size of the screen. The value @code{fullboth} specifies that both the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 width and the height shall be set to the size of the screen.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 @node Layout Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 @subsubsection Layout Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 These frame parameters enable or disable various parts of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 frame, or control their sizes.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 @item border-width
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 The width in pixels of the frame's border.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 @item internal-border-width
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 The distance in pixels between text (or fringe) and the frame's border.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 @item vertical-scroll-bars
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 Whether the frame has scroll bars for vertical scrolling, and which side
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 of the frame they should be on. The possible values are @code{left},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 @code{right}, and @code{nil} for no scroll bars.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 @ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 @item horizontal-scroll-bars
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 Whether the frame has scroll bars for horizontal scrolling
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 (non-@code{nil} means yes). Horizontal scroll bars are not currently
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 implemented.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 @end ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 @item scroll-bar-width
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 The width of vertical scroll bars, in pixels, or @code{nil} meaning to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 use the default width.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 @item left-fringe
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 @itemx right-fringe
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 The default width of the left and right fringes of windows in this
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 frame (@pxref{Fringes}). If either of these is zero, that effectively
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 removes the corresponding fringe. A value of @code{nil} stands for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 the standard fringe width, which is the width needed to display the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 fringe bitmaps.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 The combined fringe widths must add up to an integral number of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 columns, so the actual default fringe widths for the frame may be
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 larger than the specified values. The extra width needed to reach an
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 acceptable total is distributed evenly between the left and right
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 fringe. However, you can force one fringe or the other to a precise
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 width by specifying that width as a negative integer. If both widths are
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 negative, only the left fringe gets the specified width.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 @item menu-bar-lines
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 The number of lines to allocate at the top of the frame for a menu
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 bar. The default is 1. A value of @code{nil} means don't display a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 menu bar. @xref{Menu Bar}. (The X toolkit and GTK allow at most one
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 menu bar line; they treat larger values as 1.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 @item tool-bar-lines
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 The number of lines to use for the tool bar. A value of @code{nil}
102918
f166876b8717 * keymaps.texi (Tool Bar): Mention that some platforms do not
Chong Yidong <cyd@stupidchicken.com>
parents: 102846
diff changeset
671 means don't display a tool bar. (GTK and Nextstep allow at most one
f166876b8717 * keymaps.texi (Tool Bar): Mention that some platforms do not
Chong Yidong <cyd@stupidchicken.com>
parents: 102846
diff changeset
672 tool bar line; they treat larger values as 1.)
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 @item line-spacing
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 Additional space to leave below each text line, in pixels (a positive
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 integer). @xref{Line Height}, for more information.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 @node Buffer Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 @subsubsection Buffer Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 These frame parameters, meaningful on all kinds of terminals, deal
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 with which buffers have been, or should, be displayed in the frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 @item minibuffer
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 Whether this frame has its own minibuffer. The value @code{t} means
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 yes, @code{nil} means no, @code{only} means this frame is just a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 minibuffer. If the value is a minibuffer window (in some other frame),
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 the new frame uses that minibuffer.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 @item buffer-predicate
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 The buffer-predicate function for this frame. The function
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 @code{other-buffer} uses this predicate (from the selected frame) to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 decide which buffers it should consider, if the predicate is not
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 @code{nil}. It calls the predicate with one argument, a buffer, once for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 each buffer; if the predicate returns a non-@code{nil} value, it
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 considers that buffer.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 @item buffer-list
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 A list of buffers that have been selected in this frame,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 ordered most-recently-selected first.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 @item unsplittable
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 If non-@code{nil}, this frame's window is never split automatically.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 @node Management Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 @subsubsection Window Management Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710 @cindex window manager, and frame parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 These frame parameters, meaningful only on window system displays,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 interact with the window manager.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 @item visibility
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 The state of visibility of the frame. There are three possibilities:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 @code{nil} for invisible, @code{t} for visible, and @code{icon} for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 iconified. @xref{Visibility of Frames}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 @item auto-raise
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 Whether selecting the frame raises it (non-@code{nil} means yes).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 @item auto-lower
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 Whether deselecting the frame lowers it (non-@code{nil} means yes).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 @item icon-type
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 The type of icon to use for this frame when it is iconified. If the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 value is a string, that specifies a file containing a bitmap to use.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 Any other non-@code{nil} value specifies the default bitmap icon (a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 picture of a gnu); @code{nil} specifies a text icon.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 @item icon-name
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 The name to use in the icon for this frame, when and if the icon
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 appears. If this is @code{nil}, the frame's title is used.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 @item window-id
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 The number of the window-system window used by the frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 to contain the actual Emacs windows.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 @item outer-window-id
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 The number of the outermost window-system window used for the whole frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 @item wait-for-wm
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 If non-@code{nil}, tell Xt to wait for the window manager to confirm
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 geometry changes. Some window managers, including versions of Fvwm2
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748 prevent hanging with those window managers.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 @ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 @item parent-id
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @c ??? Not yet working.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753 The X window number of the window that should be the parent of this one.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 Specifying this lets you create an Emacs window inside some other
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 application's window. (It is not certain this will be implemented; try
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 it and see if it works.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 @end ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 @node Cursor Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 @subsubsection Cursor Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763 This frame parameter controls the way the cursor looks.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 @item cursor-type
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 How to display the cursor. Legitimate values are:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 @item box
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 Display a filled box. (This is the default.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 @item hollow
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 Display a hollow box.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 @item nil
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775 Don't display a cursor.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776 @item bar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 Display a vertical bar between characters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 @item (bar . @var{width})
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 Display a vertical bar @var{width} pixels wide between characters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @item hbar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 Display a horizontal bar.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 @item (hbar . @var{height})
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 Display a horizontal bar @var{height} pixels high.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 @vindex cursor-type
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 The buffer-local variable @code{cursor-type} overrides the value of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 the @code{cursor-type} frame parameter, but if it is @code{t}, that
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 means to use the cursor specified for the frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 @defvar blink-cursor-alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 This variable specifies how to blink the cursor. Each element has the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 form @code{(@var{on-state} . @var{off-state})}. Whenever the cursor
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 type equals @var{on-state} (comparing using @code{equal}), the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 corresponding @var{off-state} specifies what the cursor looks like
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 when it blinks ``off.'' Both @var{on-state} and @var{off-state}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 should be suitable values for the @code{cursor-type} frame parameter.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 There are various defaults for how to blink each type of cursor, if
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 the type is not mentioned as an @var{on-state} here. Changes in this
85114
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
802 variable do not take effect immediately, only when you specify the
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
803 @code{cursor-type} frame parameter.
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
804 @end defvar
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
805
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
806 @defvar cursor-in-non-selected-windows
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
807 This variable controls how the cursor looks in a window that is not
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
808 selected. It supports the same values as the @code{cursor-type} frame
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
809 parameter; also, @code{nil} means don't display a cursor in
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
810 nonselected windows, and @code{t} (the default) means use a standard
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
811 modificatoin of the usual cursor type (solid box becomes hollow box,
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
812 and bar becomes a narrower bar).
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 @node Color Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 @subsubsection Color Parameters
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 These frame parameters control the use of colors.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 @item background-mode
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 This parameter is either @code{dark} or @code{light}, according
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823 to whether the background color is a light one or a dark one.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 @item tty-color-mode
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 @cindex standard colors for character terminals
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 This parameter overrides the terminal's color support as given by the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 system's terminal capabilities database in that this parameter's value
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 specifies the color mode to use in terminal frames. The value can be
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 either a symbol or a number. A number specifies the number of colors
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 to use (and, indirectly, what commands to issue to produce each
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 color). For example, @code{(tty-color-mode . 8)} specifies use of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 ANSI escape sequences for 8 standard text colors. A value of -1 turns
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 off color support.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836 If the parameter's value is a symbol, it specifies a number through
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 the value of @code{tty-color-mode-alist}, and the associated number is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 used instead.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 @item screen-gamma
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 @cindex gamma correction
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842 If this is a number, Emacs performs ``gamma correction'' which adjusts
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 the brightness of all colors. The value should be the screen gamma of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 your display, a floating point number.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846 Usual PC monitors have a screen gamma of 2.2, so color values in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 Emacs, and in X windows generally, are calibrated to display properly
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 on a monitor with that gamma value. If you specify 2.2 for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 @code{screen-gamma}, that means no correction is needed. Other values
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 request correction, designed to make the corrected colors appear on
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 your screen the way they would have appeared without correction on an
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 ordinary monitor with a gamma value of 2.2.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 If your monitor displays colors too light, you should specify a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 @code{screen-gamma} value smaller than 2.2. This requests correction
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 that makes colors darker. A screen gamma value of 1.5 may give good
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 results for LCD color displays.
99685
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
858
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
859 @item alpha
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
860 @cindex opacity, frame
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
861 @cindex transparency, frame
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
862 @vindex frame-alpha-lower-limit
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
863 This parameter specifies the opacity of the frame, on graphical
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
864 displays that support variable opacity. It should be an integer
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
865 between 0 and 100, where 0 means completely transparent and 100 means
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
866 completely opaque. It can also have a @code{nil} value, which tells
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
867 Emacs not to set the frame opacity (leaving it to the window manager).
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
868
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
869 To prevent the frame from disappearing completely from view, the
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
870 variable @code{frame-alpha-lower-limit} defines a lower opacity limit.
99685
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
871 If the value of the frame parameter is less than the value of this
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
872 variable, Emacs uses the latter. By default,
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
873 @code{frame-alpha-lower-limit} is 20.
99685
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
874
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
875 The @code{alpha} frame parameter can also be a cons cell
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
876 @code{(@samp{active} . @samp{inactive})}, where @samp{active} is the
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
877 opacity of the frame when it is selected, and @samp{inactive} is the
1b4415b23803 (Color Parameters): Document alpha parameter.
Chong Yidong <cyd@stupidchicken.com>
parents: 99490
diff changeset
878 opactity when it is not selected.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880
99687
94e37721e194 Minor fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 99685
diff changeset
881 The following frame parameters are semi-obsolete in that they are
94e37721e194 Minor fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 99685
diff changeset
882 automatically equivalent to particular face attributes of particular
94e37721e194 Minor fix.
Chong Yidong <cyd@stupidchicken.com>
parents: 99685
diff changeset
883 faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}):
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 @table @code
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 @item font
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 The name of the font for displaying text in the frame. This is a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 string, either a valid font name for your system or the name of an Emacs
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 fontset (@pxref{Fontsets}). It is equivalent to the @code{font}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 attribute of the @code{default} face.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 @item foreground-color
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 The color to use for the image of a character. It is equivalent to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 the @code{:foreground} attribute of the @code{default} face.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 @item background-color
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 The color to use for the background of characters. It is equivalent to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 the @code{:background} attribute of the @code{default} face.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900 @item mouse-color
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 The color for the mouse pointer. It is equivalent to the @code{:background}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 attribute of the @code{mouse} face.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 @item cursor-color
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 The color for the cursor that shows point. It is equivalent to the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 @code{:background} attribute of the @code{cursor} face.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 @item border-color
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 The color for the border of the frame. It is equivalent to the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 @code{:background} attribute of the @code{border} face.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 @item scroll-bar-foreground
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 If non-@code{nil}, the color for the foreground of scroll bars. It is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 equivalent to the @code{:foreground} attribute of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 @code{scroll-bar} face.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 @item scroll-bar-background
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 If non-@code{nil}, the color for the background of scroll bars. It is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 equivalent to the @code{:background} attribute of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 @code{scroll-bar} face.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 @node Size and Position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 @subsection Frame Size And Position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 @cindex size of frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 @cindex screen size
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 @cindex frame size
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 @cindex resize frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 You can read or change the size and position of a frame using the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 frame parameters @code{left}, @code{top}, @code{height}, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 @code{width}. Whatever geometry parameters you don't specify are chosen
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 by the window manager in its usual fashion.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 Here are some special features for working with sizes and positions.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 (For the precise meaning of ``selected frame'' used by these functions,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 see @ref{Input Focus}.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 @defun set-frame-position frame left top
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 This function sets the position of the top left corner of @var{frame} to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 @var{left} and @var{top}. These arguments are measured in pixels, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 normally count from the top left corner of the screen.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 Negative parameter values position the bottom edge of the window up from
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 the bottom edge of the screen, or the right window edge to the left of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 the right edge of the screen. It would probably be better if the values
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 were always counted from the left and top, so that negative arguments
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 would position the frame partly off the top or left edge of the screen,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 but it seems inadvisable to change that now.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 @defun frame-height &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 @defunx frame-width &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 These functions return the height and width of @var{frame}, measured in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 lines and columns. If you don't supply @var{frame}, they use the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 @defun screen-height
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 @defunx screen-width
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 These functions are old aliases for @code{frame-height} and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 @code{frame-width}. When you are using a non-window terminal, the size
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 of the frame is normally the same as the size of the terminal screen.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 @defun frame-pixel-height &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967 @defunx frame-pixel-width &optional frame
87453
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
968 These functions return the height and width of the main display area
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
969 of @var{frame}, measured in pixels. If you don't supply @var{frame},
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
970 they use the selected frame.
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
971
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
972 These values include the internal borders, and windows' scroll bars
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
973 and fringes (which belong to individual windows, not to the frame
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
974 itself), but do not include menu bars or tool bars (except when using
cdd30283527d Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85688
diff changeset
975 X without an X toolkit).
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 @defun frame-char-height &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 @defunx frame-char-width &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 These functions return the height and width of a character in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 @var{frame}, measured in pixels. The values depend on the choice of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 font. If you don't supply @var{frame}, these functions use the selected
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 @defun set-frame-size frame cols rows
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 This function sets the size of @var{frame}, measured in characters;
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 @var{cols} and @var{rows} specify the new width and height.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 To set the size based on values measured in pixels, use
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 @code{frame-char-height} and @code{frame-char-width} to convert
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 them to units of characters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 @defun set-frame-height frame lines &optional pretend
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 This function resizes @var{frame} to a height of @var{lines} lines. The
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 sizes of existing windows in @var{frame} are altered proportionally to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 fit.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 If @var{pretend} is non-@code{nil}, then Emacs displays @var{lines}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 lines of output in @var{frame}, but does not change its value for the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002 actual height of the frame. This is only useful for a terminal frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 Using a smaller height than the terminal actually implements may be
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004 useful to reproduce behavior observed on a smaller screen, or if the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 terminal malfunctions when using its whole screen. Setting the frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 height ``for real'' does not always work, because knowing the correct
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 actual size may be necessary for correct cursor positioning on a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 terminal frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 @defun set-frame-width frame width &optional pretend
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 This function sets the width of @var{frame}, measured in characters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 The argument @var{pretend} has the same meaning as in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 @code{set-frame-height}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 @findex set-screen-height
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 @findex set-screen-width
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 The older functions @code{set-screen-height} and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 @code{set-screen-width} were used to specify the height and width of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 screen, in Emacs versions that did not support multiple frames. They
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 are semi-obsolete, but still work; they apply to the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 @node Geometry
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 @subsection Geometry
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 Here's how to examine the data in an X-style window geometry
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 specification:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 @defun x-parse-geometry geom
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 @cindex geometry specification
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 The function @code{x-parse-geometry} converts a standard X window
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033 geometry string to an alist that you can use as part of the argument to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 @code{make-frame}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036 The alist describes which parameters were specified in @var{geom}, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 gives the values specified for them. Each element looks like
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 @code{(@var{parameter} . @var{value})}. The possible @var{parameter}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 values are @code{left}, @code{top}, @code{width}, and @code{height}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 For the size parameters, the value must be an integer. The position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 parameter names @code{left} and @code{top} are not totally accurate,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 because some values indicate the position of the right or bottom edges
92096
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
1044 instead. The @var{value} possibilities for the position parameters are:
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
1045 an integer, a list @code{(+ @var{pos})}, or a list @code{(- @var{pos})};
6cc4c897d108 (Position Parameters): Clarify the description of `left' and `top',
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
1046 as previously described (@pxref{Position Parameters}).
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 Here is an example:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051 (x-parse-geometry "35x70+0-0")
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 @result{} ((height . 70) (width . 35)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 (top - 0) (left . 0))
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1057 @node Terminal Parameters
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1058 @section Terminal Parameters
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1059 @cindex terminal parameters
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1060
101257
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1061 Each terminal has a list of associated parameters. These
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1062 @dfn{terminal parameters} are mostly a convenient way of storage for
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1063 terminal-local variables, but some terminal parameters have a special
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1064 meaning.
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1065
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1066 This section describes functions to read and change the parameter values
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1067 of a terminal. They all accept as their argument either a terminal or
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1068 a frame; the latter means use that frame's terminal. An argument of
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1069 @code{nil} means the selected frame's terminal.
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1070
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1071 @defun terminal-parameters &optional terminal
101257
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1072 This function returns an alist listing all the parameters of
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1073 @var{terminal} and their values.
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1074 @end defun
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1075
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1076 @defun terminal-parameter terminal parameter
101257
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1077 This function returns the value of the parameter @var{parameter} (a
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1078 symbol) of @var{terminal}. If @var{terminal} has no setting for
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1079 @var{parameter}, this function returns @code{nil}.
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1080 @end defun
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1081
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1082 @defun set-terminal-parameter terminal parameter value
101257
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1083 This function sets the parameter @var{parm} of @var{terminal} to the
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1084 specified @var{value}, and returns the previous value of that
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1085 parameter.
101251
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1086 @end defun
03e8c210e9a0 (Frames): Document `frame-terminal' and `terminal-live-p'.
Eli Zaretskii <eliz@gnu.org>
parents: 100980
diff changeset
1087
101257
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1088 Here's a list of a few terminal parameters that have a special
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1089 meaning:
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1090
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1091 @table @code
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1092 @item background-mode
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1093 The classification of the terminal's background color, either
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1094 @code{light} or @code{dark}.
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1095 @item normal-erase-is-backspace
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1096 Value is either 1 or 0, depending on whether
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1097 @code{normal-erase-is-backspace-mode} is turned on or off on this
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1098 terminal. @xref{DEL Does Not Delete,,, emacs, The Emacs Manual}.
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1099 @item terminal-initted
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1100 After the terminal is initialized, this is set to the
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1101 terminal-specific initialization function.
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1102 @end table
29b0330cf9d3 (Terminal Parameters): Document `terminal-parameters', `terminal-parameter',
Eli Zaretskii <eliz@gnu.org>
parents: 101251
diff changeset
1103
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 @node Frame Titles
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 @section Frame Titles
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 @cindex frame title
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 Every frame has a @code{name} parameter; this serves as the default
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 for the frame title which window systems typically display at the top of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 the frame. You can specify a name explicitly by setting the @code{name}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 frame property.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 Normally you don't specify the name explicitly, and Emacs computes the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 frame name automatically based on a template stored in the variable
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 @code{frame-title-format}. Emacs recomputes the name each time the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 frame is redisplayed.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 @defvar frame-title-format
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 This variable specifies how to compute a name for a frame when you have
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 not explicitly specified one. The variable's value is actually a mode
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121 line construct, just like @code{mode-line-format}, except that the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 @samp{%c} and @samp{%l} constructs are ignored. @xref{Mode Line
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 Data}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 @defvar icon-title-format
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 This variable specifies how to compute the name for an iconified frame,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 when you have not explicitly specified the frame title. This title
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 appears in the icon itself.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 @defvar multiple-frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 This variable is set automatically by Emacs. Its value is @code{t} when
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 there are two or more frames (not counting minibuffer-only frames or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 invisible frames). The default value of @code{frame-title-format} uses
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136 @code{multiple-frames} so as to put the buffer name in the frame title
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 only when there is more than one frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 The value of this variable is not guaranteed to be accurate except
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 while processing @code{frame-title-format} or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 @code{icon-title-format}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 @node Deleting Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 @section Deleting Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 @cindex deleting frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 Frames remain potentially visible until you explicitly @dfn{delete}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 them. A deleted frame cannot appear on the screen, but continues to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 exist as a Lisp object until there are no references to it.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 @deffn Command delete-frame &optional frame force
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 @vindex delete-frame-functions
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 This function deletes the frame @var{frame}. Unless @var{frame} is a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 tooltip, it first runs the hook @code{delete-frame-functions} (each
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 function gets one argument, @var{frame}). By default, @var{frame} is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 A frame cannot be deleted if its minibuffer is used by other frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 Normally, you cannot delete a frame if all other frames are invisible,
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1161 but if @var{force} is non-@code{nil}, then you are allowed to do so.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 @end deffn
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 @defun frame-live-p frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165 The function @code{frame-live-p} returns non-@code{nil} if the frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 @var{frame} has not been deleted. The possible non-@code{nil} return
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 values are like those of @code{framep}. @xref{Frames}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 Some window managers provide a command to delete a window. These work
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 by sending a special message to the program that operates the window.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 When Emacs gets one of these commands, it generates a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173 @code{delete-frame} event, whose normal definition is a command that
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174 calls the function @code{delete-frame}. @xref{Misc Events}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 @node Finding All Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 @section Finding All Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 @cindex frames, scanning all
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 @defun frame-list
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 The function @code{frame-list} returns a list of all the frames that
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 have not been deleted. It is analogous to @code{buffer-list} for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 buffers, and includes frames on all terminals. The list that you get is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 newly created, so modifying the list doesn't have any effect on the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 internals of Emacs.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 @defun visible-frame-list
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 This function returns a list of just the currently visible frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 @xref{Visibility of Frames}. (Terminal frames always count as
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 ``visible,'' even though only the selected one is actually displayed.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 @defun next-frame &optional frame minibuf
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195 The function @code{next-frame} lets you cycle conveniently through all
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 the frames on the current display from an arbitrary starting point. It
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 returns the ``next'' frame after @var{frame} in the cycle. If
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 @var{frame} is omitted or @code{nil}, it defaults to the selected frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 (@pxref{Input Focus}).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 The second argument, @var{minibuf}, says which frames to consider:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203 @table @asis
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204 @item @code{nil}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205 Exclude minibuffer-only frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 @item @code{visible}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207 Consider all visible frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 @item 0
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 Consider all visible or iconified frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 @item a window
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211 Consider only the frames using that particular window as their
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 minibuffer.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213 @item anything else
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214 Consider all frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 @end table
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218 @defun previous-frame &optional frame minibuf
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219 Like @code{next-frame}, but cycles through all frames in the opposite
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 direction.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 See also @code{next-window} and @code{previous-window}, in @ref{Cyclic
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224 Window Ordering}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1226 @node Frames and Windows
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227 @section Frames and Windows
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1229 Each window is part of one and only one frame; you can get that frame
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 with @code{window-frame}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232 @defun window-frame window
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233 This function returns the frame that @var{window} is on.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 All the non-minibuffer windows in a frame are arranged in a cyclic
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237 order. The order runs from the frame's top window, which is at the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 upper left corner, down and to the right, until it reaches the window at
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 the lower right corner (always the minibuffer window, if the frame has
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 one), and then it moves back to the top. @xref{Cyclic Window Ordering}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242 @defun frame-first-window &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243 This returns the topmost, leftmost window of frame @var{frame}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 If omitted or @code{nil}, @var{frame} defaults to the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247 At any time, exactly one window on any frame is @dfn{selected within the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248 frame}. The significance of this designation is that selecting the
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1249 frame also selects this window. Conversely, selecting a window for
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1250 Emacs with @code{select-window} also makes that window selected within
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1251 its frame. @xref{Selecting Windows}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 @defun frame-selected-window &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254 This function returns the window on @var{frame} that is selected
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255 within @var{frame}. If omitted or @code{nil}, @var{frame} defaults to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1259 @defun set-frame-selected-window frame window &optional norecord
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260 This sets the selected window of frame @var{frame} to @var{window}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 If @var{frame} is @code{nil}, it operates on the selected frame. If
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262 @var{frame} is the selected frame, this makes @var{window} the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 selected window. This function returns @var{window}.
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1264
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1265 Optional argument @var{norecord} non-@code{nil} means to neither change
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1266 the order of recently selected windows nor the buffer list (@pxref{The
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1267 Buffer List}).
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 Another function that (usually) returns one of the windows in a given
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 frame is @code{minibuffer-window}. @xref{Definition of minibuffer-window}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1272
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273 @node Minibuffers and Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274 @section Minibuffers and Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1276 Normally, each frame has its own minibuffer window at the bottom, which
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1277 is used whenever that frame is selected. If the frame has a minibuffer,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278 you can get it with @code{minibuffer-window} (@pxref{Definition of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279 minibuffer-window}).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1281 However, you can also create a frame with no minibuffer. Such a frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282 must use the minibuffer window of some other frame. When you create the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283 frame, you can specify explicitly the minibuffer window to use (in some
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 other frame). If you don't, then the minibuffer is found in the frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285 which is the value of the variable @code{default-minibuffer-frame}. Its
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 value should be a frame that does have a minibuffer.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288 If you use a minibuffer-only frame, you might want that frame to raise
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 when you enter the minibuffer. If so, set the variable
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 @code{minibuffer-auto-raise} to @code{t}. @xref{Raising and Lowering}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1292 @defvar default-minibuffer-frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1293 This variable specifies the frame to use for the minibuffer window, by
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1294 default. It does not affect existing frames. It is always local to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1295 the current terminal and cannot be buffer-local. @xref{Multiple
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1296 Terminals}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1297 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1298
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1299 @node Input Focus
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300 @section Input Focus
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 @cindex input focus
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302 @c @cindex selected frame Duplicates selected-frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304 At any time, one frame in Emacs is the @dfn{selected frame}. The selected
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 window always resides on the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 When Emacs displays its frames on several terminals (@pxref{Multiple
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1308 Terminals}), each terminal has its own selected frame. But only one
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1309 of these is ``@emph{the} selected frame'': it's the frame that belongs
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1310 to the terminal from which the most recent input came. That is, when
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1311 Emacs runs a command that came from a certain terminal, the selected
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1312 frame is the one of that terminal. Since Emacs runs only a single
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1313 command at any given time, it needs to consider only one selected
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1314 frame at a time; this frame is what we call @dfn{the selected frame}
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1315 in this manual. The display on which the selected frame is shown is
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
1316 the @dfn{selected frame's display}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318 @defun selected-frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1319 This function returns the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 Some window systems and window managers direct keyboard input to the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323 window object that the mouse is in; others require explicit clicks or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 commands to @dfn{shift the focus} to various window objects. Either
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325 way, Emacs automatically keeps track of which frame has the focus. To
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1326 explicitly switch to a different frame from a Lisp function, call
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 @code{select-frame-set-input-focus}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329 Lisp programs can also switch frames ``temporarily'' by calling the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 function @code{select-frame}. This does not alter the window system's
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 concept of focus; rather, it escapes from the window manager's control
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1332 until that control is somehow reasserted.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 When using a text-only terminal, only one frame can be displayed at a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1335 time on the terminal, so after a call to @code{select-frame}, the next
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1336 redisplay actually displays the newly selected frame. This frame
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1337 remains selected until a subsequent call to @code{select-frame}. Each
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1338 terminal frame has a number which appears in the mode line before the
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1339 buffer name (@pxref{Mode Line Variables}).
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1340
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1341 @defun select-frame-set-input-focus frame
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1342 This function selects @var{frame}, raises it (should it happen to be
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1343 obscured by other frames) and tries to give it the X server's focus. On
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1344 a text-only terminal, the next redisplay displays the new frame on the
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1345 entire terminal screen. The return value of this function is not
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1346 significant.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1347 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1348
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1349 @c ??? This is not yet implemented properly.
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1350 @defun select-frame frame &optional norecord
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351 This function selects frame @var{frame}, temporarily disregarding the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352 focus of the X server if any. The selection of @var{frame} lasts until
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353 the next time the user does something to select a different frame, or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 until the next time this function is called. (If you are using a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355 window system, the previously selected frame may be restored as the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356 selected frame after return to the command loop, because it still may
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1357 have the window system's input focus.)
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1358
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1359 The specified @var{frame} becomes the selected frame, as explained
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1360 above, and the terminal that @var{frame} is on becomes the selected
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1361 terminal. The window selected within @var{frame} becomes the selected
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1362 window. This function returns @var{frame}, or @code{nil} if @var{frame}
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1363 has been deleted.
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1364
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1365 Optional argument @var{norecord} non-@code{nil} means to neither change
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1366 the order of recently selected windows nor the buffer list. @xref{The
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1367 Buffer List}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369 In general, you should never use @code{select-frame} in a way that could
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 switch to a different terminal without switching back when you're done.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373 Emacs cooperates with the window system by arranging to select frames as
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374 the server and window manager request. It does so by generating a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375 special kind of input event, called a @dfn{focus} event, when
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376 appropriate. The command loop handles a focus event by calling
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377 @code{handle-switch-frame}. @xref{Focus Events}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1379 @deffn Command handle-switch-frame frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380 This function handles a focus event by selecting frame @var{frame}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1381
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382 Focus events normally do their job by invoking this command.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 Don't call it for any other reason.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1384 @end deffn
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386 @defun redirect-frame-focus frame &optional focus-frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1387 This function redirects focus from @var{frame} to @var{focus-frame}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1388 This means that @var{focus-frame} will receive subsequent keystrokes and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1389 events intended for @var{frame}. After such an event, the value of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1390 @code{last-event-frame} will be @var{focus-frame}. Also, switch-frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1391 events specifying @var{frame} will instead select @var{focus-frame}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393 If @var{focus-frame} is omitted or @code{nil}, that cancels any existing
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 redirection for @var{frame}, which therefore once again receives its own
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 events.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1396
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1397 One use of focus redirection is for frames that don't have minibuffers.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1398 These frames use minibuffers on other frames. Activating a minibuffer
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1399 on another frame redirects focus to that frame. This puts the focus on
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1400 the minibuffer's frame, where it belongs, even though the mouse remains
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1401 in the frame that activated the minibuffer.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1402
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1403 Selecting a frame can also change focus redirections. Selecting frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1404 @code{bar}, when @code{foo} had been selected, changes any redirections
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1405 pointing to @code{foo} so that they point to @code{bar} instead. This
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1406 allows focus redirection to work properly when the user switches from
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1407 one frame to another using @code{select-window}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1409 This means that a frame whose focus is redirected to itself is treated
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1410 differently from a frame whose focus is not redirected.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1411 @code{select-frame} affects the former but not the latter.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1412
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1413 The redirection lasts until @code{redirect-frame-focus} is called to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1414 change it.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1415 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1416
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417 @defopt focus-follows-mouse
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1418 This option is how you inform Emacs whether the window manager transfers
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1419 focus when the user moves the mouse. Non-@code{nil} says that it does.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 When this is so, the command @code{other-frame} moves the mouse to a
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1421 position consistent with the new selected frame.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 @end defopt
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424 @node Visibility of Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1425 @section Visibility of Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1426 @cindex visible frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1427 @cindex invisible frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1428 @cindex iconified frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429 @cindex frame visibility
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431 A window frame may be @dfn{visible}, @dfn{invisible}, or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1432 @dfn{iconified}. If it is visible, you can see its contents, unless
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1433 other windows cover it. If it is iconified, the frame's contents do
101939
d55a24c5ff3f (Visibility of Frames): Mention the effect multiple
Glenn Morris <rgm@gnu.org>
parents: 101349
diff changeset
1434 not appear on the screen, but an icon does. (Note: because of the
d55a24c5ff3f (Visibility of Frames): Mention the effect multiple
Glenn Morris <rgm@gnu.org>
parents: 101349
diff changeset
1435 way in which some window managers implement the concept of multiple
d55a24c5ff3f (Visibility of Frames): Mention the effect multiple
Glenn Morris <rgm@gnu.org>
parents: 101349
diff changeset
1436 workspaces, or desktops, all frames on other workspaces may appear to
d55a24c5ff3f (Visibility of Frames): Mention the effect multiple
Glenn Morris <rgm@gnu.org>
parents: 101349
diff changeset
1437 Emacs to be iconified.) If the frame is invisible, it doesn't show on
d55a24c5ff3f (Visibility of Frames): Mention the effect multiple
Glenn Morris <rgm@gnu.org>
parents: 101349
diff changeset
1438 the screen, not even as an icon.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1439
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1440 Visibility is meaningless for terminal frames, since only the selected
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1441 one is actually displayed in any case.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1442
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1443 @deffn Command make-frame-visible &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1444 This function makes frame @var{frame} visible. If you omit
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1445 @var{frame}, it makes the selected frame visible. This does not raise
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446 the frame, but you can do that with @code{raise-frame} if you wish
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1447 (@pxref{Raising and Lowering}).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1448 @end deffn
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1449
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450 @deffn Command make-frame-invisible &optional frame force
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451 This function makes frame @var{frame} invisible. If you omit
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1452 @var{frame}, it makes the selected frame invisible.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1453
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1454 Unless @var{force} is non-@code{nil}, this function refuses to make
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1455 @var{frame} invisible if all other frames are invisible..
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1456 @end deffn
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1457
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1458 @deffn Command iconify-frame &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1459 This function iconifies frame @var{frame}. If you omit @var{frame}, it
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1460 iconifies the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1461 @end deffn
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1462
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1463 @defun frame-visible-p frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464 This returns the visibility status of frame @var{frame}. The value is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465 @code{t} if @var{frame} is visible, @code{nil} if it is invisible, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466 @code{icon} if it is iconified.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 On a text-only terminal, all frames are considered visible, whether
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469 they are currently being displayed or not, and this function returns
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470 @code{t} for all frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473 The visibility status of a frame is also available as a frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 parameter. You can read or change it as such. @xref{Management
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475 Parameters}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1476
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 The user can iconify and deiconify frames with the window manager.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1478 This happens below the level at which Emacs can exert any control, but
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479 Emacs does provide events that you can use to keep track of such
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1480 changes. @xref{Misc Events}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1481
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1482 @node Raising and Lowering
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1483 @section Raising and Lowering Frames
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1484
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1485 Most window systems use a desktop metaphor. Part of this metaphor is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486 the idea that windows are stacked in a notional third dimension
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 perpendicular to the screen surface, and thus ordered from ``highest''
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488 to ``lowest.'' Where two windows overlap, the one higher up covers
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 the one underneath. Even a window at the bottom of the stack can be
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 seen if no other window overlaps it.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492 @c @cindex raising a frame redundant with raise-frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493 @cindex lowering a frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494 A window's place in this ordering is not fixed; in fact, users tend
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495 to change the order frequently. @dfn{Raising} a window means moving
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496 it ``up,'' to the top of the stack. @dfn{Lowering} a window means
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 moving it to the bottom of the stack. This motion is in the notional
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498 third dimension only, and does not change the position of the window
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499 on the screen.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1501 With Emacs, frames constitute the windows in the metaphor sketched
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1502 above. You can raise and lower frames using these functions:
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504 @deffn Command raise-frame &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1505 This function raises frame @var{frame} (default, the selected frame).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1506 If @var{frame} is invisible or iconified, this makes it visible.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507 @end deffn
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509 @deffn Command lower-frame &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510 This function lowers frame @var{frame} (default, the selected frame).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511 @end deffn
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513 @defopt minibuffer-auto-raise
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 If this is non-@code{nil}, activation of the minibuffer raises the frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1515 that the minibuffer window is in.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1516 @end defopt
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1518 You can also enable auto-raise (raising automatically when a frame is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519 selected) or auto-lower (lowering automatically when it is deselected)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 for any frame using frame parameters. @xref{Management Parameters}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522 @node Frame Configurations
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 @section Frame Configurations
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 @cindex frame configuration
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 A @dfn{frame configuration} records the current arrangement of frames,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527 all their properties, and the window configuration of each one.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 (@xref{Window Configurations}.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530 @defun current-frame-configuration
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531 This function returns a frame configuration list that describes
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532 the current arrangement of frames and their contents.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535 @defun set-frame-configuration configuration &optional nodelete
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536 This function restores the state of frames described in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1537 @var{configuration}. However, this function does not restore deleted
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 frames.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1539
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540 Ordinarily, this function deletes all existing frames not listed in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541 @var{configuration}. But if @var{nodelete} is non-@code{nil}, the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542 unwanted frames are iconified instead.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1543 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1544
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1545 @node Mouse Tracking
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1546 @section Mouse Tracking
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1547 @cindex mouse tracking
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548 @c @cindex tracking the mouse Duplicates track-mouse
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1549
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1550 Sometimes it is useful to @dfn{track} the mouse, which means to display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1551 something to indicate where the mouse is and move the indicator as the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552 mouse moves. For efficient mouse tracking, you need a way to wait until
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1553 the mouse actually moves.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 The convenient way to track the mouse is to ask for events to represent
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556 mouse motion. Then you can wait for motion by waiting for an event. In
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557 addition, you can easily handle any other sorts of events that may
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 occur. That is useful, because normally you don't want to track the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 mouse forever---only until some other event, such as the release of a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560 button.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 @defspec track-mouse body@dots{}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 This special form executes @var{body}, with generation of mouse motion
99763
742bad2b3aeb (Frames): Fix typo, add cross references, reword.
Martin Rudalics <rudalics@gmx.at>
parents: 99687
diff changeset
1564 events enabled. Typically, @var{body} would use @code{read-event} to
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 read the motion events and modify the display accordingly. @xref{Motion
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566 Events}, for the format of mouse motion events.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 The value of @code{track-mouse} is that of the last form in @var{body}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 You should design @var{body} to return when it sees the up-event that
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1570 indicates the release of the button, or whatever kind of event means
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571 it is time to stop tracking.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1572 @end defspec
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1573
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1574 The usual purpose of tracking mouse motion is to indicate on the screen
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1575 the consequences of pushing or releasing a button at the current
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576 position.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1577
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578 In many cases, you can avoid the need to track the mouse by using
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579 the @code{mouse-face} text property (@pxref{Special Properties}).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 That works at a much lower level and runs more smoothly than
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581 Lisp-level mouse tracking.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583 @ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1584 @c These are not implemented yet.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 These functions change the screen appearance instantaneously. The
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587 effect is transient, only until the next ordinary Emacs redisplay. That
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588 is OK for mouse tracking, since it doesn't make sense for mouse tracking
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1589 to change the text, and the body of @code{track-mouse} normally reads
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 the events itself and does not do redisplay.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1592 @defun x-contour-region window beg end
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1593 This function draws lines to make a box around the text from @var{beg}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1594 to @var{end}, in window @var{window}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1595 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1596
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1597 @defun x-uncontour-region window beg end
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1598 This function erases the lines that would make a box around the text
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1599 from @var{beg} to @var{end}, in window @var{window}. Use it to remove
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600 a contour that you previously made by calling @code{x-contour-region}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603 @defun x-draw-rectangle frame left top right bottom
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604 This function draws a hollow rectangle on frame @var{frame} with the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605 specified edge coordinates, all measured in pixels from the inside top
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 left corner. It uses the cursor color, the one used for indicating the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607 location of point.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1610 @defun x-erase-rectangle frame left top right bottom
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1611 This function erases a hollow rectangle on frame @var{frame} with the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612 specified edge coordinates, all measured in pixels from the inside top
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 left corner. Erasure means redrawing the text and background that
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1614 normally belong in the specified rectangle.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1616 @end ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618 @node Mouse Position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619 @section Mouse Position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620 @cindex mouse position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1621 @cindex position of mouse
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 The functions @code{mouse-position} and @code{set-mouse-position}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624 give access to the current position of the mouse.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1625
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1626 @defun mouse-position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1627 This function returns a description of the position of the mouse. The
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628 value looks like @code{(@var{frame} @var{x} . @var{y})}, where @var{x}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1629 and @var{y} are integers giving the position in characters relative to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1630 the top left corner of the inside of @var{frame}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1633 @defvar mouse-position-function
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1634 If non-@code{nil}, the value of this variable is a function for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1635 @code{mouse-position} to call. @code{mouse-position} calls this
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1636 function just before returning, with its normal return value as the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1637 sole argument, and it returns whatever this function returns to it.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1638
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 This abnormal hook exists for the benefit of packages like
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1640 @file{xt-mouse.el} that need to do mouse handling at the Lisp level.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1641 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1642
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1643 @defun set-mouse-position frame x y
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 This function @dfn{warps the mouse} to position @var{x}, @var{y} in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645 frame @var{frame}. The arguments @var{x} and @var{y} are integers,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 giving the position in characters relative to the top left corner of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647 inside of @var{frame}. If @var{frame} is not visible, this function
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648 does nothing. The return value is not significant.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1649 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1651 @defun mouse-pixel-position
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1652 This function is like @code{mouse-position} except that it returns
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653 coordinates in units of pixels rather than units of characters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1655
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 @defun set-mouse-pixel-position frame x y
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1657 This function warps the mouse like @code{set-mouse-position} except that
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1658 @var{x} and @var{y} are in units of pixels rather than units of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1659 characters. These coordinates are not required to be within the frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 If @var{frame} is not visible, this function does nothing. The return
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662 value is not significant.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1663 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1664
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1665 @need 3000
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1666
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1667 @node Pop-Up Menus
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1668 @section Pop-Up Menus
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1669
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1670 When using a window system, a Lisp program can pop up a menu so that
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1671 the user can choose an alternative with the mouse.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1672
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1673 @defun x-popup-menu position menu
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1674 This function displays a pop-up menu and returns an indication of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1675 what selection the user makes.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1676
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1677 The argument @var{position} specifies where on the screen to put the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1678 top left corner of the menu. It can be either a mouse button event
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1679 (which says to put the menu where the user actuated the button) or a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1680 list of this form:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1681
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683 ((@var{xoffset} @var{yoffset}) @var{window})
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1685
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1686 @noindent
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687 where @var{xoffset} and @var{yoffset} are coordinates, measured in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1688 pixels, counting from the top left corner of @var{window}. @var{window}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689 may be a window or a frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1691 If @var{position} is @code{t}, it means to use the current mouse
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1692 position. If @var{position} is @code{nil}, it means to precompute the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1693 key binding equivalents for the keymaps specified in @var{menu},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694 without actually displaying or popping up the menu.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1695
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1696 The argument @var{menu} says what to display in the menu. It can be a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1697 keymap or a list of keymaps (@pxref{Menu Keymaps}). In this case, the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1698 return value is the list of events corresponding to the user's choice.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1699 (This list has more than one element if the choice occurred in a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1700 submenu.) Note that @code{x-popup-menu} does not actually execute the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1701 command bound to that sequence of events.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1702
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1703 Alternatively, @var{menu} can have the following form:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1704
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1705 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1706 (@var{title} @var{pane1} @var{pane2}...)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1707 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1708
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1709 @noindent
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1710 where each pane is a list of form
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1711
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1712 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1713 (@var{title} @var{item1} @var{item2}...)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1714 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1715
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1716 Each item should normally be a cons cell @code{(@var{line} . @var{value})},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1717 where @var{line} is a string, and @var{value} is the value to return if
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1718 that @var{line} is chosen. An item can also be a string; this makes a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1719 non-selectable line in the menu.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1720
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1721 If the user gets rid of the menu without making a valid choice, for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1722 instance by clicking the mouse away from a valid choice or by typing
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1723 keyboard input, then this normally results in a quit and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1724 @code{x-popup-menu} does not return. But if @var{position} is a mouse
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1725 button event (indicating that the user invoked the menu with the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1726 mouse) then no quit occurs and @code{x-popup-menu} returns @code{nil}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1727 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1728
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1729 @strong{Usage note:} Don't use @code{x-popup-menu} to display a menu
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1730 if you could do the job with a prefix key defined with a menu keymap.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1731 If you use a menu keymap to implement a menu, @kbd{C-h c} and @kbd{C-h
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1732 a} can see the individual items in that menu and provide help for them.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1733 If instead you implement the menu by defining a command that calls
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1734 @code{x-popup-menu}, the help facilities cannot know what happens inside
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1735 that command, so they cannot give any help for the menu's items.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1736
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1737 The menu bar mechanism, which lets you switch between submenus by
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1738 moving the mouse, cannot look within the definition of a command to see
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1739 that it calls @code{x-popup-menu}. Therefore, if you try to implement a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1740 submenu using @code{x-popup-menu}, it cannot work with the menu bar in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1741 an integrated fashion. This is why all menu bar submenus are
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1742 implemented with menu keymaps within the parent menu, and never with
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1743 @code{x-popup-menu}. @xref{Menu Bar}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1744
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1745 If you want a menu bar submenu to have contents that vary, you should
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1746 still use a menu keymap to implement it. To make the contents vary, add
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1747 a hook function to @code{menu-bar-update-hook} to update the contents of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1748 the menu keymap as necessary.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1749
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1750 @node Dialog Boxes
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1751 @section Dialog Boxes
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1752 @cindex dialog boxes
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1753
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1754 A dialog box is a variant of a pop-up menu---it looks a little
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1755 different, it always appears in the center of a frame, and it has just
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1756 one level and one or more buttons. The main use of dialog boxes is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1757 for asking questions that the user can answer with ``yes,'' ``no,''
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1758 and a few other alternatives. With a single button, they can also
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1759 force the user to acknowledge important information. The functions
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1760 @code{y-or-n-p} and @code{yes-or-no-p} use dialog boxes instead of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1761 keyboard, when called from commands invoked by mouse clicks.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1762
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1763 @defun x-popup-dialog position contents &optional header
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1764 This function displays a pop-up dialog box and returns an indication of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1765 what selection the user makes. The argument @var{contents} specifies
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1766 the alternatives to offer; it has this format:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1767
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1768 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1769 (@var{title} (@var{string} . @var{value})@dots{})
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1770 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1771
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1772 @noindent
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1773 which looks like the list that specifies a single pane for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1774 @code{x-popup-menu}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1775
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1776 The return value is @var{value} from the chosen alternative.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1777
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1778 As for @code{x-popup-menu}, an element of the list may be just a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1779 string instead of a cons cell @code{(@var{string} . @var{value})}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1780 That makes a box that cannot be selected.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1781
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1782 If @code{nil} appears in the list, it separates the left-hand items from
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1783 the right-hand items; items that precede the @code{nil} appear on the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1784 left, and items that follow the @code{nil} appear on the right. If you
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1785 don't include a @code{nil} in the list, then approximately half the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1786 items appear on each side.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1787
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1788 Dialog boxes always appear in the center of a frame; the argument
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1789 @var{position} specifies which frame. The possible values are as in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1790 @code{x-popup-menu}, but the precise coordinates or the individual
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1791 window don't matter; only the frame matters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1792
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1793 If @var{header} is non-@code{nil}, the frame title for the box is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1794 @samp{Information}, otherwise it is @samp{Question}. The former is used
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1795 for @code{message-box} (@pxref{message-box}).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1796
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1797 In some configurations, Emacs cannot display a real dialog box; so
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1798 instead it displays the same items in a pop-up menu in the center of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1799 frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1800
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801 If the user gets rid of the dialog box without making a valid choice,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1802 for instance using the window manager, then this produces a quit and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1803 @code{x-popup-dialog} does not return.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1804 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1805
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1806 @node Pointer Shape
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 @section Pointer Shape
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808 @cindex pointer shape
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809 @cindex mouse pointer shape
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1810
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811 You can specify the mouse pointer style for particular text or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1812 images using the @code{pointer} text property, and for images with the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813 @code{:pointer} and @code{:map} image properties. The values you can
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814 use in these properties are @code{text} (or @code{nil}), @code{arrow},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1815 @code{hand}, @code{vdrag}, @code{hdrag}, @code{modeline}, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1816 @code{hourglass}. @code{text} stands for the usual mouse pointer
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817 style used over text.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1819 Over void parts of the window (parts that do not correspond to any
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1820 of the buffer contents), the mouse pointer usually uses the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1821 @code{arrow} style, but you can specify a different style (one of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822 those above) by setting @code{void-text-area-pointer}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824 @defvar void-text-area-pointer
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 This variable specifies the mouse pointer style for void text areas.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826 These include the areas after the end of a line or below the last line
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827 in the buffer. The default is to use the @code{arrow} (non-text)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1828 pointer style.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1829 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830
100980
2a3ac16edc52 (Pointer Shape): Clarify that only X supports
Jason Rumney <jasonr@gnu.org>
parents: 100974
diff changeset
1831 When using X, you can specify what the @code{text} pointer style
2a3ac16edc52 (Pointer Shape): Clarify that only X supports
Jason Rumney <jasonr@gnu.org>
parents: 100974
diff changeset
1832 really looks like by setting the variable @code{x-pointer-shape}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834 @defvar x-pointer-shape
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835 This variable specifies the pointer shape to use ordinarily in the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1836 Emacs frame, for the @code{text} pointer style.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839 @defvar x-sensitive-text-pointer-shape
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840 This variable specifies the pointer shape to use when the mouse
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841 is over mouse-sensitive text.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1842 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 These variables affect newly created frames. They do not normally
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1845 affect existing frames; however, if you set the mouse color of a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1846 frame, that also installs the current value of those two variables.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1847 @xref{Color Parameters}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1848
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 The values you can use, to specify either of these pointer shapes, are
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1850 defined in the file @file{lisp/term/x-win.el}. Use @kbd{M-x apropos
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851 @key{RET} x-pointer @key{RET}} to see a list of them.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1853 @node Window System Selections
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1854 @section Window System Selections
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1855 @cindex selection (for window systems)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1856
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1857 The X server records a set of @dfn{selections} which permit transfer of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1858 data between application programs. The various selections are
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1859 distinguished by @dfn{selection types}, represented in Emacs by
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860 symbols. X clients including Emacs can read or set the selection for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861 any given type.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863 @deffn Command x-set-selection type data
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 This function sets a ``selection'' in the X server. It takes two
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 arguments: a selection type @var{type}, and the value to assign to it,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866 @var{data}. If @var{data} is @code{nil}, it means to clear out the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867 selection. Otherwise, @var{data} may be a string, a symbol, an integer
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868 (or a cons of two integers or list of two integers), an overlay, or a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869 cons of two markers pointing to the same buffer. An overlay or a pair
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1870 of markers stands for text in the overlay or between the markers.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872 The argument @var{data} may also be a vector of valid non-vector
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873 selection values.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875 Each possible @var{type} has its own selection value, which changes
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876 independently. The usual values of @var{type} are @code{PRIMARY},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 @code{SECONDARY} and @code{CLIPBOARD}; these are symbols with upper-case
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1878 names, in accord with X Window System conventions. If @var{type} is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879 @code{nil}, that stands for @code{PRIMARY}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1880
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881 This function returns @var{data}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882 @end deffn
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884 @defun x-get-selection &optional type data-type
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885 This function accesses selections set up by Emacs or by other X
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886 clients. It takes two optional arguments, @var{type} and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887 @var{data-type}. The default for @var{type}, the selection type, is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888 @code{PRIMARY}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890 The @var{data-type} argument specifies the form of data conversion to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891 use, to convert the raw data obtained from another X client into Lisp
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 data. Meaningful values include @code{TEXT}, @code{STRING},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893 @code{UTF8_STRING}, @code{TARGETS}, @code{LENGTH}, @code{DELETE},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894 @code{FILE_NAME}, @code{CHARACTER_POSITION}, @code{NAME},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895 @code{LINE_NUMBER}, @code{COLUMN_NUMBER}, @code{OWNER_OS},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 @code{HOST_NAME}, @code{USER}, @code{CLASS}, @code{ATOM}, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 @code{INTEGER}. (These are symbols with upper-case names in accord
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898 with X conventions.) The default for @var{data-type} is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899 @code{STRING}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1900 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1901
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1902 @cindex cut buffer
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903 The X server also has a set of eight numbered @dfn{cut buffers} which can
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904 store text or other data being moved between applications. Cut buffers
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 are considered obsolete, but Emacs supports them for the sake of X
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 clients that still use them. Cut buffers are numbered from 0 to 7.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1908 @defun x-get-cut-buffer &optional n
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1909 This function returns the contents of cut buffer number @var{n}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1910 If omitted @var{n} defaults to 0.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1911 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913 @defun x-set-cut-buffer string &optional push
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914 @anchor{Definition of x-set-cut-buffer}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915 This function stores @var{string} into the first cut buffer (cut buffer
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 0). If @var{push} is @code{nil}, only the first cut buffer is changed.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917 If @var{push} is non-@code{nil}, that says to move the values down
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918 through the series of cut buffers, much like the way successive kills in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919 Emacs move down the kill ring. In other words, the previous value of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920 the first cut buffer moves into the second cut buffer, and the second to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921 the third, and so on through all eight cut buffers.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924 @defvar selection-coding-system
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1925 This variable specifies the coding system to use when reading and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 writing selections or the clipboard. @xref{Coding
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927 Systems}. The default is @code{compound-text-with-extensions}, which
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928 converts to the text representation that X11 normally uses.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1929 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1930
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1931 @cindex clipboard support (for MS-Windows)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1932 When Emacs runs on MS-Windows, it does not implement X selections in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 general, but it does support the clipboard. @code{x-get-selection}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934 and @code{x-set-selection} on MS-Windows support the text data type
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 only; if the clipboard holds other types of data, Emacs treats the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 clipboard as empty.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938 @defopt x-select-enable-clipboard
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939 If this is non-@code{nil}, the Emacs yank functions consult the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 clipboard before the primary selection, and the kill functions store in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941 the clipboard as well as the primary selection. Otherwise they do not
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942 access the clipboard at all. The default is @code{nil} on most systems,
97043
9592c50233ab Remove support for Mac Carbon.
Dan Nicolaescu <dann@ics.uci.edu>
parents: 92098
diff changeset
1943 but @code{t} on MS-Windows.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1944 @end defopt
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1945
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946 @node Drag and Drop
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947 @section Drag and Drop
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1949 @vindex x-dnd-test-function
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950 @vindex x-dnd-known-types
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 When a user drags something from another application over Emacs, that other
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952 application expects Emacs to tell it if Emacs can handle the data that is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1953 dragged. The variable @code{x-dnd-test-function} is used by Emacs to determine
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1954 what to reply. The default value is @code{x-dnd-default-test-function}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955 which accepts drops if the type of the data to be dropped is present in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 @code{x-dnd-known-types}. You can customize @code{x-dnd-test-function} and/or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1957 @code{x-dnd-known-types} if you want Emacs to accept or reject drops based
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1958 on some other criteria.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1959
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1960 @vindex x-dnd-types-alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1961 If you want to change the way Emacs handles drop of different types
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1962 or add a new type, customize @code{x-dnd-types-alist}. This requires
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1963 detailed knowledge of what types other applications use for drag and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1964 drop.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1965
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1966 @vindex dnd-protocol-alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1967 When an URL is dropped on Emacs it may be a file, but it may also be
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1968 another URL type (ftp, http, etc.). Emacs first checks
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1969 @code{dnd-protocol-alist} to determine what to do with the URL. If
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1970 there is no match there and if @code{browse-url-browser-function} is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1971 an alist, Emacs looks for a match there. If no match is found the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1972 text for the URL is inserted. If you want to alter Emacs behavior,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973 you can customize these variables.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975 @node Color Names
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976 @section Color Names
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1977
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1978 @cindex color names
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1979 @cindex specify color
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980 @cindex numerical RGB color specification
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981 A color name is text (usually in a string) that specifies a color.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982 Symbolic names such as @samp{black}, @samp{white}, @samp{red}, etc.,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1983 are allowed; use @kbd{M-x list-colors-display} to see a list of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1984 defined names. You can also specify colors numerically in forms such
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985 as @samp{#@var{rgb}} and @samp{RGB:@var{r}/@var{g}/@var{b}}, where
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1986 @var{r} specifies the red level, @var{g} specifies the green level,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1987 and @var{b} specifies the blue level. You can use either one, two,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1988 three, or four hex digits for @var{r}; then you must use the same
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1989 number of hex digits for all @var{g} and @var{b} as well, making
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1990 either 3, 6, 9 or 12 hex digits in all. (See the documentation of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1991 X Window System for more details about numerical RGB specification of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1992 colors.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1993
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1994 These functions provide a way to determine which color names are
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1995 valid, and what they look like. In some cases, the value depends on the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1996 @dfn{selected frame}, as described below; see @ref{Input Focus}, for the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1997 meaning of the term ``selected frame.''
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1998
98969
5919c911fb16 (Color Names): Add an xref to `read-color'.
Eli Zaretskii <eliz@gnu.org>
parents: 98755
diff changeset
1999 To read user input of color names with completion, use
5919c911fb16 (Color Names): Add an xref to `read-color'.
Eli Zaretskii <eliz@gnu.org>
parents: 98755
diff changeset
2000 @code{read-color} (@pxref{High-Level Completion, read-color}).
5919c911fb16 (Color Names): Add an xref to `read-color'.
Eli Zaretskii <eliz@gnu.org>
parents: 98755
diff changeset
2001
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2002 @defun color-defined-p color &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2003 This function reports whether a color name is meaningful. It returns
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2004 @code{t} if so; otherwise, @code{nil}. The argument @var{frame} says
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2005 which frame's display to ask about; if @var{frame} is omitted or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2006 @code{nil}, the selected frame is used.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2007
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2008 Note that this does not tell you whether the display you are using
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2009 really supports that color. When using X, you can ask for any defined
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2010 color on any kind of display, and you will get some result---typically,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2011 the closest it can do. To determine whether a frame can really display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2012 a certain color, use @code{color-supported-p} (see below).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2013
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2014 @findex x-color-defined-p
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2015 This function used to be called @code{x-color-defined-p},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2016 and that name is still supported as an alias.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2017 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2018
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2019 @defun defined-colors &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2020 This function returns a list of the color names that are defined
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2021 and supported on frame @var{frame} (default, the selected frame).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2022 If @var{frame} does not support colors, the value is @code{nil}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2023
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2024 @findex x-defined-colors
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2025 This function used to be called @code{x-defined-colors},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2026 and that name is still supported as an alias.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2027 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2028
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2029 @defun color-supported-p color &optional frame background-p
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2030 This returns @code{t} if @var{frame} can really display the color
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2031 @var{color} (or at least something close to it). If @var{frame} is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2032 omitted or @code{nil}, the question applies to the selected frame.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2033
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2034 Some terminals support a different set of colors for foreground and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2035 background. If @var{background-p} is non-@code{nil}, that means you are
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2036 asking whether @var{color} can be used as a background; otherwise you
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2037 are asking whether it can be used as a foreground.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2038
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2039 The argument @var{color} must be a valid color name.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2040 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2042 @defun color-gray-p color &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2043 This returns @code{t} if @var{color} is a shade of gray, as defined on
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2044 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2045 question applies to the selected frame. If @var{color} is not a valid
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2046 color name, this function returns @code{nil}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2049 @defun color-values color &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2050 @cindex rgb value
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2051 This function returns a value that describes what @var{color} should
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2052 ideally look like on @var{frame}. If @var{color} is defined, the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053 value is a list of three integers, which give the amount of red, the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054 amount of green, and the amount of blue. Each integer ranges in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055 principle from 0 to 65535, but some displays may not use the full
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2056 range. This three-element list is called the @dfn{rgb values} of the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2057 color.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2058
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059 If @var{color} is not defined, the value is @code{nil}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2061 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2062 (color-values "black")
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063 @result{} (0 0 0)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2064 (color-values "white")
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065 @result{} (65280 65280 65280)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066 (color-values "red")
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067 @result{} (65280 0 0)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068 (color-values "pink")
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069 @result{} (65280 49152 51968)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 (color-values "hungry")
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2071 @result{} nil
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2072 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2073
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074 The color values are returned for @var{frame}'s display. If
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075 @var{frame} is omitted or @code{nil}, the information is returned for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076 the selected frame's display. If the frame cannot display colors, the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077 value is @code{nil}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079 @findex x-color-values
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2080 This function used to be called @code{x-color-values},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2081 and that name is still supported as an alias.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2083
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2084 @node Text Terminal Colors
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2085 @section Text Terminal Colors
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2086 @cindex colors on text-only terminals
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088 Text-only terminals usually support only a small number of colors,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2089 and the computer uses small integers to select colors on the terminal.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2090 This means that the computer cannot reliably tell what the selected
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091 color looks like; instead, you have to inform your application which
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2092 small integers correspond to which colors. However, Emacs does know
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2093 the standard set of colors and will try to use them automatically.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2094
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2095 The functions described in this section control how terminal colors
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2096 are used by Emacs.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2097
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2098 Several of these functions use or return @dfn{rgb values}, described
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099 in @ref{Color Names}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2100
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2101 These functions accept a display (either a frame or the name of a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2102 terminal) as an optional argument. We hope in the future to make Emacs
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2103 support more than one text-only terminal at one time; then this argument
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104 will specify which terminal to operate on (the default being the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105 selected frame's terminal; @pxref{Input Focus}). At present, though,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 the @var{frame} argument has no effect.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2108 @defun tty-color-define name number &optional rgb frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2109 This function associates the color name @var{name} with
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2110 color number @var{number} on the terminal.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2111
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2112 The optional argument @var{rgb}, if specified, is an rgb value, a list
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2113 of three numbers that specify what the color actually looks like.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2114 If you do not specify @var{rgb}, then this color cannot be used by
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2115 @code{tty-color-approximate} to approximate other colors, because
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2116 Emacs will not know what it looks like.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2117 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2118
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2119 @defun tty-color-clear &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2120 This function clears the table of defined colors for a text-only terminal.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2121 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2122
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2123 @defun tty-color-alist &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2124 This function returns an alist recording the known colors supported by a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2125 text-only terminal.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2126
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2127 Each element has the form @code{(@var{name} @var{number} . @var{rgb})}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2128 or @code{(@var{name} @var{number})}. Here, @var{name} is the color
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2129 name, @var{number} is the number used to specify it to the terminal.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2130 If present, @var{rgb} is a list of three color values (for red, green,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2131 and blue) that says what the color actually looks like.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2132 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2133
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2134 @defun tty-color-approximate rgb &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2135 This function finds the closest color, among the known colors
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2136 supported for @var{display}, to that described by the rgb value
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2137 @var{rgb} (a list of color values). The return value is an element of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2138 @code{tty-color-alist}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2139 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2140
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2141 @defun tty-color-translate color &optional frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2142 This function finds the closest color to @var{color} among the known
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2143 colors supported for @var{display} and returns its index (an integer).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2144 If the name @var{color} is not defined, the value is @code{nil}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2145 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2146
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2147 @node Resources
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2148 @section X Resources
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2149
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2150 @defun x-get-resource attribute class &optional component subclass
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2151 The function @code{x-get-resource} retrieves a resource value from the X
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2152 Window defaults database.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2153
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2154 Resources are indexed by a combination of a @dfn{key} and a @dfn{class}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2155 This function searches using a key of the form
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156 @samp{@var{instance}.@var{attribute}} (where @var{instance} is the name
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2157 under which Emacs was invoked), and using @samp{Emacs.@var{class}} as
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2158 the class.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2159
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2160 The optional arguments @var{component} and @var{subclass} add to the key
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2161 and the class, respectively. You must specify both of them or neither.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2162 If you specify them, the key is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2163 @samp{@var{instance}.@var{component}.@var{attribute}}, and the class is
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2164 @samp{Emacs.@var{class}.@var{subclass}}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2165 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2166
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2167 @defvar x-resource-class
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2168 This variable specifies the application name that @code{x-get-resource}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2169 should look up. The default value is @code{"Emacs"}. You can examine X
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2170 resources for application names other than ``Emacs'' by binding this
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2171 variable to some other string, around a call to @code{x-get-resource}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2172 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2173
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2174 @defvar x-resource-name
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2175 This variable specifies the instance name that @code{x-get-resource}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2176 should look up. The default value is the name Emacs was invoked with,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2177 or the value specified with the @samp{-name} or @samp{-rn} switches.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2178 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2179
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2180 To illustrate some of the above, suppose that you have the line:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2181
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183 xterm.vt100.background: yellow
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2185
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2186 @noindent
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2187 in your X resources file (whose name is usually @file{~/.Xdefaults}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2188 or @file{~/.Xresources}). Then:
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2189
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2190 @example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2191 @group
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2192 (let ((x-resource-class "XTerm") (x-resource-name "xterm"))
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193 (x-get-resource "vt100.background" "VT100.Background"))
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194 @result{} "yellow"
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195 @end group
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2196 @group
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197 (let ((x-resource-class "XTerm") (x-resource-name "xterm"))
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2198 (x-get-resource "background" "VT100" "vt100" "Background"))
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2199 @result{} "yellow"
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200 @end group
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2201 @end example
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2202
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2203 @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2205 @node Display Feature Testing
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2206 @section Display Feature Testing
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2207 @cindex display feature testing
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2208
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2209 The functions in this section describe the basic capabilities of a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210 particular display. Lisp programs can use them to adapt their behavior
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211 to what the display can do. For example, a program that ordinarily uses
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2212 a popup menu could use the minibuffer if popup menus are not supported.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 The optional argument @var{display} in these functions specifies which
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215 display to ask the question about. It can be a display name, a frame
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216 (which designates the display that frame is on), or @code{nil} (which
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217 refers to the selected frame's display, @pxref{Input Focus}).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219 @xref{Color Names}, @ref{Text Terminal Colors}, for other functions to
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220 obtain information about displays.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2221
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2222 @defun display-popup-menus-p &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223 This function returns @code{t} if popup menus are supported on
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224 @var{display}, @code{nil} if not. Support for popup menus requires that
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2225 the mouse be available, since the user cannot choose menu items without
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2226 a mouse.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2227 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2228
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2229 @defun display-graphic-p &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2230 This function returns @code{t} if @var{display} is a graphic display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2231 capable of displaying several frames and several different fonts at
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2232 once. This is true for displays that use a window system such as X, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2233 false for text-only terminals.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2234 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2235
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2236 @defun display-mouse-p &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237 @cindex mouse, availability
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238 This function returns @code{t} if @var{display} has a mouse available,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2239 @code{nil} if not.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2240 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2241
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2242 @defun display-color-p &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2243 @findex x-display-color-p
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2244 This function returns @code{t} if the screen is a color screen.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2245 It used to be called @code{x-display-color-p}, and that name
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2246 is still supported as an alias.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2248
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2249 @defun display-grayscale-p &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2250 This function returns @code{t} if the screen can display shades of gray.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2251 (All color displays can do this.)
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2252 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2253
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2254 @defun display-supports-face-attributes-p attributes &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2255 @anchor{Display Face Attribute Testing}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2256 This function returns non-@code{nil} if all the face attributes in
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2257 @var{attributes} are supported (@pxref{Face Attributes}).
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2258
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2259 The definition of `supported' is somewhat heuristic, but basically
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2260 means that a face containing all the attributes in @var{attributes},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2261 when merged with the default face for display, can be represented in a
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2262 way that's
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2263
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2264 @enumerate
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2265 @item
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2266 different in appearance than the default face, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2267
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2268 @item
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2269 `close in spirit' to what the attributes specify, if not exact.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2270 @end enumerate
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272 Point (2) implies that a @code{:weight black} attribute will be
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273 satisfied by any display that can display bold, as will
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274 @code{:foreground "yellow"} as long as some yellowish color can be
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2275 displayed, but @code{:slant italic} will @emph{not} be satisfied by
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2276 the tty display code's automatic substitution of a `dim' face for
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2277 italic.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2278 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2279
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2280 @defun display-selections-p &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2281 This function returns @code{t} if @var{display} supports selections.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2282 Windowed displays normally support selections, but they may also be
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2283 supported in some other cases.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2284 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2285
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286 @defun display-images-p &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287 This function returns @code{t} if @var{display} can display images.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288 Windowed displays ought in principle to handle images, but some
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 systems lack the support for that. On a display that does not support
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290 images, Emacs cannot display a tool bar.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2291 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2292
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2293 @defun display-screens &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2294 This function returns the number of screens associated with the display.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297 @defun display-pixel-height &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2298 This function returns the height of the screen in pixels.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2299 On a character terminal, it gives the height in characters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2300
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2301 For graphical terminals, note that on ``multi-monitor'' setups this
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2302 refers to the pixel width for all physical monitors associated with
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
2303 @var{display}. @xref{Multiple Terminals}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2304 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2305
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306 @defun display-pixel-width &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2307 This function returns the width of the screen in pixels.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2308 On a character terminal, it gives the width in characters.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2309
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2310 For graphical terminals, note that on ``multi-monitor'' setups this
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2311 refers to the pixel width for all physical monitors associated with
102846
a447859a557b * frames.texi (Frames): Clean up introduction. Document `ns'
Chong Yidong <cyd@stupidchicken.com>
parents: 101939
diff changeset
2312 @var{display}. @xref{Multiple Terminals}.
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2314
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2315 @defun display-mm-height &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2316 This function returns the height of the screen in millimeters,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2317 or @code{nil} if Emacs cannot get that information.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2320 @defun display-mm-width &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2321 This function returns the width of the screen in millimeters,
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2322 or @code{nil} if Emacs cannot get that information.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 @defvar display-mm-dimensions-alist
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2326 This variable allows the user to specify the dimensions of graphical
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2327 displays returned by @code{display-mm-height} and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 @code{display-mm-width} in case the system provides incorrect values.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2330
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2331 @defun display-backing-store &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2332 This function returns the backing store capability of the display.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2333 Backing store means recording the pixels of windows (and parts of
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2334 windows) that are not exposed, so that when exposed they can be
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2335 displayed very quickly.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337 Values can be the symbols @code{always}, @code{when-mapped}, or
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338 @code{not-useful}. The function can also return @code{nil}
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2339 when the question is inapplicable to a certain kind of display.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2340 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2341
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2342 @defun display-save-under &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2343 This function returns non-@code{nil} if the display supports the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 SaveUnder feature. That feature is used by pop-up windows
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2345 to save the pixels they obscure, so that they can pop down
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346 quickly.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2347 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349 @defun display-planes &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350 This function returns the number of planes the display supports.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2351 This is typically the number of bits per pixel.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2352 For a tty display, it is log to base two of the number of colors supported.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2353 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2354
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2355 @defun display-visual-class &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2356 This function returns the visual class for the screen. The value is one
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2357 of the symbols @code{static-gray}, @code{gray-scale},
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2358 @code{static-color}, @code{pseudo-color}, @code{true-color}, and
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2359 @code{direct-color}.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2360 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2361
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2362 @defun display-color-cells &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2363 This function returns the number of color cells the screen supports.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2364 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2365
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2366 These functions obtain additional information specifically
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2367 about X displays.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2368
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2369 @defun x-server-version &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2370 This function returns the list of version numbers of the X server
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2371 running the display. The value is a list of three integers: the major
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2372 and minor version numbers of the X protocol, and the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2373 distributor-specific release number of the X server software itself.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2374 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2375
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2376 @defun x-server-vendor &optional display
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2377 This function returns the ``vendor'' that provided the X server
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2378 software (as a string). Really this means whoever distributes the X
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2379 server.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2380
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2381 When the developers of X labelled software distributors as
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2382 ``vendors,'' they showed their false assumption that no system could
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2383 ever be developed and distributed noncommercially.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2384 @end defun
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2385
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2386 @ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2387 @defvar x-no-window-manager
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2388 This variable's value is @code{t} if no X window manager is in use.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2389 @end defvar
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2390 @end ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2391
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2392 @ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2393 @item
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2394 The functions @code{x-pixel-width} and @code{x-pixel-height} return the
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2395 width and height of an X Window frame, measured in pixels.
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2396 @end ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2397
100720
87e287e416fe (Multiple Terminals, Low-level Terminal)
Eli Zaretskii <eliz@gnu.org>
parents: 99763
diff changeset
2398
84068
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2399 @ignore
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2400 arch-tag: 94977df6-3dca-4730-b57b-c6329e9282ba
c5bc1b7f62d7 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2401 @end ignore