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