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;
74 GtkWindowType type : 4;
75 guint has_user_ref_count : 1;
77 guint allow_shrink : 1;
79 guint auto_shrink : 1;
80 guint handling_resize : 1;
83 /* The following flag is initially TRUE when a window is mapped.
84 * and will be set to FALSE after it is first positioned.
85 * It is also temporarily reset when the window's size changes.
87 * When TRUE, we move the window to the position the app set.
89 guint use_uposition : 1;
91 guint destroy_with_parent : 1;
95 /* gtk_window_iconify() called before realization */
96 guint iconify_initially : 1;
97 guint stick_initially : 1;
98 guint maximize_initially : 1;
101 GdkWindowTypeHint type_hint : 3;
102 GdkGravity gravity : 5;
109 GdkModifierType mnemonic_modifier;
112 struct _GtkWindowClass
114 GtkBinClass parent_class;
116 void (* set_focus) (GtkWindow *window,
118 gboolean (* frame_event) (GtkWidget *widget,
121 /* G_SIGNAL_ACTION signals for keybindings */
123 void (* activate_focus) (GtkWindow *window);
124 void (* activate_default) (GtkWindow *window);
125 void (* move_focus) (GtkWindow *window,
126 GtkDirectionType direction);
129 #define GTK_TYPE_WINDOW_GROUP (gtk_window_group_get_type ())
130 #define GTK_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
131 #define GTK_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
132 #define GTK_IS_WINDOW_GROUP(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
133 #define GTK_IS_WINDOW_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
134 #define GTK_WINDOW_GROUP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
136 struct _GtkWindowGroup
138 GObject parent_instance;
143 struct _GtkWindowGroupClass
145 GObjectClass parent_class;
148 GtkType gtk_window_get_type (void) G_GNUC_CONST;
149 GtkWidget* gtk_window_new (GtkWindowType type);
150 void gtk_window_set_title (GtkWindow *window,
152 G_CONST_RETURN gchar *gtk_window_get_title (GtkWindow *window);
153 void gtk_window_set_wmclass (GtkWindow *window,
154 const gchar *wmclass_name,
155 const gchar *wmclass_class);
156 void gtk_window_set_role (GtkWindow *window,
158 G_CONST_RETURN gchar *gtk_window_get_role (GtkWindow *window);
159 void gtk_window_add_accel_group (GtkWindow *window,
160 GtkAccelGroup *accel_group);
161 void gtk_window_remove_accel_group (GtkWindow *window,
162 GtkAccelGroup *accel_group);
163 void gtk_window_set_position (GtkWindow *window,
164 GtkWindowPosition position);
165 gboolean gtk_window_activate_focus (GtkWindow *window);
166 gboolean gtk_window_activate_default (GtkWindow *window);
168 void gtk_window_set_transient_for (GtkWindow *window,
170 GtkWindow *gtk_window_get_transient_for (GtkWindow *window);
171 void gtk_window_set_type_hint (GtkWindow *window,
172 GdkWindowTypeHint hint);
173 GdkWindowTypeHint gtk_window_get_type_hint (GtkWindow *window);
174 void gtk_window_set_destroy_with_parent (GtkWindow *window,
176 gboolean gtk_window_get_destroy_with_parent (GtkWindow *window);
178 void gtk_window_set_resizeable (GtkWindow *window,
179 gboolean resizeable);
180 gboolean gtk_window_get_resizeable (GtkWindow *window);
182 void gtk_window_set_gravity (GtkWindow *window,
184 GdkGravity gtk_window_get_gravity (GtkWindow *window);
187 void gtk_window_set_geometry_hints (GtkWindow *window,
188 GtkWidget *geometry_widget,
189 GdkGeometry *geometry,
190 GdkWindowHints geom_mask);
192 /* gtk_window_set_has_frame () must be called before realizing the window_*/
193 void gtk_window_set_has_frame (GtkWindow *window,
195 gboolean gtk_window_get_has_frame (GtkWindow *window);
196 void gtk_window_set_frame_dimensions (GtkWindow *window,
201 void gtk_window_get_frame_dimensions (GtkWindow *window,
206 void gtk_window_set_decorated (GtkWindow *window,
208 gboolean gtk_window_get_decorated (GtkWindow *window);
210 /* If window is set modal, input will be grabbed when show and released when hide */
211 void gtk_window_set_modal (GtkWindow *window,
213 gboolean gtk_window_get_modal (GtkWindow *window);
214 GList* gtk_window_list_toplevels (void);
216 void gtk_window_add_mnemonic (GtkWindow *window,
219 void gtk_window_remove_mnemonic (GtkWindow *window,
222 gboolean gtk_window_mnemonic_activate (GtkWindow *window,
224 GdkModifierType modifier);
225 void gtk_window_set_mnemonic_modifier (GtkWindow *window,
226 GdkModifierType modifier);
227 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
229 void gtk_window_present (GtkWindow *window);
230 void gtk_window_iconify (GtkWindow *window);
231 void gtk_window_deiconify (GtkWindow *window);
232 void gtk_window_stick (GtkWindow *window);
233 void gtk_window_unstick (GtkWindow *window);
234 void gtk_window_maximize (GtkWindow *window);
235 void gtk_window_unmaximize (GtkWindow *window);
237 void gtk_window_begin_resize_drag (GtkWindow *window,
243 void gtk_window_begin_move_drag (GtkWindow *window,
249 #ifndef GTK_DISABLE_DEPRECATED
250 void gtk_window_set_policy (GtkWindow *window,
255 /* The following differs from gtk_widget_set_usize, in that
256 * gtk_widget_set_usize() overrides the requisition, so sets a minimum
257 * size, while this only sets the size requested from the WM.
259 void gtk_window_set_default_size (GtkWindow *window,
262 void gtk_window_get_default_size (GtkWindow *window,
268 GType gtk_window_group_get_type (void) G_GNUC_CONST;;
270 GtkWindowGroup * gtk_window_group_new (void);
271 void gtk_window_group_add_window (GtkWindowGroup *window_group,
273 void gtk_window_group_remove_window (GtkWindowGroup *window_group,
276 /* --- internal functions --- */
277 void gtk_window_set_focus (GtkWindow *window,
279 void gtk_window_set_default (GtkWindow *window,
280 GtkWidget *defaultw);
281 void gtk_window_remove_embedded_xid (GtkWindow *window,
283 void gtk_window_add_embedded_xid (GtkWindow *window,
285 void _gtk_window_reposition (GtkWindow *window,
288 void _gtk_window_constrain_size (GtkWindow *window,
293 GtkWindowGroup *_gtk_window_get_group (GtkWindow *window);
297 #endif /* __cplusplus */
300 #endif /* __GTK_WINDOW_H__ */