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 #endif /* __cplusplus */
42 #define GTK_TYPE_WINDOW (gtk_window_get_type ())
43 #define GTK_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
44 #define GTK_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
45 #define GTK_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_WINDOW))
46 #define GTK_IS_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
47 #define GTK_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW, GtkWindowClass))
50 typedef struct _GtkWindow GtkWindow;
51 typedef struct _GtkWindowClass GtkWindowClass;
52 typedef struct _GtkWindowGeometryInfo GtkWindowGeometryInfo;
53 typedef struct _GtkWindowGroup GtkWindowGroup;
54 typedef struct _GtkWindowGroupClass GtkWindowGroupClass;
65 GtkWidget *focus_widget;
66 GtkWidget *default_widget;
67 GtkWindow *transient_parent;
68 GtkWindowGeometryInfo *geometry_info;
70 GtkWindowGroup *group;
72 guint16 configure_request_count;
73 guint allow_shrink : 1;
75 guint 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 need_default_position : 1;
83 guint need_default_size : 1;
85 guint type : 4; /* GtkWindowType */
86 guint has_user_ref_count : 1;
90 guint destroy_with_parent : 1;
94 /* gtk_window_iconify() called before realization */
95 guint iconify_initially : 1;
96 guint stick_initially : 1;
97 guint maximize_initially : 1;
100 guint type_hint : 3; /* GdkWindowTypeHint */
101 guint gravity : 5; /* GdkGravity */
104 guint has_toplevel_focus : 1;
111 guint keys_changed_handler;
113 GdkModifierType mnemonic_modifier;
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);
130 void (* move_focus) (GtkWindow *window,
131 GtkDirectionType direction);
133 void (*keys_changed) (GtkWindow *window);
135 /* Padding for future expansion */
136 void (*_gtk_reserved1) (void);
137 void (*_gtk_reserved2) (void);
138 void (*_gtk_reserved3) (void);
139 void (*_gtk_reserved4) (void);
142 #define GTK_TYPE_WINDOW_GROUP (gtk_window_group_get_type ())
143 #define GTK_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
144 #define GTK_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
145 #define GTK_IS_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
146 #define GTK_IS_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
147 #define GTK_WINDOW_GROUP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
149 struct _GtkWindowGroup
151 GObject parent_instance;
156 struct _GtkWindowGroupClass
158 GObjectClass parent_class;
160 /* Padding for future expansion */
161 void (*_gtk_reserved1) (void);
162 void (*_gtk_reserved2) (void);
163 void (*_gtk_reserved3) (void);
164 void (*_gtk_reserved4) (void);
167 GType gtk_window_get_type (void) G_GNUC_CONST;
168 GtkWidget* gtk_window_new (GtkWindowType type);
169 void gtk_window_set_title (GtkWindow *window,
171 G_CONST_RETURN gchar *gtk_window_get_title (GtkWindow *window);
172 void gtk_window_set_wmclass (GtkWindow *window,
173 const gchar *wmclass_name,
174 const gchar *wmclass_class);
175 void gtk_window_set_role (GtkWindow *window,
177 G_CONST_RETURN gchar *gtk_window_get_role (GtkWindow *window);
178 void gtk_window_add_accel_group (GtkWindow *window,
179 GtkAccelGroup *accel_group);
180 void gtk_window_remove_accel_group (GtkWindow *window,
181 GtkAccelGroup *accel_group);
182 void gtk_window_set_position (GtkWindow *window,
183 GtkWindowPosition position);
184 gboolean gtk_window_activate_focus (GtkWindow *window);
185 void gtk_window_set_focus (GtkWindow *window,
187 GtkWidget *gtk_window_get_focus (GtkWindow *window);
188 void gtk_window_set_default (GtkWindow *window,
189 GtkWidget *default_widget);
190 gboolean gtk_window_activate_default (GtkWindow *window);
192 void gtk_window_set_transient_for (GtkWindow *window,
194 GtkWindow *gtk_window_get_transient_for (GtkWindow *window);
195 void gtk_window_set_type_hint (GtkWindow *window,
196 GdkWindowTypeHint hint);
197 GdkWindowTypeHint gtk_window_get_type_hint (GtkWindow *window);
198 void gtk_window_set_skip_taskbar_hint (GtkWindow *window,
200 gboolean gtk_window_get_skip_taskbar_hint (GtkWindow *window);
201 void gtk_window_set_skip_pager_hint (GtkWindow *window,
203 gboolean gtk_window_get_skip_pager_hint (GtkWindow *window);
204 void gtk_window_set_accept_focus (GtkWindow *window,
206 gboolean gtk_window_get_accept_focus (GtkWindow *window);
207 void gtk_window_set_focus_on_map (GtkWindow *window,
209 gboolean gtk_window_get_focus_on_map (GtkWindow *window);
210 void gtk_window_set_destroy_with_parent (GtkWindow *window,
212 gboolean gtk_window_get_destroy_with_parent (GtkWindow *window);
214 void gtk_window_set_resizable (GtkWindow *window,
216 gboolean gtk_window_get_resizable (GtkWindow *window);
218 void gtk_window_set_gravity (GtkWindow *window,
220 GdkGravity gtk_window_get_gravity (GtkWindow *window);
223 void gtk_window_set_geometry_hints (GtkWindow *window,
224 GtkWidget *geometry_widget,
225 GdkGeometry *geometry,
226 GdkWindowHints geom_mask);
228 void gtk_window_set_screen (GtkWindow *window,
230 GdkScreen* gtk_window_get_screen (GtkWindow *window);
232 gboolean gtk_window_is_active (GtkWindow *window);
233 gboolean gtk_window_has_toplevel_focus (GtkWindow *window);
237 /* gtk_window_set_has_frame () must be called before realizing the window_*/
238 void gtk_window_set_has_frame (GtkWindow *window,
240 gboolean gtk_window_get_has_frame (GtkWindow *window);
241 void gtk_window_set_frame_dimensions (GtkWindow *window,
246 void gtk_window_get_frame_dimensions (GtkWindow *window,
251 void gtk_window_set_decorated (GtkWindow *window,
253 gboolean gtk_window_get_decorated (GtkWindow *window);
255 void gtk_window_set_icon_list (GtkWindow *window,
257 GList* gtk_window_get_icon_list (GtkWindow *window);
258 void gtk_window_set_icon (GtkWindow *window,
260 void gtk_window_set_icon_name (GtkWindow *window,
262 gboolean gtk_window_set_icon_from_file (GtkWindow *window,
263 const gchar *filename,
265 GdkPixbuf* gtk_window_get_icon (GtkWindow *window);
267 gchar *gtk_window_get_icon_name (GtkWindow *window);
268 void gtk_window_set_default_icon_list (GList *list);
269 GList* gtk_window_get_default_icon_list (void);
270 void gtk_window_set_default_icon (GdkPixbuf *icon);
271 void gtk_window_set_default_icon_name (const gchar *name);
272 gboolean gtk_window_set_default_icon_from_file (const gchar *filename,
275 void gtk_window_set_auto_startup_notification (gboolean setting);
277 /* If window is set modal, input will be grabbed when show and released when hide */
278 void gtk_window_set_modal (GtkWindow *window,
280 gboolean gtk_window_get_modal (GtkWindow *window);
281 GList* gtk_window_list_toplevels (void);
283 void gtk_window_add_mnemonic (GtkWindow *window,
286 void gtk_window_remove_mnemonic (GtkWindow *window,
289 gboolean gtk_window_mnemonic_activate (GtkWindow *window,
291 GdkModifierType modifier);
292 void gtk_window_set_mnemonic_modifier (GtkWindow *window,
293 GdkModifierType modifier);
294 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
296 gboolean gtk_window_activate_key (GtkWindow *window,
298 gboolean gtk_window_propagate_key_event (GtkWindow *window,
301 void gtk_window_present (GtkWindow *window);
302 void gtk_window_iconify (GtkWindow *window);
303 void gtk_window_deiconify (GtkWindow *window);
304 void gtk_window_stick (GtkWindow *window);
305 void gtk_window_unstick (GtkWindow *window);
306 void gtk_window_maximize (GtkWindow *window);
307 void gtk_window_unmaximize (GtkWindow *window);
308 void gtk_window_fullscreen (GtkWindow *window);
309 void gtk_window_unfullscreen (GtkWindow *window);
310 void gtk_window_set_keep_above (GtkWindow *window, gboolean setting);
311 void gtk_window_set_keep_below (GtkWindow *window, gboolean setting);
313 void gtk_window_begin_resize_drag (GtkWindow *window,
319 void gtk_window_begin_move_drag (GtkWindow *window,
325 #ifndef GTK_DISABLE_DEPRECATED
326 void gtk_window_set_policy (GtkWindow *window,
330 #define gtk_window_position gtk_window_set_position
331 #endif /* GTK_DISABLE_DEPRECATED */
333 /* Set initial default size of the window (does not constrain user
336 void gtk_window_set_default_size (GtkWindow *window,
339 void gtk_window_get_default_size (GtkWindow *window,
342 void gtk_window_resize (GtkWindow *window,
345 void gtk_window_get_size (GtkWindow *window,
348 void gtk_window_move (GtkWindow *window,
351 void gtk_window_get_position (GtkWindow *window,
354 gboolean gtk_window_parse_geometry (GtkWindow *window,
355 const gchar *geometry);
357 /* Ignore this unless you are writing a GUI builder */
358 void gtk_window_reshow_with_initial_size (GtkWindow *window);
362 GType gtk_window_group_get_type (void) G_GNUC_CONST;
364 GtkWindowGroup * gtk_window_group_new (void);
365 void gtk_window_group_add_window (GtkWindowGroup *window_group,
367 void gtk_window_group_remove_window (GtkWindowGroup *window_group,
370 /* --- internal functions --- */
371 void _gtk_window_internal_set_focus (GtkWindow *window,
373 void gtk_window_remove_embedded_xid (GtkWindow *window,
375 void gtk_window_add_embedded_xid (GtkWindow *window,
377 void _gtk_window_reposition (GtkWindow *window,
380 void _gtk_window_constrain_size (GtkWindow *window,
385 GtkWindowGroup *_gtk_window_get_group (GtkWindow *window);
387 void _gtk_window_set_has_toplevel_focus (GtkWindow *window,
388 gboolean has_toplevel_focus);
389 void _gtk_window_unset_focus_and_default (GtkWindow *window,
392 void _gtk_window_set_is_active (GtkWindow *window,
395 typedef void (*GtkWindowKeysForeachFunc) (GtkWindow *window,
397 GdkModifierType modifiers,
398 gboolean is_mnemonic,
401 void _gtk_window_keys_foreach (GtkWindow *window,
402 GtkWindowKeysForeachFunc func,
405 /* --- internal (GtkAcceleratable) --- */
406 gboolean _gtk_window_query_nonaccels (GtkWindow *window,
408 GdkModifierType accel_mods);
412 #endif /* __cplusplus */
415 #endif /* __GTK_WINDOW_H__ */