annotate src/frameslots.h @ 314:341dac730539 r21-0b55

Import from CVS: tag r21-0b55
author cvs
date Mon, 13 Aug 2007 10:44:22 +0200
parents 57709be46d1b
children b8cc9ab3f761
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 /* Definitions of marked slots in frames
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 Copyright (C) 1988, 1992, 1993, 1994 Free Software Foundation, Inc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 Copyright (C) 1996 Ben Wing.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 This file is part of XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 XEmacs is free software; you can redistribute it and/or modify it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10 later version.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 for more details.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 along with XEmacs; see the file COPYING. If not, write to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 Boston, MA 02111-1307, USA. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 /* Synched up with: FSF 19.30. Split out of frame.h. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23
286
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
24 #ifdef FRAME_SLOT_DECLARATION
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
25 #define MARKED_SLOT_ARRAY(slot, size) MARKED_SLOT(slot[size])
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
26 #else
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
27 #define MARKED_SLOT_ARRAY(slot, size) do { \
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
28 int mslotidx; \
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
29 for (mslotidx = 0; mslotidx < size; mslotidx++) \
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
30 { \
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
31 MARKED_SLOT (slot[mslotidx]); \
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
32 } \
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
33 } while (0);
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
34 #endif
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
35
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 /* device frame belongs to. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 MARKED_SLOT (device);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39 /* Name of this frame: a Lisp string.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 NOT the same as the frame's title, even though FSF bogusly
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41 confuses the two. The frame's name is used for resourcing
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 and lookup purposes and is something you can count on having
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 a specific value, while the frame's title may vary depending
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 on the user's choice of `frame-title-format'. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 MARKED_SLOT (name);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 /* The frame which should receive keystrokes that occur in this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 frame, or nil if they should go to the frame itself. This is
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 usually nil, but if the frame is minibufferless, we can use this
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 to redirect keystrokes to a surrogate minibuffer frame when
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 needed.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 Note that a value of nil is different than having the field point
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 to the frame itself. Whenever the Fselect_frame function is used
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 to shift from one frame to the other, any redirections to the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 original frame are shifted to the newly selected frame; if
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 focus_frame is nil, Fselect_frame will leave it alone. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 MARKED_SLOT (focus_frame);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 /* This frame's root window. Every frame has one.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 If the frame has only a minibuffer window, this is it.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 Otherwise, if the frame has a minibuffer window, this is its sibling. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 MARKED_SLOT (root_window);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 /* This frame's selected window.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 Each frame has its own window hierarchy
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67 and one of the windows in it is selected within the frame.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 The selected window of the selected frame is Emacs's selected window. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 MARKED_SLOT (selected_window);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 /* This frame's minibuffer window.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 Most frames have their own minibuffer windows,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 but only the selected frame's minibuffer window
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 can actually appear to exist. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 MARKED_SLOT (minibuffer_window);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 /* The most recently selected nonminibuf window.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 This is used by things like the toolbar code, which doesn't
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 want the toolbar to change when moving to the minibuffer.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 This will only be a minibuf window if we are a minibuf-only
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 frame. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 MARKED_SLOT (last_nonminibuf_window);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 /* frame property list */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85 MARKED_SLOT (plist);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 /* A copy of the global Vbuffer_list, to maintain a per-frame buffer
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 ordering. The Vbuffer_list variable and the buffer_list slot of each
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 frame contain exactly the same data, just in different orders. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 MARKED_SLOT (buffer_alist);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 /* Predicate for selecting buffers for other-buffer. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 MARKED_SLOT (buffer_predicate);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 /* The current mouse pointer for the frame. This is set by calling
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 `set-frame-pointer'. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97 MARKED_SLOT (pointer);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99 /* The current icon for the frame. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 MARKED_SLOT (icon);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
102 #ifdef HAVE_MENUBARS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103 /* Vector representing the menubar currently displayed. See menubar-x.c. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104 MARKED_SLOT (menubar_data);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107 /* specifier values cached in the struct frame: */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109 #ifdef HAVE_MENUBARS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110 MARKED_SLOT (menubar_visible_p);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 #ifdef HAVE_SCROLLBARS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 /* Width and height of the scrollbars. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115 MARKED_SLOT (scrollbar_width);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 MARKED_SLOT (scrollbar_height);
282
c42ec1d1cded Import from CVS: tag r21-0b39
cvs
parents: 215
diff changeset
117 /* Whether the scrollbars are visible */
c42ec1d1cded Import from CVS: tag r21-0b39
cvs
parents: 215
diff changeset
118 MARKED_SLOT (horizontal_scrollbar_visible_p);
c42ec1d1cded Import from CVS: tag r21-0b39
cvs
parents: 215
diff changeset
119 MARKED_SLOT (vertical_scrollbar_visible_p);
c42ec1d1cded Import from CVS: tag r21-0b39
cvs
parents: 215
diff changeset
120 /* Scrollbars location */
c42ec1d1cded Import from CVS: tag r21-0b39
cvs
parents: 215
diff changeset
121 MARKED_SLOT (scrollbar_on_left_p);
c42ec1d1cded Import from CVS: tag r21-0b39
cvs
parents: 215
diff changeset
122 MARKED_SLOT (scrollbar_on_top_p);
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
123 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
124
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
125 #ifdef HAVE_TOOLBARS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
126 /* The following three don't really need to be cached except
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
127 that we need to know when they've changed. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
128 MARKED_SLOT (default_toolbar_width);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129 MARKED_SLOT (default_toolbar_height);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130 MARKED_SLOT (default_toolbar_visible_p);
215
1f0dabaa0855 Import from CVS: tag r20-4b6
cvs
parents: 0
diff changeset
131 MARKED_SLOT (default_toolbar_border_width);
286
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
132
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
133 /* List of toolbar buttons of current toolbars */
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
134 MARKED_SLOT_ARRAY (toolbar_buttons, 4);
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
135 /* Size of the toolbars. The frame-local toolbar space is
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
136 subtracted before the windows are arranged. Window and buffer
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
137 local toolbars overlay their windows. */
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
138 MARKED_SLOT_ARRAY (toolbar_size, 4);
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
139 /* Visibility of the toolbars. This acts as a valve for toolbar_size. */
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
140 MARKED_SLOT_ARRAY (toolbar_visible_p, 4);
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
141 /* Thickness of the border around the toolbar. */
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
142 MARKED_SLOT_ARRAY (toolbar_border_width, 4);
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 /* Possible frame-local default for outside margin widths. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146 MARKED_SLOT (left_margin_width);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
147 MARKED_SLOT (right_margin_width);
286
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
148
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
149 #undef MARKED_SLOT
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
150 #undef MARKED_SLOT_ARRAY
57709be46d1b Import from CVS: tag r21-0b41
cvs
parents: 282
diff changeset
151 #undef FRAME_SLOT_DECLARATION