Pileus Git - ~andy/gtk/blob - gtk/gtkwindow.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 #ifndef __GTK_WINDOW_H__
  28 #define __GTK_WINDOW_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkaccelgroup.h>
  33 #include <gtk/gtkbin.h>
  34 #include <gtk/gtkenums.h>
  35 #include <gtk/gtkwidget.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif /* __cplusplus */
  40
  41
  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))
  48
  49
  50 typedef struct _GtkWindow      GtkWindow;
  51 typedef struct _GtkWindowClass GtkWindowClass;
  52
  53 struct _GtkWindow
  54 {
  55   GtkBin bin;
  56
  57   gchar *title;
  58   gchar *wmclass_name;
  59   gchar *wmclass_class;
  60   GtkWindowType type;
  61
  62   GdkWindow *frame;
  63
  64   GtkWidget *focus_widget;
  65   GtkWidget *default_widget;
  66   GtkWindow *transient_parent;
  67
  68   gushort resize_count;
  69   guint has_user_ref_count : 1;
  70   guint allow_shrink : 1;
  71   guint allow_grow : 1;
  72   guint auto_shrink : 1;
  73   guint handling_resize : 1;
  74   guint position : 2;
  75
  76   /* The following flag is initially TRUE when a window is mapped.
  77    * and will be set to FALSE after it is first positioned.
  78    * It is also temporarily reset when the window's size changes.
  79    *
  80    * When TRUE, we move the window to the position the app set.
  81    */
  82   guint use_uposition : 1;
  83   guint modal : 1;
  84   guint destroy_with_parent : 1;
  85
  86   guint has_frame : 1;
  87
  88   /* gtk_window_iconify() called before realization */
  89   guint iconify_initially : 1;
  90   guint stick_initially : 1;
  91   guint maximize_initially : 1;
  92
  93   guint frame_left;
  94   guint frame_top;
  95   guint frame_right;
  96   guint frame_bottom;
  97 };
  98
  99 struct _GtkWindowClass
 100 {
 101   GtkBinClass parent_class;
 102
 103   void     (* set_focus)   (GtkWindow *window,
 104                             GtkWidget *focus);
 105   gboolean (* frame_event) (GtkWidget *widget,
 106                             GdkEvent  *event);
 107 };
 108
 109
 110 GtkType    gtk_window_get_type                 (void) G_GNUC_CONST;
 111 GtkWidget* gtk_window_new                      (GtkWindowType        type);
 112 void       gtk_window_set_title                (GtkWindow           *window,
 113                                                 const gchar         *title);
 114 void       gtk_window_set_wmclass              (GtkWindow           *window,
 115                                                 const gchar         *wmclass_name,
 116                                                 const gchar         *wmclass_class);
 117 void       gtk_window_set_policy               (GtkWindow           *window,
 118                                                 gint                 allow_shrink,
 119                                                 gint                 allow_grow,
 120                                                 gint                 auto_shrink);
 121 void       gtk_window_add_accel_group          (GtkWindow           *window,
 122                                                 GtkAccelGroup       *accel_group);
 123 void       gtk_window_remove_accel_group       (GtkWindow           *window,
 124                                                 GtkAccelGroup       *accel_group);
 125 void       gtk_window_set_position             (GtkWindow           *window,
 126                                                 GtkWindowPosition    position);
 127 gint       gtk_window_activate_focus           (GtkWindow           *window);
 128 gint       gtk_window_activate_default         (GtkWindow           *window);
 129
 130 void       gtk_window_set_transient_for        (GtkWindow           *window,
 131                                                 GtkWindow           *parent);
 132 void       gtk_window_set_destroy_with_parent  (GtkWindow           *window,
 133                                                 gboolean             setting);
 134 void       gtk_window_set_geometry_hints       (GtkWindow           *window,
 135                                                 GtkWidget           *geometry_widget,
 136                                                 GdkGeometry         *geometry,
 137                                                 GdkWindowHints       geom_mask);
 138 /* The following differs from gtk_widget_set_usize, in that
 139  * gtk_widget_set_usize() overrides the requisition, so sets a minimum
 140  * size, while this only sets the size requested from the WM.
 141  */
 142 void       gtk_window_set_default_size         (GtkWindow           *window,
 143                                                 gint                 width,
 144                                                 gint                 height);
 145 /* gtk_window_set_has_frame () must be called before realizing the window_*/
 146 void       gtk_window_set_has_frame            (GtkWindow *window);
 147 void       gtk_window_set_frame_dimensions     (GtkWindow *window,
 148                                                 gint       left,
 149                                                 gint       top,
 150                                                 gint       right,
 151                                                 gint       bottom);
 152
 153 /* If window is set modal, input will be grabbed when show and released when hide */
 154 void       gtk_window_set_modal                (GtkWindow           *window,
 155                                                 gboolean             modal);
 156 GList*     gtk_window_list_toplevels           (void);
 157
 158 /* Get the "built-in" accel group (convenience thing) */
 159 GtkAccelGroup* gtk_window_get_default_accel_group (GtkWindow *window);
 160
 161 void     gtk_window_present       (GtkWindow *window);
 162 void     gtk_window_iconify       (GtkWindow *window);
 163 void     gtk_window_deiconify     (GtkWindow *window);
 164 void     gtk_window_stick         (GtkWindow *window);
 165 void     gtk_window_unstick       (GtkWindow *window);
 166 void     gtk_window_maximize      (GtkWindow *window);
 167 void     gtk_window_unmaximize    (GtkWindow *window);
 168
 169
 170 /* --- internal functions --- */
 171 void       gtk_window_set_focus                (GtkWindow           *window,
 172                                                 GtkWidget           *focus);
 173 void       gtk_window_set_default              (GtkWindow           *window,
 174                                                 GtkWidget           *defaultw);
 175 void       gtk_window_remove_embedded_xid      (GtkWindow           *window,
 176                                                 guint                xid);
 177 void       gtk_window_add_embedded_xid         (GtkWindow           *window,
 178                                                 guint                xid);
 179 void       gtk_window_reposition               (GtkWindow           *window,
 180                                                 gint                 x,
 181                                                 gint                 y);
 182 void       _gtk_window_constrain_size          (GtkWindow           *window,
 183                                                 gint                 width,
 184                                                 gint                 height,
 185                                                 gint                *new_width,
 186                                                 gint                *new_height);
 187
 188 #ifdef __cplusplus
 189 }
 190 #endif /* __cplusplus */
 191
 192
 193 #endif /* __GTK_WINDOW_H__ */