428
|
1 /* Define frame-object for XEmacs.
|
|
2 Copyright (C) 1988, 1992, 1993, 1994 Free Software Foundation, Inc.
|
872
|
3 Copyright (C) 1995, 2002 Ben Wing.
|
428
|
4
|
|
5 This file is part of XEmacs.
|
|
6
|
|
7 XEmacs is free software; you can redistribute it and/or modify it
|
|
8 under the terms of the GNU General Public License as published by the
|
|
9 Free Software Foundation; either version 2, or (at your option) any
|
|
10 later version.
|
|
11
|
|
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
15 for more details.
|
|
16
|
|
17 You should have received a copy of the GNU General Public License
|
|
18 along with XEmacs; see the file COPYING. If not, write to
|
|
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
20 Boston, MA 02111-1307, USA. */
|
|
21
|
|
22 /* Synched up with: FSF 19.30. */
|
|
23
|
440
|
24 #ifndef INCLUDED_frame_h_
|
|
25 #define INCLUDED_frame_h_
|
428
|
26
|
|
27 #include "redisplay.h"
|
800
|
28 #include "console.h" /* for error_check_frame_type */
|
428
|
29
|
872
|
30 struct frame;
|
428
|
31
|
872
|
32 EXFUN (Fselected_frame, 1);
|
428
|
33 EXFUN (Fdelete_frame, 2);
|
|
34 EXFUN (Fframe_iconified_p, 1);
|
|
35 EXFUN (Fframe_name, 1);
|
|
36 EXFUN (Fframe_property, 3);
|
|
37 EXFUN (Fmake_frame, 2);
|
|
38 EXFUN (Fmake_frame_visible, 1);
|
|
39 EXFUN (Fraise_frame, 1);
|
|
40 EXFUN (Fselect_frame, 1);
|
|
41 EXFUN (Fset_frame_pointer, 2);
|
|
42 EXFUN (Fset_frame_position, 3);
|
442
|
43 EXFUN (Fset_frame_properties, 2);
|
428
|
44 EXFUN (Fset_frame_size, 4);
|
|
45
|
|
46 extern Lisp_Object Qbackground_toolbar_color, Qbell_volume, Qborder_color;
|
|
47 extern Lisp_Object Qborder_width, Qbottom_toolbar_shadow_color;
|
|
48 extern Lisp_Object Qbottom_toolbar_shadow_pixmap, Qdelete_frame;
|
|
49 extern Lisp_Object Qdeselect_frame_hook, Qdrag_and_drop_functions, Qgc_pointer;
|
|
50 extern Lisp_Object Qiconic, Qinitially_unmapped, Qinter_line_space;
|
|
51 extern Lisp_Object Qinternal_border_width, Qinvisible, Qmap_frame_hook;
|
|
52 extern Lisp_Object Qminibuffer, Qmodeline_pointer, Qmouse_enter_frame_hook;
|
|
53 extern Lisp_Object Qmouse_leave_frame_hook, Qpointer_background;
|
|
54 extern Lisp_Object Qpointer_color, Qpopup, Qscrollbar_placement;
|
|
55 extern Lisp_Object Qselect_frame_hook, Qspace_pointer;
|
|
56 extern Lisp_Object Qsynchronize_minibuffers, Qtext_pointer;
|
|
57 extern Lisp_Object Qtoolbar_shadow_thickness, Qtop_toolbar_shadow_color;
|
|
58 extern Lisp_Object Qtop_toolbar_shadow_pixmap, Qunmap_frame_hook;
|
|
59 extern Lisp_Object Qunsplittable, Quse_backing_store, Qvisible, Qvisual_bell;
|
|
60 extern Lisp_Object Vframe_icon_title_format, Vframe_title_format;
|
|
61 extern Lisp_Object Vmouse_motion_handler;
|
|
62
|
|
63 DECLARE_LRECORD (frame, struct frame);
|
|
64 #define XFRAME(x) XRECORD (x, frame, struct frame)
|
617
|
65 #define wrap_frame(p) wrap_record (p, frame)
|
428
|
66 #define FRAMEP(x) RECORDP (x, frame)
|
|
67 #define CHECK_FRAME(x) CHECK_RECORD (x, frame)
|
|
68 #define CONCHECK_FRAME(x) CONCHECK_RECORD (x, frame)
|
|
69
|
872
|
70 /* Basic properties available to non-privileged users; redefined in
|
|
71 frame-impl.h */
|
|
72
|
|
73 int frame_live_p (struct frame *f);
|
|
74 Lisp_Object frame_device (struct frame *f);
|
|
75
|
|
76 #define FRAME_LIVE_P(f) frame_live_p (f)
|
|
77 #define FRAME_DEVICE(f) frame_device (f)
|
|
78
|
|
79 #define FRAME_XDEVICE(f) XDEVICE (FRAME_DEVICE (f))
|
|
80 #define FRAME_CONSOLE(f) XDEVICE_CONSOLE (FRAME_DEVICE (f))
|
|
81 #define FRAME_XCONSOLE(f) XCONSOLE (FRAME_CONSOLE (f))
|
|
82
|
|
83 #define XFRAME_DEVICE(f) FRAME_DEVICE (XFRAME (f))
|
|
84 #define XFRAME_XDEVICE(f) XDEVICE (XFRAME_DEVICE (f))
|
|
85 #define XFRAME_CONSOLE(f) XDEVICE_CONSOLE (XFRAME_DEVICE (f))
|
|
86 #define XFRAME_XCONSOLE(f) XCONSOLE (XFRAME_CONSOLE (f))
|
|
87
|
428
|
88 #define CHECK_LIVE_FRAME(x) do { \
|
|
89 CHECK_FRAME (x); \
|
|
90 if (! FRAME_LIVE_P (XFRAME (x))) \
|
|
91 dead_wrong_type_argument (Qframe_live_p, (x)); \
|
|
92 } while (0)
|
|
93 #define CONCHECK_LIVE_FRAME(x) do { \
|
|
94 CONCHECK_FRAME (x); \
|
|
95 if (! FRAME_LIVE_P (XFRAME (x))) \
|
|
96 x = wrong_type_argument (Qframe_live_p, (x)); \
|
|
97 } while (0)
|
|
98
|
|
99 #define FW_FRAME(obj) \
|
|
100 (WINDOWP (obj) ? WINDOW_FRAME (XWINDOW (obj)) \
|
442
|
101 : (FRAMEP (obj) ? obj \
|
|
102 : Qnil))
|
428
|
103
|
|
104 /* Equivalent in FSF Emacs:
|
|
105
|
|
106 FOR_EACH_FRAME (LIST_VAR, FRAME_VAR) followed by a statement is a
|
|
107 `for' loop which iterates over the elements of Vframe_list. The
|
|
108 loop will set FRAME_VAR, a Lisp_Object, to each frame in
|
|
109 Vframe_list in succession and execute the statement. LIST_VAR
|
|
110 should be a Lisp_Object too; it is used to iterate through the
|
|
111 Vframe_list.
|
|
112 */
|
|
113
|
|
114 /* NO_BREAK means that "break" doesn't do what you think it does!
|
|
115 Use goto instead. "continue" is OK, though. */
|
|
116 #define FRAME_LOOP_NO_BREAK(frmcons, devcons, concons) \
|
|
117 DEVICE_LOOP_NO_BREAK (devcons, concons) \
|
|
118 DEVICE_FRAME_LOOP (frmcons, XDEVICE (XCAR (devcons)))
|
|
119
|
|
120 void update_frame_title (struct frame *f);
|
444
|
121 Lisp_Object next_frame (Lisp_Object, Lisp_Object, Lisp_Object);
|
|
122 Lisp_Object previous_frame (Lisp_Object, Lisp_Object, Lisp_Object);
|
428
|
123 void pixel_to_char_size (struct frame *f, int pixel_width, int pixel_height,
|
|
124 int *char_width, int *char_height);
|
|
125 void char_to_pixel_size (struct frame *f, int char_width, int char_height,
|
|
126 int *pixel_width, int *pixel_height);
|
|
127 void round_size_to_char (struct frame *f, int in_width, int in_height,
|
|
128 int *out_width, int *out_height);
|
|
129 void pixel_to_real_char_size (struct frame *f, int pixel_width, int pixel_height,
|
|
130 int *char_width, int *char_height);
|
|
131 void char_to_real_pixel_size (struct frame *f, int char_width, int char_height,
|
|
132 int *pixel_width, int *pixel_height);
|
|
133 void round_size_to_real_char (struct frame *f, int in_width, int in_height,
|
|
134 int *out_width, int *out_height);
|
|
135 void change_frame_size (struct frame *frame,
|
|
136 int newlength, int newwidth,
|
|
137 int delay);
|
|
138 void adjust_frame_size (struct frame *frame);
|
|
139 void frame_size_slipped (Lisp_Object specifier, struct frame *f,
|
|
140 Lisp_Object oldval);
|
853
|
141 int enter_redisplay_critical_section (void);
|
|
142 void exit_redisplay_critical_section (int);
|
428
|
143 void select_frame_1 (Lisp_Object frame);
|
|
144 void select_frame_2 (Lisp_Object frame);
|
|
145 struct frame *selected_frame (void);
|
|
146 struct frame *device_selected_frame (struct device *d);
|
|
147 struct frame *decode_frame (Lisp_Object frame);
|
|
148 struct frame *decode_frame_or_selected (Lisp_Object cdf);
|
|
149 Lisp_Object make_frame (struct frame *f);
|
|
150 int other_visible_frames (struct frame *f);
|
|
151 void delete_frame_internal (struct frame *f, int force,
|
|
152 int called_from_delete_device,
|
|
153 int from_io_error);
|
|
154 void io_error_delete_frame (Lisp_Object frame);
|
|
155 Lisp_Object find_some_frame (int (*predicate) (Lisp_Object, void *),
|
|
156 void *closure);
|
444
|
157 int device_matches_device_spec (Lisp_Object device, Lisp_Object device_spec);
|
428
|
158 Lisp_Object frame_first_window (struct frame *f);
|
|
159 int show_gc_cursor (struct frame *f, Lisp_Object cursor);
|
|
160 void set_frame_selected_window (struct frame *f, Lisp_Object window);
|
|
161 int is_surrogate_for_selected_frame (struct frame *f);
|
|
162 void update_frame_icon (struct frame *f);
|
|
163 void invalidate_vertical_divider_cache_in_frame (struct frame *f);
|
|
164
|
438
|
165 void init_frame (void);
|
|
166
|
440
|
167 #endif /* INCLUDED_frame_h_ */
|