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