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