1 /* GTK - The GIMP 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_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>
38 #include "gtk/gtkaccelgroupprivate.h"
43 #define GTK_TYPE_WINDOW (gtk_window_get_type ())
44 #define GTK_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
45 #define GTK_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
46 #define GTK_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_WINDOW))
47 #define GTK_IS_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
48 #define GTK_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW, GtkWindowClass))
51 typedef struct _GtkWindowClass GtkWindowClass;
52 typedef struct _GtkWindowGeometryInfo GtkWindowGeometryInfo;
53 typedef struct _GtkWindowGroup GtkWindowGroup;
54 typedef struct _GtkWindowGroupClass GtkWindowGroupClass;
61 gchar *GSEAL (wmclass_name);
62 gchar *GSEAL (wmclass_class);
63 gchar *GSEAL (wm_role);
65 GtkWidget *GSEAL (focus_widget);
66 GtkWidget *GSEAL (default_widget);
67 GtkWindow *GSEAL (transient_parent);
68 GtkWindowGeometryInfo *GSEAL (geometry_info);
69 GdkWindow *GSEAL (frame);
70 GtkWindowGroup *GSEAL (group);
72 guint16 GSEAL (configure_request_count);
73 guint GSEAL (allow_shrink) : 1;
74 guint GSEAL (allow_grow) : 1;
75 guint GSEAL (configure_notify_received) : 1;
76 /* The following flags are initially TRUE (before a window is mapped).
77 * They cause us to compute a configure request that involves
78 * default-only parameters. Once mapped, we set them to FALSE.
79 * Then we set them to TRUE again on unmap (for position)
80 * and on unrealize (for size).
82 guint GSEAL (need_default_position) : 1;
83 guint GSEAL (need_default_size) : 1;
84 guint GSEAL (position) : 3;
85 guint GSEAL (type) : 4; /* GtkWindowType */
86 guint GSEAL (has_user_ref_count) : 1;
87 guint GSEAL (has_focus) : 1;
89 guint GSEAL (modal) : 1;
90 guint GSEAL (destroy_with_parent) : 1;
92 guint GSEAL (has_frame) : 1;
94 /* gtk_window_iconify() called before realization */
95 guint GSEAL (iconify_initially) : 1;
96 guint GSEAL (stick_initially) : 1;
97 guint GSEAL (maximize_initially) : 1;
98 guint GSEAL (decorated) : 1;
100 guint GSEAL (type_hint) : 3; /* GdkWindowTypeHint if the hint is one of the original eight. If not, then
101 * it contains GDK_WINDOW_TYPE_HINT_NORMAL
103 guint GSEAL (gravity) : 5; /* GdkGravity */
105 guint GSEAL (is_active) : 1;
106 guint GSEAL (has_toplevel_focus) : 1;
108 guint GSEAL (frame_left);
109 guint GSEAL (frame_top);
110 guint GSEAL (frame_right);
111 guint GSEAL (frame_bottom);
113 guint GSEAL (keys_changed_handler);
115 GdkModifierType GSEAL (mnemonic_modifier);
116 GdkScreen *GSEAL (screen);
119 struct _GtkWindowClass
121 GtkBinClass parent_class;
123 void (* set_focus) (GtkWindow *window,
125 gboolean (* frame_event) (GtkWindow *window,
128 /* G_SIGNAL_ACTION signals for keybindings */
130 void (* activate_focus) (GtkWindow *window);
131 void (* activate_default) (GtkWindow *window);
133 /* as of GTK+ 2.12 the "move-focus" signal has been moved to GtkWidget,
134 * so this is merley a virtual function now. Overriding it in subclasses
135 * continues to work though.
137 void (* move_focus) (GtkWindow *window,
138 GtkDirectionType direction);
140 void (*keys_changed) (GtkWindow *window);
142 /* Padding for future expansion */
143 void (*_gtk_reserved1) (void);
144 void (*_gtk_reserved2) (void);
145 void (*_gtk_reserved3) (void);
146 void (*_gtk_reserved4) (void);
149 #define GTK_TYPE_WINDOW_GROUP (gtk_window_group_get_type ())
150 #define GTK_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
151 #define GTK_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
152 #define GTK_IS_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
153 #define GTK_IS_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
154 #define GTK_WINDOW_GROUP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
156 struct _GtkWindowGroup
158 GObject parent_instance;
160 GSList *GSEAL (grabs);
163 struct _GtkWindowGroupClass
165 GObjectClass parent_class;
167 /* Padding for future expansion */
168 void (*_gtk_reserved1) (void);
169 void (*_gtk_reserved2) (void);
170 void (*_gtk_reserved3) (void);
171 void (*_gtk_reserved4) (void);
175 /* Reserve old names for DLL ABI backward compatibility */
176 #define gtk_window_set_icon_from_file gtk_window_set_icon_from_file_utf8
177 #define gtk_window_set_default_icon_from_file gtk_window_set_default_icon_from_file_utf8
180 GType gtk_window_get_type (void) G_GNUC_CONST;
181 GtkWidget* gtk_window_new (GtkWindowType type);
182 void gtk_window_set_title (GtkWindow *window,
184 G_CONST_RETURN gchar *gtk_window_get_title (GtkWindow *window);
185 void gtk_window_set_wmclass (GtkWindow *window,
186 const gchar *wmclass_name,
187 const gchar *wmclass_class);
188 void gtk_window_set_role (GtkWindow *window,
190 void gtk_window_set_startup_id (GtkWindow *window,
191 const gchar *startup_id);
192 G_CONST_RETURN gchar *gtk_window_get_role (GtkWindow *window);
193 void gtk_window_add_accel_group (GtkWindow *window,
194 GtkAccelGroup *accel_group);
195 void gtk_window_remove_accel_group (GtkWindow *window,
196 GtkAccelGroup *accel_group);
197 void gtk_window_set_position (GtkWindow *window,
198 GtkWindowPosition position);
199 gboolean gtk_window_activate_focus (GtkWindow *window);
200 void gtk_window_set_focus (GtkWindow *window,
202 GtkWidget *gtk_window_get_focus (GtkWindow *window);
203 void gtk_window_set_default (GtkWindow *window,
204 GtkWidget *default_widget);
205 GtkWidget *gtk_window_get_default_widget (GtkWindow *window);
206 gboolean gtk_window_activate_default (GtkWindow *window);
208 void gtk_window_set_transient_for (GtkWindow *window,
210 GtkWindow *gtk_window_get_transient_for (GtkWindow *window);
211 void gtk_window_set_opacity (GtkWindow *window,
213 gdouble gtk_window_get_opacity (GtkWindow *window);
214 void gtk_window_set_type_hint (GtkWindow *window,
215 GdkWindowTypeHint hint);
216 GdkWindowTypeHint gtk_window_get_type_hint (GtkWindow *window);
217 void gtk_window_set_skip_taskbar_hint (GtkWindow *window,
219 gboolean gtk_window_get_skip_taskbar_hint (GtkWindow *window);
220 void gtk_window_set_skip_pager_hint (GtkWindow *window,
222 gboolean gtk_window_get_skip_pager_hint (GtkWindow *window);
223 void gtk_window_set_urgency_hint (GtkWindow *window,
225 gboolean gtk_window_get_urgency_hint (GtkWindow *window);
226 void gtk_window_set_accept_focus (GtkWindow *window,
228 gboolean gtk_window_get_accept_focus (GtkWindow *window);
229 void gtk_window_set_focus_on_map (GtkWindow *window,
231 gboolean gtk_window_get_focus_on_map (GtkWindow *window);
232 void gtk_window_set_destroy_with_parent (GtkWindow *window,
234 gboolean gtk_window_get_destroy_with_parent (GtkWindow *window);
235 void gtk_window_set_mnemonics_visible (GtkWindow *window,
237 gboolean gtk_window_get_mnemonics_visible (GtkWindow *window);
239 void gtk_window_set_resizable (GtkWindow *window,
241 gboolean gtk_window_get_resizable (GtkWindow *window);
243 void gtk_window_set_gravity (GtkWindow *window,
245 GdkGravity gtk_window_get_gravity (GtkWindow *window);
248 void gtk_window_set_geometry_hints (GtkWindow *window,
249 GtkWidget *geometry_widget,
250 GdkGeometry *geometry,
251 GdkWindowHints geom_mask);
253 void gtk_window_set_screen (GtkWindow *window,
255 GdkScreen* gtk_window_get_screen (GtkWindow *window);
257 gboolean gtk_window_is_active (GtkWindow *window);
258 gboolean gtk_window_has_toplevel_focus (GtkWindow *window);
262 /* gtk_window_set_has_frame () must be called before realizing the window_*/
263 void gtk_window_set_has_frame (GtkWindow *window,
265 gboolean gtk_window_get_has_frame (GtkWindow *window);
266 void gtk_window_set_frame_dimensions (GtkWindow *window,
271 void gtk_window_get_frame_dimensions (GtkWindow *window,
276 void gtk_window_set_decorated (GtkWindow *window,
278 gboolean gtk_window_get_decorated (GtkWindow *window);
279 void gtk_window_set_deletable (GtkWindow *window,
281 gboolean gtk_window_get_deletable (GtkWindow *window);
283 void gtk_window_set_icon_list (GtkWindow *window,
285 GList* gtk_window_get_icon_list (GtkWindow *window);
286 void gtk_window_set_icon (GtkWindow *window,
288 void gtk_window_set_icon_name (GtkWindow *window,
290 gboolean gtk_window_set_icon_from_file (GtkWindow *window,
291 const gchar *filename,
293 GdkPixbuf* gtk_window_get_icon (GtkWindow *window);
295 gchar *gtk_window_get_icon_name (GtkWindow *window);
296 void gtk_window_set_default_icon_list (GList *list);
297 GList* gtk_window_get_default_icon_list (void);
298 void gtk_window_set_default_icon (GdkPixbuf *icon);
299 void gtk_window_set_default_icon_name (const gchar *name);
301 gchar *gtk_window_get_default_icon_name (void);
302 gboolean gtk_window_set_default_icon_from_file (const gchar *filename,
305 void gtk_window_set_auto_startup_notification (gboolean setting);
307 /* If window is set modal, input will be grabbed when show and released when hide */
308 void gtk_window_set_modal (GtkWindow *window,
310 gboolean gtk_window_get_modal (GtkWindow *window);
311 GList* gtk_window_list_toplevels (void);
313 void gtk_window_add_mnemonic (GtkWindow *window,
316 void gtk_window_remove_mnemonic (GtkWindow *window,
319 gboolean gtk_window_mnemonic_activate (GtkWindow *window,
321 GdkModifierType modifier);
322 void gtk_window_set_mnemonic_modifier (GtkWindow *window,
323 GdkModifierType modifier);
324 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
326 gboolean gtk_window_activate_key (GtkWindow *window,
328 gboolean gtk_window_propagate_key_event (GtkWindow *window,
331 void gtk_window_present (GtkWindow *window);
332 void gtk_window_present_with_time (GtkWindow *window,
334 void gtk_window_iconify (GtkWindow *window);
335 void gtk_window_deiconify (GtkWindow *window);
336 void gtk_window_stick (GtkWindow *window);
337 void gtk_window_unstick (GtkWindow *window);
338 void gtk_window_maximize (GtkWindow *window);
339 void gtk_window_unmaximize (GtkWindow *window);
340 void gtk_window_fullscreen (GtkWindow *window);
341 void gtk_window_unfullscreen (GtkWindow *window);
342 void gtk_window_set_keep_above (GtkWindow *window, gboolean setting);
343 void gtk_window_set_keep_below (GtkWindow *window, gboolean setting);
345 void gtk_window_begin_resize_drag (GtkWindow *window,
351 void gtk_window_begin_move_drag (GtkWindow *window,
357 /* Set initial default size of the window (does not constrain user
360 void gtk_window_set_default_size (GtkWindow *window,
363 void gtk_window_get_default_size (GtkWindow *window,
366 void gtk_window_resize (GtkWindow *window,
369 void gtk_window_get_size (GtkWindow *window,
372 void gtk_window_move (GtkWindow *window,
375 void gtk_window_get_position (GtkWindow *window,
378 gboolean gtk_window_parse_geometry (GtkWindow *window,
379 const gchar *geometry);
380 GtkWindowGroup *gtk_window_get_group (GtkWindow *window);
381 gboolean gtk_window_has_group (GtkWindow *window);
383 /* Ignore this unless you are writing a GUI builder */
384 void gtk_window_reshow_with_initial_size (GtkWindow *window);
386 GtkWindowType gtk_window_get_window_type (GtkWindow *window);
390 GType gtk_window_group_get_type (void) G_GNUC_CONST;
392 GtkWindowGroup * gtk_window_group_new (void);
393 void gtk_window_group_add_window (GtkWindowGroup *window_group,
395 void gtk_window_group_remove_window (GtkWindowGroup *window_group,
397 GList * gtk_window_group_list_windows (GtkWindowGroup *window_group);
399 GtkWidget * gtk_window_group_get_current_device_grab (GtkWindowGroup *window_group,
403 /* --- internal functions --- */
404 void _gtk_window_internal_set_focus (GtkWindow *window,
406 void gtk_window_remove_embedded_xid (GtkWindow *window,
407 GdkNativeWindow xid);
408 void gtk_window_add_embedded_xid (GtkWindow *window,
409 GdkNativeWindow xid);
410 void _gtk_window_reposition (GtkWindow *window,
413 void _gtk_window_constrain_size (GtkWindow *window,
418 GtkWidget *_gtk_window_group_get_current_grab (GtkWindowGroup *window_group);
419 void _gtk_window_group_add_device_grab (GtkWindowGroup *window_group,
422 gboolean block_others);
423 void _gtk_window_group_remove_device_grab (GtkWindowGroup *window_group,
427 gboolean _gtk_window_group_widget_is_blocked_for_device (GtkWindowGroup *window_group,
431 void _gtk_window_set_has_toplevel_focus (GtkWindow *window,
432 gboolean has_toplevel_focus);
433 void _gtk_window_unset_focus_and_default (GtkWindow *window,
436 void _gtk_window_set_is_active (GtkWindow *window,
439 void _gtk_window_set_is_toplevel (GtkWindow *window,
440 gboolean is_toplevel);
442 typedef void (*GtkWindowKeysForeachFunc) (GtkWindow *window,
444 GdkModifierType modifiers,
445 gboolean is_mnemonic,
448 void _gtk_window_keys_foreach (GtkWindow *window,
449 GtkWindowKeysForeachFunc func,
452 /* --- internal (GtkAcceleratable) --- */
453 gboolean _gtk_window_query_nonaccels (GtkWindow *window,
455 GdkModifierType accel_mods);
459 #endif /* __GTK_WINDOW_H__ */