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) (GTK_CHECK_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
44 #define GTK_WINDOW_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
45 #define GTK_IS_WINDOW(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_WINDOW))
46 #define GTK_IS_WINDOW_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
47 #define GTK_WINDOW_GET_CLASS(obj) (GTK_CHECK_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 */
108 guint keys_changed_handler;
110 GdkModifierType mnemonic_modifier;
111 gpointer gtk_reserved1; /* For future GdkScreen * */
114 struct _GtkWindowClass
116 GtkBinClass parent_class;
118 void (* set_focus) (GtkWindow *window,
120 gboolean (* frame_event) (GtkWindow *window,
123 /* G_SIGNAL_ACTION signals for keybindings */
125 void (* activate_focus) (GtkWindow *window);
126 void (* activate_default) (GtkWindow *window);
127 void (* move_focus) (GtkWindow *window,
128 GtkDirectionType direction);
130 void (*keys_changed) (GtkWindow *window);
133 #define GTK_TYPE_WINDOW_GROUP (gtk_window_group_get_type ())
134 #define GTK_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
135 #define GTK_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
136 #define GTK_IS_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
137 #define GTK_IS_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
138 #define GTK_WINDOW_GROUP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
140 struct _GtkWindowGroup
142 GObject parent_instance;
147 struct _GtkWindowGroupClass
149 GObjectClass parent_class;
152 GtkType gtk_window_get_type (void) G_GNUC_CONST;
153 GtkWidget* gtk_window_new (GtkWindowType type);
154 void gtk_window_set_title (GtkWindow *window,
156 G_CONST_RETURN gchar *gtk_window_get_title (GtkWindow *window);
157 void gtk_window_set_wmclass (GtkWindow *window,
158 const gchar *wmclass_name,
159 const gchar *wmclass_class);
160 void gtk_window_set_role (GtkWindow *window,
162 G_CONST_RETURN gchar *gtk_window_get_role (GtkWindow *window);
163 void gtk_window_add_accel_group (GtkWindow *window,
164 GtkAccelGroup *accel_group);
165 void gtk_window_remove_accel_group (GtkWindow *window,
166 GtkAccelGroup *accel_group);
167 void gtk_window_set_position (GtkWindow *window,
168 GtkWindowPosition position);
169 gboolean gtk_window_activate_focus (GtkWindow *window);
170 void gtk_window_set_focus (GtkWindow *window,
172 GtkWidget *gtk_window_get_focus (GtkWindow *window);
173 void gtk_window_set_default (GtkWindow *window,
174 GtkWidget *default_widget);
175 gboolean gtk_window_activate_default (GtkWindow *window);
177 void gtk_window_set_transient_for (GtkWindow *window,
179 GtkWindow *gtk_window_get_transient_for (GtkWindow *window);
180 void gtk_window_set_type_hint (GtkWindow *window,
181 GdkWindowTypeHint hint);
182 GdkWindowTypeHint gtk_window_get_type_hint (GtkWindow *window);
183 void gtk_window_set_destroy_with_parent (GtkWindow *window,
185 gboolean gtk_window_get_destroy_with_parent (GtkWindow *window);
187 void gtk_window_set_resizable (GtkWindow *window,
189 gboolean gtk_window_get_resizable (GtkWindow *window);
191 void gtk_window_set_gravity (GtkWindow *window,
193 GdkGravity gtk_window_get_gravity (GtkWindow *window);
196 void gtk_window_set_geometry_hints (GtkWindow *window,
197 GtkWidget *geometry_widget,
198 GdkGeometry *geometry,
199 GdkWindowHints geom_mask);
201 /* gtk_window_set_has_frame () must be called before realizing the window_*/
202 void gtk_window_set_has_frame (GtkWindow *window,
204 gboolean gtk_window_get_has_frame (GtkWindow *window);
205 void gtk_window_set_frame_dimensions (GtkWindow *window,
210 void gtk_window_get_frame_dimensions (GtkWindow *window,
215 void gtk_window_set_decorated (GtkWindow *window,
217 gboolean gtk_window_get_decorated (GtkWindow *window);
219 void gtk_window_set_icon_list (GtkWindow *window,
221 GList* gtk_window_get_icon_list (GtkWindow *window);
222 void gtk_window_set_icon (GtkWindow *window,
224 GdkPixbuf* gtk_window_get_icon (GtkWindow *window);
225 void gtk_window_set_default_icon_list (GList *list);
226 GList* gtk_window_get_default_icon_list (void);
228 /* If window is set modal, input will be grabbed when show and released when hide */
229 void gtk_window_set_modal (GtkWindow *window,
231 gboolean gtk_window_get_modal (GtkWindow *window);
232 GList* gtk_window_list_toplevels (void);
234 void gtk_window_add_mnemonic (GtkWindow *window,
237 void gtk_window_remove_mnemonic (GtkWindow *window,
240 gboolean gtk_window_mnemonic_activate (GtkWindow *window,
242 GdkModifierType modifier);
243 void gtk_window_set_mnemonic_modifier (GtkWindow *window,
244 GdkModifierType modifier);
245 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
247 void gtk_window_present (GtkWindow *window);
248 void gtk_window_iconify (GtkWindow *window);
249 void gtk_window_deiconify (GtkWindow *window);
250 void gtk_window_stick (GtkWindow *window);
251 void gtk_window_unstick (GtkWindow *window);
252 void gtk_window_maximize (GtkWindow *window);
253 void gtk_window_unmaximize (GtkWindow *window);
255 void gtk_window_begin_resize_drag (GtkWindow *window,
261 void gtk_window_begin_move_drag (GtkWindow *window,
267 #ifndef GTK_DISABLE_DEPRECATED
268 void gtk_window_set_policy (GtkWindow *window,
272 #define gtk_window_position gtk_window_set_position
273 #endif /* GTK_DISABLE_DEPRECATED */
275 /* Set initial default size of the window (does not constrain user
278 void gtk_window_set_default_size (GtkWindow *window,
281 void gtk_window_get_default_size (GtkWindow *window,
284 void gtk_window_resize (GtkWindow *window,
287 void gtk_window_get_size (GtkWindow *window,
290 void gtk_window_move (GtkWindow *window,
293 void gtk_window_get_position (GtkWindow *window,
296 gboolean gtk_window_parse_geometry (GtkWindow *window,
297 const gchar *geometry);
299 /* Ignore this unless you are writing a GUI builder */
300 void gtk_window_reshow_with_initial_size (GtkWindow *window);
304 GType gtk_window_group_get_type (void) G_GNUC_CONST;
306 GtkWindowGroup * gtk_window_group_new (void);
307 void gtk_window_group_add_window (GtkWindowGroup *window_group,
309 void gtk_window_group_remove_window (GtkWindowGroup *window_group,
312 /* --- internal functions --- */
313 void _gtk_window_internal_set_focus (GtkWindow *window,
315 void gtk_window_remove_embedded_xid (GtkWindow *window,
317 void gtk_window_add_embedded_xid (GtkWindow *window,
319 void _gtk_window_reposition (GtkWindow *window,
322 void _gtk_window_constrain_size (GtkWindow *window,
327 GtkWindowGroup *_gtk_window_get_group (GtkWindow *window);
328 gboolean _gtk_window_activate_key (GtkWindow *window,
331 /* --- internal (GtkAcceleratable) --- */
332 gboolean _gtk_window_query_nonaccels (GtkWindow *window,
334 GdkModifierType accel_mods);
338 #endif /* __cplusplus */
341 #endif /* __GTK_WINDOW_H__ */