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