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