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 G_BEGIN_DECLS
  38
  39 #define GTK_TYPE_WINDOW                 (gtk_window_get_type ())
  40 #define GTK_WINDOW(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
  41 #define GTK_WINDOW_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
  42 #define GTK_IS_WINDOW(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_WINDOW))
  43 #define GTK_IS_WINDOW_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
  44 #define GTK_WINDOW_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW, GtkWindowClass))
  45
  46
  47 typedef struct _GtkWindow             GtkWindow;
  48 typedef struct _GtkWindowClass        GtkWindowClass;
  49 typedef struct _GtkWindowGeometryInfo GtkWindowGeometryInfo;
  50 typedef struct _GtkWindowGroup        GtkWindowGroup;
  51 typedef struct _GtkWindowGroupClass   GtkWindowGroupClass;
  52
  53 struct _GtkWindow
  54 {
  55   GtkBin bin;
  56
  57   gchar *title;
  58   gchar *wmclass_name;
  59   gchar *wmclass_class;
  60   gchar *wm_role;
  61
  62   GtkWidget *focus_widget;
  63   GtkWidget *default_widget;
  64   GtkWindow *transient_parent;
  65   GtkWindowGeometryInfo *geometry_info;
  66   GdkWindow *frame;
  67   GtkWindowGroup *group;
  68
  69   guint16 configure_request_count;
  70   guint allow_shrink : 1;
  71   guint allow_grow : 1;
  72   guint configure_notify_received : 1;
  73   /* The following flags are initially TRUE (before a window is mapped).
  74    * They cause us to compute a configure request that involves
  75    * default-only parameters. Once mapped, we set them to FALSE.
  76    * Then we set them to TRUE again on unmap (for position)
  77    * and on unrealize (for size).
  78    */
  79   guint need_default_position : 1;
  80   guint need_default_size : 1;
  81   guint position : 3;
  82   guint type : 4; /* GtkWindowType */
  83   guint has_user_ref_count : 1;
  84   guint has_focus : 1;
  85
  86   guint modal : 1;
  87   guint destroy_with_parent : 1;
  88
  89   guint has_frame : 1;
  90
  91   /* gtk_window_iconify() called before realization */
  92   guint iconify_initially : 1;
  93   guint stick_initially : 1;
  94   guint maximize_initially : 1;
  95   guint decorated : 1;
  96
  97   guint type_hint : 3; /* GdkWindowTypeHint if the hint is one of the original eight. If not, then
  98                         * it contains GDK_WINDOW_TYPE_HINT_NORMAL
  99                         */
 100   guint gravity : 5; /* GdkGravity */
 101
 102   guint is_active : 1;
 103   guint has_toplevel_focus : 1;
 104
 105   guint frame_left;
 106   guint frame_top;
 107   guint frame_right;
 108   guint frame_bottom;
 109
 110   guint keys_changed_handler;
 111
 112   GdkModifierType mnemonic_modifier;
 113   GdkScreen      *screen;
 114 };
 115
 116 struct _GtkWindowClass
 117 {
 118   GtkBinClass parent_class;
 119
 120   void     (* set_focus)   (GtkWindow *window,
 121                             GtkWidget *focus);
 122   gboolean (* frame_event) (GtkWindow *window,
 123                             GdkEvent  *event);
 124
 125   /* G_SIGNAL_ACTION signals for keybindings */
 126
 127   void     (* activate_focus)          (GtkWindow       *window);
 128   void     (* activate_default)        (GtkWindow       *window);
 129   void     (* move_focus)              (GtkWindow       *window,
 130                                         GtkDirectionType direction);
 131
 132   void     (*keys_changed)             (GtkWindow       *window);
 133
 134   /* Padding for future expansion */
 135   void (*_gtk_reserved1) (void);
 136   void (*_gtk_reserved2) (void);
 137   void (*_gtk_reserved3) (void);
 138   void (*_gtk_reserved4) (void);
 139 };
 140
 141 #define GTK_TYPE_WINDOW_GROUP             (gtk_window_group_get_type ())
 142 #define GTK_WINDOW_GROUP(object)          (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
 143 #define GTK_WINDOW_GROUP_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
 144 #define GTK_IS_WINDOW_GROUP(object)       (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
 145 #define GTK_IS_WINDOW_GROUP_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
 146 #define GTK_WINDOW_GROUP_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
 147
 148 struct _GtkWindowGroup
 149 {
 150   GObject parent_instance;
 151
 152   GSList *grabs;
 153 };
 154
 155 struct _GtkWindowGroupClass
 156 {
 157   GObjectClass parent_class;
 158
 159   /* Padding for future expansion */
 160   void (*_gtk_reserved1) (void);
 161   void (*_gtk_reserved2) (void);
 162   void (*_gtk_reserved3) (void);
 163   void (*_gtk_reserved4) (void);
 164 };
 165
 166 #ifdef G_OS_WIN32
 167 /* Reserve old names for DLL ABI backward compatibility */
 168 #define gtk_window_set_icon_from_file gtk_window_set_icon_from_file_utf8
 169 #define gtk_window_set_default_icon_from_file gtk_window_set_default_icon_from_file_utf8
 170 #endif
 171
 172 GType      gtk_window_get_type                 (void) G_GNUC_CONST;
 173 GtkWidget* gtk_window_new                      (GtkWindowType        type);
 174 void       gtk_window_set_title                (GtkWindow           *window,
 175                                                 const gchar         *title);
 176 G_CONST_RETURN gchar *gtk_window_get_title     (GtkWindow           *window);
 177 void       gtk_window_set_wmclass              (GtkWindow           *window,
 178                                                 const gchar         *wmclass_name,
 179                                                 const gchar         *wmclass_class);
 180 void       gtk_window_set_role                 (GtkWindow           *window,
 181                                                 const gchar         *role);
 182 G_CONST_RETURN gchar *gtk_window_get_role      (GtkWindow           *window);
 183 void       gtk_window_add_accel_group          (GtkWindow           *window,
 184                                                 GtkAccelGroup       *accel_group);
 185 void       gtk_window_remove_accel_group       (GtkWindow           *window,
 186                                                 GtkAccelGroup       *accel_group);
 187 void       gtk_window_set_position             (GtkWindow           *window,
 188                                                 GtkWindowPosition    position);
 189 gboolean   gtk_window_activate_focus           (GtkWindow           *window);
 190 void       gtk_window_set_focus                (GtkWindow           *window,
 191                                                 GtkWidget           *focus);
 192 GtkWidget *gtk_window_get_focus                (GtkWindow           *window);
 193 void       gtk_window_set_default              (GtkWindow           *window,
 194                                                 GtkWidget           *default_widget);
 195 gboolean   gtk_window_activate_default         (GtkWindow           *window);
 196
 197 void       gtk_window_set_transient_for        (GtkWindow           *window,
 198                                                 GtkWindow           *parent);
 199 GtkWindow *gtk_window_get_transient_for        (GtkWindow           *window);
 200 void       gtk_window_set_type_hint            (GtkWindow           *window,
 201                                                 GdkWindowTypeHint    hint);
 202 GdkWindowTypeHint gtk_window_get_type_hint     (GtkWindow           *window);
 203 void       gtk_window_set_skip_taskbar_hint    (GtkWindow           *window,
 204                                                 gboolean             setting);
 205 gboolean   gtk_window_get_skip_taskbar_hint    (GtkWindow           *window);
 206 void       gtk_window_set_skip_pager_hint      (GtkWindow           *window,
 207                                                 gboolean             setting);
 208 gboolean   gtk_window_get_skip_pager_hint      (GtkWindow           *window);
 209 void       gtk_window_set_urgency_hint         (GtkWindow           *window,
 210                                                 gboolean             setting);
 211 gboolean   gtk_window_get_urgency_hint         (GtkWindow           *window);
 212 void       gtk_window_set_accept_focus         (GtkWindow           *window,
 213                                                 gboolean             setting);
 214 gboolean   gtk_window_get_accept_focus         (GtkWindow           *window);
 215 void       gtk_window_set_focus_on_map         (GtkWindow           *window,
 216                                                 gboolean             setting);
 217 gboolean   gtk_window_get_focus_on_map         (GtkWindow           *window);
 218 void       gtk_window_set_destroy_with_parent  (GtkWindow           *window,
 219                                                 gboolean             setting);
 220 gboolean   gtk_window_get_destroy_with_parent  (GtkWindow           *window);
 221
 222 void       gtk_window_set_resizable            (GtkWindow           *window,
 223                                                 gboolean             resizable);
 224 gboolean   gtk_window_get_resizable            (GtkWindow           *window);
 225
 226 void       gtk_window_set_gravity              (GtkWindow           *window,
 227                                                 GdkGravity           gravity);
 228 GdkGravity gtk_window_get_gravity              (GtkWindow           *window);
 229
 230
 231 void       gtk_window_set_geometry_hints       (GtkWindow           *window,
 232                                                 GtkWidget           *geometry_widget,
 233                                                 GdkGeometry         *geometry,
 234                                                 GdkWindowHints       geom_mask);
 235
 236 void       gtk_window_set_screen               (GtkWindow           *window,
 237                                                 GdkScreen           *screen);
 238 GdkScreen* gtk_window_get_screen               (GtkWindow           *window);
 239
 240 gboolean   gtk_window_is_active                (GtkWindow           *window);
 241 gboolean   gtk_window_has_toplevel_focus       (GtkWindow           *window);
 242
 243
 244
 245 /* gtk_window_set_has_frame () must be called before realizing the window_*/
 246 void       gtk_window_set_has_frame            (GtkWindow *window,
 247                                                 gboolean   setting);
 248 gboolean   gtk_window_get_has_frame            (GtkWindow *window);
 249 void       gtk_window_set_frame_dimensions     (GtkWindow *window,
 250                                                 gint       left,
 251                                                 gint       top,
 252                                                 gint       right,
 253                                                 gint       bottom);
 254 void       gtk_window_get_frame_dimensions     (GtkWindow *window,
 255                                                 gint      *left,
 256                                                 gint      *top,
 257                                                 gint      *right,
 258                                                 gint      *bottom);
 259 void       gtk_window_set_decorated            (GtkWindow *window,
 260                                                 gboolean   setting);
 261 gboolean   gtk_window_get_decorated            (GtkWindow *window);
 262 void       gtk_window_set_deletable            (GtkWindow *window,
 263                                                 gboolean   setting);
 264 gboolean   gtk_window_get_deletable            (GtkWindow *window);
 265
 266 void       gtk_window_set_icon_list                (GtkWindow  *window,
 267                                                     GList      *list);
 268 GList*     gtk_window_get_icon_list                (GtkWindow  *window);
 269 void       gtk_window_set_icon                     (GtkWindow  *window,
 270                                                     GdkPixbuf  *icon);
 271 void       gtk_window_set_icon_name                (GtkWindow   *window,
 272                                                     const gchar *name);
 273 gboolean   gtk_window_set_icon_from_file           (GtkWindow   *window,
 274                                                     const gchar *filename,
 275                                                     GError     **err);
 276 GdkPixbuf* gtk_window_get_icon                     (GtkWindow  *window);
 277 G_CONST_RETURN
 278 gchar     *gtk_window_get_icon_name                (GtkWindow  *window);
 279 void       gtk_window_set_default_icon_list        (GList      *list);
 280 GList*     gtk_window_get_default_icon_list        (void);
 281 void       gtk_window_set_default_icon             (GdkPixbuf  *icon);
 282 void       gtk_window_set_default_icon_name        (const gchar *name);
 283 gboolean   gtk_window_set_default_icon_from_file   (const gchar *filename,
 284                                                     GError     **err);
 285
 286 void       gtk_window_set_auto_startup_notification (gboolean setting);
 287
 288 /* If window is set modal, input will be grabbed when show and released when hide */
 289 void       gtk_window_set_modal      (GtkWindow *window,
 290                                       gboolean   modal);
 291 gboolean   gtk_window_get_modal      (GtkWindow *window);
 292 GList*     gtk_window_list_toplevels (void);
 293
 294 void     gtk_window_add_mnemonic          (GtkWindow       *window,
 295                                            guint            keyval,
 296                                            GtkWidget       *target);
 297 void     gtk_window_remove_mnemonic       (GtkWindow       *window,
 298                                            guint            keyval,
 299                                            GtkWidget       *target);
 300 gboolean gtk_window_mnemonic_activate     (GtkWindow       *window,
 301                                            guint            keyval,
 302                                            GdkModifierType  modifier);
 303 void     gtk_window_set_mnemonic_modifier (GtkWindow       *window,
 304                                            GdkModifierType  modifier);
 305 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
 306
 307 gboolean gtk_window_activate_key          (GtkWindow        *window,
 308                                            GdkEventKey      *event);
 309 gboolean gtk_window_propagate_key_event   (GtkWindow        *window,
 310                                            GdkEventKey      *event);
 311
 312 void     gtk_window_present            (GtkWindow *window);
 313 void     gtk_window_present_with_time  (GtkWindow *window,
 314                                         guint32    timestamp);
 315 void     gtk_window_iconify       (GtkWindow *window);
 316 void     gtk_window_deiconify     (GtkWindow *window);
 317 void     gtk_window_stick         (GtkWindow *window);
 318 void     gtk_window_unstick       (GtkWindow *window);
 319 void     gtk_window_maximize      (GtkWindow *window);
 320 void     gtk_window_unmaximize    (GtkWindow *window);
 321 void     gtk_window_fullscreen    (GtkWindow *window);
 322 void     gtk_window_unfullscreen  (GtkWindow *window);
 323 void     gtk_window_set_keep_above    (GtkWindow *window, gboolean setting);
 324 void     gtk_window_set_keep_below    (GtkWindow *window, gboolean setting);
 325
 326 void gtk_window_begin_resize_drag (GtkWindow     *window,
 327                                    GdkWindowEdge  edge,
 328                                    gint           button,
 329                                    gint           root_x,
 330                                    gint           root_y,
 331                                    guint32        timestamp);
 332 void gtk_window_begin_move_drag   (GtkWindow     *window,
 333                                    gint           button,
 334                                    gint           root_x,
 335                                    gint           root_y,
 336                                    guint32        timestamp);
 337
 338 #ifndef GTK_DISABLE_DEPRECATED
 339 void       gtk_window_set_policy               (GtkWindow           *window,
 340                                                 gint                 allow_shrink,
 341                                                 gint                 allow_grow,
 342                                                 gint                 auto_shrink);
 343 #define gtk_window_position                     gtk_window_set_position
 344 #endif /* GTK_DISABLE_DEPRECATED */
 345
 346 /* Set initial default size of the window (does not constrain user
 347  * resize operations)
 348  */
 349 void     gtk_window_set_default_size (GtkWindow   *window,
 350                                       gint         width,
 351                                       gint         height);
 352 void     gtk_window_get_default_size (GtkWindow   *window,
 353                                       gint        *width,
 354                                       gint        *height);
 355 void     gtk_window_resize           (GtkWindow   *window,
 356                                       gint         width,
 357                                       gint         height);
 358 void     gtk_window_get_size         (GtkWindow   *window,
 359                                       gint        *width,
 360                                       gint        *height);
 361 void     gtk_window_move             (GtkWindow   *window,
 362                                       gint         x,
 363                                       gint         y);
 364 void     gtk_window_get_position     (GtkWindow   *window,
 365                                       gint        *root_x,
 366                                       gint        *root_y);
 367 gboolean gtk_window_parse_geometry   (GtkWindow   *window,
 368                                       const gchar *geometry);
 369 GtkWindowGroup *gtk_window_get_group (GtkWindow   *window);
 370
 371 /* Ignore this unless you are writing a GUI builder */
 372 void     gtk_window_reshow_with_initial_size (GtkWindow *window);
 373
 374 /* Window groups
 375  */
 376 GType            gtk_window_group_get_type      (void) G_GNUC_CONST;
 377
 378 GtkWindowGroup * gtk_window_group_new           (void);
 379 void             gtk_window_group_add_window    (GtkWindowGroup     *window_group,
 380                                                  GtkWindow          *window);
 381 void             gtk_window_group_remove_window (GtkWindowGroup     *window_group,
 382                                                  GtkWindow          *window);
 383
 384 /* --- internal functions --- */
 385 void            _gtk_window_internal_set_focus (GtkWindow *window,
 386                                                 GtkWidget *focus);
 387 void            gtk_window_remove_embedded_xid (GtkWindow *window,
 388                                                 guint      xid);
 389 void            gtk_window_add_embedded_xid    (GtkWindow *window,
 390                                                 guint      xid);
 391 void            _gtk_window_reposition         (GtkWindow *window,
 392                                                 gint       x,
 393                                                 gint       y);
 394 void            _gtk_window_constrain_size     (GtkWindow *window,
 395                                                 gint       width,
 396                                                 gint       height,
 397                                                 gint      *new_width,
 398                                                 gint      *new_height);
 399 GtkWidget      *_gtk_window_group_get_current_grab (GtkWindowGroup *window_group);
 400
 401 void            _gtk_window_set_has_toplevel_focus (GtkWindow *window,
 402                                                     gboolean   has_toplevel_focus);
 403 void            _gtk_window_unset_focus_and_default (GtkWindow *window,
 404                                                      GtkWidget *widget);
 405
 406 void            _gtk_window_set_is_active          (GtkWindow *window,
 407                                                     gboolean   is_active);
 408
 409 typedef void (*GtkWindowKeysForeachFunc) (GtkWindow      *window,
 410                                           guint           keyval,
 411                                           GdkModifierType modifiers,
 412                                           gboolean        is_mnemonic,
 413                                           gpointer        data);
 414
 415 void _gtk_window_keys_foreach (GtkWindow               *window,
 416                                GtkWindowKeysForeachFunc func,
 417                                gpointer                 func_data);
 418
 419 /* --- internal (GtkAcceleratable) --- */
 420 gboolean        _gtk_window_query_nonaccels     (GtkWindow      *window,
 421                                                  guint           accel_key,
 422                                                  GdkModifierType accel_mods);
 423
 424 G_END_DECLS
 425
 426 #endif /* __GTK_WINDOW_H__ */