annotate lispref/frames.texi @ 67764:1868b265123d

*** empty log message ***
author Eli Zaretskii <eliz@gnu.org>
date Fri, 23 Dec 2005 15:45:07 +0000
parents e836425ee789
children c27d8d7e14fd 2d92f5c9d6ae
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.
64889
e836425ee789 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64882
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2002, 2003,
e836425ee789 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64882
diff changeset
4 @c 2004, 2005 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
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
82 This function creates and returns a new frame, displaying the current
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
83 buffer. If you are using a supported window system, it makes a window
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
84 frame; otherwise, it makes a terminal frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 The argument is an alist specifying frame parameters. Any parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 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
88 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
89 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
90 your system.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92 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
93 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
94 Parameters}, for documentation of individual parameters you can specify.
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
95
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
96 This function itself does not make the new frame the selected frame.
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
97 @xref{Input Focus}. The previously selected frame remains selected.
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
98 However, the window system may select the new frame for its own reasons,
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
99 for instance if the frame appears under the mouse pointer and your
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
100 setup is for focus to follow the pointer.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
103 @defvar before-make-frame-hook
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 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
105 frame.
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
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
108 @defvar after-make-frame-functions
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
109 @tindex after-make-frame-functions
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
110 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
111 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
112 frame just created.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 @end defvar
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
115 @node Multiple Displays
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
116 @section Multiple Displays
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
117 @cindex multiple X displays
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
118 @cindex displays, multiple
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
119
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
120 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
121 Initially, Emacs uses just one display---the one chosen with the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
122 @code{DISPLAY} environment variable or with the @samp{--display} option
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
123 (@pxref{Initial Options,,, emacs, The GNU Emacs Manual}). To connect to
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
124 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
125 the @code{display} frame parameter when you create the frame.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
126
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
127 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
128 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
129 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
130 @ref{Input Focus}.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
131
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
132 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
133 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
134 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
135 to. These variables include @code{default-minibuffer-frame},
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
136 @code{defining-kbd-macro}, @code{last-kbd-macro}, and
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
137 @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
138 be buffer-local (@pxref{Buffer-Local Variables}) or frame-local.
12067
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 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
141 @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
142 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
143 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
144 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
145 terminal.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
146
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
147 @deffn Command make-frame-on-display display &optional parameters
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
148 This creates and returns a new frame on display @var{display}, taking
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
149 the other frame parameters from @var{parameters}. Aside from the
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
150 @var{display} argument, it is like @code{make-frame} (@pxref{Creating
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
151 Frames}).
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
152 @end deffn
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
153
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
154 @defun x-display-list
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
155 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
156 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
157 a display name.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
158 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
159
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
160 @defun x-open-connection display &optional xrm-string must-succeed
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
161 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
162 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
163 that communication can be established with that display.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
164
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
165 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
166 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
167 @file{.Xresources} file. The values you specify override the resource
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
168 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
169 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
170 look like:
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
171
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
172 @example
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
173 "*BorderWidth: 3\n*InternalBorder: 2\n"
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
174 @end example
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
175
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
176 @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}.
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
177
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
178 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
179 terminates Emacs. Otherwise, it is an ordinary Lisp error.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
180 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
181
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
182 @defun x-close-connection display
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
183 This function closes the connection to display @var{display}. Before
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
184 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
185 that display (@pxref{Deleting Frames}).
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
186 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
187
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188 @node Frame Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 @section Frame Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
191 A frame has many parameters that control its appearance and behavior.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192 Just what parameters a frame has depends on what display mechanism it
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 uses.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
195 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
196 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
197 only the @code{height}, @code{width}, @code{name}, @code{title},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
198 @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
199 parameters do something special. If the terminal supports colors, the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
200 parameters @code{foreground-color}, @code{background-color},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
201 @code{background-mode} and @code{display-type} are also meaningful.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 @menu
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 * Parameter Access:: How to change a frame's parameters.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 * 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
206 * 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
207 * Size and Position:: Changing the size and position of a frame.
64882
8269d1de182b (Geometry): New node, split from Size and Position.
Richard M. Stallman <rms@gnu.org>
parents: 64878
diff changeset
208 * Geometry:: Parsing geometry specifications.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
209 @end menu
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
211 @node Parameter Access
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212 @subsection Access to Frame Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
214 These functions let you read and change the parameter values of a
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215 frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
217 @defun frame-parameter frame parameter
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
218 @tindex frame-parameter
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
219 This function returns the value of the parameter @var{parameter} (a
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
220 symbol) of @var{frame}. If @var{frame} is @code{nil}, it returns the
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
221 selected frame's parameter. If @var{frame} has no setting for
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
222 @var{parameter}, this function returns @code{nil}.
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
223 @end defun
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
224
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
225 @defun frame-parameters &optional frame
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226 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
227 parameters of @var{frame} and their values. If @var{frame} is
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
228 @code{nil} or omitted, this returns the selected frame's parameters
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
229 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
230
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231 @defun modify-frame-parameters frame alist
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 This function alters the parameters of frame @var{frame} based on the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233 elements of @var{alist}. Each element of @var{alist} has the form
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 @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
235 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
236 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
237 frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
240 @defun modify-all-frames-parameters alist
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
241 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
242 according to @var{alist}, then modifies @code{default-frame-alist}
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
243 (and, if necessary, @code{initial-frame-alist}) to apply the same
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
244 parameter values to frames that will be created henceforth.
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
245 @end defun
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
246
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
247 @node Initial Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
248 @subsection Initial Frame Parameters
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
249
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
250 You can specify the parameters for the initial startup frame
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
251 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
252
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
253 @defvar initial-frame-alist
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
254 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
255 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
256 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
257 Each element has the form:
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
258
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
259 @example
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
260 (@var{parameter} . @var{value})
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
261 @end example
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
262
25875
6a17c48b52ef *** empty log message ***
Phillip Rulon <pjr@gnu.org>
parents: 25751
diff changeset
263 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
264 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
265 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
266 created initial frame.
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
267
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
268 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
269 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
270 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
271 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
272 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
273
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
274 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
275 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
276 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
277 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
278 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
279 the initial frame, specify the same parameters in
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
280 @code{initial-frame-alist} with values that match the X resources.
6547
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
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
283 If these parameters specify a separate minibuffer-only frame with
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
284 @code{(minibuffer . nil)}, and you have not created one, Emacs creates
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
285 one for you.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
286
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
287 @defvar minibuffer-frame-alist
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
288 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
289 an initial minibuffer-only frame---if such a frame is needed, according
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
290 to the parameters for the main initial frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
291 @end defvar
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
292
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
293 @defvar default-frame-alist
16528
62be63ee468d Clarify initial-frame-alist and default-frame-alist.
Richard M. Stallman <rms@gnu.org>
parents: 15061
diff changeset
294 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
295 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
296 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
297 in many cases.
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
298
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
299 Setting this variable does not affect existing frames.
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
300 @end defvar
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
301
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
302 See also @code{special-display-frame-alist}. @xref{Definition of
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
303 special-display-frame-alist}.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
304
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
305 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
306 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
307 exception is @samp{-geometry}, which adds the specified position to
62583
3052b909ad3f (Initial Parameters): Update cross reference to "Emacs Invocation".
Eli Zaretskii <eliz@gnu.org>
parents: 62095
diff changeset
308 @code{initial-frame-alist} instead. @xref{Emacs Invocation,, Command
3052b909ad3f (Initial Parameters): Update cross reference to "Emacs Invocation".
Eli Zaretskii <eliz@gnu.org>
parents: 62095
diff changeset
309 Line Arguments for Emacs Invocation, emacs, The GNU Emacs Manual}.
8110
bf6ecdddf78b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7684
diff changeset
310
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
311 @node Window Frame Parameters
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
312 @subsection Window Frame Parameters
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
313
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
314 Just what parameters a frame has depends on what display mechanism
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
315 it uses. This section describes the parameters that have special
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
316 meanings on some or all kinds of terminals. Of these, @code{name},
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
317 @code{title}, @code{height}, @code{width}, @code{buffer-list} and
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
318 @code{buffer-predicate} provide meaningful information in terminal
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
319 frames, and @code{tty-color-mode} is meaningful @emph{only} in
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
320 terminal frames.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
321
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
322 @menu
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
323 * Basic Parameters:: Parameters that are fundamental.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
324 * Position Parameters:: The position of the frame on the screen.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
325 * Size Parameters:: Frame's size.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
326 * Layout Parameters:: Size of parts of the frame, and
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
327 enabling or disabling some parts.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
328 * Buffer Parameters:: Which buffers have been or should be shown.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
329 * Management Parameters:: Communicating with the window manager.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
330 * Cursor Parameters:: Controlling the cursor appearance.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
331 * Color Parameters:: Colors of various parts of the frame.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
332 @end menu
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
333
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
334 @node Basic Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
335 @subsubsection Basic Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
336
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
337 These frame parameters give the most basic information about the
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
338 frame. @code{title} and @code{name} are meaningful on all terminals.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
339
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
340 @table @code
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
341 @item display
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
342 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
343 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
344 @code{DISPLAY} environment variable.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
345
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
346 @item display-type
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
347 This parameter describes the range of possible colors that can be used
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
348 in this frame. Its value is @code{color}, @code{grayscale} or
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
349 @code{mono}.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
350
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
351 @item title
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
352 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
353 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
354 if @code{mode-line-frame-identification} uses @samp{%F}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
355 (@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
356 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
357 @xref{Frame Titles}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
358
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 @item name
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
360 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
361 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
362 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
363 (@pxref{Frame Titles}).
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 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
366 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
367 looking up X resources for the frame.
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
368 @end table
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
370 @node Position Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
371 @subsubsection Position Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
372
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
373 Position parameters' values are normally measured in pixels, but on
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
374 text-only terminals they count characters or lines instead.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
375
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
376 @table @code
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377 @item left
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
378 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
379 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
380 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
381 negative @var{pos} value.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
382
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
383 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
384 @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
385 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
386 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
387 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
388 positive.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
389
12388
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
390 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
391 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
392 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
393
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394 @item top
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
395 The screen position of the top edge, in pixels, with respect to the
62853
0a1026721b52 (Window Frame Parameters): Document user-size.
Richard M. Stallman <rms@gnu.org>
parents: 62688
diff changeset
396 top edge of the screen. It works just like @code{left}, except vertically
0a1026721b52 (Window Frame Parameters): Document user-size.
Richard M. Stallman <rms@gnu.org>
parents: 62688
diff changeset
397 instead of horizontally.
12388
35668330115e Clarify need for user-position to get left and top obeyed.
Richard M. Stallman <rms@gnu.org>
parents: 12125
diff changeset
398
10220
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
399 @item icon-left
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
400 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
401 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
402 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
403
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
404 If you specify a value for this parameter, then you must also specify
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
405 a value for @code{icon-top} and vice versa. The window manager may
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
406 ignore these two parameters.
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
407
10220
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
408 @item icon-top
126f7560fd28 Add icon-left and icon-top frame parameters.
Richard M. Stallman <rms@gnu.org>
parents: 9453
diff changeset
409 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
410 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
411 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
412
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
413 @item user-position
14658
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
414 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
415 @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
416 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
417 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
418 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
419
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
420 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
421 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
422 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
423 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
424 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
425 ignore them.
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
426
c2ed969842dc Clarify purpose of user-position parameter.
Richard M. Stallman <rms@gnu.org>
parents: 14200
diff changeset
427 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
428 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
429 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
430 @code{nil}.
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
431 @end table
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
432
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
433 @node Size Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
434 @subsubsection Size Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
435
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
436 Size parameters' values are normally measured in pixels, but on
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
437 text-only terminals they count characters or lines instead.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
438
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
439 @table @code
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
440 @item height
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
441 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
442 pixels, call @code{frame-pixel-height}; see @ref{Size and Position}.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
444 @item width
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
445 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
446 pixels, call @code{frame-pixel-width}; see @ref{Size and Position}.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
447
62853
0a1026721b52 (Window Frame Parameters): Document user-size.
Richard M. Stallman <rms@gnu.org>
parents: 62688
diff changeset
448 @item user-size
0a1026721b52 (Window Frame Parameters): Document user-size.
Richard M. Stallman <rms@gnu.org>
parents: 62688
diff changeset
449 This does for the size parameters @code{height} and @code{width} what
0a1026721b52 (Window Frame Parameters): Document user-size.
Richard M. Stallman <rms@gnu.org>
parents: 62688
diff changeset
450 the @code{user-position} parameter (see above) does for the position
0a1026721b52 (Window Frame Parameters): Document user-size.
Richard M. Stallman <rms@gnu.org>
parents: 62688
diff changeset
451 parameters @code{top} and @code{left}.
0a1026721b52 (Window Frame Parameters): Document user-size.
Richard M. Stallman <rms@gnu.org>
parents: 62688
diff changeset
452
42713
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
453 @item fullscreen
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
454 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
455 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
456 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
457 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
458 width and the height shall be set to the size of the screen.
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
459 @end table
42713
d977aa26f8f8 (Window Frame Parameters): Document the fullscreen parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 40310
diff changeset
460
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
461 @node Layout Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
462 @subsubsection Layout Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
463
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
464 These frame parameters enable or disable various parts of the
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
465 frame, or control their sizes.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
466
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
467 @table @code
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
468 @item border-width
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
469 The width in pixels of the window border.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
470
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
471 @item internal-border-width
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
472 The distance in pixels between text and border.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
473
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
474 @item vertical-scroll-bars
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
475 Whether the frame has scroll bars for vertical scrolling, and which side
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
476 of the frame they should be on. The possible values are @code{left},
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
477 @code{right}, and @code{nil} for no scroll bars.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
478
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
479 @ignore
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
480 @item horizontal-scroll-bars
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
481 Whether the frame has scroll bars for horizontal scrolling
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
482 (non-@code{nil} means yes). Horizontal scroll bars are not currently
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
483 implemented.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
484 @end ignore
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
485
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
486 @item scroll-bar-width
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
487 The width of vertical scroll bars, in pixels, or @code{nil} meaning to
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
488 use the default width.
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22843
diff changeset
489
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
490 @item left-fringe
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
491 @itemx right-fringe
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
492 The default width of the left and right fringes of windows in this
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
493 frame (@pxref{Fringes}). If either of these is zero, that effectively
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
494 removes the corresponding fringe. A value of @code{nil} stands for
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
495 the standard fringe width, which is the width needed to display the
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
496 fringe bitmaps.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
497
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
498 The combined fringe widths must add up to an integral number of
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
499 columns, so the actual default fringe widths for the frame may be
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
500 larger than the specified values. The extra width needed to reach an
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
501 acceptable total is distributed evenly between the left and right
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
502 fringe. However, you can force one fringe or the other to a precise
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
503 width by specifying that width as a negative integer. If both widths are
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
504 negative, only the left fringe gets the specified width.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
505
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
506 @item menu-bar-lines
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
507 The number of lines to allocate at the top of the frame for a menu
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
508 bar. The default is 1. A value of @code{nil} means don't display a
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
509 menu bar. @xref{Menu Bar}. (The X toolkit and GTK allow at most one
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
510 menu bar line; they treat larger values as 1.)
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
511
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
512 @item tool-bar-lines
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
513 The number of lines to use for the tool bar. A value of @code{nil}
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
514 means don't display a tool bar. (GTK allows at most one tool bar line;
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
515 it treats larger values as 1.)
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
516
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
517 @item line-spacing
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
518 Additional space to leave below each text line, in pixels (a positive
64882
8269d1de182b (Geometry): New node, split from Size and Position.
Richard M. Stallman <rms@gnu.org>
parents: 64878
diff changeset
519 integer). @xref{Line Height}, for more information.
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
520 @end table
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
521
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
522 @node Buffer Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
523 @subsubsection Buffer Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
524
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
525 These frame parameters, meaningful on all kinds of terminals, deal
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
526 with which buffers have been, or should, be displayed in the frame.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
527
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
528 @table @code
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529 @item minibuffer
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 Whether this frame has its own minibuffer. The value @code{t} means
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531 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
532 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
533 the new frame uses that minibuffer.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
535 @item buffer-predicate
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
536 The buffer-predicate function for this frame. The function
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
537 @code{other-buffer} uses this predicate (from the selected frame) to
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
538 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
539 @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
540 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
541 considers that buffer.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
542
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
543 @item buffer-list
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
544 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
545 ordered most-recently-selected first.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
546
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
547 @item unsplittable
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
548 If non-@code{nil}, this frame's window is never split automatically.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
549 @end table
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
550
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
551 @node Management Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
552 @subsubsection Window Management Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
553
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
554 These frame parameters, meaningful only on window system displays,
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
555 interact with the window manager.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
556
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
557 @table @code
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
558 @item visibility
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
559 The state of visibility of the frame. There are three possibilities:
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
560 @code{nil} for invisible, @code{t} for visible, and @code{icon} for
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
561 iconified. @xref{Visibility of Frames}.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
562
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563 @item auto-raise
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564 Whether selecting the frame raises it (non-@code{nil} means yes).
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 @item auto-lower
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 Whether deselecting the frame lowers it (non-@code{nil} means yes).
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569 @item icon-type
10759
fe6bdcb0d99f Update icon-type values.
Richard M. Stallman <rms@gnu.org>
parents: 10220
diff changeset
570 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
571 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
572 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
573 picture of a gnu); @code{nil} specifies a text icon.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
574
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
575 @item icon-name
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
576 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
577 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
578
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
579 @item window-id
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
580 The number of the window-system window used by the frame
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
581 to contain the actual Emacs windows.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
582
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
583 @item outer-window-id
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
584 The number of the outermost window-system window used for the whole frame.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
585
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
586 @item wait-for-wm
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
587 If non-@code{nil}, tell Xt to wait for the window manager to confirm
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
588 geometry changes. Some window managers, including versions of Fvwm2
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
589 and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
590 prevent hanging with those window managers.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
591
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
592 @ignore
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
593 @item parent-id
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
594 @c ??? Not yet working.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
595 The X window number of the window that should be the parent of this one.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
596 Specifying this lets you create an Emacs window inside some other
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
597 application's window. (It is not certain this will be implemented; try
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
598 it and see if it works.)
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
599 @end ignore
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
600 @end table
42752
6fce183f6920 (Window Frame Parameters): Document the new tty-color-mode parameter.
Eli Zaretskii <eliz@gnu.org>
parents: 42713
diff changeset
601
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
602 @node Cursor Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
603 @subsubsection Cursor Parameters
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
604
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
605 This frame parameter controls the way the cursor looks.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
606
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
607 @table @code
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 @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
609 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
610
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
611 @table @code
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
612 @item box
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
613 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
614 @item hollow
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
615 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
616 @item nil
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
617 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
618 @item bar
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
619 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
620 @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
621 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
622 @item hbar
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
623 Display a horizontal bar.
58257
8f67c69ee3ee (Window Frame Parameters): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 57766
diff changeset
624 @item (hbar . @var{height})
8f67c69ee3ee (Window Frame Parameters): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 57766
diff changeset
625 Display a horizontal bar @var{height} pixels high.
47055
6469b390d805 Describe blink-cursor-alist and new values for cursor-type.
Richard M. Stallman <rms@gnu.org>
parents: 45865
diff changeset
626 @end table
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
627 @end table
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628
39221
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
629 @vindex cursor-type
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
630 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
631 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
632 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
633
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
634 @defvar blink-cursor-alist
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
635 This variable specifies how to blink the cursor. Each element has the
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
636 form @code{(@var{on-state} . @var{off-state})}. Whenever the cursor
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
637 type equals @var{on-state} (comparing using @code{equal}), the
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
638 corresponding @var{off-state} specifies what the cursor looks like
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
639 when it blinks ``off''. Both @var{on-state} and @var{off-state}
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
640 should be suitable values for the @code{cursor-type} frame parameter.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
642 There are various defaults for how to blink each type of cursor, if
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
643 the type is not mentioned as an @var{on-state} here. Changes in this
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
644 variable do not take effect immediately, because the variable is
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
645 examined only when you specify the @code{cursor-type} parameter.
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
646 @end defvar
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
647
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
648 @node Color Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
649 @subsubsection Color Parameters
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
650
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
651 These frame parameters control the use of colors.
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
652
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
653 @table @code
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
654 @item background-mode
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
655 This parameter is either @code{dark} or @code{light}, according
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
656 to whether the background color is a light one or a dark one.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
658 @item tty-color-mode
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
659 @cindex standard colors for character terminals
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
660 This parameter overrides the terminal's color support as given by the
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
661 system's terminal capabilities database in that this parameter's value
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
662 specifies the color mode to use in terminal frames. The value can be
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
663 either a symbol or a number. A number specifies the number of colors
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
664 to use (and, indirectly, what commands to issue to produce each
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
665 color). For example, @code{(tty-color-mode . 8)} specifies use of the
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
666 ANSI escape sequences for 8 standard text colors. A value of -1 turns
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
667 off color support.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
668
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
669 If the parameter's value is a symbol, it specifies a number through
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
670 the value of @code{tty-color-mode-alist}, and the associated number is
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
671 used instead.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
673 @item screen-gamma
31375
35ac470e5e9c *** empty log message ***
Dave Love <fx@gnu.org>
parents: 27654
diff changeset
674 @cindex gamma correction
43578
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
675 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
676 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
677 your display, a floating point number.
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
678
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
679 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
680 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
681 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
682 @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
683 request correction, designed to make the corrected colors appear on
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
684 your screen the way they would have appeared without correction on an
43578
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
685 ordinary monitor with a gamma value of 2.2.
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
686
fa66c2edee4d Clarify gamma correction.
Richard M. Stallman <rms@gnu.org>
parents: 43562
diff changeset
687 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
688 @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
689 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
690 results for LCD color displays.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 @end table
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692
52144
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
693 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
694 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
695
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
696 @table @code
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
697 @item font
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
698 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
699 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
700 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
701 attribute of the @code{default} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
702
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
703 @item foreground-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
704 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
705 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
706
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
707 @item background-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
708 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
709 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
710
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
711 @item mouse-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
712 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
713 attribute of the @code{mouse} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
714
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
715 @item cursor-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
716 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
717 @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
718
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
719 @item border-color
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
720 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
721 @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
722
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
723 @item scroll-bar-foreground
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
724 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
725 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
726 @code{scroll-bar} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
727
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
728 @item scroll-bar-background
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
729 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
730 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
731 @code{scroll-bar} face.
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
732 @end table
85f4da4e24de (Parameter Access): Add modify-all-frames-parameters.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
733
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
734 @node Size and Position
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
735 @subsection Frame Size And Position
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
736 @cindex size of frame
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
737 @cindex screen size
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
738 @cindex frame size
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
739 @cindex resize frame
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
740
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
741 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
742 frame parameters @code{left}, @code{top}, @code{height}, and
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
743 @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
744 by the window manager in its usual fashion.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
745
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
746 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
747 (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
748 see @ref{Input Focus}.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
749
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
750 @defun set-frame-position frame left top
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
751 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
752 @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
753 normally count from the top left corner of the screen.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
754
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
755 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
756 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
757 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
758 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
759 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
760 but it seems inadvisable to change that now.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
761 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
762
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
763 @defun frame-height &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
764 @defunx frame-width &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
765 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
766 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
767 selected frame.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
768 @end defun
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
769
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
770 @defun screen-height
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
771 @defunx screen-width
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
772 These functions are old aliases for @code{frame-height} and
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
773 @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
774 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
775 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
776
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
777 @defun frame-pixel-height &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
778 @defunx frame-pixel-width &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
779 These functions return the height and width of @var{frame}, measured in
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
780 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
781 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
782
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
783 @defun frame-char-height &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
784 @defunx frame-char-width &optional frame
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
785 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
786 @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
787 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
788 frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
789 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
790
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
791 @defun set-frame-size frame cols rows
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
792 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
793 @var{cols} and @var{rows} specify the new width and height.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
794
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
795 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
796 @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
797 them to units of characters.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
798 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
799
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
800 @defun set-frame-height frame lines &optional pretend
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
801 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
802 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
803 fit.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
804
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
805 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
806 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
807 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
808 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
809 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
810 terminal malfunctions when using its whole screen. Setting the frame
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
811 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
812 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
813 terminal frame.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
814 @end defun
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
815
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
816 @defun set-frame-width frame width &optional pretend
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
817 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
818 The argument @var{pretend} has the same meaning as in
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
819 @code{set-frame-height}.
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
820 @end defun
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
821
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
822 @findex set-screen-height
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
823 @findex set-screen-width
22267
dfac7398266b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
824 The older functions @code{set-screen-height} and
dfac7398266b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22252
diff changeset
825 @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
826 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
827 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
828
64882
8269d1de182b (Geometry): New node, split from Size and Position.
Richard M. Stallman <rms@gnu.org>
parents: 64878
diff changeset
829 @node Geometry
8269d1de182b (Geometry): New node, split from Size and Position.
Richard M. Stallman <rms@gnu.org>
parents: 64878
diff changeset
830 @subsection Geometry
8269d1de182b (Geometry): New node, split from Size and Position.
Richard M. Stallman <rms@gnu.org>
parents: 64878
diff changeset
831
8269d1de182b (Geometry): New node, split from Size and Position.
Richard M. Stallman <rms@gnu.org>
parents: 64878
diff changeset
832 Here's how to examine the data in an X-style window geometry
8269d1de182b (Geometry): New node, split from Size and Position.
Richard M. Stallman <rms@gnu.org>
parents: 64878
diff changeset
833 specification:
8269d1de182b (Geometry): New node, split from Size and Position.
Richard M. Stallman <rms@gnu.org>
parents: 64878
diff changeset
834
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
835 @defun x-parse-geometry geom
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
836 @cindex geometry specification
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
837 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
838 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
839 @code{make-frame}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
840
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
841 The alist describes which parameters were specified in @var{geom}, and
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
842 gives the values specified for them. Each element looks like
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
843 @code{(@var{parameter} . @var{value})}. The possible @var{parameter}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
844 values are @code{left}, @code{top}, @code{width}, and @code{height}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
845
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
846 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
847 parameter names @code{left} and @code{top} are not totally accurate,
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
848 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
849 instead. These are the @var{value} possibilities for the position
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
850 parameters:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
851
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
852 @table @asis
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
853 @item an integer
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
854 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
855 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
856 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
857 screen.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
858
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
859 @item @code{(+ @var{position})}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
860 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
861 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
862 @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
863 position outside the screen.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
864
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
865 @item @code{(- @var{position})}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
866 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
867 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
868 @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
869 position outside the screen.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
870 @end table
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
871
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
872 Here is an example:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
873
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
874 @example
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
875 (x-parse-geometry "35x70+0-0")
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
876 @result{} ((height . 70) (width . 35)
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
877 (top - 0) (left . 0))
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
878 @end example
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
879 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
880
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
881 @node Frame Titles
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
882 @section Frame Titles
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
883
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
884 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
885 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
886 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
887 frame property.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
888
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
889 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
890 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
891 @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
892 frame is redisplayed.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
893
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
894 @defvar frame-title-format
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
895 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
896 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
897 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
898 Data}.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
899 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
900
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
901 @defvar icon-title-format
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
902 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
903 when you have not explicitly specified the frame title. This title
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
904 appears in the icon itself.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
905 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
906
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
907 @defvar multiple-frames
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
908 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
909 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
910 invisible frames). The default value of @code{frame-title-format} uses
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
911 @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
912 only when there is more than one frame.
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
913
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
914 The value of this variable is not guaranteed to be accurate except
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
915 while processing @code{frame-title-format} or
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
916 @code{icon-title-format}.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
917 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
918
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
919 @node Deleting Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
920 @section Deleting Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
921 @cindex deletion of frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
922
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
923 Frames remain potentially visible until you explicitly @dfn{delete}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
924 them. A deleted frame cannot appear on the screen, but continues to
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
925 exist as a Lisp object until there are no references to it.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
926
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
927 @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
928 @vindex delete-frame-functions
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
929 This function deletes the frame @var{frame}. Unless @var{frame} is a
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
930 tooltip, it first runs the hook @code{delete-frame-functions} (each
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
931 function gets one argument, @var{frame}). By default, @var{frame} is
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
932 the selected frame.
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
933
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
934 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
935 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
936 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
937 @end deffn
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
938
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
939 @defun frame-live-p frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
940 The function @code{frame-live-p} returns non-@code{nil} if the frame
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
941 @var{frame} has not been deleted. The possible non-@code{nil} return
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
942 values are like those of @code{framep}. @xref{Frames}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
943 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
944
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
945 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
946 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
947 When Emacs gets one of these commands, it generates a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
948 @code{delete-frame} event, whose normal definition is a command that
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
949 calls the function @code{delete-frame}. @xref{Misc Events}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
950
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
951 @node Finding All Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
952 @section Finding All Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
953
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
954 @defun frame-list
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
955 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
956 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
957 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
958 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
959 internals of Emacs.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
960 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
961
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
962 @defun visible-frame-list
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
963 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
964 @xref{Visibility of Frames}. (Terminal frames always count as
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
965 ``visible'', even though only the selected one is actually displayed.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
966 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
967
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
968 @defun next-frame &optional frame minibuf
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
969 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
970 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
971 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
972 @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
973 (@pxref{Input Focus}).
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
974
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
975 The second argument, @var{minibuf}, says which frames to consider:
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
976
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
977 @table @asis
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
978 @item @code{nil}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
979 Exclude minibuffer-only frames.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
980 @item @code{visible}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
981 Consider all visible frames.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
982 @item 0
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
983 Consider all visible or iconified frames.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
984 @item a window
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
985 Consider only the frames using that particular window as their
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
986 minibuffer.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
987 @item anything else
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
988 Consider all frames.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
989 @end table
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
990 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
991
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
992 @defun previous-frame &optional frame minibuf
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
993 Like @code{next-frame}, but cycles through all frames in the opposite
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
994 direction.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
995 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
996
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
997 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
998 Window Ordering}.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
999
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1000 @node Frames and Windows
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1001 @section Frames and Windows
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1002
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1003 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
1004 with @code{window-frame}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1005
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1006 @defun window-frame window
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1007 This function returns the frame that @var{window} is on.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1008 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1009
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1010 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
1011 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
1012 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
1013 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
1014 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
1015
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1016 @defun frame-first-window &optional frame
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1017 This returns the topmost, leftmost window of frame @var{frame}.
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1018 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
1019 @end defun
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1020
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1021 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
1022 frame}. The significance of this designation is that selecting the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1023 frame also selects this window. You can get the frame's current
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1024 selected window with @code{frame-selected-window}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1025
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1026 @defun frame-selected-window &optional frame
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1027 This function returns the window on @var{frame} that is selected
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1028 within @var{frame}. If omitted or @code{nil}, @var{frame} defaults to
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1029 the selected frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1030 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1031
53426
adae6745b4c9 (Frames and Windows): Add set-frame-selected-window and frame-root-window.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1032 @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
1033 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
1034 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
1035 @var{frame} is the selected frame, this makes @var{window} the
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1036 selected window. This function returns @var{window}.
53426
adae6745b4c9 (Frames and Windows): Add set-frame-selected-window and frame-root-window.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1037 @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
1038
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1039 Conversely, selecting a window for Emacs with @code{select-window} also
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1040 makes that window selected within its frame. @xref{Selecting Windows}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1041
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1042 Another function that (usually) returns one of the windows in a given
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1043 frame is @code{minibuffer-window}. @xref{Definition of minibuffer-window}.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1044
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1045 @node Minibuffers and Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1046 @section Minibuffers and Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1047
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1048 Normally, each frame has its own minibuffer window at the bottom, which
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1049 is used whenever that frame is selected. If the frame has a minibuffer,
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1050 you can get it with @code{minibuffer-window} (@pxref{Definition of
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1051 minibuffer-window}).
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1052
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1053 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
1054 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
1055 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
1056 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
1057 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
1058 value should be a frame that does have a minibuffer.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1059
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1060 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
1061 when you enter the minibuffer. If so, set the variable
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1062 @code{minibuffer-auto-raise} to @code{t}. @xref{Raising and Lowering}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1063
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1064 @defvar default-minibuffer-frame
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1065 This variable specifies the frame to use for the minibuffer window, by
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1066 default. It does not affect existing frames. It is always local to
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1067 the current terminal and cannot be buffer-local. @xref{Multiple
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1068 Displays}.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1069 @end defvar
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1070
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1071 @node Input Focus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1072 @section Input Focus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1073 @cindex input focus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1074 @cindex selected frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1075
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1076 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
1077 window always resides on the selected frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1078
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1079 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
1080 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
1081 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
1082 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
1083 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
1084 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
1085 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
1086 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
1087 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
1088 frame's display}.
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1089
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1090 @defun selected-frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1091 This function returns the selected frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1092 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1093
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1094 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
1095 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
1096 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
1097 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
1098 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
1099 @code{select-frame-set-input-focus}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1100
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1101 Lisp programs can also switch frames ``temporarily'' by calling the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1102 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
1103 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
1104 until that control is somehow reasserted.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1105
56338
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1106 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
1107 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
1108 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
1109 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
1110 @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
1111 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
1112 Line Variables}).
56338
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1113
fa931ffb96c8 (Input Focus): Add documentation for `select-frame-set-input-focus'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 56215
diff changeset
1114 @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
1115 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
1116 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
1117 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
1118 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
1119 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
1120 @end defun
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1121
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1122 @c ??? This is not yet implemented properly.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1123 @defun select-frame frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1124 This function selects frame @var{frame}, temporarily disregarding the
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1125 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
1126 the next time the user does something to select a different frame, or
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1127 until the next time this function is called. (If you are using a
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1128 window system, the previously selected frame may be restored as the
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1129 selected frame after return to the command loop, because it still may
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1130 have the window system's input focus.) The specified @var{frame}
39402
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1131 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
1132 @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
1133 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
1134
3a102bf6010f (Input Focus): Clarify which frame is _the_ selected
Eli Zaretskii <eliz@gnu.org>
parents: 39221
diff changeset
1135 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
1136 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
1137 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1138
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1139 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
1140 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
1141 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
1142 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
1143 @code{handle-switch-frame}. @xref{Focus Events}.
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 @deffn Command handle-switch-frame frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1146 This function handles a focus event by selecting frame @var{frame}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1147
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1148 Focus events normally do their job by invoking this command.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1149 Don't call it for any other reason.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1150 @end deffn
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1151
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1152 @defun redirect-frame-focus frame &optional focus-frame
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1153 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
1154 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
1155 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
1156 @code{last-event-frame} will be @var{focus-frame}. Also, switch-frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1157 events specifying @var{frame} will instead select @var{focus-frame}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1158
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1159 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
1160 redirection for @var{frame}, which therefore once again receives its own
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1161 events.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1162
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1163 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
1164 These frames use minibuffers on other frames. Activating a minibuffer
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1165 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
1166 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
1167 in the frame that activated the minibuffer.
6547
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 Selecting a frame can also change focus redirections. Selecting frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1170 @code{bar}, when @code{foo} had been selected, changes any redirections
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1171 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
1172 allows focus redirection to work properly when the user switches from
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1173 one frame to another using @code{select-window}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1174
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1175 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
1176 differently from a frame whose focus is not redirected.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1177 @code{select-frame} affects the former but not the latter.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1178
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1179 The redirection lasts until @code{redirect-frame-focus} is called to
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1180 change it.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1181 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1182
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1183 @defopt focus-follows-mouse
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1184 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
1185 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
1186 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
1187 position consistent with the new selected frame.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1188 @end defopt
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1189
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1190 @node Visibility of Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1191 @section Visibility of Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1192 @cindex visible frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1193 @cindex invisible frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1194 @cindex iconified frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1195 @cindex frame visibility
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1196
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1197 A window frame may be @dfn{visible}, @dfn{invisible}, or
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1198 @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
1199 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
1200 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
1201 even as an icon.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1202
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1203 Visibility is meaningless for terminal frames, since only the selected
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1204 one is actually displayed in any case.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1205
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1206 @deffn Command make-frame-visible &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1207 This function makes frame @var{frame} visible. If you omit @var{frame},
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1208 it makes the selected frame visible.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1209 @end deffn
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1210
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1211 @deffn Command make-frame-invisible &optional frame force
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1212 This function makes frame @var{frame} invisible. If you omit
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1213 @var{frame}, it makes the selected frame invisible.
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1214
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1215 Unless @var{force} is non-@code{nil}, this function refuses to make
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1216 @var{frame} invisible if all other frames are invisible..
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1217 @end deffn
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1218
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1219 @deffn Command iconify-frame &optional frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1220 This function iconifies frame @var{frame}. If you omit @var{frame}, it
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1221 iconifies the selected frame.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1222 @end deffn
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 @defun frame-visible-p frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1225 This returns the visibility status of frame @var{frame}. The value is
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1226 @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
1227 @code{icon} if it is iconified.
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1228
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1229 On a text-only terminal, all frames are considered visible, whether
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1230 they are currently being displayed or not, and this function returns
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1231 @code{t} for all frames.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1232 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1233
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1234 The visibility status of a frame is also available as a frame
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
1235 parameter. You can read or change it as such. @xref{Management
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1236 Parameters}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1237
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1238 The user can iconify and deiconify frames with the window manager.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1239 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
1240 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
1241 changes. @xref{Misc Events}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1242
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1243 @node Raising and Lowering
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1244 @section Raising and Lowering Frames
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1245
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1246 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
1247 the idea that windows are stacked in a notional third dimension
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1248 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
1249 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
1250 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
1251 seen if no other window overlaps it.
6547
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 @cindex raising a frame
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1254 @cindex lowering a frame
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1255 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
1256 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
1257 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
1258 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
1259 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
1260 on the screen.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1261
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1262 You can raise and lower Emacs frame Windows with these functions:
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1263
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1264 @deffn Command raise-frame &optional frame
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1265 This function raises frame @var{frame} (default, the selected frame).
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1266 If @var{frame} is invisible or iconified, this makes it visible.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1267 @end deffn
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1268
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1269 @deffn Command lower-frame &optional frame
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1270 This function lowers frame @var{frame} (default, the selected frame).
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1271 @end deffn
6547
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 @defopt minibuffer-auto-raise
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1274 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
1275 that the minibuffer window is in.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1276 @end defopt
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1277
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1278 You can also enable auto-raise (raising automatically when a frame is
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1279 selected) or auto-lower (lowering automatically when it is deselected)
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
1280 for any frame using frame parameters. @xref{Management Parameters}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1281
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1282 @node Frame Configurations
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1283 @section Frame Configurations
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1284 @cindex frame configuration
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1285
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1286 A @dfn{frame configuration} records the current arrangement of frames,
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1287 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
1288 (@xref{Window Configurations}.)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1289
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1290 @defun current-frame-configuration
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
1291 This function returns a frame configuration list that describes
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1292 the current arrangement of frames and their contents.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1293 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1294
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1295 @defun set-frame-configuration configuration &optional nodelete
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1296 This function restores the state of frames described in
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1297 @var{configuration}. However, this function does not restore deleted
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1298 frames.
26388
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1299
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1300 Ordinarily, this function deletes all existing frames not listed in
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1301 @var{configuration}. But if @var{nodelete} is non-@code{nil}, the
4577ed337157 Patch from rms.
Gerd Moellmann <gerd@gnu.org>
parents: 26211
diff changeset
1302 unwanted frames are iconified instead.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1303 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1304
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1305 @node Mouse Tracking
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1306 @section Mouse Tracking
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1307 @cindex mouse tracking
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1308 @cindex tracking the mouse
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1309
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
1310 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
1311 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
1312 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
1313 the mouse actually moves.
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 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
1316 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
1317 addition, you can easily handle any other sorts of events that may
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1318 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
1319 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
1320 button.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1321
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1322 @defspec track-mouse body@dots{}
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1323 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
1324 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
1325 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
1326 Events}, for the format of mouse motion events.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1327
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1328 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
1329 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
1330 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
1331 it is time to stop tracking.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1332 @end defspec
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1333
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1334 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
1335 the consequences of pushing or releasing a button at the current
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1336 position.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1337
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1338 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
1339 the @code{mouse-face} text property (@pxref{Special Properties}).
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1340 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
1341 Lisp-level mouse tracking.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1342
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1343 @ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1344 @c These are not implemented yet.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1345
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1346 These functions change the screen appearance instantaneously. The
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1347 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
1348 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
1349 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
1350 the events itself and does not do redisplay.
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 @defun x-contour-region window beg end
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1353 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
1354 to @var{end}, in window @var{window}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1355 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1356
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1357 @defun x-uncontour-region window beg end
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1358 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
1359 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
1360 a contour that you previously made by calling @code{x-contour-region}.
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
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1363 @defun x-draw-rectangle frame left top right bottom
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1364 This function draws a hollow rectangle on frame @var{frame} with the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1365 specified edge coordinates, all measured in pixels from the inside top
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1366 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
1367 location of point.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1368 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1369
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1370 @defun x-erase-rectangle frame left top right bottom
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1371 This function erases a hollow rectangle on frame @var{frame} with the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1372 specified edge coordinates, all measured in pixels from the inside top
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1373 left corner. Erasure means redrawing the text and background that
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1374 normally belong in the specified rectangle.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1375 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1376 @end ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1377
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1378 @node Mouse Position
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1379 @section Mouse Position
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1380 @cindex mouse position
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1381 @cindex position of mouse
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1382
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1383 The functions @code{mouse-position} and @code{set-mouse-position}
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1384 give access to the current position of the mouse.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1385
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1386 @defun mouse-position
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1387 This function returns a description of the position of the mouse. The
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1388 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
1389 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
1390 the top left corner of the inside of @var{frame}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1391 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1392
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
1393 @defvar mouse-position-function
39221
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1394 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
1395 @code{mouse-position} to call. @code{mouse-position} calls this
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1396 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
1397 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
1398
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1399 This abnormal hook exists for the benefit of packages like
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
1400 @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
1401 @end defvar
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
1402
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1403 @defun set-mouse-position frame x y
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1404 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
1405 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
1406 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
1407 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
1408 does nothing. The return value is not significant.
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1409 @end defun
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1410
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1411 @defun mouse-pixel-position
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1412 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
1413 coordinates in units of pixels rather than units of characters.
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1414 @end defun
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1415
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1416 @defun set-mouse-pixel-position frame x y
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1417 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
1418 @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
1419 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
1420
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1421 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
1422 value is not significant.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1423 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1424
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1425 @need 3000
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1426
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1427 @node Pop-Up Menus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1428 @section Pop-Up Menus
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1429
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1430 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
1431 the user can choose an alternative with the mouse.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1432
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1433 @defun x-popup-menu position menu
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1434 This function displays a pop-up menu and returns an indication of
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1435 what selection the user makes.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1436
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1437 The argument @var{position} specifies where on the screen to put the
62013
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1438 top left corner of the menu. It can be either a mouse button event
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1439 (which says to put the menu where the user actuated the button) or a
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1440 list of this form:
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1441
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1442 @example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1443 ((@var{xoffset} @var{yoffset}) @var{window})
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1444 @end example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1445
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1446 @noindent
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1447 where @var{xoffset} and @var{yoffset} are coordinates, measured in
62013
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1448 pixels, counting from the top left corner of @var{window}. @var{window}
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1449 may be a window or a frame.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1450
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1451 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
1452 position. If @var{position} is @code{nil}, it means to precompute the
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1453 key binding equivalents for the keymaps specified in @var{menu},
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1454 without actually displaying or popping up the menu.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1455
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1456 The argument @var{menu} says what to display in the menu. It can be a
62013
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1457 keymap or a list of keymaps (@pxref{Menu Keymaps}). In this case, the
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1458 return value is the list of events corresponding to the user's choice.
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1459 (This list has more than one element if the choice occurred in a
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1460 submenu.) Note that @code{x-popup-menu} does not actually execute the
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1461 command bound to that sequence of events.
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1462
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1463 Alternatively, @var{menu} can have the following form:
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1464
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1465 @example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1466 (@var{title} @var{pane1} @var{pane2}...)
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1467 @end example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1468
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1469 @noindent
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1470 where each pane is a list of form
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1471
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1472 @example
62013
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1473 (@var{title} @var{item1} @var{item2}...)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1474 @end example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1475
62013
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1476 Each item should normally be a cons cell @code{(@var{line} . @var{value})},
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1477 where @var{line} is a string, and @var{value} is the value to return if
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1478 that @var{line} is chosen. An item can also be a string; this makes a
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1479 non-selectable line in the menu.
62095
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1480
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1481 If the user gets rid of the menu without making a valid choice, for
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1482 instance by clicking the mouse away from a valid choice or by typing
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1483 keyboard input, then this normally results in a quit and
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1484 @code{x-popup-menu} does not return. But if @var{position} is a mouse
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1485 button event (indicating that the user invoked the menu with the
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1486 mouse) then no quit occurs and @code{x-popup-menu} returns @code{nil}.
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
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1489 @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
1490 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
1491 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
1492 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
1493 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
1494 @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
1495 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
1496
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1497 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
1498 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
1499 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
1500 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
1501 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
1502 implemented with menu keymaps within the parent menu, and never with
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1503 @code{x-popup-menu}. @xref{Menu Bar}.
14200
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1504
5a3beebafdcb Explain avoiding x-popup-menu for menu bar submenu.
Richard M. Stallman <rms@gnu.org>
parents: 13155
diff changeset
1505 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
1506 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
1507 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
1508 the menu keymap as necessary.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1509
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1510 @node Dialog Boxes
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1511 @section Dialog Boxes
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1512 @cindex dialog boxes
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1513
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1514 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
1515 different, it always appears in the center of a frame, and it has just
62663
68061d13d085 (Dialog Boxes): Descibe new optional argument.
Nick Roberts <nickrob@snap.net.nz>
parents: 62583
diff changeset
1516 one level and one or more buttons. The main use of dialog boxes is
68061d13d085 (Dialog Boxes): Descibe new optional argument.
Nick Roberts <nickrob@snap.net.nz>
parents: 62583
diff changeset
1517 for asking questions that the user can answer with ``yes'', ``no'',
68061d13d085 (Dialog Boxes): Descibe new optional argument.
Nick Roberts <nickrob@snap.net.nz>
parents: 62583
diff changeset
1518 and a few other alternatives. With a single button, they can also
68061d13d085 (Dialog Boxes): Descibe new optional argument.
Nick Roberts <nickrob@snap.net.nz>
parents: 62583
diff changeset
1519 force the user to acknowledge important information. The functions
68061d13d085 (Dialog Boxes): Descibe new optional argument.
Nick Roberts <nickrob@snap.net.nz>
parents: 62583
diff changeset
1520 @code{y-or-n-p} and @code{yes-or-no-p} use dialog boxes instead of the
68061d13d085 (Dialog Boxes): Descibe new optional argument.
Nick Roberts <nickrob@snap.net.nz>
parents: 62583
diff changeset
1521 keyboard, when called from commands invoked by mouse clicks.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1522
62679
800ffd9ab4b2 (Dialog Boxes): HEADER argument to `x-popup-dialog' is optional.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62664
diff changeset
1523 @defun x-popup-dialog position contents &optional header
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1524 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
1525 what selection the user makes. The argument @var{contents} specifies
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1526 the alternatives to offer; it has this format:
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1527
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1528 @example
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1529 (@var{title} (@var{string} . @var{value})@dots{})
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1530 @end example
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1531
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1532 @noindent
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1533 which looks like the list that specifies a single pane for
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1534 @code{x-popup-menu}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1535
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1536 The return value is @var{value} from the chosen alternative.
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1537
62013
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1538 As for @code{x-popup-menu}, an element of the list may be just a
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1539 string instead of a cons cell @code{(@var{string} . @var{value})}.
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1540 That makes a box that cannot be selected.
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1541
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1542 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
1543 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
1544 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
1545 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
1546 items appear on each side.
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1547
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1548 Dialog boxes always appear in the center of a frame; the argument
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1549 @var{position} specifies which frame. The possible values are as in
62013
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1550 @code{x-popup-menu}, but the precise coordinates or the individual
9208ec58c990 (Pop-Up Menus): Correct and clarify description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 60445
diff changeset
1551 window don't matter; only the frame matters.
7174
0313f520a4d9 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6547
diff changeset
1552
62688
08abb83f8aec (Dialog Boxes): Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 62679
diff changeset
1553 If @var{header} is non-@code{nil}, the frame title for the box is
08abb83f8aec (Dialog Boxes): Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 62679
diff changeset
1554 @samp{Information}, otherwise it is @samp{Question}. The former is used
62663
68061d13d085 (Dialog Boxes): Descibe new optional argument.
Nick Roberts <nickrob@snap.net.nz>
parents: 62583
diff changeset
1555 for @code{message-box} (@pxref{The Echo Area}).
68061d13d085 (Dialog Boxes): Descibe new optional argument.
Nick Roberts <nickrob@snap.net.nz>
parents: 62583
diff changeset
1556
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1557 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
1558 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
1559 frame.
62095
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1560
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1561 If the user gets rid of the dialog box without making a valid choice,
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1562 for instance using the window manager, then this produces a quit and
f1e37047f8ed (Pop-Up Menus): Complete description of `x-popup-menu'.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62013
diff changeset
1563 @code{x-popup-dialog} does not return.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1564 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1565
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1566 @node Pointer Shapes
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1567 @section Pointer Shapes
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1568 @cindex pointer shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1569 @cindex mouse pointer shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1570
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
1571 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
1572 various situations, when using the X Window System:
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1573
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1574 @table @code
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1575 @item x-pointer-shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1576 @vindex x-pointer-shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1577 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
1578 frame.
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1579
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1580 @item x-sensitive-text-pointer-shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1581 @vindex x-sensitive-text-pointer-shape
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1582 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
1583 is over mouse-sensitive text.
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1584 @end table
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1585
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1586 These variables affect newly created frames. They do not normally
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1587 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
1588 that also updates its pointer shapes based on the current values of
64873
a8651fc70979 (Window Frame Parameters): Node split up.
Richard M. Stallman <rms@gnu.org>
parents: 64451
diff changeset
1589 these variables. @xref{Color Parameters}.
7684
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1590
ec7caebc4a1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 7174
diff changeset
1591 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
1592 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
1593 @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
1594
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1595 @node Window System Selections
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
1596 @section Window System Selections
35476
26912db550c3 Change "X windows" instances.
Dave Love <fx@gnu.org>
parents: 35037
diff changeset
1597 @cindex selection (for window systems)
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1598
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1599 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
1600 data between application programs. The various selections are
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1601 distinguished by @dfn{selection types}, represented in Emacs by
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1602 symbols. X clients including Emacs can read or set the selection for
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1603 any given type.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1604
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1605 @deffn Command x-set-selection type data
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1606 This function sets a ``selection'' in the X server. It takes two
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1607 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
1608 @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
1609 selection. Otherwise, @var{data} may be a string, a symbol, an integer
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1610 (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
1611 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
1612 of markers stands for text in the overlay or between the markers.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1613
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1614 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
1615 selection values.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1616
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1617 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
1618 independently. The usual values of @var{type} are @code{PRIMARY},
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1619 @code{SECONDARY} and @code{CLIPBOARD}; these are symbols with upper-case
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1620 names, in accord with X Window System conventions. If @var{type} is
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1621 @code{nil}, that stands for @code{PRIMARY}.
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1622
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1623 This function returns @var{data}.
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1624 @end deffn
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1625
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
1626 @defun x-get-selection &optional type data-type
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1627 This function accesses selections set up by Emacs or by other X
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1628 clients. It takes two optional arguments, @var{type} and
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1629 @var{data-type}. The default for @var{type}, the selection type, is
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1630 @code{PRIMARY}.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1631
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1632 The @var{data-type} argument specifies the form of data conversion to
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1633 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
1634 data. Meaningful values include @code{TEXT}, @code{STRING},
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 62853
diff changeset
1635 @code{UTF8_STRING}, @code{TARGETS}, @code{LENGTH}, @code{DELETE},
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 62853
diff changeset
1636 @code{FILE_NAME}, @code{CHARACTER_POSITION}, @code{NAME},
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 62853
diff changeset
1637 @code{LINE_NUMBER}, @code{COLUMN_NUMBER}, @code{OWNER_OS},
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 62853
diff changeset
1638 @code{HOST_NAME}, @code{USER}, @code{CLASS}, @code{ATOM}, and
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 62853
diff changeset
1639 @code{INTEGER}. (These are symbols with upper-case names in accord
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 62853
diff changeset
1640 with X conventions.) The default for @var{data-type} is
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 62853
diff changeset
1641 @code{STRING}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1642 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1643
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1644 @cindex cut buffer
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1645 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
1646 store text or other data being moved between applications. Cut buffers
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1647 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
1648 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
1649
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1650 @defun x-get-cut-buffer &optional n
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1651 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
1652 If omitted @var{n} defaults to 0.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1653 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1654
56215
c9aa4127a482 Reposition @anchor's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54118
diff changeset
1655 @defun x-set-cut-buffer string &optional push
54118
7e1d7032e956 (Window System Selections): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54030
diff changeset
1656 @anchor{Definition of x-set-cut-buffer}
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1657 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
1658 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
1659 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
1660 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
1661 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
1662 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
1663 the third, and so on through all eight cut buffers.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1664 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1665
22742
39fe58403429 Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents: 22274
diff changeset
1666 @defvar selection-coding-system
39fe58403429 Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents: 22274
diff changeset
1667 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
1668 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
1669 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
1670 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
1671 @end defvar
39fe58403429 Add selection-coding-system.
Richard M. Stallman <rms@gnu.org>
parents: 22274
diff changeset
1672
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1673 @cindex clipboard support (for MS-Windows)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1674 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
1675 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
1676 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
1677 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
1678 clipboard as empty.
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1679
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1680 @defopt x-select-enable-clipboard
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1681 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
1682 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
1683 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
1684 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
1685 but @code{t} on MS-Windows.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1686 @end defopt
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1687
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1688 @node Color Names
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1689 @section Color Names
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1690
59927
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1691 @cindex color names
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1692 @cindex specify color
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1693 @cindex numerical RGB color specification
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1694 A color name is text (usually in a string) that specifies a color.
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1695 Symbolic names such as @samp{black}, @samp{white}, @samp{red}, etc.,
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1696 are allowed; use @kbd{M-x list-colors-display} to see a list of
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1697 defined names. You can also specify colors numerically in forms such
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1698 as @samp{#@var{rgb}} and @samp{RGB:@var{r}/@var{g}/@var{b}}, where
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1699 @var{r} specifies the red level, @var{g} specifies the green level,
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1700 and @var{b} specifies the blue level. You can use either one, two,
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1701 three, or four hex digits for @var{r}; then you must use the same
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1702 number of hex digits for all @var{g} and @var{b} as well, making
59927
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1703 either 3, 6, 9 or 12 hex digits in all. (See the documentation of the
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1704 X Window System for more details about numerical RGB specification of
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1705 colors.)
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1706
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1707 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
1708 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
1709 @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
1710 meaning of the term ``selected frame''.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1711
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1712 @defun color-defined-p color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1713 @tindex color-defined-p
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1714 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
1715 @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
1716 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
1717 @code{nil}, the selected frame is used.
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1718
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1719 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
1720 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
1721 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
1722 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
1723 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
1724
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1725 @findex x-color-defined-p
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1726 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
1727 and that name is still supported as an alias.
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1728 @end defun
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1729
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1730 @defun defined-colors &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1731 @tindex defined-colors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1732 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
1733 and supported on frame @var{frame} (default, the selected frame).
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1734 If @var{frame} does not support colors, the value is @code{nil}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1735
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1736 @findex x-defined-colors
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1737 This function used to be called @code{x-defined-colors},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1738 and that name is still supported as an alias.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1739 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1740
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1741 @defun color-supported-p color &optional frame background-p
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1742 @tindex color-supported-p
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1743 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
1744 @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
1745 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
1746
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1747 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
1748 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
1749 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
1750 are asking whether it can be used as a foreground.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1751
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1752 The argument @var{color} must be a valid color name.
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1753 @end defun
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1754
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1755 @defun color-gray-p color &optional frame
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1756 @tindex color-gray-p
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1757 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
1758 @var{frame}'s display. If @var{frame} is omitted or @code{nil}, the
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1759 question applies to the selected frame. If @var{color} is not a valid
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1760 color name, this function returns @code{nil}.
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1761 @end defun
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1762
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1763 @defun color-values color &optional frame
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1764 @tindex color-values
59927
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1765 @cindex rgb value
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1766 This function returns a value that describes what @var{color} should
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1767 ideally look like on @var{frame}. If @var{color} is defined, the
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1768 value is a list of three integers, which give the amount of red, the
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1769 amount of green, and the amount of blue. Each integer ranges in
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1770 principle from 0 to 65535, but some displays may not use the full
59927
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1771 range. This three-element list is called the @dfn{rgb values} of the
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1772 color.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1773
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1774 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
1775
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1776 @example
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1777 (color-values "black")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1778 @result{} (0 0 0)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1779 (color-values "white")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1780 @result{} (65280 65280 65280)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1781 (color-values "red")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1782 @result{} (65280 0 0)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1783 (color-values "pink")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1784 @result{} (65280 49152 51968)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1785 (color-values "hungry")
8712
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1786 @result{} nil
9bc99cd7a6ee entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 8427
diff changeset
1787 @end example
12676
d97688032b10 multiple-frames is not terminal-local.
Richard M. Stallman <rms@gnu.org>
parents: 12388
diff changeset
1788
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1789 The color values are returned for @var{frame}'s display. If
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1790 @var{frame} is omitted or @code{nil}, the information is returned for
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1791 the selected frame's display. If the frame cannot display colors, the
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1792 value is @code{nil}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1793
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1794 @findex x-color-values
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1795 This function used to be called @code{x-color-values},
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1796 and that name is still supported as an alias.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1797 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1798
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1799 @node Text Terminal Colors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1800 @section Text Terminal Colors
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1801 @cindex colors on text-only terminals
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1802
60445
823da03182ac (Text Terminal Colors): Get rid of "Emacs 21", and make it read better.
Richard M. Stallman <rms@gnu.org>
parents: 59927
diff changeset
1803 Text-only terminals usually support only a small number of colors,
823da03182ac (Text Terminal Colors): Get rid of "Emacs 21", and make it read better.
Richard M. Stallman <rms@gnu.org>
parents: 59927
diff changeset
1804 and the computer uses small integers to select colors on the terminal.
823da03182ac (Text Terminal Colors): Get rid of "Emacs 21", and make it read better.
Richard M. Stallman <rms@gnu.org>
parents: 59927
diff changeset
1805 This means that the computer cannot reliably tell what the selected
823da03182ac (Text Terminal Colors): Get rid of "Emacs 21", and make it read better.
Richard M. Stallman <rms@gnu.org>
parents: 59927
diff changeset
1806 color looks like; instead, you have to inform your application which
823da03182ac (Text Terminal Colors): Get rid of "Emacs 21", and make it read better.
Richard M. Stallman <rms@gnu.org>
parents: 59927
diff changeset
1807 small integers correspond to which colors. However, Emacs does know
823da03182ac (Text Terminal Colors): Get rid of "Emacs 21", and make it read better.
Richard M. Stallman <rms@gnu.org>
parents: 59927
diff changeset
1808 the standard set of colors and will try to use them automatically.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1809
42957
6a35c3566bfd (Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents: 42752
diff changeset
1810 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
1811 are used by Emacs.
6a35c3566bfd (Text Terminal Colors): Document tty-display-color-cells.
Eli Zaretskii <eliz@gnu.org>
parents: 42752
diff changeset
1812
59927
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1813 Several of these functions use or return @dfn{rgb values}, described
30ef6c521f51 (Color Names): Add pointer to the X docs about RGB
Eli Zaretskii <eliz@gnu.org>
parents: 59878
diff changeset
1814 in @ref{Color Names}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1815
27374
0f5edee5242b *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
1816 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
1817 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
1818 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
1819 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
1820 selected frame's terminal; @pxref{Input Focus}). At present, though,
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1821 the @var{frame} argument has no effect.
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1822
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1823 @defun tty-color-define name number &optional rgb frame
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1824 @tindex tty-color-define
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1825 This function associates the color name @var{name} with
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1826 color number @var{number} on the terminal.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1827
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1828 The optional argument @var{rgb}, if specified, is an rgb value, a list
64451
efc3cdafca80 (Text Terminal Colors, Resources): Delete duplicate words.
Juri Linkov <juri@jurta.org>
parents: 63636
diff changeset
1829 of three numbers that specify what the color actually looks like.
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1830 If you do not specify @var{rgb}, then this color cannot be used by
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1831 @code{tty-color-approximate} to approximate other colors, because
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1832 Emacs will not know what it looks like.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1833 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1834
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1835 @defun tty-color-clear &optional frame
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1836 @tindex tty-color-clear
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1837 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
1838 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1839
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1840 @defun tty-color-alist &optional frame
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1841 @tindex tty-color-alist
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1842 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
1843 text-only terminal.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1844
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1845 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
1846 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
1847 name, @var{number} is the number used to specify it to the terminal.
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1848 If present, @var{rgb} is a list of three color values (for red, green,
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1849 and blue) that says what the color actually looks like.
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1850 @end defun
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1851
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1852 @defun tty-color-approximate rgb &optional frame
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1853 @tindex tty-color-approximate
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1854 This function finds the closest color, among the known colors
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1855 supported for @var{display}, to that described by the rgb value
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1856 @var{rgb} (a list of color values). The return value is an element of
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1857 @code{tty-color-alist}.
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1858 @end defun
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1859
59878
11f2e6f2a600 (Window Frame Parameters): Explain pixel=char on tty.
Richard M. Stallman <rms@gnu.org>
parents: 58884
diff changeset
1860 @defun tty-color-translate color &optional frame
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
1861 @tindex tty-color-translate
27093
4b1a67a46d8c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 26388
diff changeset
1862 This function finds the closest color to @var{color} among the known
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1863 colors supported for @var{display} and returns its index (an integer).
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1864 If the name @var{color} is not defined, the value is @code{nil}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1865 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1866
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1867 @node Resources
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1868 @section X Resources
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1869
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1870 @defun x-get-resource attribute class &optional component subclass
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1871 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
1872 Window defaults database.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1873
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1874 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
1875 This function searches using a key of the form
8427
bc548090f760 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 8110
diff changeset
1876 @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
1877 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
1878 the class.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1879
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1880 The optional arguments @var{component} and @var{subclass} add to the key
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1881 and the class, respectively. You must specify both of them or neither.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1882 If you specify them, the key is
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1883 @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
1884 @samp{Emacs.@var{class}.@var{subclass}}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1885 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1886
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1887 @defvar x-resource-class
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1888 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
1889 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
1890 resources for application names other than ``Emacs'' by binding this
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1891 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
1892 @end defvar
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 16528
diff changeset
1893
54030
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1894 @defvar x-resource-name
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1895 This variable specifies the instance name that @code{x-get-resource}
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1896 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
1897 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
1898 @end defvar
c97510dccd0d Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 53490
diff changeset
1899
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1900 To illustrate some of the above, suppose that you have the line:
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1901
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1902 @example
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1903 xterm.vt100.background: yellow
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1904 @end example
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1905
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1906 @noindent
64451
efc3cdafca80 (Text Terminal Colors, Resources): Delete duplicate words.
Juri Linkov <juri@jurta.org>
parents: 63636
diff changeset
1907 in your X resources file (whose name is usually @file{~/.Xdefaults}
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 62853
diff changeset
1908 or @file{~/.Xresources}). Then:
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1909
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1910 @example
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1911 @group
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1912 (let ((x-resource-class "XTerm") (x-resource-name "xterm"))
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1913 (x-get-resource "vt100.background" "VT100.Background"))
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1914 @result{} "yellow"
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1915 @end group
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1916 @group
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1917 (let ((x-resource-class "XTerm") (x-resource-name "xterm"))
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1918 (x-get-resource "background" "VT100" "vt100" "Background"))
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1919 @result{} "yellow"
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1920 @end group
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1921 @end example
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
1922
45779
4964699e51b4 (Initial Parameters, Resources): Fix references to the Emacs manual.
Andreas Schwab <schwab@suse.de>
parents: 45744
diff changeset
1923 @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1924
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1925 @node Display Feature Testing
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1926 @section Display Feature Testing
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1927 @cindex display feature testing
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1928
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1929 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
1930 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
1931 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
1932 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
1933
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1934 The optional argument @var{display} in these functions specifies which
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1935 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
1936 (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
1937 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
1938
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1939 @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
1940 obtain information about displays.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1941
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1942 @defun display-popup-menus-p &optional display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1943 @tindex display-popup-menus-p
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1944 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
1945 @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
1946 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
1947 a mouse.
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1948 @end defun
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1949
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1950 @defun display-graphic-p &optional display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1951 @tindex display-graphic-p
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1952 @cindex frames, more than one on display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1953 @cindex fonts, more than one on display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1954 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
1955 capable of displaying several frames and several different fonts at
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1956 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
1957 false for text-only terminals.
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1958 @end defun
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
1959
27654
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1960 @defun display-mouse-p &optional display
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1961 @tindex display-mouse-p
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1962 @cindex mouse, availability
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1963 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
1964 @code{nil} if not.
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1965 @end defun
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
1966
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1967 @defun display-color-p &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1968 @tindex display-color-p
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1969 @findex x-display-color-p
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1970 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
1971 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
1972 is still supported as an alias.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1973 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1974
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1975 @defun display-grayscale-p &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1976 @tindex display-grayscale-p
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1977 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
1978 (All color displays can do this.)
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1979 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
1980
56215
c9aa4127a482 Reposition @anchor's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54118
diff changeset
1981 @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
1982 @anchor{Display Face Attribute Testing}
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1983 @tindex display-supports-face-attributes-p
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1984 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
1985 @var{attributes} are supported (@pxref{Face Attributes}).
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1986
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1987 The definition of `supported' is somewhat heuristic, but basically
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1988 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
1989 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
1990 way that's
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1991
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1992 @enumerate
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1993 @item
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1994 different in appearance than the default face, and
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1995
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1996 @item
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1997 `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
1998 @end enumerate
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
1999
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
2000 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
2001 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
2002 @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
2003 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
2004 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
2005 italic.
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
2006 @end defun
75e9d527da2b display-supports-face-attributes-p
Miles Bader <miles@gnu.org>
parents: 44693
diff changeset
2007
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2008 @defun display-selections-p &optional display
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2009 @tindex display-selections-p
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2010 This function returns @code{t} if @var{display} supports selections.
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2011 Windowed displays normally support selections, but they may also be
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2012 supported in some other cases.
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2013 @end defun
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2014
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
2015 @defun display-images-p &optional display
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
2016 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
2017 Windowed displays ought in principle to handle images, but some
68b26e98aef6 Clarify recent changes.
Richard M. Stallman <rms@gnu.org>
parents: 39197
diff changeset
2018 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
2019 images, Emacs cannot display a tool bar.
39197
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
2020 @end defun
f56fa34012c0 (Mouse Position): Document mouse-position-function.
Eli Zaretskii <eliz@gnu.org>
parents: 36348
diff changeset
2021
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2022 @defun display-screens &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2023 @tindex display-screens
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2024 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
2025 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2026
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2027 @defun display-pixel-height &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2028 @tindex display-pixel-height
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2029 This function returns the height of the screen in pixels.
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
2030 On a character terminal, it gives the height in characters.
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2031 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2032
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2033 @defun display-mm-height &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2034 @tindex display-mm-height
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2035 This function returns the height of the screen in millimeters,
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2036 or @code{nil} if Emacs cannot get that information.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2037 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2038
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2039 @defun display-pixel-width &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2040 @tindex display-pixel-width
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2041 This function returns the width of the screen in pixels.
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
2042 On a character terminal, it gives the width in characters.
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2043 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2044
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2045 @defun display-mm-width &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2046 @tindex display-mm-width
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2047 This function returns the width of the screen in millimeters,
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2048 or @code{nil} if Emacs cannot get that information.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2049 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2050
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2051 @defun display-backing-store &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2052 @tindex display-backing-store
27654
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
2053 This function returns the backing store capability of the display.
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
2054 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
2055 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
2056 displayed very quickly.
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
2057
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2058 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
2059 @code{not-useful}. The function can also return @code{nil}
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2060 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
2061 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2062
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2063 @defun display-save-under &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2064 @tindex display-save-under
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2065 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
2066 SaveUnder feature. That feature is used by pop-up windows
cabb1b4c4424 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27532
diff changeset
2067 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
2068 quickly.
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2069 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2070
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2071 @defun display-planes &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2072 @tindex display-planes
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2073 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
2074 This is typically the number of bits per pixel.
63636
75c04f750f89 Fix spellings.
Juanma Barranquero <lekktu@gmail.com>
parents: 63583
diff changeset
2075 For a tty display, it is log to base two of the number of colors supported.
27532
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2076 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2077
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2078 @defun display-visual-class &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2079 @tindex display-visual-class
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2080 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
2081 of the symbols @code{static-gray}, @code{gray-scale},
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2082 @code{static-color}, @code{pseudo-color}, @code{true-color}, and
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2083 @code{direct-color}.
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2084 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2085
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2086 @defun display-color-cells &optional display
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2087 @tindex display-color-cells
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2088 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
2089 @end defun
ada257a7df9f *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27447
diff changeset
2090
27447
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2091 These functions obtain additional information specifically
ef387684dc33 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27374
diff changeset
2092 about X displays.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2093
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
2094 @defun x-server-version &optional display
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
2095 This function returns the list of version numbers of the X server
56535
fee4457701d8 Various changes in addition to:
Luc Teirlinck <teirllm@auburn.edu>
parents: 56380
diff changeset
2096 running the display. The value is a list of three integers: the major
57766
49c3962f983c (Display Feature Testing): Explain about "vendor".
Richard M. Stallman <rms@gnu.org>
parents: 56639
diff changeset
2097 and minor version numbers of the X protocol, and the
49c3962f983c (Display Feature Testing): Explain about "vendor".
Richard M. Stallman <rms@gnu.org>
parents: 56639
diff changeset
2098 distributor-specific release number of the X server software itself.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2099 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2100
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10759
diff changeset
2101 @defun x-server-vendor &optional display
57766
49c3962f983c (Display Feature Testing): Explain about "vendor".
Richard M. Stallman <rms@gnu.org>
parents: 56639
diff changeset
2102 This function returns the ``vendor'' that provided the X server
49c3962f983c (Display Feature Testing): Explain about "vendor".
Richard M. Stallman <rms@gnu.org>
parents: 56639
diff changeset
2103 software (as a string). Really this means whoever distributes the X
49c3962f983c (Display Feature Testing): Explain about "vendor".
Richard M. Stallman <rms@gnu.org>
parents: 56639
diff changeset
2104 server.
49c3962f983c (Display Feature Testing): Explain about "vendor".
Richard M. Stallman <rms@gnu.org>
parents: 56639
diff changeset
2105
49c3962f983c (Display Feature Testing): Explain about "vendor".
Richard M. Stallman <rms@gnu.org>
parents: 56639
diff changeset
2106 When the developers of X labelled software distributors as
49c3962f983c (Display Feature Testing): Explain about "vendor".
Richard M. Stallman <rms@gnu.org>
parents: 56639
diff changeset
2107 ``vendors'', they showed their false assumption that no system could
49c3962f983c (Display Feature Testing): Explain about "vendor".
Richard M. Stallman <rms@gnu.org>
parents: 56639
diff changeset
2108 ever be developed and distributed noncommercially.
6547
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2109 @end defun
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2110
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2111 @ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2112 @defvar x-no-window-manager
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
2113 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
2114 @end defvar
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2115 @end ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2116
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2117 @ignore
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2118 @item
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2119 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
2120 width and height of an X Window frame, measured in pixels.
610cde67456a Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2121 @end ignore
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52144
diff changeset
2122
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52144
diff changeset
2123 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52144
diff changeset
2124 arch-tag: 94977df6-3dca-4730-b57b-c6329e9282ba
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 52144
diff changeset
2125 @end ignore