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 typedef struct _GtkWindowGeometryInfo GtkWindowGeometryInfo;
  53 typedef struct _GtkWindowGroup        GtkWindowGroup;
  54 typedef struct _GtkWindowGroupClass   GtkWindowGroupClass;
  55
  56 struct _GtkWindow
  57 {
  58   GtkBin bin;
  59
  60   gchar *title;
  61   gchar *wmclass_name;
  62   gchar *wmclass_class;
  63   gchar *wm_role;
  64
  65   GtkWidget *focus_widget;
  66   GtkWidget *default_widget;
  67   GtkWindow *transient_parent;
  68   GtkWindowGeometryInfo *geometry_info;
  69   GdkWindow *frame;
  70   GtkWindowGroup *group;
  71
  72   guint16 configure_request_count;
  73   guint allow_shrink : 1;
  74   guint allow_grow : 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).
  81    */
  82   guint need_default_position : 1;
  83   guint need_default_size : 1;
  84   guint position : 3;
  85   GtkWindowType type : 4;
  86   guint has_user_ref_count : 1;
  87   guint has_focus : 1;
  88
  89   guint modal : 1;
  90   guint destroy_with_parent : 1;
  91
  92   guint has_frame : 1;
  93
  94   /* gtk_window_iconify() called before realization */
  95   guint iconify_initially : 1;
  96   guint stick_initially : 1;
  97   guint maximize_initially : 1;
  98   guint decorated : 1;
  99
 100   GdkWindowTypeHint type_hint : 3;
 101   GdkGravity gravity : 5;
 102
 103   guint frame_left;
 104   guint frame_top;
 105   guint frame_right;
 106   guint frame_bottom;
 107
 108   GdkModifierType mnemonic_modifier;
 109   gpointer gtk_reserved1;       /* For future GdkScreen * */
 110 };
 111
 112 struct _GtkWindowClass
 113 {
 114   GtkBinClass parent_class;
 115
 116   void     (* set_focus)   (GtkWindow *window,
 117                             GtkWidget *focus);
 118   gboolean (* frame_event) (GtkWidget *widget,
 119                             GdkEvent  *event);
 120
 121   /* G_SIGNAL_ACTION signals for keybindings */
 122
 123   void     (* activate_focus)          (GtkWindow       *window);
 124   void     (* activate_default)        (GtkWindow       *window);
 125   void     (* move_focus)              (GtkWindow       *window,
 126                                         GtkDirectionType direction);
 127 };
 128
 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))
 135
 136 struct _GtkWindowGroup
 137 {
 138   GObject parent_instance;
 139
 140   GSList *grabs;
 141 };
 142
 143 struct _GtkWindowGroupClass
 144 {
 145   GObjectClass parent_class;
 146 };
 147
 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,
 151                                                 const gchar         *title);
 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,
 157                                                 const gchar         *role);
 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 GtkWidget *gtk_window_get_focus                (GtkWindow           *window);
 167 gboolean   gtk_window_activate_default         (GtkWindow           *window);
 168
 169 void       gtk_window_set_transient_for        (GtkWindow           *window,
 170                                                 GtkWindow           *parent);
 171 GtkWindow *gtk_window_get_transient_for        (GtkWindow           *window);
 172 void       gtk_window_set_type_hint            (GtkWindow           *window,
 173                                                 GdkWindowTypeHint    hint);
 174 GdkWindowTypeHint gtk_window_get_type_hint     (GtkWindow           *window);
 175 void       gtk_window_set_destroy_with_parent  (GtkWindow           *window,
 176                                                 gboolean             setting);
 177 gboolean   gtk_window_get_destroy_with_parent  (GtkWindow           *window);
 178
 179 void       gtk_window_set_resizable            (GtkWindow           *window,
 180                                                 gboolean             resizable);
 181 gboolean   gtk_window_get_resizable            (GtkWindow           *window);
 182
 183 void       gtk_window_set_gravity              (GtkWindow           *window,
 184                                                 GdkGravity           gravity);
 185 GdkGravity gtk_window_get_gravity              (GtkWindow           *window);
 186
 187
 188 void       gtk_window_set_geometry_hints       (GtkWindow           *window,
 189                                                 GtkWidget           *geometry_widget,
 190                                                 GdkGeometry         *geometry,
 191                                                 GdkWindowHints       geom_mask);
 192
 193 /* gtk_window_set_has_frame () must be called before realizing the window_*/
 194 void       gtk_window_set_has_frame            (GtkWindow *window,
 195                                                 gboolean   setting);
 196 gboolean   gtk_window_get_has_frame            (GtkWindow *window);
 197 void       gtk_window_set_frame_dimensions     (GtkWindow *window,
 198                                                 gint       left,
 199                                                 gint       top,
 200                                                 gint       right,
 201                                                 gint       bottom);
 202 void       gtk_window_get_frame_dimensions     (GtkWindow *window,
 203                                                 gint      *left,
 204                                                 gint      *top,
 205                                                 gint      *right,
 206                                                 gint      *bottom);
 207 void       gtk_window_set_decorated            (GtkWindow *window,
 208                                                 gboolean   setting);
 209 gboolean   gtk_window_get_decorated            (GtkWindow *window);
 210
 211 void       gtk_window_set_icon_list                (GtkWindow  *window,
 212                                                     GList      *list);
 213 GList*     gtk_window_get_icon_list                (GtkWindow  *window);
 214 void       gtk_window_set_icon                     (GtkWindow  *window,
 215                                                     GdkPixbuf  *icon);
 216 GdkPixbuf* gtk_window_get_icon                     (GtkWindow  *window);
 217 void       gtk_window_set_default_icon_list        (GList      *list);
 218 GList*     gtk_window_get_default_icon_list        (void);
 219
 220 /* If window is set modal, input will be grabbed when show and released when hide */
 221 void       gtk_window_set_modal      (GtkWindow *window,
 222                                       gboolean   modal);
 223 gboolean   gtk_window_get_modal      (GtkWindow *window);
 224 GList*     gtk_window_list_toplevels (void);
 225
 226 void     gtk_window_add_mnemonic          (GtkWindow       *window,
 227                                            guint            keyval,
 228                                            GtkWidget       *target);
 229 void     gtk_window_remove_mnemonic       (GtkWindow       *window,
 230                                            guint            keyval,
 231                                            GtkWidget       *target);
 232 gboolean gtk_window_mnemonic_activate     (GtkWindow       *window,
 233                                            guint            keyval,
 234                                            GdkModifierType  modifier);
 235 void     gtk_window_set_mnemonic_modifier (GtkWindow       *window,
 236                                            GdkModifierType  modifier);
 237 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
 238
 239 void     gtk_window_present       (GtkWindow *window);
 240 void     gtk_window_iconify       (GtkWindow *window);
 241 void     gtk_window_deiconify     (GtkWindow *window);
 242 void     gtk_window_stick         (GtkWindow *window);
 243 void     gtk_window_unstick       (GtkWindow *window);
 244 void     gtk_window_maximize      (GtkWindow *window);
 245 void     gtk_window_unmaximize    (GtkWindow *window);
 246
 247 void gtk_window_begin_resize_drag (GtkWindow     *window,
 248                                    GdkWindowEdge  edge,
 249                                    gint           button,
 250                                    gint           root_x,
 251                                    gint           root_y,
 252                                    guint32        timestamp);
 253 void gtk_window_begin_move_drag   (GtkWindow     *window,
 254                                    gint           button,
 255                                    gint           root_x,
 256                                    gint           root_y,
 257                                    guint32        timestamp);
 258
 259 #ifndef GTK_DISABLE_DEPRECATED
 260 void       gtk_window_set_policy               (GtkWindow           *window,
 261                                                 gint                 allow_shrink,
 262                                                 gint                 allow_grow,
 263                                                 gint                 auto_shrink);
 264 #define gtk_window_position                     gtk_window_set_position
 265 #endif /* GTK_DISABLE_DEPRECATED */
 266
 267 /* Set initial default size of the window (does not constrain user
 268  * resize operations)
 269  */
 270 void     gtk_window_set_default_size (GtkWindow   *window,
 271                                       gint         width,
 272                                       gint         height);
 273 void     gtk_window_get_default_size (GtkWindow   *window,
 274                                       gint        *width,
 275                                       gint        *height);
 276 void     gtk_window_resize           (GtkWindow   *window,
 277                                       gint         width,
 278                                       gint         height);
 279 void     gtk_window_get_size         (GtkWindow   *window,
 280                                       gint        *width,
 281                                       gint        *height);
 282 void     gtk_window_move             (GtkWindow   *window,
 283                                       gint         x,
 284                                       gint         y);
 285 void     gtk_window_get_position     (GtkWindow   *window,
 286                                       gint        *root_x,
 287                                       gint        *root_y);
 288 gboolean gtk_window_parse_geometry   (GtkWindow   *window,
 289                                       const gchar *geometry);
 290
 291 /* Ignore this unless you are writing a GUI builder */
 292 void     gtk_window_reshow_with_initial_size (GtkWindow *window);
 293
 294 /* Window groups
 295  */
 296 GType            gtk_window_group_get_type      (void) G_GNUC_CONST;
 297
 298 GtkWindowGroup * gtk_window_group_new           (void);
 299 void             gtk_window_group_add_window    (GtkWindowGroup     *window_group,
 300                                                  GtkWindow          *window);
 301 void             gtk_window_group_remove_window (GtkWindowGroup     *window_group,
 302                                                  GtkWindow          *window);
 303
 304 /* --- internal functions --- */
 305 void            gtk_window_set_focus           (GtkWindow *window,
 306                                                 GtkWidget *focus);
 307 void            gtk_window_set_default         (GtkWindow *window,
 308                                                 GtkWidget *defaultw);
 309 void            gtk_window_remove_embedded_xid (GtkWindow *window,
 310                                                 guint      xid);
 311 void            gtk_window_add_embedded_xid    (GtkWindow *window,
 312                                                 guint      xid);
 313 void            _gtk_window_reposition         (GtkWindow *window,
 314                                                 gint       x,
 315                                                 gint       y);
 316 void            _gtk_window_constrain_size     (GtkWindow *window,
 317                                                 gint       width,
 318                                                 gint       height,
 319                                                 gint      *new_width,
 320                                                 gint      *new_height);
 321 GtkWindowGroup *_gtk_window_get_group          (GtkWindow *window);
 322
 323 #ifdef __cplusplus
 324 }
 325 #endif /* __cplusplus */
 326
 327
 328 #endif /* __GTK_WINDOW_H__ */