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