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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __GTK_WINDOW_H__
  26 #define __GTK_WINDOW_H__
  27
  28
  29 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  30 #error "Only <gtk/gtk.h> can be included directly."
  31 #endif
  32
  33 #include <gtk/gtkapplication.h>
  34 #include <gtk/gtkaccelgroup.h>
  35 #include <gtk/gtkbin.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #define GTK_TYPE_WINDOW                 (gtk_window_get_type ())
  40 #define GTK_WINDOW(obj)                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
  41 #define GTK_WINDOW_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
  42 #define GTK_IS_WINDOW(obj)              (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_WINDOW))
  43 #define GTK_IS_WINDOW_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
  44 #define GTK_WINDOW_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW, GtkWindowClass))
  45
  46 typedef struct _GtkWindowPrivate      GtkWindowPrivate;
  47 typedef struct _GtkWindowClass        GtkWindowClass;
  48 typedef struct _GtkWindowGeometryInfo GtkWindowGeometryInfo;
  49 typedef struct _GtkWindowGroup        GtkWindowGroup;
  50 typedef struct _GtkWindowGroupClass   GtkWindowGroupClass;
  51 typedef struct _GtkWindowGroupPrivate GtkWindowGroupPrivate;
  52
  53 struct _GtkWindow
  54 {
  55   GtkBin bin;
  56
  57   GtkWindowPrivate *priv;
  58 };
  59
  60 struct _GtkWindowClass
  61 {
  62   GtkBinClass parent_class;
  63
  64   void     (* set_focus)   (GtkWindow *window,
  65                             GtkWidget *focus);
  66
  67   /* G_SIGNAL_ACTION signals for keybindings */
  68
  69   void     (* activate_focus)   (GtkWindow *window);
  70   void     (* activate_default) (GtkWindow *window);
  71   void     (* keys_changed)     (GtkWindow *window);
  72
  73   /* Padding for future expansion */
  74   void (*_gtk_reserved1) (void);
  75   void (*_gtk_reserved2) (void);
  76   void (*_gtk_reserved3) (void);
  77   void (*_gtk_reserved4) (void);
  78 };
  79
  80 #define GTK_TYPE_WINDOW_GROUP             (gtk_window_group_get_type ())
  81 #define GTK_WINDOW_GROUP(object)          (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
  82 #define GTK_WINDOW_GROUP_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
  83 #define GTK_IS_WINDOW_GROUP(object)       (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
  84 #define GTK_IS_WINDOW_GROUP_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
  85 #define GTK_WINDOW_GROUP_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
  86
  87 struct _GtkWindowGroup
  88 {
  89   GObject parent_instance;
  90
  91   GtkWindowGroupPrivate *priv;
  92 };
  93
  94 struct _GtkWindowGroupClass
  95 {
  96   GObjectClass parent_class;
  97
  98   /* Padding for future expansion */
  99   void (*_gtk_reserved1) (void);
 100   void (*_gtk_reserved2) (void);
 101   void (*_gtk_reserved3) (void);
 102   void (*_gtk_reserved4) (void);
 103 };
 104
 105 GType      gtk_window_get_type                 (void) G_GNUC_CONST;
 106 GtkWidget* gtk_window_new                      (GtkWindowType        type);
 107 void       gtk_window_set_title                (GtkWindow           *window,
 108                                                 const gchar         *title);
 109 const gchar * gtk_window_get_title             (GtkWindow           *window);
 110 void       gtk_window_set_wmclass              (GtkWindow           *window,
 111                                                 const gchar         *wmclass_name,
 112                                                 const gchar         *wmclass_class);
 113 void       gtk_window_set_role                 (GtkWindow           *window,
 114                                                 const gchar         *role);
 115 void       gtk_window_set_startup_id           (GtkWindow           *window,
 116                                                 const gchar         *startup_id);
 117 const gchar * gtk_window_get_role              (GtkWindow           *window);
 118 void       gtk_window_add_accel_group          (GtkWindow           *window,
 119                                                 GtkAccelGroup       *accel_group);
 120 void       gtk_window_remove_accel_group       (GtkWindow           *window,
 121                                                 GtkAccelGroup       *accel_group);
 122 void       gtk_window_set_position             (GtkWindow           *window,
 123                                                 GtkWindowPosition    position);
 124 gboolean   gtk_window_activate_focus           (GtkWindow           *window);
 125 void       gtk_window_set_focus                (GtkWindow           *window,
 126                                                 GtkWidget           *focus);
 127 GtkWidget *gtk_window_get_focus                (GtkWindow           *window);
 128 void       gtk_window_set_default              (GtkWindow           *window,
 129                                                 GtkWidget           *default_widget);
 130 GtkWidget *gtk_window_get_default_widget       (GtkWindow           *window);
 131 gboolean   gtk_window_activate_default         (GtkWindow           *window);
 132
 133 void       gtk_window_set_transient_for        (GtkWindow           *window,
 134                                                 GtkWindow           *parent);
 135 GtkWindow *gtk_window_get_transient_for        (GtkWindow           *window);
 136 GDK_AVAILABLE_IN_3_4
 137 void       gtk_window_set_attached_to          (GtkWindow           *window,
 138                                                 GtkWidget           *attach_widget);
 139 GDK_AVAILABLE_IN_3_4
 140 GtkWidget *gtk_window_get_attached_to          (GtkWindow           *window);
 141 GDK_DEPRECATED_IN_3_8_FOR(gtk_widget_set_opacity)
 142 void       gtk_window_set_opacity              (GtkWindow           *window,
 143                                                 gdouble              opacity);
 144 GDK_DEPRECATED_IN_3_8_FOR(gtk_widget_get_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 GDK_AVAILABLE_IN_3_4
 168 void       gtk_window_set_hide_titlebar_when_maximized (GtkWindow   *window,
 169                                                         gboolean     setting);
 170 GDK_AVAILABLE_IN_3_4
 171 gboolean   gtk_window_get_hide_titlebar_when_maximized (GtkWindow   *window);
 172 void       gtk_window_set_mnemonics_visible    (GtkWindow           *window,
 173                                                 gboolean             setting);
 174 gboolean   gtk_window_get_mnemonics_visible    (GtkWindow           *window);
 175 GDK_AVAILABLE_IN_3_2
 176 void       gtk_window_set_focus_visible        (GtkWindow           *window,
 177                                                 gboolean             setting);
 178 GDK_AVAILABLE_IN_3_2
 179 gboolean   gtk_window_get_focus_visible        (GtkWindow           *window);
 180
 181 void       gtk_window_set_resizable            (GtkWindow           *window,
 182                                                 gboolean             resizable);
 183 gboolean   gtk_window_get_resizable            (GtkWindow           *window);
 184
 185 void       gtk_window_set_gravity              (GtkWindow           *window,
 186                                                 GdkGravity           gravity);
 187 GdkGravity gtk_window_get_gravity              (GtkWindow           *window);
 188
 189
 190 void       gtk_window_set_geometry_hints       (GtkWindow           *window,
 191                                                 GtkWidget           *geometry_widget,
 192                                                 GdkGeometry         *geometry,
 193                                                 GdkWindowHints       geom_mask);
 194
 195 void       gtk_window_set_screen               (GtkWindow           *window,
 196                                                 GdkScreen           *screen);
 197 GdkScreen* gtk_window_get_screen               (GtkWindow           *window);
 198
 199 gboolean   gtk_window_is_active                (GtkWindow           *window);
 200 gboolean   gtk_window_has_toplevel_focus       (GtkWindow           *window);
 201
 202 void       gtk_window_set_decorated            (GtkWindow *window,
 203                                                 gboolean   setting);
 204 gboolean   gtk_window_get_decorated            (GtkWindow *window);
 205 void       gtk_window_set_deletable            (GtkWindow *window,
 206                                                 gboolean   setting);
 207 gboolean   gtk_window_get_deletable            (GtkWindow *window);
 208
 209 void       gtk_window_set_icon_list                (GtkWindow  *window,
 210                                                     GList      *list);
 211 GList*     gtk_window_get_icon_list                (GtkWindow  *window);
 212 void       gtk_window_set_icon                     (GtkWindow  *window,
 213                                                     GdkPixbuf  *icon);
 214 void       gtk_window_set_icon_name                (GtkWindow   *window,
 215                                                     const gchar *name);
 216 gboolean   gtk_window_set_icon_from_file           (GtkWindow   *window,
 217                                                     const gchar *filename,
 218                                                     GError     **err);
 219 GdkPixbuf* gtk_window_get_icon                     (GtkWindow  *window);
 220 const gchar * gtk_window_get_icon_name             (GtkWindow  *window);
 221 void       gtk_window_set_default_icon_list        (GList      *list);
 222 GList*     gtk_window_get_default_icon_list        (void);
 223 void       gtk_window_set_default_icon             (GdkPixbuf  *icon);
 224 void       gtk_window_set_default_icon_name        (const gchar *name);
 225 const gchar * gtk_window_get_default_icon_name     (void);
 226 gboolean   gtk_window_set_default_icon_from_file   (const gchar *filename,
 227                                                     GError     **err);
 228
 229 void       gtk_window_set_auto_startup_notification (gboolean setting);
 230
 231 /* If window is set modal, input will be grabbed when show and released when hide */
 232 void       gtk_window_set_modal      (GtkWindow *window,
 233                                       gboolean   modal);
 234 gboolean   gtk_window_get_modal      (GtkWindow *window);
 235 GList*     gtk_window_list_toplevels (void);
 236 void       gtk_window_set_has_user_ref_count (GtkWindow *window,
 237                                               gboolean   setting);
 238
 239 void     gtk_window_add_mnemonic          (GtkWindow       *window,
 240                                            guint            keyval,
 241                                            GtkWidget       *target);
 242 void     gtk_window_remove_mnemonic       (GtkWindow       *window,
 243                                            guint            keyval,
 244                                            GtkWidget       *target);
 245 gboolean gtk_window_mnemonic_activate     (GtkWindow       *window,
 246                                            guint            keyval,
 247                                            GdkModifierType  modifier);
 248 void     gtk_window_set_mnemonic_modifier (GtkWindow       *window,
 249                                            GdkModifierType  modifier);
 250 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
 251
 252 gboolean gtk_window_activate_key          (GtkWindow        *window,
 253                                            GdkEventKey      *event);
 254 gboolean gtk_window_propagate_key_event   (GtkWindow        *window,
 255                                            GdkEventKey      *event);
 256
 257 void     gtk_window_present            (GtkWindow *window);
 258 void     gtk_window_present_with_time  (GtkWindow *window,
 259                                         guint32    timestamp);
 260 void     gtk_window_iconify       (GtkWindow *window);
 261 void     gtk_window_deiconify     (GtkWindow *window);
 262 void     gtk_window_stick         (GtkWindow *window);
 263 void     gtk_window_unstick       (GtkWindow *window);
 264 void     gtk_window_maximize      (GtkWindow *window);
 265 void     gtk_window_unmaximize    (GtkWindow *window);
 266 void     gtk_window_fullscreen    (GtkWindow *window);
 267 void     gtk_window_unfullscreen  (GtkWindow *window);
 268 void     gtk_window_set_keep_above    (GtkWindow *window, gboolean setting);
 269 void     gtk_window_set_keep_below    (GtkWindow *window, gboolean setting);
 270
 271 void gtk_window_begin_resize_drag (GtkWindow     *window,
 272                                    GdkWindowEdge  edge,
 273                                    gint           button,
 274                                    gint           root_x,
 275                                    gint           root_y,
 276                                    guint32        timestamp);
 277 void gtk_window_begin_move_drag   (GtkWindow     *window,
 278                                    gint           button,
 279                                    gint           root_x,
 280                                    gint           root_y,
 281                                    guint32        timestamp);
 282
 283 /* Set initial default size of the window (does not constrain user
 284  * resize operations)
 285  */
 286 void     gtk_window_set_default_size (GtkWindow   *window,
 287                                       gint         width,
 288                                       gint         height);
 289 void     gtk_window_get_default_size (GtkWindow   *window,
 290                                       gint        *width,
 291                                       gint        *height);
 292 void     gtk_window_resize           (GtkWindow   *window,
 293                                       gint         width,
 294                                       gint         height);
 295 void     gtk_window_get_size         (GtkWindow   *window,
 296                                       gint        *width,
 297                                       gint        *height);
 298 void     gtk_window_move             (GtkWindow   *window,
 299                                       gint         x,
 300                                       gint         y);
 301 void     gtk_window_get_position     (GtkWindow   *window,
 302                                       gint        *root_x,
 303                                       gint        *root_y);
 304 gboolean gtk_window_parse_geometry   (GtkWindow   *window,
 305                                       const gchar *geometry);
 306
 307 void gtk_window_set_default_geometry (GtkWindow *window,
 308                                       gint       width,
 309                                       gint       height);
 310 void gtk_window_resize_to_geometry   (GtkWindow *window,
 311                                       gint       width,
 312                                       gint       height);
 313
 314 GtkWindowGroup *gtk_window_get_group (GtkWindow   *window);
 315 gboolean gtk_window_has_group        (GtkWindow   *window);
 316
 317 /* Ignore this unless you are writing a GUI builder */
 318 void     gtk_window_reshow_with_initial_size (GtkWindow *window);
 319
 320 GtkWindowType gtk_window_get_window_type     (GtkWindow     *window);
 321
 322 /* Window groups
 323  */
 324 GType            gtk_window_group_get_type      (void) G_GNUC_CONST;
 325
 326 GtkWindowGroup * gtk_window_group_new           (void);
 327 void             gtk_window_group_add_window    (GtkWindowGroup     *window_group,
 328                                                  GtkWindow          *window);
 329 void             gtk_window_group_remove_window (GtkWindowGroup     *window_group,
 330                                                  GtkWindow          *window);
 331 GList *          gtk_window_group_list_windows  (GtkWindowGroup     *window_group);
 332
 333 GtkWidget *      gtk_window_group_get_current_grab (GtkWindowGroup *window_group);
 334 GtkWidget *      gtk_window_group_get_current_device_grab (GtkWindowGroup *window_group,
 335                                                            GdkDevice      *device);
 336
 337 GtkApplication *gtk_window_get_application      (GtkWindow          *window);
 338 void            gtk_window_set_application      (GtkWindow          *window,
 339                                                  GtkApplication     *application);
 340
 341
 342 /* Window grips
 343  */
 344 void     gtk_window_set_has_resize_grip    (GtkWindow    *window,
 345                                             gboolean      value);
 346 gboolean gtk_window_get_has_resize_grip    (GtkWindow    *window);
 347 gboolean gtk_window_resize_grip_is_visible (GtkWindow    *window);
 348 gboolean gtk_window_get_resize_grip_area   (GtkWindow    *window,
 349                                             GdkRectangle *rect);
 350
 351 G_END_DECLS
 352
 353 #endif /* __GTK_WINDOW_H__ */