1 /* GTK - The GTK+ Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
31 #ifndef __GTK_WINDOW_H__
32 #define __GTK_WINDOW_H__
35 #include <gtk/gtkaccelgroup.h>
36 #include <gtk/gtkbin.h>
37 #include <gtk/gtkenums.h>
41 #define GTK_TYPE_WINDOW (gtk_window_get_type ())
42 #define GTK_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
43 #define GTK_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
44 #define GTK_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_WINDOW))
45 #define GTK_IS_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
46 #define GTK_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW, GtkWindowClass))
49 typedef struct _GtkWindowClass GtkWindowClass;
50 typedef struct _GtkWindowGeometryInfo GtkWindowGeometryInfo;
51 typedef struct _GtkWindowGroup GtkWindowGroup;
52 typedef struct _GtkWindowGroupClass GtkWindowGroupClass;
59 gchar *GSEAL (wmclass_name);
60 gchar *GSEAL (wmclass_class);
61 gchar *GSEAL (wm_role);
63 GtkWidget *GSEAL (focus_widget);
64 GtkWidget *GSEAL (default_widget);
65 GtkWindow *GSEAL (transient_parent);
66 GtkWindowGeometryInfo *GSEAL (geometry_info);
67 GdkWindow *GSEAL (frame);
68 GtkWindowGroup *GSEAL (group);
70 guint16 GSEAL (configure_request_count);
71 guint GSEAL (allow_shrink) : 1;
72 guint GSEAL (allow_grow) : 1;
73 guint GSEAL (configure_notify_received) : 1;
74 /* The following flags are initially TRUE (before a window is mapped).
75 * They cause us to compute a configure request that involves
76 * default-only parameters. Once mapped, we set them to FALSE.
77 * Then we set them to TRUE again on unmap (for position)
78 * and on unrealize (for size).
80 guint GSEAL (need_default_position) : 1;
81 guint GSEAL (need_default_size) : 1;
82 guint GSEAL (position) : 3;
83 guint GSEAL (type) : 4; /* GtkWindowType */
84 guint GSEAL (has_user_ref_count) : 1;
85 guint GSEAL (has_focus) : 1;
87 guint GSEAL (modal) : 1;
88 guint GSEAL (destroy_with_parent) : 1;
90 guint GSEAL (has_frame) : 1;
92 /* gtk_window_iconify() called before realization */
93 guint GSEAL (iconify_initially) : 1;
94 guint GSEAL (stick_initially) : 1;
95 guint GSEAL (maximize_initially) : 1;
96 guint GSEAL (decorated) : 1;
98 guint GSEAL (type_hint) : 3; /* GdkWindowTypeHint if the hint is one of the original eight. If not, then
99 * it contains GDK_WINDOW_TYPE_HINT_NORMAL
101 guint GSEAL (gravity) : 5; /* GdkGravity */
103 guint GSEAL (is_active) : 1;
104 guint GSEAL (has_toplevel_focus) : 1;
106 guint GSEAL (frame_left);
107 guint GSEAL (frame_top);
108 guint GSEAL (frame_right);
109 guint GSEAL (frame_bottom);
111 guint GSEAL (keys_changed_handler);
113 GdkModifierType GSEAL (mnemonic_modifier);
114 GdkScreen *GSEAL (screen);
117 struct _GtkWindowClass
119 GtkBinClass parent_class;
121 void (* set_focus) (GtkWindow *window,
123 gboolean (* frame_event) (GtkWindow *window,
126 /* G_SIGNAL_ACTION signals for keybindings */
128 void (* activate_focus) (GtkWindow *window);
129 void (* activate_default) (GtkWindow *window);
131 /* as of GTK+ 2.12 the "move-focus" signal has been moved to GtkWidget,
132 * so this is merley a virtual function now. Overriding it in subclasses
133 * continues to work though.
135 void (* move_focus) (GtkWindow *window,
136 GtkDirectionType direction);
138 void (*keys_changed) (GtkWindow *window);
140 /* Padding for future expansion */
141 void (*_gtk_reserved1) (void);
142 void (*_gtk_reserved2) (void);
143 void (*_gtk_reserved3) (void);
144 void (*_gtk_reserved4) (void);
147 #define GTK_TYPE_WINDOW_GROUP (gtk_window_group_get_type ())
148 #define GTK_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
149 #define GTK_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
150 #define GTK_IS_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
151 #define GTK_IS_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
152 #define GTK_WINDOW_GROUP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
154 struct _GtkWindowGroup
156 GObject parent_instance;
158 GSList *GSEAL (grabs);
161 struct _GtkWindowGroupClass
163 GObjectClass parent_class;
165 /* Padding for future expansion */
166 void (*_gtk_reserved1) (void);
167 void (*_gtk_reserved2) (void);
168 void (*_gtk_reserved3) (void);
169 void (*_gtk_reserved4) (void);
173 /* Reserve old names for DLL ABI backward compatibility */
174 #define gtk_window_set_icon_from_file gtk_window_set_icon_from_file_utf8
175 #define gtk_window_set_default_icon_from_file gtk_window_set_default_icon_from_file_utf8
178 GType gtk_window_get_type (void) G_GNUC_CONST;
179 GtkWidget* gtk_window_new (GtkWindowType type);
180 void gtk_window_set_title (GtkWindow *window,
182 G_CONST_RETURN gchar *gtk_window_get_title (GtkWindow *window);
183 void gtk_window_set_wmclass (GtkWindow *window,
184 const gchar *wmclass_name,
185 const gchar *wmclass_class);
186 void gtk_window_set_role (GtkWindow *window,
188 void gtk_window_set_startup_id (GtkWindow *window,
189 const gchar *startup_id);
190 G_CONST_RETURN gchar *gtk_window_get_role (GtkWindow *window);
191 void gtk_window_add_accel_group (GtkWindow *window,
192 GtkAccelGroup *accel_group);
193 void gtk_window_remove_accel_group (GtkWindow *window,
194 GtkAccelGroup *accel_group);
195 void gtk_window_set_position (GtkWindow *window,
196 GtkWindowPosition position);
197 gboolean gtk_window_activate_focus (GtkWindow *window);
198 void gtk_window_set_focus (GtkWindow *window,
200 GtkWidget *gtk_window_get_focus (GtkWindow *window);
201 void gtk_window_set_default (GtkWindow *window,
202 GtkWidget *default_widget);
203 GtkWidget *gtk_window_get_default (GtkWindow *window);
204 gboolean gtk_window_activate_default (GtkWindow *window);
206 void gtk_window_set_transient_for (GtkWindow *window,
208 GtkWindow *gtk_window_get_transient_for (GtkWindow *window);
209 void gtk_window_set_opacity (GtkWindow *window,
211 gdouble gtk_window_get_opacity (GtkWindow *window);
212 void gtk_window_set_type_hint (GtkWindow *window,
213 GdkWindowTypeHint hint);
214 GdkWindowTypeHint gtk_window_get_type_hint (GtkWindow *window);
215 void gtk_window_set_skip_taskbar_hint (GtkWindow *window,
217 gboolean gtk_window_get_skip_taskbar_hint (GtkWindow *window);
218 void gtk_window_set_skip_pager_hint (GtkWindow *window,
220 gboolean gtk_window_get_skip_pager_hint (GtkWindow *window);
221 void gtk_window_set_urgency_hint (GtkWindow *window,
223 gboolean gtk_window_get_urgency_hint (GtkWindow *window);
224 void gtk_window_set_accept_focus (GtkWindow *window,
226 gboolean gtk_window_get_accept_focus (GtkWindow *window);
227 void gtk_window_set_focus_on_map (GtkWindow *window,
229 gboolean gtk_window_get_focus_on_map (GtkWindow *window);
230 void gtk_window_set_destroy_with_parent (GtkWindow *window,
232 gboolean gtk_window_get_destroy_with_parent (GtkWindow *window);
234 void gtk_window_set_resizable (GtkWindow *window,
236 gboolean gtk_window_get_resizable (GtkWindow *window);
238 void gtk_window_set_gravity (GtkWindow *window,
240 GdkGravity gtk_window_get_gravity (GtkWindow *window);
243 void gtk_window_set_geometry_hints (GtkWindow *window,
244 GtkWidget *geometry_widget,
245 GdkGeometry *geometry,
246 GdkWindowHints geom_mask);
248 void gtk_window_set_screen (GtkWindow *window,
250 GdkScreen* gtk_window_get_screen (GtkWindow *window);
252 gboolean gtk_window_is_active (GtkWindow *window);
253 gboolean gtk_window_has_toplevel_focus (GtkWindow *window);
257 /* gtk_window_set_has_frame () must be called before realizing the window_*/
258 void gtk_window_set_has_frame (GtkWindow *window,
260 gboolean gtk_window_get_has_frame (GtkWindow *window);
261 void gtk_window_set_frame_dimensions (GtkWindow *window,
266 void gtk_window_get_frame_dimensions (GtkWindow *window,
271 void gtk_window_set_decorated (GtkWindow *window,
273 gboolean gtk_window_get_decorated (GtkWindow *window);
274 void gtk_window_set_deletable (GtkWindow *window,
276 gboolean gtk_window_get_deletable (GtkWindow *window);
278 void gtk_window_set_icon_list (GtkWindow *window,
280 GList* gtk_window_get_icon_list (GtkWindow *window);
281 void gtk_window_set_icon (GtkWindow *window,
283 void gtk_window_set_icon_name (GtkWindow *window,
285 gboolean gtk_window_set_icon_from_file (GtkWindow *window,
286 const gchar *filename,
288 GdkPixbuf* gtk_window_get_icon (GtkWindow *window);
290 gchar *gtk_window_get_icon_name (GtkWindow *window);
291 void gtk_window_set_default_icon_list (GList *list);
292 GList* gtk_window_get_default_icon_list (void);
293 void gtk_window_set_default_icon (GdkPixbuf *icon);
294 void gtk_window_set_default_icon_name (const gchar *name);
295 gboolean gtk_window_set_default_icon_from_file (const gchar *filename,
298 void gtk_window_set_auto_startup_notification (gboolean setting);
300 /* If window is set modal, input will be grabbed when show and released when hide */
301 void gtk_window_set_modal (GtkWindow *window,
303 gboolean gtk_window_get_modal (GtkWindow *window);
304 GList* gtk_window_list_toplevels (void);
306 void gtk_window_add_mnemonic (GtkWindow *window,
309 void gtk_window_remove_mnemonic (GtkWindow *window,
312 gboolean gtk_window_mnemonic_activate (GtkWindow *window,
314 GdkModifierType modifier);
315 void gtk_window_set_mnemonic_modifier (GtkWindow *window,
316 GdkModifierType modifier);
317 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
319 gboolean gtk_window_activate_key (GtkWindow *window,
321 gboolean gtk_window_propagate_key_event (GtkWindow *window,
324 void gtk_window_present (GtkWindow *window);
325 void gtk_window_present_with_time (GtkWindow *window,
327 void gtk_window_iconify (GtkWindow *window);
328 void gtk_window_deiconify (GtkWindow *window);
329 void gtk_window_stick (GtkWindow *window);
330 void gtk_window_unstick (GtkWindow *window);
331 void gtk_window_maximize (GtkWindow *window);
332 void gtk_window_unmaximize (GtkWindow *window);
333 void gtk_window_fullscreen (GtkWindow *window);
334 void gtk_window_unfullscreen (GtkWindow *window);
335 void gtk_window_set_keep_above (GtkWindow *window, gboolean setting);
336 void gtk_window_set_keep_below (GtkWindow *window, gboolean setting);
338 void gtk_window_begin_resize_drag (GtkWindow *window,
344 void gtk_window_begin_move_drag (GtkWindow *window,
350 #ifndef GTK_DISABLE_DEPRECATED
351 void gtk_window_set_policy (GtkWindow *window,
355 #define gtk_window_position gtk_window_set_position
356 #endif /* GTK_DISABLE_DEPRECATED */
358 /* Set initial default size of the window (does not constrain user
361 void gtk_window_set_default_size (GtkWindow *window,
364 void gtk_window_get_default_size (GtkWindow *window,
367 void gtk_window_resize (GtkWindow *window,
370 void gtk_window_get_size (GtkWindow *window,
373 void gtk_window_move (GtkWindow *window,
376 void gtk_window_get_position (GtkWindow *window,
379 gboolean gtk_window_parse_geometry (GtkWindow *window,
380 const gchar *geometry);
381 GtkWindowGroup *gtk_window_get_group (GtkWindow *window);
383 /* Ignore this unless you are writing a GUI builder */
384 void gtk_window_reshow_with_initial_size (GtkWindow *window);
388 GType gtk_window_group_get_type (void) G_GNUC_CONST;
390 GtkWindowGroup * gtk_window_group_new (void);
391 void gtk_window_group_add_window (GtkWindowGroup *window_group,
393 void gtk_window_group_remove_window (GtkWindowGroup *window_group,
395 GList * gtk_window_group_list_windows (GtkWindowGroup *window_group);
398 /* --- internal functions --- */
399 void _gtk_window_internal_set_focus (GtkWindow *window,
401 void gtk_window_remove_embedded_xid (GtkWindow *window,
403 void gtk_window_add_embedded_xid (GtkWindow *window,
405 void _gtk_window_reposition (GtkWindow *window,
408 void _gtk_window_constrain_size (GtkWindow *window,
413 GtkWidget *_gtk_window_group_get_current_grab (GtkWindowGroup *window_group);
415 void _gtk_window_set_has_toplevel_focus (GtkWindow *window,
416 gboolean has_toplevel_focus);
417 void _gtk_window_unset_focus_and_default (GtkWindow *window,
420 void _gtk_window_set_is_active (GtkWindow *window,
423 typedef void (*GtkWindowKeysForeachFunc) (GtkWindow *window,
425 GdkModifierType modifiers,
426 gboolean is_mnemonic,
429 void _gtk_window_keys_foreach (GtkWindow *window,
430 GtkWindowKeysForeachFunc func,
433 /* --- internal (GtkAcceleratable) --- */
434 gboolean _gtk_window_query_nonaccels (GtkWindow *window,
436 GdkModifierType accel_mods);
440 #endif /* __GTK_WINDOW_H__ */