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 #ifndef __GTK_WINDOW_H__
28 #define __GTK_WINDOW_H__
32 #include <gtk/gtkaccelgroup.h>
33 #include <gtk/gtkbin.h>
34 #include <gtk/gtkenums.h>
35 #include <gtk/gtkwidget.h>
39 #define GTK_TYPE_WINDOW (gtk_window_get_type ())
40 #define GTK_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
41 #define GTK_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
42 #define GTK_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_WINDOW))
43 #define GTK_IS_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
44 #define GTK_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW, GtkWindowClass))
47 typedef struct _GtkWindowClass GtkWindowClass;
48 typedef struct _GtkWindowGeometryInfo GtkWindowGeometryInfo;
49 typedef struct _GtkWindowGroup GtkWindowGroup;
50 typedef struct _GtkWindowGroupClass GtkWindowGroupClass;
61 GtkWidget *focus_widget;
62 GtkWidget *default_widget;
63 GtkWindow *transient_parent;
64 GtkWindowGeometryInfo *geometry_info;
66 GtkWindowGroup *group;
68 guint16 configure_request_count;
69 guint allow_shrink : 1;
71 guint configure_notify_received : 1;
72 /* The following flags are initially TRUE (before a window is mapped).
73 * They cause us to compute a configure request that involves
74 * default-only parameters. Once mapped, we set them to FALSE.
75 * Then we set them to TRUE again on unmap (for position)
76 * and on unrealize (for size).
78 guint need_default_position : 1;
79 guint need_default_size : 1;
81 guint type : 4; /* GtkWindowType */
82 guint has_user_ref_count : 1;
86 guint destroy_with_parent : 1;
90 /* gtk_window_iconify() called before realization */
91 guint iconify_initially : 1;
92 guint stick_initially : 1;
93 guint maximize_initially : 1;
96 guint type_hint : 3; /* GdkWindowTypeHint if the hint is one of the original eight. If not, then
97 * it contains GDK_WINDOW_TYPE_HINT_NORMAL
99 guint gravity : 5; /* GdkGravity */
102 guint has_toplevel_focus : 1;
109 guint keys_changed_handler;
111 GdkModifierType mnemonic_modifier;
115 struct _GtkWindowClass
117 GtkBinClass parent_class;
119 void (* set_focus) (GtkWindow *window,
121 gboolean (* frame_event) (GtkWindow *window,
124 /* G_SIGNAL_ACTION signals for keybindings */
126 void (* activate_focus) (GtkWindow *window);
127 void (* activate_default) (GtkWindow *window);
128 void (* move_focus) (GtkWindow *window,
129 GtkDirectionType direction);
131 void (*keys_changed) (GtkWindow *window);
133 /* Padding for future expansion */
134 void (*_gtk_reserved1) (void);
135 void (*_gtk_reserved2) (void);
136 void (*_gtk_reserved3) (void);
137 void (*_gtk_reserved4) (void);
140 #define GTK_TYPE_WINDOW_GROUP (gtk_window_group_get_type ())
141 #define GTK_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
142 #define GTK_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
143 #define GTK_IS_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
144 #define GTK_IS_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
145 #define GTK_WINDOW_GROUP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
147 struct _GtkWindowGroup
149 GObject parent_instance;
154 struct _GtkWindowGroupClass
156 GObjectClass parent_class;
158 /* Padding for future expansion */
159 void (*_gtk_reserved1) (void);
160 void (*_gtk_reserved2) (void);
161 void (*_gtk_reserved3) (void);
162 void (*_gtk_reserved4) (void);
166 /* Reserve old names for DLL ABI backward compatibility */
167 #define gtk_window_set_icon_from_file gtk_window_set_icon_from_file_utf8
168 #define gtk_window_set_default_icon_from_file gtk_window_set_default_icon_from_file_utf8
171 GType gtk_window_get_type (void) G_GNUC_CONST;
172 GtkWidget* gtk_window_new (GtkWindowType type);
173 void gtk_window_set_title (GtkWindow *window,
175 G_CONST_RETURN gchar *gtk_window_get_title (GtkWindow *window);
176 void gtk_window_set_wmclass (GtkWindow *window,
177 const gchar *wmclass_name,
178 const gchar *wmclass_class);
179 void gtk_window_set_role (GtkWindow *window,
181 G_CONST_RETURN gchar *gtk_window_get_role (GtkWindow *window);
182 void gtk_window_add_accel_group (GtkWindow *window,
183 GtkAccelGroup *accel_group);
184 void gtk_window_remove_accel_group (GtkWindow *window,
185 GtkAccelGroup *accel_group);
186 void gtk_window_set_position (GtkWindow *window,
187 GtkWindowPosition position);
188 gboolean gtk_window_activate_focus (GtkWindow *window);
189 void gtk_window_set_focus (GtkWindow *window,
191 GtkWidget *gtk_window_get_focus (GtkWindow *window);
192 void gtk_window_set_default (GtkWindow *window,
193 GtkWidget *default_widget);
194 gboolean gtk_window_activate_default (GtkWindow *window);
196 void gtk_window_set_transient_for (GtkWindow *window,
198 GtkWindow *gtk_window_get_transient_for (GtkWindow *window);
199 void gtk_window_set_type_hint (GtkWindow *window,
200 GdkWindowTypeHint hint);
201 GdkWindowTypeHint gtk_window_get_type_hint (GtkWindow *window);
202 void gtk_window_set_skip_taskbar_hint (GtkWindow *window,
204 gboolean gtk_window_get_skip_taskbar_hint (GtkWindow *window);
205 void gtk_window_set_skip_pager_hint (GtkWindow *window,
207 gboolean gtk_window_get_skip_pager_hint (GtkWindow *window);
208 void gtk_window_set_urgency_hint (GtkWindow *window,
210 gboolean gtk_window_get_urgency_hint (GtkWindow *window);
211 void gtk_window_set_accept_focus (GtkWindow *window,
213 gboolean gtk_window_get_accept_focus (GtkWindow *window);
214 void gtk_window_set_focus_on_map (GtkWindow *window,
216 gboolean gtk_window_get_focus_on_map (GtkWindow *window);
217 void gtk_window_set_destroy_with_parent (GtkWindow *window,
219 gboolean gtk_window_get_destroy_with_parent (GtkWindow *window);
221 void gtk_window_set_resizable (GtkWindow *window,
223 gboolean gtk_window_get_resizable (GtkWindow *window);
225 void gtk_window_set_gravity (GtkWindow *window,
227 GdkGravity gtk_window_get_gravity (GtkWindow *window);
230 void gtk_window_set_geometry_hints (GtkWindow *window,
231 GtkWidget *geometry_widget,
232 GdkGeometry *geometry,
233 GdkWindowHints geom_mask);
235 void gtk_window_set_screen (GtkWindow *window,
237 GdkScreen* gtk_window_get_screen (GtkWindow *window);
239 gboolean gtk_window_is_active (GtkWindow *window);
240 gboolean gtk_window_has_toplevel_focus (GtkWindow *window);
244 /* gtk_window_set_has_frame () must be called before realizing the window_*/
245 void gtk_window_set_has_frame (GtkWindow *window,
247 gboolean gtk_window_get_has_frame (GtkWindow *window);
248 void gtk_window_set_frame_dimensions (GtkWindow *window,
253 void gtk_window_get_frame_dimensions (GtkWindow *window,
258 void gtk_window_set_decorated (GtkWindow *window,
260 gboolean gtk_window_get_decorated (GtkWindow *window);
261 void gtk_window_set_deletable (GtkWindow *window,
263 gboolean gtk_window_get_deletable (GtkWindow *window);
265 void gtk_window_set_icon_list (GtkWindow *window,
267 GList* gtk_window_get_icon_list (GtkWindow *window);
268 void gtk_window_set_icon (GtkWindow *window,
270 void gtk_window_set_icon_name (GtkWindow *window,
272 gboolean gtk_window_set_icon_from_file (GtkWindow *window,
273 const gchar *filename,
275 GdkPixbuf* gtk_window_get_icon (GtkWindow *window);
277 gchar *gtk_window_get_icon_name (GtkWindow *window);
278 void gtk_window_set_default_icon_list (GList *list);
279 GList* gtk_window_get_default_icon_list (void);
280 void gtk_window_set_default_icon (GdkPixbuf *icon);
281 void gtk_window_set_default_icon_name (const gchar *name);
282 gboolean gtk_window_set_default_icon_from_file (const gchar *filename,
285 void gtk_window_set_auto_startup_notification (gboolean setting);
287 /* If window is set modal, input will be grabbed when show and released when hide */
288 void gtk_window_set_modal (GtkWindow *window,
290 gboolean gtk_window_get_modal (GtkWindow *window);
291 GList* gtk_window_list_toplevels (void);
293 void gtk_window_add_mnemonic (GtkWindow *window,
296 void gtk_window_remove_mnemonic (GtkWindow *window,
299 gboolean gtk_window_mnemonic_activate (GtkWindow *window,
301 GdkModifierType modifier);
302 void gtk_window_set_mnemonic_modifier (GtkWindow *window,
303 GdkModifierType modifier);
304 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
306 gboolean gtk_window_activate_key (GtkWindow *window,
308 gboolean gtk_window_propagate_key_event (GtkWindow *window,
311 void gtk_window_present (GtkWindow *window);
312 void gtk_window_present_with_time (GtkWindow *window,
314 void gtk_window_iconify (GtkWindow *window);
315 void gtk_window_deiconify (GtkWindow *window);
316 void gtk_window_stick (GtkWindow *window);
317 void gtk_window_unstick (GtkWindow *window);
318 void gtk_window_maximize (GtkWindow *window);
319 void gtk_window_unmaximize (GtkWindow *window);
320 void gtk_window_fullscreen (GtkWindow *window);
321 void gtk_window_unfullscreen (GtkWindow *window);
322 void gtk_window_set_keep_above (GtkWindow *window, gboolean setting);
323 void gtk_window_set_keep_below (GtkWindow *window, gboolean setting);
325 void gtk_window_begin_resize_drag (GtkWindow *window,
331 void gtk_window_begin_move_drag (GtkWindow *window,
337 #ifndef GTK_DISABLE_DEPRECATED
338 void gtk_window_set_policy (GtkWindow *window,
342 #define gtk_window_position gtk_window_set_position
343 #endif /* GTK_DISABLE_DEPRECATED */
345 /* Set initial default size of the window (does not constrain user
348 void gtk_window_set_default_size (GtkWindow *window,
351 void gtk_window_get_default_size (GtkWindow *window,
354 void gtk_window_resize (GtkWindow *window,
357 void gtk_window_get_size (GtkWindow *window,
360 void gtk_window_move (GtkWindow *window,
363 void gtk_window_get_position (GtkWindow *window,
366 gboolean gtk_window_parse_geometry (GtkWindow *window,
367 const gchar *geometry);
368 GtkWindowGroup *gtk_window_get_group (GtkWindow *window);
370 /* Ignore this unless you are writing a GUI builder */
371 void gtk_window_reshow_with_initial_size (GtkWindow *window);
375 GType gtk_window_group_get_type (void) G_GNUC_CONST;
377 GtkWindowGroup * gtk_window_group_new (void);
378 void gtk_window_group_add_window (GtkWindowGroup *window_group,
380 void gtk_window_group_remove_window (GtkWindowGroup *window_group,
383 /* --- internal functions --- */
384 void _gtk_window_internal_set_focus (GtkWindow *window,
386 void gtk_window_remove_embedded_xid (GtkWindow *window,
388 void gtk_window_add_embedded_xid (GtkWindow *window,
390 void _gtk_window_reposition (GtkWindow *window,
393 void _gtk_window_constrain_size (GtkWindow *window,
398 GtkWidget *_gtk_window_group_get_current_grab (GtkWindowGroup *window_group);
400 void _gtk_window_set_has_toplevel_focus (GtkWindow *window,
401 gboolean has_toplevel_focus);
402 void _gtk_window_unset_focus_and_default (GtkWindow *window,
405 void _gtk_window_set_is_active (GtkWindow *window,
408 typedef void (*GtkWindowKeysForeachFunc) (GtkWindow *window,
410 GdkModifierType modifiers,
411 gboolean is_mnemonic,
414 void _gtk_window_keys_foreach (GtkWindow *window,
415 GtkWindowKeysForeachFunc func,
418 /* --- internal (GtkAcceleratable) --- */
419 gboolean _gtk_window_query_nonaccels (GtkWindow *window,
421 GdkModifierType accel_mods);
425 #endif /* __GTK_WINDOW_H__ */