annotate lispref/frames.texi @ 56463:e86e7a1eccac

Describe `Auto Revert Tail Mode' in `Commentary' section. (auto-revert-handler): Do not check `auto-revert-tail-mode' for non-file buffers. We know it is nil.
author Luc Teirlinck <teirllm@auburn.edu>
date Sat, 17 Jul 2004 20:53:22 +0000
parents dcdd02599cbd
children fee4457701d8 029a652ac817
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
56338
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2002, 2004
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48700
diff changeset
4 @c Free Software Foundation, Inc.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 @setfilename ../info/frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 @node Frames, Positions, Windows, Top
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 @chapter Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 @cindex frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
13155
0b8e0559dcee Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents: 12676
diff changeset
11 A @dfn{frame} is a rectangle on the screen that contains one or more
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 Emacs windows. A frame initially contains a single main window (plus
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
13 perhaps a minibuffer window), which you can subdivide vertically or
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 horizontally into smaller windows.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 @cindex terminal frame
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
17 When Emacs runs on a text-only terminal, it starts with one
12125
995be67f3fd1 updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents: 12098
diff changeset
18 @dfn{terminal frame}. If you create additional ones, Emacs displays
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
19 one and only one at any given time---on the terminal screen, of course.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
20
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
21 @cindex window frame
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
22 When Emacs communicates directly with a supported window system, such
35476
26912db550c3 Change "X windows" instances.
Dave Love <fx@gnu.org>
parents: 35037
diff changeset
23 as X, it does not have a terminal frame; instead, it starts with
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
24 a single @dfn{window frame}, but you can create more, and Emacs can
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
25 display several such frames at once as is usual for window systems.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 @defun framep object
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
28 This predicate returns a non-@code{nil} value if @var{object} is a
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
29 frame, and @code{nil} otherwise. For a frame, the value indicates which
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
30 kind of display the frame uses:
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
31
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
32 @table @code
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
33 @item x
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
34 The frame is displayed in an X window.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
35 @item t
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
36 A terminal frame on a character display.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
37 @item mac
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
38 The frame is displayed on a Macintosh.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
39 @item w32
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
40 The frame is displayed on MS-Windows 9X/NT.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
41 @item pc
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
42 The frame is displayed on an MS-DOS terminal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
43 @end table
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 @menu
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
47 * Creating Frames:: Creating additional frames.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
48 * Multiple Displays:: Creating frames on other displays.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 * Frame Parameters:: Controlling frame size, position, font, etc.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
50 * Frame Titles:: Automatic updating of frame titles.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 * Deleting Frames:: Frames last until explicitly deleted.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 * Finding All Frames:: How to examine all existing frames.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 * Frames and Windows:: A frame contains windows;
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
54 display of text always works through windows.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55 * Minibuffers and Frames:: How a frame finds the minibuffer to use.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 * Input Focus:: Specifying the selected frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 * Visibility of Frames:: Frames may be visible or invisible, or icons.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
58 * Raising and Lowering:: Raising a frame makes it hide other windows;
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
59 lowering it makes the others hide it.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 * Frame Configurations:: Saving the state of all frames.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 * Mouse Tracking:: Getting events that say when the mouse moves.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 * Mouse Position:: Asking where the mouse is, or moving it.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 * Pop-Up Menus:: Displaying a menu for the user to select from.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 * Dialog Boxes:: Displaying a box to ask yes or no.
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
65 * Pointer Shapes:: Specifying the shape of the mouse pointer.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
66 * Window System Selections:: Transferring text to and from other X clients.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
67 * Color Names:: Getting the definitions of color names.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
68 * Text Terminal Colors:: Defining colors for text-only terminals.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 * Resources:: Getting resource values from the server.
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
70 * Display Feature Testing:: Determining the features of a terminal.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 @end menu
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48700
diff changeset
73 @xref{Display}, for information about the related topic of
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
74 controlling Emacs redisplay.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 @node Creating Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 @section Creating Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 To create a new frame, call the function @code{make-frame}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80
13155
0b8e0559dcee Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents: 12676
diff changeset
81 @defun make-frame &optional alist
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
82 This function creates a new frame. If you are using a supported window
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
83 system, it makes a window frame; otherwise, it makes a terminal frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 The argument is an alist specifying frame parameters. Any parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 not mentioned in @var{alist} default according to the value of the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
87 variable @code{default-frame-alist}; parameters not specified even there
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
88 default from the standard X resources or whatever is used instead on
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
89 your system.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91 The set of possible parameters depends in principle on what kind of
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
92 window system Emacs uses to display its frames. @xref{Window Frame
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
93 Parameters}, for documentation of individual parameters you can specify.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
96 @defvar before-make-frame-hook
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 A normal hook run by @code{make-frame} before it actually creates the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 @end defvar
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
101 @defvar after-make-frame-functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
102 @tindex after-make-frame-functions
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
103 An abnormal hook run by @code{make-frame} after it creates the frame.
32596
1cb37313bcac Obsolete variable `after-make-frame-hook'.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 31375
diff changeset
104 Each function in @code{after-make-frame-functions} receives one argument, the
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
105 frame just created.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 @end defvar
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
108 @node Multiple Displays
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
109 @section Multiple Displays
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
110 @cindex multiple X displays
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
111 @cindex displays, multiple
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
112
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
113 A single Emacs can talk to more than one X display.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
114 Initially, Emacs uses just one display---the one chosen with the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
115 @code{DISPLAY} environment variable or with the @samp{--display} option
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
116 (@pxref{Initial Options,,, emacs, The GNU Emacs Manual}). To connect to
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
117 another display, use the command @code{make-frame-on-display} or specify
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
118 the @code{display} frame parameter when you create the frame.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
119
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
120 Emacs treats each X server as a separate terminal, giving each one its
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
121 own selected frame and its own minibuffer windows. However, only one of
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
122 those frames is ``@emph{the} selected frame'' at any given moment, see
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
123 @ref{Input Focus}.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
124
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
125 A few Lisp variables are @dfn{terminal-local}; that is, they have a
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
126 separate binding for each terminal. The binding in effect at any time
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
127 is the one for the terminal that the currently selected frame belongs
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
128 to. These variables include @code{default-minibuffer-frame},
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
129 @code{defining-kbd-macro}, @code{last-kbd-macro}, and
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
130 @code{system-key-alist}. They are always terminal-local, and can never
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
131 be buffer-local (@pxref{Buffer-Local Variables}) or frame-local.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
132
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
133 A single X server can handle more than one screen. A display name
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
134 @samp{@var{host}:@var{server}.@var{screen}} has three parts; the last
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
135 part specifies the screen number for a given server. When you use two
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
136 screens belonging to one server, Emacs knows by the similarity in their
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
137 names that they share a single keyboard, and it treats them as a single
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
138 terminal.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
139
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
140 @deffn Command make-frame-on-display display &optional parameters
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
141 This creates a new frame on display @var{display}, taking the other
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
142 frame parameters from @var{parameters}. Aside from the @var{display}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
143 argument, it is like @code{make-frame} (@pxref{Creating Frames}).
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
144 @end deffn
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
145
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
146 @defun x-display-list
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
147 This returns a list that indicates which X displays Emacs has a
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
148 connection to. The elements of the list are strings, and each one is
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
149 a display name.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
150 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
151
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
152 @defun x-open-connection display &optional xrm-string must-succeed
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
153 This function opens a connection to the X display @var{display}. It
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
154 does not create a frame on that display, but it permits you to check
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
155 that communication can be established with that display.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
156
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
157 The optional argument @var{xrm-string}, if not @code{nil}, is a
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
158 string of resource names and values, in the same format used in the
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
159 @file{.Xresources} file. The values you specify override the resource
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
160 values recorded in the X server itself; they apply to all Emacs frames
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
161 created on this display. Here's an example of what this string might
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
162 look like:
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
163
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
164 @example
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
165 "*BorderWidth: 3\n*InternalBorder: 2\n"
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
166 @end example
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
167
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
168 @xref{Resources}.
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
169
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
170 If @var{must-succeed} is non-@code{nil}, failure to open the connection
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
171 terminates Emacs. Otherwise, it is an ordinary Lisp error.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
172 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
173
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
174 @defun x-close-connection display
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
175 This function closes the connection to display @var{display}. Before
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
176 you can do this, you must first delete all the frames that were open on
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
177 that display (@pxref{Deleting Frames}).
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
178 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
179
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
180 @node Frame Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 @section Frame Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
183 A frame has many parameters that control its appearance and behavior.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184 Just what parameters a frame has depends on what display mechanism it
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 uses.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
187 Frame parameters exist mostly for the sake of window systems. A
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
188 terminal frame has a few parameters, mostly for compatibility's sake;
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
189 only the @code{height}, @code{width}, @code{name}, @code{title},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
190 @code{menu-bar-lines}, @code{buffer-list} and @code{buffer-predicate}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
191 parameters do something special. If the terminal supports colors, the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
192 parameters @code{foreground-color}, @code{background-color},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
193 @code{background-mode} and @code{display-type} are also meaningful.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 @menu
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196 * Parameter Access:: How to change a frame's parameters.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 * Initial Parameters:: Specifying frame parameters when you make a frame.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
198 * Window Frame Parameters:: List of frame parameters for window systems.
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
199 * Size and Position:: Changing the size and position of a frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200 @end menu
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
201
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 @node Parameter Access
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 @subsection Access to Frame Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 These functions let you read and change the parameter values of a
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
206 frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
208 @defun frame-parameter frame parameter
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
209 @tindex frame-parameter
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
210 This function returns the value of the parameter named @var{parameter}
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
211 of @var{frame}. If @var{frame} is @code{nil}, it returns the
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
212 selected frame's parameter.
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
213 @end defun
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
214
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
215 @defun frame-parameters &optional frame
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216 The function @code{frame-parameters} returns an alist listing all the
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
217 parameters of @var{frame} and their values. If @var{frame} is
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
218 @code{nil} or omitted, this returns the selected frame's parameters
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221 @defun modify-frame-parameters frame alist
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222 This function alters the parameters of frame @var{frame} based on the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223 elements of @var{alist}. Each element of @var{alist} has the form
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 @code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 parameter. If you don't mention a parameter in @var{alist}, its value
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
226 doesn't change. If @var{frame} is @code{nil}, it defaults to the selected
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
227 frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
228 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
229
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
230 @defun modify-all-frames-parameters alist
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
231 This function alters the frame parameters of all existing frames
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
232 according to @var{alist}, then modifies @code{default-frame-alist}
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
233 to apply the same parameter values to frames that will be created
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
234 henceforth.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
235 @end defun
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
236
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
237 @node Initial Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238 @subsection Initial Frame Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
240 You can specify the parameters for the initial startup frame
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
241 by setting @code{initial-frame-alist} in your init file (@pxref{Init File}).
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
242
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
243 @defvar initial-frame-alist
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
244 This variable's value is an alist of parameter values used when creating
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
245 the initial window frame. You can set this variable to specify the
16528
62be63ee468d Clarify initial-frame-alist and default-frame-alist.
Richard M. Stallman <rms@gnu.org>
parents: 15061
diff changeset
246 appearance of the initial frame without altering subsequent frames.
62be63ee468d Clarify initial-frame-alist and default-frame-alist.
Richard M. Stallman <rms@gnu.org>
parents: 15061
diff changeset
247 Each element has the form:
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
248
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
249 @example
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
250 (@var{parameter} . @var{value})
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
251 @end example
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
252
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
253 Emacs creates the initial frame before it reads your init
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
254 file. After reading that file, Emacs checks @code{initial-frame-alist},
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
255 and applies the parameter settings in the altered value to the already
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
256 created initial frame.
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
257
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
258 If these settings affect the frame geometry and appearance, you'll see
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
259 the frame appear with the wrong ones and then change to the specified
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
260 ones. If that bothers you, you can specify the same geometry and
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
261 appearance with X resources; those do take effect before the frame is
45779
4964699e51b4 (Initial Parameters, Resources): Fix references to the Emacs manual.
Andreas Schwab <schwab@suse.de>
parents: 45744
diff changeset
262 created. @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}.
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
263
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
264 X resource settings typically apply to all frames. If you want to
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
265 specify some X resources solely for the sake of the initial frame, and
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
266 you don't want them to apply to subsequent frames, here's how to achieve
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
267 this. Specify parameters in @code{default-frame-alist} to override the
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
268 X resources for subsequent frames; then, to prevent these from affecting
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
269 the initial frame, specify the same parameters in
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
270 @code{initial-frame-alist} with values that match the X resources.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
271 @end defvar
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
272
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
273 If these parameters specify a separate minibuffer-only frame with
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
274 @code{(minibuffer . nil)}, and you have not created one, Emacs creates
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
275 one for you.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
277 @defvar minibuffer-frame-alist
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
278 This variable's value is an alist of parameter values used when creating
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
279 an initial minibuffer-only frame---if such a frame is needed, according
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
280 to the parameters for the main initial frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281 @end defvar
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
282
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
283 @defvar default-frame-alist
16528
62be63ee468d Clarify initial-frame-alist and default-frame-alist.
Richard M. Stallman <rms@gnu.org>
parents: 15061
diff changeset
284 This is an alist specifying default values of frame parameters for all
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
285 Emacs frames---the first frame, and subsequent frames. When using the X
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
286 Window System, you can get the same results by means of X resources
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
287 in many cases.
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
288 @end defvar
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
289
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
290 See also @code{special-display-frame-alist}, in @ref{Choosing Window}.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
291
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
292 If you use options that specify window appearance when you invoke Emacs,
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
293 they take effect by adding elements to @code{default-frame-alist}. One
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
294 exception is @samp{-geometry}, which adds the specified position to
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
295 @code{initial-frame-alist} instead. @xref{Command Arguments,,, emacs,
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
296 The GNU Emacs Manual}.
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
297
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
298 @node Window Frame Parameters
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
299 @subsection Window Frame Parameters
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
300
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
301 Just what parameters a frame has depends on what display mechanism it
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
302 uses. Here is a table of the parameters that have special meanings in a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
303 window frame; of these, @code{name}, @code{title}, @code{height},
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
304 @code{width}, @code{buffer-list} and @code{buffer-predicate} provide
42752
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
305 meaningful information in terminal frames, and @code{tty-color-mode}
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
306 is meaningful @emph{only} in terminal frames.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
307
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
308 @table @code
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
309 @item display
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
310 The display on which to open this frame. It should be a string of the
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
311 form @code{"@var{host}:@var{dpy}.@var{screen}"}, just like the
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
312 @code{DISPLAY} environment variable.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
313
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
314 @item title
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
315 If a frame has a non-@code{nil} title, it appears in the window system's
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
316 border for the frame, and also in the mode line of windows in that frame
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
317 if @code{mode-line-frame-identification} uses @samp{%F}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
318 (@pxref{%-Constructs}). This is normally the case when Emacs is not
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
319 using a window system, and can only display one frame at a time.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
320 @xref{Frame Titles}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
321
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
322 @item name
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
323 The name of the frame. The frame name serves as a default for the frame
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
324 title, if the @code{title} parameter is unspecified or @code{nil}. If
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
325 you don't specify a name, Emacs sets the frame name automatically
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
326 (@pxref{Frame Titles}).
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
327
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
328 If you specify the frame name explicitly when you create the frame, the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
329 name is also used (instead of the name of the Emacs executable) when
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
330 looking up X resources for the frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
331
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
332 @item left
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
333 The screen position of the left edge, in pixels, with respect to the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
334 left edge of the screen. The value may be a positive number @var{pos},
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
335 or a list of the form @code{(+ @var{pos})} which permits specifying a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
336 negative @var{pos} value.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
337
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
338 A negative number @minus{}@var{pos}, or a list of the form @code{(-
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
339 @var{pos})}, actually specifies the position of the right edge of the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
340 window with respect to the right edge of the screen. A positive value
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
341 of @var{pos} counts toward the left. @strong{Reminder:} if the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
342 parameter is a negative integer @minus{}@var{pos}, then @var{pos} is
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
343 positive.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
344
12388
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
345 Some window managers ignore program-specified positions. If you want to
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
346 be sure the position you specify is not ignored, specify a
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
347 non-@code{nil} value for the @code{user-position} parameter as well.
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
348
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 @item top
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
350 The screen position of the top edge, in pixels, with respect to the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
351 top edge of the screen. The value may be a positive number @var{pos},
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
352 or a list of the form @code{(+ @var{pos})} which permits specifying a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
353 negative @var{pos} value.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
354
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
355 A negative number @minus{}@var{pos}, or a list of the form @code{(-
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
356 @var{pos})}, actually specifies the position of the bottom edge of the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
357 window with respect to the bottom edge of the screen. A positive value
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
358 of @var{pos} counts toward the top. @strong{Reminder:} if the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
359 parameter is a negative integer @minus{}@var{pos}, then @var{pos} is
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
360 positive.
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
361
12388
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
362 Some window managers ignore program-specified positions. If you want to
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
363 be sure the position you specify is not ignored, specify a
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
364 non-@code{nil} value for the @code{user-position} parameter as well.
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
365
10220
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
366 @item icon-left
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
367 The screen position of the left edge @emph{of the frame's icon}, in
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
368 pixels, counting from the left edge of the screen. This takes effect if
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
369 and when the frame is iconified.
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
370
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
371 @item icon-top
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
372 The screen position of the top edge @emph{of the frame's icon}, in
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
373 pixels, counting from the top edge of the screen. This takes effect if
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
374 and when the frame is iconified.
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
375
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
376 @item user-position
14658
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
377 When you create a frame and specify its screen position with the
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
378 @code{left} and @code{top} parameters, use this parameter to say whether
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
379 the specified position was user-specified (explicitly requested in some
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
380 way by a human user) or merely program-specified (chosen by a program).
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
381 A non-@code{nil} value says the position was user-specified.
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
382
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
383 Window managers generally heed user-specified positions, and some heed
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
384 program-specified positions too. But many ignore program-specified
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
385 positions, placing the window in a default fashion or letting the user
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
386 place it with the mouse. Some window managers, including @code{twm},
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
387 let the user specify whether to obey program-specified positions or
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
388 ignore them.
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
389
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
390 When you call @code{make-frame}, you should specify a non-@code{nil}
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
391 value for this parameter if the values of the @code{left} and @code{top}
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
392 parameters represent the user's stated preference; otherwise, use
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
393 @code{nil}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
395 @item height
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
396 The height of the frame contents, in characters. (To get the height in
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
397 pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
398
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399 @item width
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
400 The width of the frame contents, in characters. (To get the height in
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
401 pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402
42713
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
403 @item fullscreen
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
404 Specify that width, height or both shall be set to the size of the screen.
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
405 The value @code{fullwidth} specifies that width shall be the size of the
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
406 screen. The value @code{fullheight} specifies that height shall be the
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
407 size of the screen. The value @code{fullboth} specifies that both the
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
408 width and the height shall be set to the size of the screen.
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
409
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410 @item window-id
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
411 The number of the window-system window used by the frame
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
412 to contain the actual Emacs windows.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
413
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
414 @item outer-window-id
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
415 The number of the outermost window-system window used for the whole frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417 @item minibuffer
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
418 Whether this frame has its own minibuffer. The value @code{t} means
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419 yes, @code{nil} means no, @code{only} means this frame is just a
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
420 minibuffer. If the value is a minibuffer window (in some other frame),
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
421 the new frame uses that minibuffer.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
422
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
423 @item buffer-predicate
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
424 The buffer-predicate function for this frame. The function
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
425 @code{other-buffer} uses this predicate (from the selected frame) to
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
426 decide which buffers it should consider, if the predicate is not
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
427 @code{nil}. It calls the predicate with one argument, a buffer, once for
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
428 each buffer; if the predicate returns a non-@code{nil} value, it
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
429 considers that buffer.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
430
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
431 @item buffer-list
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
432 A list of buffers that have been selected in this frame,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
433 ordered most-recently-selected first.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
434
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
435 @item auto-raise
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
436 Whether selecting the frame raises it (non-@code{nil} means yes).
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
437
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
438 @item auto-lower
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
439 Whether deselecting the frame lowers it (non-@code{nil} means yes).
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
440
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
441 @item vertical-scroll-bars
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
442 Whether the frame has scroll bars for vertical scrolling, and which side
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
443 of the frame they should be on. The possible values are @code{left},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
444 @code{right}, and @code{nil} for no scroll bars.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
445
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
446 @item horizontal-scroll-bars
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
447 Whether the frame has scroll bars for horizontal scrolling
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
448 (non-@code{nil} means yes). (Horizontal scroll bars are not currently
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
449 implemented.)
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
450
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
451 @item scroll-bar-width
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
452 The width of the vertical scroll bar, in pixels,
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
453 or @code{nil} meaning to use the default width.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
454
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
455 @item icon-type
10759
fe6bdcb0d99f Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents: 10220
diff changeset
456 The type of icon to use for this frame when it is iconified. If the
fe6bdcb0d99f Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents: 10220
diff changeset
457 value is a string, that specifies a file containing a bitmap to use.
fe6bdcb0d99f Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents: 10220
diff changeset
458 Any other non-@code{nil} value specifies the default bitmap icon (a
fe6bdcb0d99f Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents: 10220
diff changeset
459 picture of a gnu); @code{nil} specifies a text icon.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
460
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
461 @item icon-name
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
462 The name to use in the icon for this frame, when and if the icon
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
463 appears. If this is @code{nil}, the frame's title is used.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
464
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
465 @item background-mode
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
466 This parameter is either @code{dark} or @code{light}, according
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
467 to whether the background color is a light one or a dark one.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
468
42752
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
469 @item tty-color-mode
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
470 @cindex standard colors for character terminals
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
471 This parameter overrides the terminal's color support as given by the
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
472 system's terminal capabilities database in that this parameter's value
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
473 specifies the color mode to use in terminal frames. The value can be
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
474 either a symbol or a number. A number specifies the number of colors
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
475 to use (and, indirectly, what commands to issue to produce each
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
476 color). For example, @code{(tty-color-mode . 8)} forces Emacs to use
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
477 the ANSI escape sequences for 8 standard text colors; and a value of
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
478 -1 means Emacs should turn off color support. If the parameter's
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
479 value is a symbol, that symbol is looked up in the alist
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
480 @code{tty-color-mode-alist}, and if found, the associated number is
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
481 used as the color support mode.
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
482
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
483 @item display-type
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
484 This parameter describes the range of possible colors that can be used
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
485 in this frame. Its value is @code{color}, @code{grayscale} or
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
486 @code{mono}.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
487
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
488 @item cursor-type
47055
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
489 How to display the cursor. Legitimate values are:
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
490
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
491 @table @code
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
492 @item box
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
493 Display a filled box. (This is the default.)
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
494 @item hollow
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
495 Display a hollow box.
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
496 @item nil
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
497 Don't display a cursor.
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
498 @item bar
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
499 Display a vertical bar between characters.
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
500 @item (bar . @var{width})
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
501 Display a vertical bar @var{width} pixels wide between characters.
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
502 @item hbar
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
503 Display a horizontal bar.
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
504 @item (bar . @var{width})
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
505 Display a horizontal bar @var{width} pixels high.
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
506 @end table
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507
39221
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
508 @vindex cursor-type
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
509 The buffer-local variable @code{cursor-type} overrides the value of
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
510 the @code{cursor-type} frame parameter, but if it is @code{t}, that
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
511 means to use the cursor specified for the frame.
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
512
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 @item border-width
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 The width in pixels of the window border.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
516 @item internal-border-width
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
517 The distance in pixels between text and border.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
519 @item left-fringe
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
520 @itemx right-fringe
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
521 The default width of the left and right fringes of windows in this
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
522 frame (@pxref{Fringes}). If either of these is zero, that effectively
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
523 removes the corresponding fringe. A value of @code{nil} stands for
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
524 the standard fringe width, which is the width needed to display the
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
525 fringe bitmaps.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
526
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
527 The combined fringe widths must add up to an integral number of
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
528 columns, so the actual default fringe widths for the frame may be
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
529 larger than the specified values. The extra width needed to reach an
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
530 acceptable total is distributed evenly between the left and right
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
531 fringe. However, you can force one frame or the other to a precise
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
532 width by specifying that width a negative integer. If both widths are
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
533 negative, only the left fringe gets the specified width.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
534
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 @item unsplittable
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 If non-@code{nil}, this frame's window is never split automatically.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 @item visibility
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 The state of visibility of the frame. There are three possibilities:
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 @code{nil} for invisible, @code{t} for visible, and @code{icon} for
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541 iconified. @xref{Visibility of Frames}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 @item menu-bar-lines
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 The number of lines to allocate at the top of the frame for a menu bar.
9453
67b759a9096d menu-bar-lines fix.
Richard M. Stallman <rms@gnu.org>
parents: 8712
diff changeset
545 The default is 1. @xref{Menu Bar}. (In Emacs versions that use the X
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
546 toolkit or GTK, there is only one menu bar line; all that matters about the
9453
67b759a9096d menu-bar-lines fix.
Richard M. Stallman <rms@gnu.org>
parents: 8712
diff changeset
547 number you specify is whether it is greater than zero.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
549 @item screen-gamma
31375
35ac470e5e9c *** empty log message ***
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
550 @cindex gamma correction
43578
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
551 If this is a number, Emacs performs ``gamma correction'' which adjusts
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
552 the brightness of all colors. The value should be the screen gamma of
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
553 your display, a floating point number.
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
554
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
555 Usual PC monitors have a screen gamma of 2.2, so color values in
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
556 Emacs, and in X windows generally, are calibrated to display properly
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
557 on a monitor with that gamma value. If you specify 2.2 for
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
558 @code{screen-gamma}, that means no correction is needed. Other values
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
559 request correction, designed to make the corrected colors appear on
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
560 your screen they way they would have appeared without correction on an
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
561 ordinary monitor with a gamma value of 2.2.
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
562
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
563 If your monitor displays colors too light, you should specify a
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
564 @code{screen-gamma} value smaller than 2.2. This requests correction
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
565 that makes colors darker. A screen gamma value of 1.5 may give good
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
566 results for LCD color displays.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
567
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
568 @item tool-bar-lines
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
569 The number of lines to use for the toolbar. A value of @code{nil} means
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
570 don't display a tool bar. (In Emacs versions that use GTK, there is
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
571 only one tool bar line; all that matters about the number you specify
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
572 is whether it is greater than zero.)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
573
31375
35ac470e5e9c *** empty log message ***
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
574 @item line-spacing
35ac470e5e9c *** empty log message ***
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
575 Additional space put below text lines in pixels (a positive integer).
35ac470e5e9c *** empty log message ***
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
576
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
577 @ignore
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
578 @item parent-id
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579 @c ??? Not yet working.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580 The X window number of the window that should be the parent of this one.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581 Specifying this lets you create an Emacs window inside some other
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 application's window. (It is not certain this will be implemented; try
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583 it and see if it works.)
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
584 @end ignore
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
585 @end table
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
586
47055
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
587 @defvar blink-cursor-alist
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
588 This variable specifies how to blink the cursor. Each element has the
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
589 form @code{(@var{on-state} . @var{off-state})}. Whenever the cursor
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
590 type equals @var{on-state} (comparing using @code{equal}), Emacs uses
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
591 @var{off-state} to specify what the cursor looks like when it blinks
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
592 ``off''. Both @var{on-state} and @var{off-state} should be suitable
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
593 values for the @code{cursor-type} frame parameter.
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
594
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
595 There are various defaults for how to blink each type of cursor,
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
596 if the type is not mentioned as an @var{on-state} here. Changes
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
597 in this variable do not take effect immediately, because the variable
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
598 is examined only when you specify a cursor type for a frame.
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
599 @end defvar
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
600
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
601 These frame parameters are semi-obsolete in that they are automatically
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
602 equivalent to particular face attributes of particular faces.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
603
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
604 @table @code
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
605 @item font
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
606 The name of the font for displaying text in the frame. This is a
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
607 string, either a valid font name for your system or the name of an Emacs
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
608 fontset (@pxref{Fontsets}). It is equivalent to the @code{font}
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
609 attribute of the @code{default} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
610
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
611 @item foreground-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
612 The color to use for the image of a character. It is equivalent to
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
613 the @code{:foreground} attribute of the @code{default} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
614
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
615 @item background-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
616 The color to use for the background of characters. It is equivalent to
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
617 the @code{:background} attribute of the @code{default} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
618
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
619 @item mouse-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
620 The color for the mouse pointer. It is equivalent to the @code{:background}
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
621 attribute of the @code{mouse} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
622
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
623 @item cursor-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
624 The color for the cursor that shows point. It is equivalent to the
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
625 @code{:background} attribute of the @code{cursor} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
626
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
627 @item border-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
628 The color for the border of the frame. It is equivalent to the
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
629 @code{:background} attribute of the @code{border} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
630
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
631 @item scroll-bar-foreground
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
632 If non-@code{nil}, the color for the foreground of scroll bars. It is
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
633 equivalent to the @code{:foreground} attribute of the
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
634 @code{scroll-bar} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
635
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
636 @item scroll-bar-background
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
637 If non-@code{nil}, the color for the background of scroll bars. It is
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
638 equivalent to the @code{:background} attribute of the
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
639 @code{scroll-bar} face.
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
640
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
641 @item wait-for-wm
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
642 If non-@code{nil}, tell Xt to wait for the window manager to confirm
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
643 geometry changes. Some window managers, including versions of Fvwm2
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
644 and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
645 prevent hanging with those window managers.
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
646 @end table
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
647
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
648 @node Size and Position
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649 @subsection Frame Size And Position
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
650 @cindex size of frame
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
651 @cindex screen size
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
652 @cindex frame size
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
653 @cindex resize frame
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
654
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655 You can read or change the size and position of a frame using the
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
656 frame parameters @code{left}, @code{top}, @code{height}, and
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
657 @code{width}. Whatever geometry parameters you don't specify are chosen
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
658 by the window manager in its usual fashion.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
659
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
660 Here are some special features for working with sizes and positions.
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
661 (For the precise meaning of ``selected frame'' used by these functions,
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
662 see @ref{Input Focus}.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664 @defun set-frame-position frame left top
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
665 This function sets the position of the top left corner of @var{frame} to
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
666 @var{left} and @var{top}. These arguments are measured in pixels, and
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
667 normally count from the top left corner of the screen.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
668
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
669 Negative parameter values position the bottom edge of the window up from
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
670 the bottom edge of the screen, or the right window edge to the left of
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
671 the right edge of the screen. It would probably be better if the values
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
672 were always counted from the left and top, so that negative arguments
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
673 would position the frame partly off the top or left edge of the screen,
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
674 but it seems inadvisable to change that now.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
676
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
677 @defun frame-height &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
678 @defunx frame-width &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
679 These functions return the height and width of @var{frame}, measured in
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
680 lines and columns. If you don't supply @var{frame}, they use the
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
681 selected frame.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
682 @end defun
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
683
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
684 @defun screen-height
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
685 @defunx screen-width
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
686 These functions are old aliases for @code{frame-height} and
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
687 @code{frame-width}. When you are using a non-window terminal, the size
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
688 of the frame is normally the same as the size of the terminal screen.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 @defun frame-pixel-height &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 @defunx frame-pixel-width &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 These functions return the height and width of @var{frame}, measured in
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 pixels. If you don't supply @var{frame}, they use the selected frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697 @defun frame-char-height &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698 @defunx frame-char-width &optional frame
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
699 These functions return the height and width of a character in
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
700 @var{frame}, measured in pixels. The values depend on the choice of
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
701 font. If you don't supply @var{frame}, these functions use the selected
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
702 frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705 @defun set-frame-size frame cols rows
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
706 This function sets the size of @var{frame}, measured in characters;
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
707 @var{cols} and @var{rows} specify the new width and height.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
709 To set the size based on values measured in pixels, use
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
710 @code{frame-char-height} and @code{frame-char-width} to convert
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
711 them to units of characters.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
714 @defun set-frame-height frame lines &optional pretend
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
715 This function resizes @var{frame} to a height of @var{lines} lines. The
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
716 sizes of existing windows in @var{frame} are altered proportionally to
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
717 fit.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
718
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
719 If @var{pretend} is non-@code{nil}, then Emacs displays @var{lines}
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
720 lines of output in @var{frame}, but does not change its value for the
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
721 actual height of the frame. This is only useful for a terminal frame.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
722 Using a smaller height than the terminal actually implements may be
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
723 useful to reproduce behavior observed on a smaller screen, or if the
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
724 terminal malfunctions when using its whole screen. Setting the frame
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
725 height ``for real'' does not always work, because knowing the correct
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
726 actual size may be necessary for correct cursor positioning on a
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
727 terminal frame.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
728 @end defun
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
729
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
730 @defun set-frame-width frame width &optional pretend
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
731 This function sets the width of @var{frame}, measured in characters.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
732 The argument @var{pretend} has the same meaning as in
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
733 @code{set-frame-height}.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
734 @end defun
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
735
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
736 @findex set-screen-height
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
737 @findex set-screen-width
22267
dfac7398266b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
738 The older functions @code{set-screen-height} and
dfac7398266b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
739 @code{set-screen-width} were used to specify the height and width of the
dfac7398266b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
740 screen, in Emacs versions that did not support multiple frames. They
dfac7398266b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
741 are semi-obsolete, but still work; they apply to the selected frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
742
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
743 @defun x-parse-geometry geom
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
744 @cindex geometry specification
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
745 The function @code{x-parse-geometry} converts a standard X window
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
746 geometry string to an alist that you can use as part of the argument to
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
747 @code{make-frame}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
748
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
749 The alist describes which parameters were specified in @var{geom}, and
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
750 gives the values specified for them. Each element looks like
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
751 @code{(@var{parameter} . @var{value})}. The possible @var{parameter}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
752 values are @code{left}, @code{top}, @code{width}, and @code{height}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
753
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
754 For the size parameters, the value must be an integer. The position
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
755 parameter names @code{left} and @code{top} are not totally accurate,
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
756 because some values indicate the position of the right or bottom edges
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
757 instead. These are the @var{value} possibilities for the position
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
758 parameters:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
759
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
760 @table @asis
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
761 @item an integer
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
762 A positive integer relates the left edge or top edge of the window to
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
763 the left or top edge of the screen. A negative integer relates the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
764 right or bottom edge of the window to the right or bottom edge of the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
765 screen.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
766
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
767 @item @code{(+ @var{position})}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
768 This specifies the position of the left or top edge of the window
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
769 relative to the left or top edge of the screen. The integer
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
770 @var{position} may be positive or negative; a negative value specifies a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
771 position outside the screen.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
772
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
773 @item @code{(- @var{position})}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
774 This specifies the position of the right or bottom edge of the window
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
775 relative to the right or bottom edge of the screen. The integer
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
776 @var{position} may be positive or negative; a negative value specifies a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
777 position outside the screen.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
778 @end table
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
779
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
780 Here is an example:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
781
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
782 @example
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
783 (x-parse-geometry "35x70+0-0")
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
784 @result{} ((height . 70) (width . 35)
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
785 (top - 0) (left . 0))
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
786 @end example
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
787 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
788
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
789 @node Frame Titles
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
790 @section Frame Titles
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
791
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
792 Every frame has a @code{name} parameter; this serves as the default
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
793 for the frame title which window systems typically display at the top of
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
794 the frame. You can specify a name explicitly by setting the @code{name}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
795 frame property.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
796
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
797 Normally you don't specify the name explicitly, and Emacs computes the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
798 frame name automatically based on a template stored in the variable
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
799 @code{frame-title-format}. Emacs recomputes the name each time the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
800 frame is redisplayed.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
801
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
802 @defvar frame-title-format
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
803 This variable specifies how to compute a name for a frame when you have
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
804 not explicitly specified one. The variable's value is actually a mode
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
805 line construct, just like @code{mode-line-format}. @xref{Mode Line
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
806 Data}.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
807 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
808
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
809 @defvar icon-title-format
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
810 This variable specifies how to compute the name for an iconified frame,
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
811 when you have not explicitly specified the frame title. This title
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
812 appears in the icon itself.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
813 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
814
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
815 @defvar multiple-frames
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
816 This variable is set automatically by Emacs. Its value is @code{t} when
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
817 there are two or more frames (not counting minibuffer-only frames or
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
818 invisible frames). The default value of @code{frame-title-format} uses
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
819 @code{multiple-frames} so as to put the buffer name in the frame title
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
820 only when there is more than one frame.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
821 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
822
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
823 @node Deleting Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
824 @section Deleting Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
825 @cindex deletion of frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
826
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
827 Frames remain potentially visible until you explicitly @dfn{delete}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
828 them. A deleted frame cannot appear on the screen, but continues to
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
829 exist as a Lisp object until there are no references to it. There is no
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
830 way to cancel the deletion of a frame aside from restoring a saved frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
831 configuration (@pxref{Frame Configurations}); this is similar to the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
832 way windows behave.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
833
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
834 @deffn Command delete-frame &optional frame force
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
835 @vindex delete-frame-functions
34015
e998ea898e46 delete-frame-hook
Dave Love <fx@gnu.org>
parents: 32596
diff changeset
836 This function deletes the frame @var{frame} after running the hook
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
837 @code{delete-frame-functions} (each function gets one argument,
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
838 @var{frame}). By default, @var{frame} is the selected frame.
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
839
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
840 A frame cannot be deleted if its minibuffer is used by other frames.
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
841 Normally, you cannot delete a frame if all other frames are invisible,
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
842 but if the @var{force} is non-@code{nil}, then you are allowed to do so.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
843 @end deffn
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
844
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
845 @defun frame-live-p frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
846 The function @code{frame-live-p} returns non-@code{nil} if the frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
847 @var{frame} has not been deleted.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
848 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
849
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
850 Some window managers provide a command to delete a window. These work
12125
995be67f3fd1 updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents: 12098
diff changeset
851 by sending a special message to the program that operates the window.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
852 When Emacs gets one of these commands, it generates a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
853 @code{delete-frame} event, whose normal definition is a command that
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
854 calls the function @code{delete-frame}. @xref{Misc Events}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
855
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
856 @node Finding All Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
857 @section Finding All Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
858
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
859 @defun frame-list
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
860 The function @code{frame-list} returns a list of all the frames that
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
861 have not been deleted. It is analogous to @code{buffer-list} for
39504
af867d560348 (Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents: 39402
diff changeset
862 buffers, and includes frames on all terminals. The list that you get is
af867d560348 (Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents: 39402
diff changeset
863 newly created, so modifying the list doesn't have any effect on the
af867d560348 (Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents: 39402
diff changeset
864 internals of Emacs.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
865 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
866
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
867 @defun visible-frame-list
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
868 This function returns a list of just the currently visible frames.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
869 @xref{Visibility of Frames}. (Terminal frames always count as
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
870 ``visible'', even though only the selected one is actually displayed.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
871 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
872
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
873 @defun next-frame &optional frame minibuf
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
874 The function @code{next-frame} lets you cycle conveniently through all
39504
af867d560348 (Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents: 39402
diff changeset
875 the frames on the current display from an arbitrary starting point. It
af867d560348 (Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents: 39402
diff changeset
876 returns the ``next'' frame after @var{frame} in the cycle. If
af867d560348 (Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents: 39402
diff changeset
877 @var{frame} is omitted or @code{nil}, it defaults to the selected frame
af867d560348 (Finding All Frames): Document that next-frame and
Eli Zaretskii <eliz@gnu.org>
parents: 39402
diff changeset
878 (@pxref{Input Focus}).
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
879
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
880 The second argument, @var{minibuf}, says which frames to consider:
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
881
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
882 @table @asis
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
883 @item @code{nil}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
884 Exclude minibuffer-only frames.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
885 @item @code{visible}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
886 Consider all visible frames.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
887 @item 0
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
888 Consider all visible or iconified frames.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
889 @item a window
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
890 Consider only the frames using that particular window as their
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
891 minibuffer.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
892 @item anything else
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
893 Consider all frames.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
894 @end table
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
895 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
896
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
897 @defun previous-frame &optional frame minibuf
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
898 Like @code{next-frame}, but cycles through all frames in the opposite
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
899 direction.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
900 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
901
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
902 See also @code{next-window} and @code{previous-window}, in @ref{Cyclic
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
903 Window Ordering}.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
904
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
905 @node Frames and Windows
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
906 @section Frames and Windows
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
907
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
908 Each window is part of one and only one frame; you can get the frame
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
909 with @code{window-frame}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
910
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
911 @defun window-frame window
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
912 This function returns the frame that @var{window} is on.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
913 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
914
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
915 All the non-minibuffer windows in a frame are arranged in a cyclic
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
916 order. The order runs from the frame's top window, which is at the
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
917 upper left corner, down and to the right, until it reaches the window at
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
918 the lower right corner (always the minibuffer window, if the frame has
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
919 one), and then it moves back to the top. @xref{Cyclic Window Ordering}.
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
920
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
921 @defun frame-first-window &optional frame
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
922 This returns the topmost, leftmost window of frame @var{frame}.
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
923 If omitted or @code{nil}, @var{frame} defaults to the selected frame.
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
924 @end defun
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
925
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
926 At any time, exactly one window on any frame is @dfn{selected within the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
927 frame}. The significance of this designation is that selecting the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
928 frame also selects this window. You can get the frame's current
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
929 selected window with @code{frame-selected-window}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
930
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
931 @defun frame-selected-window &optional frame
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
932 This function returns the window on @var{frame} that is selected within
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
933 @var{frame}. If omitted or @code{nil}, @var{frame} defaults to the selected frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
934 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
935
53426
adae6745b4c9 (Frames and Windows): Add set-frame-selected-window and frame-root-window.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
936 @defun set-frame-selected-window frame window
adae6745b4c9 (Frames and Windows): Add set-frame-selected-window and frame-root-window.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
937 This sets the selected window of frame @var{frame} to @var{window}.
adae6745b4c9 (Frames and Windows): Add set-frame-selected-window and frame-root-window.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
938 If @var{frame} is @code{nil}, it operates on the selected frame. If
adae6745b4c9 (Frames and Windows): Add set-frame-selected-window and frame-root-window.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
939 @var{frame} is the selected frame, this makes @var{window} the
adae6745b4c9 (Frames and Windows): Add set-frame-selected-window and frame-root-window.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
940 selected window.
adae6745b4c9 (Frames and Windows): Add set-frame-selected-window and frame-root-window.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
941 @end defun
adae6745b4c9 (Frames and Windows): Add set-frame-selected-window and frame-root-window.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
942
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
943 Conversely, selecting a window for Emacs with @code{select-window} also
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
944 makes that window selected within its frame. @xref{Selecting Windows}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
945
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
946 Another function that (usually) returns one of the windows in a given
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
947 frame is @code{minibuffer-window}. @xref{Minibuffer Misc}.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
948
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
949 @node Minibuffers and Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
950 @section Minibuffers and Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
951
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
952 Normally, each frame has its own minibuffer window at the bottom, which
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
953 is used whenever that frame is selected. If the frame has a minibuffer,
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
954 you can get it with @code{minibuffer-window} (@pxref{Minibuffer Misc}).
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
955
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
956 However, you can also create a frame with no minibuffer. Such a frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
957 must use the minibuffer window of some other frame. When you create the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
958 frame, you can specify explicitly the minibuffer window to use (in some
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
959 other frame). If you don't, then the minibuffer is found in the frame
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
960 which is the value of the variable @code{default-minibuffer-frame}. Its
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
961 value should be a frame that does have a minibuffer.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
962
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
963 If you use a minibuffer-only frame, you might want that frame to raise
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
964 when you enter the minibuffer. If so, set the variable
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
965 @code{minibuffer-auto-raise} to @code{t}. @xref{Raising and Lowering}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
966
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
967 @defvar default-minibuffer-frame
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
968 This variable specifies the frame to use for the minibuffer window, by
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
969 default. It is always local to the current terminal and cannot be
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
970 buffer-local. @xref{Multiple Displays}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
971 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
972
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
973 @node Input Focus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
974 @section Input Focus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
975 @cindex input focus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
976 @cindex selected frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
977
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
978 At any time, one frame in Emacs is the @dfn{selected frame}. The selected
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
979 window always resides on the selected frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
980
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
981 When Emacs displays its frames on several terminals (@pxref{Multiple
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
982 Displays}), each terminal has its own selected frame. But only one of
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
983 these is ``@emph{the} selected frame'': it's the frame that belongs to
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
984 the terminal from which the most recent input came. That is, when Emacs
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
985 runs a command that came from a certain terminal, the selected frame is
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
986 the one of that terminal. Since Emacs runs only a single command at any
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
987 given time, it needs to consider only one selected frame at a time; this
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
988 frame is what we call @dfn{the selected frame} in this manual. The
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
989 display on which the selected frame is displayed is the @dfn{selected
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
990 frame's display}.
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
991
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
992 @defun selected-frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
993 This function returns the selected frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
994 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
995
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
996 Some window systems and window managers direct keyboard input to the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
997 window object that the mouse is in; others require explicit clicks or
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
998 commands to @dfn{shift the focus} to various window objects. Either
56338
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
999 way, Emacs automatically keeps track of which frame has the focus. To
56366
b281f2cb7724 (Input Focus): Capitalize Lisp.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56338
diff changeset
1000 switch to a different frame from a Lisp function, call
56338
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1001 @code{select-frame-set-input-focus}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1002
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1003 Lisp programs can also switch frames ``temporarily'' by calling the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1004 function @code{select-frame}. This does not alter the window system's
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1005 concept of focus; rather, it escapes from the window manager's control
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1006 until that control is somehow reasserted.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1007
56338
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1008 When using a text-only terminal, only one frame can be displayed at a
56371
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1009 time on the terminal, so after a call to @code{select-frame}, the next
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1010 redisplay actually displays the newly selected frame. This frame
56380
dcdd02599cbd (Input Focus): Minor fix.
Richard M. Stallman <rms@gnu.org>
parents: 56371
diff changeset
1011 remains selected until a subsequent call to @code{select-frame} or
56371
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1012 @code{select-frame-set-input-focus}. Each terminal frame has a number
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1013 which appears in the mode line before the buffer name (@pxref{Mode
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1014 Line Variables}).
56338
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1015
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1016 @defun select-frame-set-input-focus frame
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1017 This function makes @var{frame} the selected frame, raises it (should
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1018 it happen to be obscured by other frames) and tries to give it the X
56371
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1019 server's focus. On a text-only terminal, the next redisplay displays
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1020 the new frame on the entire terminal screen. The return value of this
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1021 function is not significant.
56338
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1022 @end defun
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1023
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1024 @c ??? This is not yet implemented properly.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1025 @defun select-frame frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1026 This function selects frame @var{frame}, temporarily disregarding the
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1027 focus of the X server if any. The selection of @var{frame} lasts until
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1028 the next time the user does something to select a different frame, or
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1029 until the next time this function is called. The specified @var{frame}
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1030 becomes the selected frame, as explained above, and the terminal that
56371
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1031 @var{frame} is on becomes the selected terminal. This function
48a83b7f435a (Input Focus): Clarify descriptions of `select-frame-set-input-focus'
Luc Teirlinck <teirllm@auburn.edu>
parents: 56366
diff changeset
1032 returns @var{frame}, or @code{nil} if @var{frame} has been deleted.
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1033
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1034 In general, you should never use @code{select-frame} in a way that could
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1035 switch to a different terminal without switching back when you're done.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1036 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1037
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1038 Emacs cooperates with the window system by arranging to select frames as
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1039 the server and window manager request. It does so by generating a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1040 special kind of input event, called a @dfn{focus} event, when
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1041 appropriate. The command loop handles a focus event by calling
13155
0b8e0559dcee Fix several minor errors.
Richard M. Stallman <rms@gnu.org>
parents: 12676
diff changeset
1042 @code{handle-switch-frame}. @xref{Focus Events}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1043
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1044 @deffn Command handle-switch-frame frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1045 This function handles a focus event by selecting frame @var{frame}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1046
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1047 Focus events normally do their job by invoking this command.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1048 Don't call it for any other reason.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1049 @end deffn
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1050
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1051 @defun redirect-frame-focus frame &optional focus-frame
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1052 This function redirects focus from @var{frame} to @var{focus-frame}.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1053 This means that @var{focus-frame} will receive subsequent keystrokes and
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1054 events intended for @var{frame}. After such an event, the value of
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1055 @code{last-event-frame} will be @var{focus-frame}. Also, switch-frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1056 events specifying @var{frame} will instead select @var{focus-frame}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1057
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1058 If @var{focus-frame} is omitted or @code{nil}, that cancels any existing
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1059 redirection for @var{frame}, which therefore once again receives its own
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1060 events.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1061
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1062 One use of focus redirection is for frames that don't have minibuffers.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1063 These frames use minibuffers on other frames. Activating a minibuffer
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1064 on another frame redirects focus to that frame. This puts the focus on
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1065 the minibuffer's frame, where it belongs, even though the mouse remains
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
1066 in the frame that activated the minibuffer.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1067
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1068 Selecting a frame can also change focus redirections. Selecting frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1069 @code{bar}, when @code{foo} had been selected, changes any redirections
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1070 pointing to @code{foo} so that they point to @code{bar} instead. This
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1071 allows focus redirection to work properly when the user switches from
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1072 one frame to another using @code{select-window}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1073
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1074 This means that a frame whose focus is redirected to itself is treated
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1075 differently from a frame whose focus is not redirected.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1076 @code{select-frame} affects the former but not the latter.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1077
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1078 The redirection lasts until @code{redirect-frame-focus} is called to
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1079 change it.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1080 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1081
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1082 @defopt focus-follows-mouse
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1083 This option is how you inform Emacs whether the window manager transfers
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1084 focus when the user moves the mouse. Non-@code{nil} says that it does.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1085 When this is so, the command @code{other-frame} moves the mouse to a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1086 position consistent with the new selected frame.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1087 @end defopt
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1088
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1089 @node Visibility of Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1090 @section Visibility of Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1091 @cindex visible frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1092 @cindex invisible frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1093 @cindex iconified frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1094 @cindex frame visibility
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1095
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1096 A window frame may be @dfn{visible}, @dfn{invisible}, or
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1097 @dfn{iconified}. If it is visible, you can see its contents. If it is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1098 iconified, the frame's contents do not appear on the screen, but an icon
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1099 does. If the frame is invisible, it doesn't show on the screen, not
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1100 even as an icon.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1101
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1102 Visibility is meaningless for terminal frames, since only the selected
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1103 one is actually displayed in any case.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1104
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1105 @deffn Command make-frame-visible &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1106 This function makes frame @var{frame} visible. If you omit @var{frame},
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1107 it makes the selected frame visible.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1108 @end deffn
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1109
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1110 @deffn Command make-frame-invisible &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1111 This function makes frame @var{frame} invisible. If you omit
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1112 @var{frame}, it makes the selected frame invisible.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1113 @end deffn
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1114
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1115 @deffn Command iconify-frame &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1116 This function iconifies frame @var{frame}. If you omit @var{frame}, it
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1117 iconifies the selected frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1118 @end deffn
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1119
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1120 @defun frame-visible-p frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1121 This returns the visibility status of frame @var{frame}. The value is
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1122 @code{t} if @var{frame} is visible, @code{nil} if it is invisible, and
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1123 @code{icon} if it is iconified.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1124 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1125
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1126 The visibility status of a frame is also available as a frame
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1127 parameter. You can read or change it as such. @xref{Window Frame
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1128 Parameters}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1129
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1130 The user can iconify and deiconify frames with the window manager.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1131 This happens below the level at which Emacs can exert any control, but
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1132 Emacs does provide events that you can use to keep track of such
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1133 changes. @xref{Misc Events}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1134
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1135 @node Raising and Lowering
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1136 @section Raising and Lowering Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1137
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1138 Most window systems use a desktop metaphor. Part of this metaphor is
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1139 the idea that windows are stacked in a notional third dimension
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1140 perpendicular to the screen surface, and thus ordered from ``highest''
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1141 to ``lowest''. Where two windows overlap, the one higher up covers
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1142 the one underneath. Even a window at the bottom of the stack can be
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1143 seen if no other window overlaps it.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1144
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1145 @cindex raising a frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1146 @cindex lowering a frame
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1147 A window's place in this ordering is not fixed; in fact, users tend
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1148 to change the order frequently. @dfn{Raising} a window means moving
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1149 it ``up'', to the top of the stack. @dfn{Lowering} a window means
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1150 moving it to the bottom of the stack. This motion is in the notional
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1151 third dimension only, and does not change the position of the window
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1152 on the screen.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1153
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1154 You can raise and lower Emacs frame Windows with these functions:
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1155
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1156 @deffn Command raise-frame &optional frame
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1157 This function raises frame @var{frame} (default, the selected frame).
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1158 @end deffn
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1159
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1160 @deffn Command lower-frame &optional frame
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1161 This function lowers frame @var{frame} (default, the selected frame).
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1162 @end deffn
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1163
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1164 @defopt minibuffer-auto-raise
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1165 If this is non-@code{nil}, activation of the minibuffer raises the frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1166 that the minibuffer window is in.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1167 @end defopt
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1168
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1169 You can also enable auto-raise (raising automatically when a frame is
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1170 selected) or auto-lower (lowering automatically when it is deselected)
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1171 for any frame using frame parameters. @xref{Window Frame Parameters}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1172
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1173 @node Frame Configurations
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1174 @section Frame Configurations
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1175 @cindex frame configuration
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1176
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1177 A @dfn{frame configuration} records the current arrangement of frames,
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1178 all their properties, and the window configuration of each one.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1179 (@xref{Window Configurations}.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1180
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1181 @defun current-frame-configuration
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
1182 This function returns a frame configuration list that describes
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1183 the current arrangement of frames and their contents.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1184 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1185
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1186 @defun set-frame-configuration configuration &optional nodelete
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1187 This function restores the state of frames described in
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1188 @var{configuration}.
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1189
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1190 Ordinarily, this function deletes all existing frames not listed in
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1191 @var{configuration}. But if @var{nodelete} is non-@code{nil}, the
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1192 unwanted frames are iconified instead.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1193 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1194
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1195 @node Mouse Tracking
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1196 @section Mouse Tracking
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1197 @cindex mouse tracking
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1198 @cindex tracking the mouse
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1199
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
1200 Sometimes it is useful to @dfn{track} the mouse, which means to display
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1201 something to indicate where the mouse is and move the indicator as the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1202 mouse moves. For efficient mouse tracking, you need a way to wait until
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1203 the mouse actually moves.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1204
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1205 The convenient way to track the mouse is to ask for events to represent
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1206 mouse motion. Then you can wait for motion by waiting for an event. In
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1207 addition, you can easily handle any other sorts of events that may
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1208 occur. That is useful, because normally you don't want to track the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1209 mouse forever---only until some other event, such as the release of a
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1210 button.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1211
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1212 @defspec track-mouse body@dots{}
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1213 This special form executes @var{body}, with generation of mouse motion
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1214 events enabled. Typically @var{body} would use @code{read-event} to
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1215 read the motion events and modify the display accordingly. @xref{Motion
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1216 Events}, for the format of mouse motion events.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1217
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1218 The value of @code{track-mouse} is that of the last form in @var{body}.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1219 You should design @var{body} to return when it sees the up-event that
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1220 indicates the release of the button, or whatever kind of event means
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1221 it is time to stop tracking.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1222 @end defspec
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1223
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1224 The usual purpose of tracking mouse motion is to indicate on the screen
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1225 the consequences of pushing or releasing a button at the current
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1226 position.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1227
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1228 In many cases, you can avoid the need to track the mouse by using
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1229 the @code{mouse-face} text property (@pxref{Special Properties}).
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1230 That works at a much lower level and runs more smoothly than
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1231 Lisp-level mouse tracking.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1232
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1233 @ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1234 @c These are not implemented yet.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1235
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1236 These functions change the screen appearance instantaneously. The
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1237 effect is transient, only until the next ordinary Emacs redisplay. That
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1238 is OK for mouse tracking, since it doesn't make sense for mouse tracking
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1239 to change the text, and the body of @code{track-mouse} normally reads
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1240 the events itself and does not do redisplay.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1241
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1242 @defun x-contour-region window beg end
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1243 This function draws lines to make a box around the text from @var{beg}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1244 to @var{end}, in window @var{window}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1245 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1246
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1247 @defun x-uncontour-region window beg end
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1248 This function erases the lines that would make a box around the text
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1249 from @var{beg} to @var{end}, in window @var{window}. Use it to remove
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1250 a contour that you previously made by calling @code{x-contour-region}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1251 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1252
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1253 @defun x-draw-rectangle frame left top right bottom
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1254 This function draws a hollow rectangle on frame @var{frame} with the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1255 specified edge coordinates, all measured in pixels from the inside top
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1256 left corner. It uses the cursor color, the one used for indicating the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1257 location of point.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1258 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1259
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1260 @defun x-erase-rectangle frame left top right bottom
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1261 This function erases a hollow rectangle on frame @var{frame} with the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1262 specified edge coordinates, all measured in pixels from the inside top
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1263 left corner. Erasure means redrawing the text and background that
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1264 normally belong in the specified rectangle.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1265 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1266 @end ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1267
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1268 @node Mouse Position
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1269 @section Mouse Position
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1270 @cindex mouse position
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1271 @cindex position of mouse
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1272
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1273 The functions @code{mouse-position} and @code{set-mouse-position}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1274 give access to the current position of the mouse.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1275
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1276 @defun mouse-position
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1277 This function returns a description of the position of the mouse. The
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1278 value looks like @code{(@var{frame} @var{x} . @var{y})}, where @var{x}
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1279 and @var{y} are integers giving the position in characters relative to
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1280 the top left corner of the inside of @var{frame}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1281 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1282
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
1283 @defvar mouse-position-function
39221
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1284 If non-@code{nil}, the value of this variable is a function for
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1285 @code{mouse-position} to call. @code{mouse-position} calls this
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1286 function just before returning, with its normal return value as the
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1287 sole argument, and it returns whatever this function returns to it.
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1288
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1289 This abnormal hook exists for the benefit of packages like
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1290 @file{xt-mouse.el} that need to do mouse handling at the Lisp level.
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
1291 @end defvar
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
1292
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1293 @defun set-mouse-position frame x y
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1294 This function @dfn{warps the mouse} to position @var{x}, @var{y} in
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1295 frame @var{frame}. The arguments @var{x} and @var{y} are integers,
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1296 giving the position in characters relative to the top left corner of the
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1297 inside of @var{frame}. If @var{frame} is not visible, this function
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1298 does nothing. The return value is not significant.
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1299 @end defun
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1300
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1301 @defun mouse-pixel-position
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1302 This function is like @code{mouse-position} except that it returns
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1303 coordinates in units of pixels rather than units of characters.
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1304 @end defun
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1305
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1306 @defun set-mouse-pixel-position frame x y
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1307 This function warps the mouse like @code{set-mouse-position} except that
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1308 @var{x} and @var{y} are in units of pixels rather than units of
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1309 characters. These coordinates are not required to be within the frame.
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1310
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1311 If @var{frame} is not visible, this function does nothing. The return
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1312 value is not significant.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1313 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1314
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1315 @need 3000
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1316
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1317 @node Pop-Up Menus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1318 @section Pop-Up Menus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1319
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1320 When using a window system, a Lisp program can pop up a menu so that
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1321 the user can choose an alternative with the mouse.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1322
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1323 @defun x-popup-menu position menu
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1324 This function displays a pop-up menu and returns an indication of
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1325 what selection the user makes.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1326
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1327 The argument @var{position} specifies where on the screen to put the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1328 menu. It can be either a mouse button event (which says to put the menu
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1329 where the user actuated the button) or a list of this form:
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1330
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1331 @example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1332 ((@var{xoffset} @var{yoffset}) @var{window})
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1333 @end example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1334
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1335 @noindent
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1336 where @var{xoffset} and @var{yoffset} are coordinates, measured in
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1337 pixels, counting from the top left corner of @var{window}'s frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1338
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1339 If @var{position} is @code{t}, it means to use the current mouse
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1340 position. If @var{position} is @code{nil}, it means to precompute the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1341 key binding equivalents for the keymaps specified in @var{menu},
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1342 without actually displaying or popping up the menu.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1343
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1344 The argument @var{menu} says what to display in the menu. It can be a
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1345 keymap or a list of keymaps (@pxref{Menu Keymaps}). Alternatively, it
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1346 can have the following form:
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1347
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1348 @example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1349 (@var{title} @var{pane1} @var{pane2}...)
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1350 @end example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1351
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1352 @noindent
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1353 where each pane is a list of form
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1354
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1355 @example
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1356 (@var{title} (@var{line} . @var{item})...)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1357 @end example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1358
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1359 Each @var{line} should be a string, and each @var{item} should be the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1360 value to return if that @var{line} is chosen.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1361 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1362
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1363 @strong{Usage note:} Don't use @code{x-popup-menu} to display a menu
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1364 if you could do the job with a prefix key defined with a menu keymap.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1365 If you use a menu keymap to implement a menu, @kbd{C-h c} and @kbd{C-h
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1366 a} can see the individual items in that menu and provide help for them.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1367 If instead you implement the menu by defining a command that calls
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1368 @code{x-popup-menu}, the help facilities cannot know what happens inside
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1369 that command, so they cannot give any help for the menu's items.
14200
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1370
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1371 The menu bar mechanism, which lets you switch between submenus by
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1372 moving the mouse, cannot look within the definition of a command to see
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1373 that it calls @code{x-popup-menu}. Therefore, if you try to implement a
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1374 submenu using @code{x-popup-menu}, it cannot work with the menu bar in
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1375 an integrated fashion. This is why all menu bar submenus are
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1376 implemented with menu keymaps within the parent menu, and never with
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1377 @code{x-popup-menu}. @xref{Menu Bar},
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1378
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1379 If you want a menu bar submenu to have contents that vary, you should
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1380 still use a menu keymap to implement it. To make the contents vary, add
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1381 a hook function to @code{menu-bar-update-hook} to update the contents of
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1382 the menu keymap as necessary.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1383
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1384 @node Dialog Boxes
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1385 @section Dialog Boxes
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1386 @cindex dialog boxes
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1387
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1388 A dialog box is a variant of a pop-up menu---it looks a little
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1389 different, it always appears in the center of a frame, and it has just
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1390 one level and one pane. The main use of dialog boxes is for asking
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1391 questions that the user can answer with ``yes'', ``no'', and a few other
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1392 alternatives. The functions @code{y-or-n-p} and @code{yes-or-no-p} use
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1393 dialog boxes instead of the keyboard, when called from commands invoked
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1394 by mouse clicks.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1395
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1396 @defun x-popup-dialog position contents
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1397 This function displays a pop-up dialog box and returns an indication of
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1398 what selection the user makes. The argument @var{contents} specifies
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1399 the alternatives to offer; it has this format:
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1400
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1401 @example
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1402 (@var{title} (@var{string} . @var{value})@dots{})
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1403 @end example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1404
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1405 @noindent
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1406 which looks like the list that specifies a single pane for
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1407 @code{x-popup-menu}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1408
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1409 The return value is @var{value} from the chosen alternative.
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1410
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1411 An element of the list may be just a string instead of a cons cell
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1412 @code{(@var{string} . @var{value})}. That makes a box that cannot
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1413 be selected.
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1414
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1415 If @code{nil} appears in the list, it separates the left-hand items from
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1416 the right-hand items; items that precede the @code{nil} appear on the
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1417 left, and items that follow the @code{nil} appear on the right. If you
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1418 don't include a @code{nil} in the list, then approximately half the
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1419 items appear on each side.
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1420
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1421 Dialog boxes always appear in the center of a frame; the argument
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1422 @var{position} specifies which frame. The possible values are as in
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1423 @code{x-popup-menu}, but the precise coordinates don't matter; only the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1424 frame matters.
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1425
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1426 In some configurations, Emacs cannot display a real dialog box; so
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1427 instead it displays the same items in a pop-up menu in the center of the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1428 frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1429 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1430
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1431 @node Pointer Shapes
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1432 @section Pointer Shapes
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1433 @cindex pointer shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1434 @cindex mouse pointer shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1435
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1436 These variables specify which shape to use for the mouse pointer in
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1437 various situations, when using the X Window System:
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1438
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1439 @table @code
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1440 @item x-pointer-shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1441 @vindex x-pointer-shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1442 This variable specifies the pointer shape to use ordinarily in the Emacs
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1443 frame.
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1444
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1445 @item x-sensitive-text-pointer-shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1446 @vindex x-sensitive-text-pointer-shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1447 This variable specifies the pointer shape to use when the mouse
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1448 is over mouse-sensitive text.
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1449 @end table
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1450
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1451 These variables affect newly created frames. They do not normally
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1452 affect existing frames; however, if you set the mouse color of a frame,
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1453 that also updates its pointer shapes based on the current values of
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1454 these variables. @xref{Window Frame Parameters}.
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1455
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1456 The values you can use, to specify either of these pointer shapes, are
15061
85ee0c14c7dc Fix a file name.
Richard M. Stallman <rms@gnu.org>
parents: 14658
diff changeset
1457 defined in the file @file{lisp/term/x-win.el}. Use @kbd{M-x apropos
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1458 @key{RET} x-pointer @key{RET}} to see a list of them.
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1459
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1460 @node Window System Selections
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1461 @section Window System Selections
35476
26912db550c3 Change "X windows" instances.
Dave Love <fx@gnu.org>
parents: 35037
diff changeset
1462 @cindex selection (for window systems)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1463
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1464 The X server records a set of @dfn{selections} which permit transfer of
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1465 data between application programs. The various selections are
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1466 distinguished by @dfn{selection types}, represented in Emacs by
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1467 symbols. X clients including Emacs can read or set the selection for
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1468 any given type.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1469
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1470 @defun x-set-selection type data
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1471 This function sets a ``selection'' in the X server. It takes two
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1472 arguments: a selection type @var{type}, and the value to assign to it,
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1473 @var{data}. If @var{data} is @code{nil}, it means to clear out the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1474 selection. Otherwise, @var{data} may be a string, a symbol, an integer
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1475 (or a cons of two integers or list of two integers), an overlay, or a
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1476 cons of two markers pointing to the same buffer. An overlay or a pair
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1477 of markers stands for text in the overlay or between the markers.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1478
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1479 The argument @var{data} may also be a vector of valid non-vector
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1480 selection values.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1481
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1482 Each possible @var{type} has its own selection value, which changes
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1483 independently. The usual values of @var{type} are @code{PRIMARY},
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1484 @code{SECONDARY} and @code{CLIPBOARD}; these are symbols with upper-case
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1485 names, in accord with X Window System conventions. The default is
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1486 @code{PRIMARY}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1487 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1488
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
1489 @defun x-get-selection &optional type data-type
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1490 This function accesses selections set up by Emacs or by other X
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1491 clients. It takes two optional arguments, @var{type} and
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1492 @var{data-type}. The default for @var{type}, the selection type, is
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1493 @code{PRIMARY}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1494
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1495 The @var{data-type} argument specifies the form of data conversion to
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1496 use, to convert the raw data obtained from another X client into Lisp
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1497 data. Meaningful values include @code{TEXT}, @code{STRING},
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1498 @code{UTF8_STRING},
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1499 @code{TARGETS}, @code{LENGTH}, @code{DELETE}, @code{FILE_NAME},
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1500 @code{CHARACTER_POSITION}, @code{LINE_NUMBER}, @code{COLUMN_NUMBER},
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1501 @code{OWNER_OS}, @code{HOST_NAME}, @code{USER}, @code{CLASS},
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1502 @code{NAME}, @code{ATOM}, and @code{INTEGER}. (These are symbols with
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1503 upper-case names in accord with X conventions.) The default for
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1504 @var{data-type} is @code{STRING}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1505 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1506
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1507 @cindex cut buffer
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1508 The X server also has a set of eight numbered @dfn{cut buffers} which can
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1509 store text or other data being moved between applications. Cut buffers
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1510 are considered obsolete, but Emacs supports them for the sake of X
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1511 clients that still use them. Cut buffers are numbered from 0 to 7.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1512
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1513 @defun x-get-cut-buffer &optional n
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1514 This function returns the contents of cut buffer number @var{n}.
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1515 If omitted @var{n} defaults to 0.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1516 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1517
56215
c9aa4127a482 Reposition @anchor's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54118
diff changeset
1518 @defun x-set-cut-buffer string &optional push
54118
7e1d7032e956 (Window System Selections): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54030
diff changeset
1519 @anchor{Definition of x-set-cut-buffer}
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1520 This function stores @var{string} into the first cut buffer (cut buffer
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1521 0). If @var{push} is @code{nil}, only the first cut buffer is changed.
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1522 If @var{push} is non-@code{nil}, that says to move the values down
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1523 through the series of cut buffers, much like the way successive kills in
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1524 Emacs move down the kill ring. In other words, the previous value of
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1525 the first cut buffer moves into the second cut buffer, and the second to
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1526 the third, and so on through all eight cut buffers.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1527 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1528
22742
39fe58403429 Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents: 22274
diff changeset
1529 @defvar selection-coding-system
39fe58403429 Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents: 22274
diff changeset
1530 This variable specifies the coding system to use when reading and
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1531 writing selections, the clipboard, or a cut buffer. @xref{Coding
43562
ca00a6c76017 (Window System Selections): The default encoding is now
Eli Zaretskii <eliz@gnu.org>
parents: 43142
diff changeset
1532 Systems}. The default is @code{compound-text-with-extensions}, which
ca00a6c76017 (Window System Selections): The default encoding is now
Eli Zaretskii <eliz@gnu.org>
parents: 43142
diff changeset
1533 converts to the text representation that X11 normally uses.
22742
39fe58403429 Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents: 22274
diff changeset
1534 @end defvar
39fe58403429 Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents: 22274
diff changeset
1535
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1536 @cindex clipboard support (for MS-Windows)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1537 When Emacs runs on MS-Windows, it does not implement X selections in
36348
3fd0e91fef4e (Window System Selections): Remove doubled `it'.
Gerd Moellmann <gerd@gnu.org>
parents: 35476
diff changeset
1538 general, but it does support the clipboard. @code{x-get-selection}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1539 and @code{x-set-selection} on MS-Windows support the text data type
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1540 only; if the clipboard holds other types of data, Emacs treats the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1541 clipboard as empty.
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1542
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1543 @defopt x-select-enable-clipboard
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1544 If this is non-@code{nil}, the Emacs yank functions consult the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1545 clipboard before the primary selection, and the kill functions store in
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1546 the clipboard as well as the primary selection. Otherwise they do not
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1547 access the clipboard at all. The default is @code{nil} on most systems,
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1548 but @code{t} on MS-Windows.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1549 @end defopt
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1550
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1551 @node Color Names
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1552 @section Color Names
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1553
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1554 These functions provide a way to determine which color names are
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1555 valid, and what they look like. In some cases, the value depends on the
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1556 @dfn{selected frame}, as described below; see @ref{Input Focus}, for the
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1557 meaning of the term ``selected frame''.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1558
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1559 @defun color-defined-p color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1560 @tindex color-defined-p
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1561 This function reports whether a color name is meaningful. It returns
12676
d97688032b10 multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents: 12388
diff changeset
1562 @code{t} if so; otherwise, @code{nil}. The argument @var{frame} says
d97688032b10 multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents: 12388
diff changeset
1563 which frame's display to ask about; if @var{frame} is omitted or
d97688032b10 multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents: 12388
diff changeset
1564 @code{nil}, the selected frame is used.
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1565
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1566 Note that this does not tell you whether the display you are using
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1567 really supports that color. When using X, you can ask for any defined
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1568 color on any kind of display, and you will get some result---typically,
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1569 the closest it can do. To determine whether a frame can really display
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1570 a certain color, use @code{color-supported-p} (see below).
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1571
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1572 @findex x-color-defined-p
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1573 This function used to be called @code{x-color-defined-p},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1574 and that name is still supported as an alias.
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1575 @end defun
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1576
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1577 @defun defined-colors &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1578 @tindex defined-colors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1579 This function returns a list of the color names that are defined
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1580 and supported on frame @var{frame} (default, the selected frame).
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1581
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1582 @findex x-defined-colors
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1583 This function used to be called @code{x-defined-colors},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1584 and that name is still supported as an alias.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1585 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1586
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1587 @defun color-supported-p color &optional frame background-p
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1588 @tindex color-supported-p
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1589 This returns @code{t} if @var{frame} can really display the color
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1590 @var{color} (or at least something close to it). If @var{frame} is
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1591 omitted or @code{nil}, the question applies to the selected frame.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1592
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1593 Some terminals support a different set of colors for foreground and
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1594 background. If @var{background-p} is non-@code{nil}, that means you are
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1595 asking whether @var{color} can be used as a background; otherwise you
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1596 are asking whether it can be used as a foreground.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1597
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1598 The argument @var{color} must be a valid color name.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1599 @end defun
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1600
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1601 @defun color-gray-p color &optional frame
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1602 @tindex color-gray-p
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1603 This returns @code{t} if @var{color} is a shade of gray, as defined on
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1604 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, the
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1605 question applies to the selected frame. The argument @var{color} must
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1606 be a valid color name.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1607 @end defun
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1608
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1609 @defun color-values color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1610 @tindex color-values
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1611 This function returns a value that describes what @var{color} should
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1612 ideally look like. If @var{color} is defined, the value is a list of
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1613 three integers, which give the amount of red, the amount of green, and
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1614 the amount of blue. Each integer ranges in principle from 0 to 65535,
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1615 but in practice no value seems to be above 65280. This kind
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1616 of three-element list is called an @dfn{rgb value}.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1617
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1618 If @var{color} is not defined, the value is @code{nil}.
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1619
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1620 @example
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1621 (color-values "black")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1622 @result{} (0 0 0)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1623 (color-values "white")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1624 @result{} (65280 65280 65280)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1625 (color-values "red")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1626 @result{} (65280 0 0)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1627 (color-values "pink")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1628 @result{} (65280 49152 51968)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1629 (color-values "hungry")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1630 @result{} nil
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1631 @end example
12676
d97688032b10 multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents: 12388
diff changeset
1632
d97688032b10 multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents: 12388
diff changeset
1633 The color values are returned for @var{frame}'s display. If @var{frame}
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1634 is omitted or @code{nil}, the information is returned for the selected
12676
d97688032b10 multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents: 12388
diff changeset
1635 frame's display.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1636
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1637 @findex x-color-values
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1638 This function used to be called @code{x-color-values},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1639 and that name is still supported as an alias.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1640 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1641
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1642 @node Text Terminal Colors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1643 @section Text Terminal Colors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1644 @cindex colors on text-only terminals
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1645
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1646 Emacs can display color on text-only terminals, starting with version
42957
6a35c3566bfd (Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents: 42752
diff changeset
1647 21. These terminals usually support only a small number of colors, and
6a35c3566bfd (Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents: 42752
diff changeset
1648 the computer uses small integers to select colors on the terminal. This
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1649 means that the computer cannot reliably tell what the selected color
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1650 looks like; instead, you have to inform your application which small
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1651 integers correspond to which colors. However, Emacs does know the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1652 standard set of colors and will try to use them automatically.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1653
42957
6a35c3566bfd (Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents: 42752
diff changeset
1654 The functions described in this section control how terminal colors
6a35c3566bfd (Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents: 42752
diff changeset
1655 are used by Emacs.
6a35c3566bfd (Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents: 42752
diff changeset
1656
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1657 @cindex rgb value
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1658 Several of these functions use or return @dfn{rgb values}. An rgb
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1659 value is a list of three integers, which give the amount of red, the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1660 amount of green, and the amount of blue. Each integer ranges in
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1661 principle from 0 to 65535, but in practice the largest value used is
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1662 65280.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1663
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1664 These functions accept a display (either a frame or the name of a
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1665 terminal) as an optional argument. We hope in the future to make Emacs
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1666 support more than one text-only terminal at one time; then this argument
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1667 will specify which terminal to operate on (the default being the
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1668 selected frame's terminal; @pxref{Input Focus}). At present, though,
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1669 the @var{display} argument has no effect.
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1670
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1671 @defun tty-color-define name number &optional rgb display
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1672 @tindex tty-color-define
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1673 This function associates the color name @var{name} with
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1674 color number @var{number} on the terminal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1675
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1676 The optional argument @var{rgb}, if specified, is an rgb value; it says
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1677 what the color actually looks like. If you do not specify @var{rgb},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1678 then this color cannot be used by @code{tty-color-approximate} to
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1679 approximate other colors, because Emacs does not know what it looks
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1680 like.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1681 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1682
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1683 @defun tty-color-clear &optional display
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1684 @tindex tty-color-clear
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1685 This function clears the table of defined colors for a text-only terminal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1686 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1687
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1688 @defun tty-color-alist &optional display
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1689 @tindex tty-color-alist
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1690 This function returns an alist recording the known colors supported by a
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1691 text-only terminal.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1692
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1693 Each element has the form @code{(@var{name} @var{number} . @var{rgb})}
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1694 or @code{(@var{name} @var{number})}. Here, @var{name} is the color
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1695 name, @var{number} is the number used to specify it to the terminal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1696 If present, @var{rgb} is an rgb value that says what the color
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1697 actually looks like.
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1698 @end defun
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1699
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1700 @defun tty-color-approximate rgb &optional display
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1701 @tindex tty-color-approximate
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1702 This function finds the closest color, among the known colors supported
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1703 for @var{display}, to that described by the rgb value @var{rgb}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1704 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1705
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1706 @defun tty-color-translate color &optional display
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1707 @tindex tty-color-translate
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1708 This function finds the closest color to @var{color} among the known
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1709 colors supported for @var{display}. If the name @var{color} is not
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1710 defined, the value is @code{nil}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1711
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1712 @var{color} can be an X-style @code{"#@var{xxxyyyzzz}"} specification
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1713 instead of an actual name. The format
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1714 @code{"RGB:@var{xx}/@var{yy}/@var{zz}"} is also supported.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1715 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1716
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1717 @node Resources
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1718 @section X Resources
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1719
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1720 @defun x-get-resource attribute class &optional component subclass
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1721 The function @code{x-get-resource} retrieves a resource value from the X
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1722 Window defaults database.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1723
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1724 Resources are indexed by a combination of a @dfn{key} and a @dfn{class}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1725 This function searches using a key of the form
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
1726 @samp{@var{instance}.@var{attribute}} (where @var{instance} is the name
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1727 under which Emacs was invoked), and using @samp{Emacs.@var{class}} as
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1728 the class.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1729
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1730 The optional arguments @var{component} and @var{subclass} add to the key
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1731 and the class, respectively. You must specify both of them or neither.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1732 If you specify them, the key is
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1733 @samp{@var{instance}.@var{component}.@var{attribute}}, and the class is
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1734 @samp{Emacs.@var{class}.@var{subclass}}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1735 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1736
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1737 @defvar x-resource-class
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1738 This variable specifies the application name that @code{x-get-resource}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1739 should look up. The default value is @code{"Emacs"}. You can examine X
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1740 resources for application names other than ``Emacs'' by binding this
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1741 variable to some other string, around a call to @code{x-get-resource}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1742 @end defvar
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1743
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1744 @defvar x-resource-name
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1745 This variable specifies the instance name that @code{x-get-resource}
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1746 should look up. The default value is the name Emacs was invoked with,
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1747 or the value specified with the @samp{-name} or @samp{-rn} switches.
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1748 @end defvar
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1749
45779
4964699e51b4 (Initial Parameters, Resources): Fix references to the Emacs manual.
Andreas Schwab <schwab@suse.de>
parents: 45744
diff changeset
1750 @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1751
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1752 @node Display Feature Testing
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1753 @section Display Feature Testing
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1754 @cindex display feature testing
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1755
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1756 The functions in this section describe the basic capabilities of a
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1757 particular display. Lisp programs can use them to adapt their behavior
48700
df6767370b43 Fix typo.
Pavel Janík <Pavel@Janik.cz>
parents: 47055
diff changeset
1758 to what the display can do. For example, a program that ordinarily uses
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1759 a popup menu could use the minibuffer if popup menus are not supported.
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1760
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1761 The optional argument @var{display} in these functions specifies which
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1762 display to ask the question about. It can be a display name, a frame
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1763 (which designates the display that frame is on), or @code{nil} (which
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1764 refers to the selected frame's display, @pxref{Input Focus}).
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1765
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1766 @xref{Color Names}, @ref{Text Terminal Colors}, for other functions to
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1767 obtain information about displays.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1768
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1769 @defun display-popup-menus-p &optional display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1770 @tindex display-popup-menus-p
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1771 This function returns @code{t} if popup menus are supported on
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1772 @var{display}, @code{nil} if not. Support for popup menus requires that
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1773 the mouse be available, since the user cannot choose menu items without
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1774 a mouse.
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1775 @end defun
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1776
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1777 @defun display-graphic-p &optional display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1778 @tindex display-graphic-p
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1779 @cindex frames, more than one on display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1780 @cindex fonts, more than one on display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1781 This function returns @code{t} if @var{display} is a graphic display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1782 capable of displaying several frames and several different fonts at
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1783 once. This is true for displays that use a window system such as X, and
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1784 false for text-only terminals.
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1785 @end defun
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1786
27654
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1787 @defun display-mouse-p &optional display
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1788 @tindex display-mouse-p
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1789 @cindex mouse, availability
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1790 This function returns @code{t} if @var{display} has a mouse available,
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1791 @code{nil} if not.
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1792 @end defun
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1793
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1794 @defun display-color-p &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1795 @tindex display-color-p
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1796 @findex x-display-color-p
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1797 This function returns @code{t} if the screen is a color screen.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1798 It used to be called @code{x-display-color-p}, and that name
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1799 is still supported as an alias.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1800 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1801
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1802 @defun display-grayscale-p &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1803 @tindex display-grayscale-p
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1804 This function returns @code{t} if the screen can display shades of gray.
27654
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1805 (All color displays can do this.)
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1806 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1807
56215
c9aa4127a482 Reposition @anchor's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54118
diff changeset
1808 @defun display-supports-face-attributes-p attributes &optional display
45744
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1809 @anchor{Display Face Attribute Testing}
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1810 @tindex display-supports-face-attributes-p
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1811 This function returns non-@code{nil} if all the face attributes in
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1812 @var{attributes} are supported (@pxref{Face Attributes}).
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1813
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1814 The definition of `supported' is somewhat heuristic, but basically
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1815 means that a face containing all the attributes in @var{attributes},
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1816 when merged with the default face for display, can be represented in a
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1817 way that's
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1818
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1819 @enumerate
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1820 @item
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1821 different in appearance than the default face, and
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1822
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1823 @item
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1824 `close in spirit' to what the attributes specify, if not exact.
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1825 @end enumerate
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1826
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1827 Point (2) implies that a @code{:weight black} attribute will be
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1828 satisfied by any display that can display bold, as will
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1829 @code{:foreground "yellow"} as long as some yellowish color can be
45865
08e62ca55f2c (Display Feature Testing): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 45779
diff changeset
1830 displayed, but @code{:slant italic} will @emph{not} be satisfied by
45744
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1831 the tty display code's automatic substitution of a `dim' face for
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1832 italic.
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1833 @end defun
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1834
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1835 @defun display-selections-p &optional display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1836 @tindex display-selections-p
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1837 This function returns @code{t} if @var{display} supports selections.
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1838 Windowed displays normally support selections, but they may also be
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1839 supported in some other cases.
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1840 @end defun
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1841
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
1842 @defun display-images-p &optional display
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
1843 This function returns @code{t} if @var{display} can display images.
39221
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1844 Windowed displays ought in principle to handle images, but some
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1845 systems lack the support for that. On a display that does not support
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1846 images, Emacs cannot display a tool bar.
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
1847 @end defun
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
1848
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1849 @defun display-screens &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1850 @tindex display-screens
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1851 This function returns the number of screens associated with the display.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1852 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1853
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1854 @defun display-pixel-height &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1855 @tindex display-pixel-height
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1856 This function returns the height of the screen in pixels.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1857 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1858
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1859 @defun display-mm-height &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1860 @tindex display-mm-height
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1861 This function returns the height of the screen in millimeters,
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1862 or @code{nil} if Emacs cannot get that information.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1863 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1864
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1865 @defun display-pixel-width &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1866 @tindex display-pixel-width
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1867 This function returns the width of the screen in pixels.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1868 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1869
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1870 @defun display-mm-width &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1871 @tindex display-mm-width
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1872 This function returns the width of the screen in millimeters,
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1873 or @code{nil} if Emacs cannot get that information.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1874 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1875
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1876 @defun display-backing-store &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1877 @tindex display-backing-store
27654
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1878 This function returns the backing store capability of the display.
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1879 Backing store means recording the pixels of windows (and parts of
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1880 windows) that are not exposed, so that when exposed they can be
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1881 displayed very quickly.
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1882
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1883 Values can be the symbols @code{always}, @code{when-mapped}, or
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1884 @code{not-useful}. The function can also return @code{nil}
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1885 when the question is inapplicable to a certain kind of display.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1886 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1887
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1888 @defun display-save-under &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1889 @tindex display-save-under
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1890 This function returns non-@code{nil} if the display supports the
27654
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1891 SaveUnder feature. That feature is used by pop-up windows
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1892 to save the pixels they obscure, so that they can pop down
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1893 quickly.
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1894 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1895
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1896 @defun display-planes &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1897 @tindex display-planes
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1898 This function returns the number of planes the display supports.
27654
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1899 This is typically the number of bits per pixel.
35037
3c5b13084896 display-planes on tty
Dave Love <fx@gnu.org>
parents: 34015
diff changeset
1900 For a tty display, it is log to base two of the number of colours supported.
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1901 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1902
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1903 @defun display-visual-class &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1904 @tindex display-visual-class
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1905 This function returns the visual class for the screen. The value is one
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1906 of the symbols @code{static-gray}, @code{gray-scale},
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1907 @code{static-color}, @code{pseudo-color}, @code{true-color}, and
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1908 @code{direct-color}.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1909 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1910
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1911 @defun display-color-cells &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1912 @tindex display-color-cells
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1913 This function returns the number of color cells the screen supports.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1914 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1915
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1916 These functions obtain additional information specifically
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1917 about X displays.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1918
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1919 @defun x-server-version &optional display
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1920 This function returns the list of version numbers of the X server
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1921 running the display.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1922 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1923
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1924 @defun x-server-vendor &optional display
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1925 This function returns the vendor that provided the X server software.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1926 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1927
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1928 @ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1929 @defvar x-no-window-manager
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1930 This variable's value is @code{t} if no X window manager is in use.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1931 @end defvar
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1932 @end ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1933
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1934 @ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1935 @item
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1936 The functions @code{x-pixel-width} and @code{x-pixel-height} return the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1937 width and height of an X Window frame, measured in pixels.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1938 @end ignore
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52144
diff changeset
1939
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52144
diff changeset
1940 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52144
diff changeset
1941 arch-tag: 94977df6-3dca-4730-b57b-c6329e9282ba
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52144
diff changeset
1942 @end ignore