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)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
  44 #define GTK_WINDOW_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
  45 #define GTK_IS_WINDOW(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_WINDOW))
  46 #define GTK_IS_WINDOW_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
  47 #define GTK_WINDOW_GET_CLASS(obj)       (G_TYPE_INSTANCE_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   guint type : 4; /* GtkWindowType */
  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   guint type_hint : 3; /* GdkWindowTypeHint */
 101   guint gravity : 5; /* GdkGravity */
 102
 103   guint is_active : 1;
 104   guint has_toplevel_focus : 1;
 105
 106   guint frame_left;
 107   guint frame_top;
 108   guint frame_right;
 109   guint frame_bottom;
 110
 111   guint keys_changed_handler;
 112
 113   GdkModifierType mnemonic_modifier;
 114   GdkScreen      *screen;
 115 };
 116
 117 struct _GtkWindowClass
 118 {
 119   GtkBinClass parent_class;
 120
 121   void     (* set_focus)   (GtkWindow *window,
 122                             GtkWidget *focus);
 123   gboolean (* frame_event) (GtkWindow *window,
 124                             GdkEvent  *event);
 125
 126   /* G_SIGNAL_ACTION signals for keybindings */
 127
 128   void     (* activate_focus)          (GtkWindow       *window);
 129   void     (* activate_default)        (GtkWindow       *window);
 130   void     (* move_focus)              (GtkWindow       *window,
 131                                         GtkDirectionType direction);
 132
 133   void     (*keys_changed)             (GtkWindow       *window);
 134
 135   /* Padding for future expansion */
 136   void (*_gtk_reserved1) (void);
 137   void (*_gtk_reserved2) (void);
 138   void (*_gtk_reserved3) (void);
 139   void (*_gtk_reserved4) (void);
 140 };
 141
 142 #define GTK_TYPE_WINDOW_GROUP             (gtk_window_group_get_type ())
 143 #define GTK_WINDOW_GROUP(object)          (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
 144 #define GTK_WINDOW_GROUP_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
 145 #define GTK_IS_WINDOW_GROUP(object)       (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
 146 #define GTK_IS_WINDOW_GROUP_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
 147 #define GTK_WINDOW_GROUP_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
 148
 149 struct _GtkWindowGroup
 150 {
 151   GObject parent_instance;
 152
 153   GSList *grabs;
 154 };
 155
 156 struct _GtkWindowGroupClass
 157 {
 158   GObjectClass parent_class;
 159
 160   /* Padding for future expansion */
 161   void (*_gtk_reserved1) (void);
 162   void (*_gtk_reserved2) (void);
 163   void (*_gtk_reserved3) (void);
 164   void (*_gtk_reserved4) (void);
 165 };
 166
 167 GType      gtk_window_get_type                 (void) G_GNUC_CONST;
 168 GtkWidget* gtk_window_new                      (GtkWindowType        type);
 169 void       gtk_window_set_title                (GtkWindow           *window,
 170                                                 const gchar         *title);
 171 G_CONST_RETURN gchar *gtk_window_get_title     (GtkWindow           *window);
 172 void       gtk_window_set_wmclass              (GtkWindow           *window,
 173                                                 const gchar         *wmclass_name,
 174                                                 const gchar         *wmclass_class);
 175 void       gtk_window_set_role                 (GtkWindow           *window,
 176                                                 const gchar         *role);
 177 G_CONST_RETURN gchar *gtk_window_get_role      (GtkWindow           *window);
 178 void       gtk_window_add_accel_group          (GtkWindow           *window,
 179                                                 GtkAccelGroup       *accel_group);
 180 void       gtk_window_remove_accel_group       (GtkWindow           *window,
 181                                                 GtkAccelGroup       *accel_group);
 182 void       gtk_window_set_position             (GtkWindow           *window,
 183                                                 GtkWindowPosition    position);
 184 gboolean   gtk_window_activate_focus           (GtkWindow           *window);
 185 void       gtk_window_set_focus                (GtkWindow           *window,
 186                                                 GtkWidget           *focus);
 187 GtkWidget *gtk_window_get_focus                (GtkWindow           *window);
 188 void       gtk_window_set_default              (GtkWindow           *window,
 189                                                 GtkWidget           *default_widget);
 190 gboolean   gtk_window_activate_default         (GtkWindow           *window);
 191
 192 void       gtk_window_set_transient_for        (GtkWindow           *window,
 193                                                 GtkWindow           *parent);
 194 GtkWindow *gtk_window_get_transient_for        (GtkWindow           *window);
 195 void       gtk_window_set_type_hint            (GtkWindow           *window,
 196                                                 GdkWindowTypeHint    hint);
 197 GdkWindowTypeHint gtk_window_get_type_hint     (GtkWindow           *window);
 198 void       gtk_window_set_skip_taskbar_hint    (GtkWindow           *window,
 199                                                 gboolean             setting);
 200 gboolean   gtk_window_get_skip_taskbar_hint    (GtkWindow           *window);
 201 void       gtk_window_set_skip_pager_hint      (GtkWindow           *window,
 202                                                 gboolean             setting);
 203 gboolean   gtk_window_get_skip_pager_hint      (GtkWindow           *window);
 204 void       gtk_window_set_accept_focus         (GtkWindow           *window,
 205                                                 gboolean             setting);
 206 gboolean   gtk_window_get_accept_focus         (GtkWindow           *window);
 207 void       gtk_window_set_focus_on_map         (GtkWindow           *window,
 208                                                 gboolean             setting);
 209 gboolean   gtk_window_get_focus_on_map         (GtkWindow           *window);
 210 void       gtk_window_set_destroy_with_parent  (GtkWindow           *window,
 211                                                 gboolean             setting);
 212 gboolean   gtk_window_get_destroy_with_parent  (GtkWindow           *window);
 213
 214 void       gtk_window_set_resizable            (GtkWindow           *window,
 215                                                 gboolean             resizable);
 216 gboolean   gtk_window_get_resizable            (GtkWindow           *window);
 217
 218 void       gtk_window_set_gravity              (GtkWindow           *window,
 219                                                 GdkGravity           gravity);
 220 GdkGravity gtk_window_get_gravity              (GtkWindow           *window);
 221
 222
 223 void       gtk_window_set_geometry_hints       (GtkWindow           *window,
 224                                                 GtkWidget           *geometry_widget,
 225                                                 GdkGeometry         *geometry,
 226                                                 GdkWindowHints       geom_mask);
 227
 228 void       gtk_window_set_screen               (GtkWindow           *window,
 229                                                 GdkScreen           *screen);
 230 GdkScreen* gtk_window_get_screen               (GtkWindow           *window);
 231
 232 gboolean   gtk_window_is_active                (GtkWindow           *window);
 233 gboolean   gtk_window_has_toplevel_focus       (GtkWindow           *window);
 234
 235
 236
 237 /* gtk_window_set_has_frame () must be called before realizing the window_*/
 238 void       gtk_window_set_has_frame            (GtkWindow *window,
 239                                                 gboolean   setting);
 240 gboolean   gtk_window_get_has_frame            (GtkWindow *window);
 241 void       gtk_window_set_frame_dimensions     (GtkWindow *window,
 242                                                 gint       left,
 243                                                 gint       top,
 244                                                 gint       right,
 245                                                 gint       bottom);
 246 void       gtk_window_get_frame_dimensions     (GtkWindow *window,
 247                                                 gint      *left,
 248                                                 gint      *top,
 249                                                 gint      *right,
 250                                                 gint      *bottom);
 251 void       gtk_window_set_decorated            (GtkWindow *window,
 252                                                 gboolean   setting);
 253 gboolean   gtk_window_get_decorated            (GtkWindow *window);
 254
 255 void       gtk_window_set_icon_list                (GtkWindow  *window,
 256                                                     GList      *list);
 257 GList*     gtk_window_get_icon_list                (GtkWindow  *window);
 258 void       gtk_window_set_icon                     (GtkWindow  *window,
 259                                                     GdkPixbuf  *icon);
 260 gboolean   gtk_window_set_icon_from_file           (GtkWindow   *window,
 261                                                     const gchar *filename,
 262                                                     GError     **err);
 263 GdkPixbuf* gtk_window_get_icon                     (GtkWindow  *window);
 264 void       gtk_window_set_default_icon_list        (GList      *list);
 265 GList*     gtk_window_get_default_icon_list        (void);
 266 void       gtk_window_set_default_icon             (GdkPixbuf  *icon);
 267 gboolean   gtk_window_set_default_icon_from_file   (const gchar *filename,
 268                                                     GError     **err);
 269
 270 void       gtk_window_set_auto_startup_notification (gboolean setting);
 271
 272 /* If window is set modal, input will be grabbed when show and released when hide */
 273 void       gtk_window_set_modal      (GtkWindow *window,
 274                                       gboolean   modal);
 275 gboolean   gtk_window_get_modal      (GtkWindow *window);
 276 GList*     gtk_window_list_toplevels (void);
 277
 278 void     gtk_window_add_mnemonic          (GtkWindow       *window,
 279                                            guint            keyval,
 280                                            GtkWidget       *target);
 281 void     gtk_window_remove_mnemonic       (GtkWindow       *window,
 282                                            guint            keyval,
 283                                            GtkWidget       *target);
 284 gboolean gtk_window_mnemonic_activate     (GtkWindow       *window,
 285                                            guint            keyval,
 286                                            GdkModifierType  modifier);
 287 void     gtk_window_set_mnemonic_modifier (GtkWindow       *window,
 288                                            GdkModifierType  modifier);
 289 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
 290
 291 gboolean gtk_window_activate_key          (GtkWindow        *window,
 292                                            GdkEventKey      *event);
 293 gboolean gtk_window_propagate_key_event   (GtkWindow        *window,
 294                                            GdkEventKey      *event);
 295
 296 void     gtk_window_present       (GtkWindow *window);
 297 void     gtk_window_iconify       (GtkWindow *window);
 298 void     gtk_window_deiconify     (GtkWindow *window);
 299 void     gtk_window_stick         (GtkWindow *window);
 300 void     gtk_window_unstick       (GtkWindow *window);
 301 void     gtk_window_maximize      (GtkWindow *window);
 302 void     gtk_window_unmaximize    (GtkWindow *window);
 303 void     gtk_window_fullscreen    (GtkWindow *window);
 304 void     gtk_window_unfullscreen  (GtkWindow *window);
 305 void     gtk_window_set_keep_above    (GtkWindow *window, gboolean setting);
 306 void     gtk_window_set_keep_below    (GtkWindow *window, gboolean setting);
 307
 308 void gtk_window_begin_resize_drag (GtkWindow     *window,
 309                                    GdkWindowEdge  edge,
 310                                    gint           button,
 311                                    gint           root_x,
 312                                    gint           root_y,
 313                                    guint32        timestamp);
 314 void gtk_window_begin_move_drag   (GtkWindow     *window,
 315                                    gint           button,
 316                                    gint           root_x,
 317                                    gint           root_y,
 318                                    guint32        timestamp);
 319
 320 #ifndef GTK_DISABLE_DEPRECATED
 321 void       gtk_window_set_policy               (GtkWindow           *window,
 322                                                 gint                 allow_shrink,
 323                                                 gint                 allow_grow,
 324                                                 gint                 auto_shrink);
 325 #define gtk_window_position                     gtk_window_set_position
 326 #endif /* GTK_DISABLE_DEPRECATED */
 327
 328 /* Set initial default size of the window (does not constrain user
 329  * resize operations)
 330  */
 331 void     gtk_window_set_default_size (GtkWindow   *window,
 332                                       gint         width,
 333                                       gint         height);
 334 void     gtk_window_get_default_size (GtkWindow   *window,
 335                                       gint        *width,
 336                                       gint        *height);
 337 void     gtk_window_resize           (GtkWindow   *window,
 338                                       gint         width,
 339                                       gint         height);
 340 void     gtk_window_get_size         (GtkWindow   *window,
 341                                       gint        *width,
 342                                       gint        *height);
 343 void     gtk_window_move             (GtkWindow   *window,
 344                                       gint         x,
 345                                       gint         y);
 346 void     gtk_window_get_position     (GtkWindow   *window,
 347                                       gint        *root_x,
 348                                       gint        *root_y);
 349 gboolean gtk_window_parse_geometry   (GtkWindow   *window,
 350                                       const gchar *geometry);
 351
 352 /* Ignore this unless you are writing a GUI builder */
 353 void     gtk_window_reshow_with_initial_size (GtkWindow *window);
 354
 355 /* Window groups
 356  */
 357 GType            gtk_window_group_get_type      (void) G_GNUC_CONST;
 358
 359 GtkWindowGroup * gtk_window_group_new           (void);
 360 void             gtk_window_group_add_window    (GtkWindowGroup     *window_group,
 361                                                  GtkWindow          *window);
 362 void             gtk_window_group_remove_window (GtkWindowGroup     *window_group,
 363                                                  GtkWindow          *window);
 364
 365 /* --- internal functions --- */
 366 void            _gtk_window_internal_set_focus (GtkWindow *window,
 367                                                 GtkWidget *focus);
 368 void            gtk_window_remove_embedded_xid (GtkWindow *window,
 369                                                 guint      xid);
 370 void            gtk_window_add_embedded_xid    (GtkWindow *window,
 371                                                 guint      xid);
 372 void            _gtk_window_reposition         (GtkWindow *window,
 373                                                 gint       x,
 374                                                 gint       y);
 375 void            _gtk_window_constrain_size     (GtkWindow *window,
 376                                                 gint       width,
 377                                                 gint       height,
 378                                                 gint      *new_width,
 379                                                 gint      *new_height);
 380 GtkWindowGroup *_gtk_window_get_group          (GtkWindow *window);
 381
 382 void            _gtk_window_set_has_toplevel_focus (GtkWindow *window,
 383                                                     gboolean   has_toplevel_focus);
 384 void            _gtk_window_unset_focus_and_default (GtkWindow *window,
 385                                                      GtkWidget *widget);
 386
 387 void            _gtk_window_set_is_active          (GtkWindow *window,
 388                                                     gboolean   is_active);
 389
 390 typedef void (*GtkWindowKeysForeachFunc) (GtkWindow      *window,
 391                                           guint           keyval,
 392                                           GdkModifierType modifiers,
 393                                           gboolean        is_mnemonic,
 394                                           gpointer        data);
 395
 396 void _gtk_window_keys_foreach (GtkWindow               *window,
 397                                GtkWindowKeysForeachFunc func,
 398                                gpointer                 func_data);
 399
 400 /* --- internal (GtkAcceleratable) --- */
 401 gboolean        _gtk_window_query_nonaccels     (GtkWindow      *window,
 402                                                  guint           accel_key,
 403                                                  GdkModifierType accel_mods);
 404
 405 #ifdef __cplusplus
 406 }
 407 #endif /* __cplusplus */
 408
 409
 410 #endif /* __GTK_WINDOW_H__ */