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 #ifndef __GTK_WINDOW_H__
  28 #define __GTK_WINDOW_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkaccelgroup.h>
  33 #include <gtk/gtkbin.h>
  34 #include <gtk/gtkenums.h>
  35 #include <gtk/gtkwidget.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif /* __cplusplus */
  40
  41
  42 #define GTK_TYPE_WINDOW                 (gtk_window_get_type ())
  43 #define GTK_WINDOW(obj)                 (GTK_CHECK_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
  44 #define GTK_WINDOW_CLASS(klass)         (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
  45 #define GTK_IS_WINDOW(obj)              (GTK_CHECK_TYPE ((obj), GTK_TYPE_WINDOW))
  46 #define GTK_IS_WINDOW_CLASS(klass)      (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
  47 #define GTK_WINDOW_GET_CLASS(obj)       (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_WINDOW, GtkWindowClass))
  48
  49
  50 typedef struct _GtkWindow             GtkWindow;
  51 typedef struct _GtkWindowClass        GtkWindowClass;
  52 typedef struct _GtkWindowGeometryInfo GtkWindowGeometryInfo;
  53 typedef struct _GtkWindowGroup        GtkWindowGroup;
  54 typedef struct _GtkWindowGroupClass   GtkWindowGroupClass;
  55
  56 struct _GtkWindow
  57 {
  58   GtkBin bin;
  59
  60   gchar *title;
  61   gchar *wmclass_name;
  62   gchar *wmclass_class;
  63   gchar *wm_role;
  64
  65   GtkWidget *focus_widget;
  66   GtkWidget *default_widget;
  67   GtkWindow *transient_parent;
  68   GtkWindowGeometryInfo *geometry_info;
  69   GdkWindow *frame;
  70   GtkWindowGroup *group;
  71
  72   guint16 configure_request_count;
  73   guint allow_shrink : 1;
  74   guint allow_grow : 1;
  75   guint configure_notify_received : 1;
  76   /* The following flags are initially TRUE (before a window is mapped).
  77    * They cause us to compute a configure request that involves
  78    * default-only parameters. Once mapped, we set them to FALSE.
  79    * Then we set them to TRUE again on unmap (for position)
  80    * and on unrealize (for size).
  81    */
  82   guint need_default_position : 1;
  83   guint need_default_size : 1;
  84   guint position : 3;
  85   GtkWindowType type : 4;
  86   guint has_user_ref_count : 1;
  87   guint has_focus : 1;
  88
  89   guint modal : 1;
  90   guint destroy_with_parent : 1;
  91
  92   guint has_frame : 1;
  93
  94   /* gtk_window_iconify() called before realization */
  95   guint iconify_initially : 1;
  96   guint stick_initially : 1;
  97   guint maximize_initially : 1;
  98   guint decorated : 1;
  99
 100   GdkWindowTypeHint type_hint : 3;
 101   GdkGravity gravity : 5;
 102
 103   guint frame_left;
 104   guint frame_top;
 105   guint frame_right;
 106   guint frame_bottom;
 107
 108   guint keys_changed_handler;
 109
 110   GdkModifierType mnemonic_modifier;
 111   gpointer gtk_reserved1;       /* For future GdkScreen * */
 112 };
 113
 114 struct _GtkWindowClass
 115 {
 116   GtkBinClass parent_class;
 117
 118   void     (* set_focus)   (GtkWindow *window,
 119                             GtkWidget *focus);
 120   gboolean (* frame_event) (GtkWindow *window,
 121                             GdkEvent  *event);
 122
 123   /* G_SIGNAL_ACTION signals for keybindings */
 124
 125   void     (* activate_focus)          (GtkWindow       *window);
 126   void     (* activate_default)        (GtkWindow       *window);
 127   void     (* move_focus)              (GtkWindow       *window,
 128                                         GtkDirectionType direction);
 129   void     (*keys_changed)             (GtkWindow       *window);
 130 };
 131
 132 #define GTK_TYPE_WINDOW_GROUP             (gtk_window_group_get_type ())
 133 #define GTK_WINDOW_GROUP(object)          (G_TYPE_CHECK_INSTANCE_CAST ((object), GTK_TYPE_WINDOW_GROUP, GtkWindowGroup))
 134 #define GTK_WINDOW_GROUP_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
 135 #define GTK_IS_WINDOW_GROUP(object)       (G_TYPE_CHECK_INSTANCE_TYPE ((object), GTK_TYPE_WINDOW_GROUP))
 136 #define GTK_IS_WINDOW_GROUP_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW_GROUP))
 137 #define GTK_WINDOW_GROUP_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW_GROUP, GtkWindowGroupClass))
 138
 139 struct _GtkWindowGroup
 140 {
 141   GObject parent_instance;
 142
 143   GSList *grabs;
 144 };
 145
 146 struct _GtkWindowGroupClass
 147 {
 148   GObjectClass parent_class;
 149 };
 150
 151 GtkType    gtk_window_get_type                 (void) G_GNUC_CONST;
 152 GtkWidget* gtk_window_new                      (GtkWindowType        type);
 153 void       gtk_window_set_title                (GtkWindow           *window,
 154                                                 const gchar         *title);
 155 G_CONST_RETURN gchar *gtk_window_get_title     (GtkWindow           *window);
 156 void       gtk_window_set_wmclass              (GtkWindow           *window,
 157                                                 const gchar         *wmclass_name,
 158                                                 const gchar         *wmclass_class);
 159 void       gtk_window_set_role                 (GtkWindow           *window,
 160                                                 const gchar         *role);
 161 G_CONST_RETURN gchar *gtk_window_get_role      (GtkWindow           *window);
 162 void       gtk_window_add_accel_group          (GtkWindow           *window,
 163                                                 GtkAccelGroup       *accel_group);
 164 void       gtk_window_remove_accel_group       (GtkWindow           *window,
 165                                                 GtkAccelGroup       *accel_group);
 166 void       gtk_window_set_position             (GtkWindow           *window,
 167                                                 GtkWindowPosition    position);
 168 gboolean   gtk_window_activate_focus           (GtkWindow           *window);
 169 void       gtk_window_set_focus                (GtkWindow           *window,
 170                                                 GtkWidget           *focus);
 171 GtkWidget *gtk_window_get_focus                (GtkWindow           *window);
 172 void       gtk_window_set_default              (GtkWindow           *window,
 173                                                 GtkWidget           *default_widget);
 174 gboolean   gtk_window_activate_default         (GtkWindow           *window);
 175
 176 void       gtk_window_set_transient_for        (GtkWindow           *window,
 177                                                 GtkWindow           *parent);
 178 GtkWindow *gtk_window_get_transient_for        (GtkWindow           *window);
 179 void       gtk_window_set_type_hint            (GtkWindow           *window,
 180                                                 GdkWindowTypeHint    hint);
 181 GdkWindowTypeHint gtk_window_get_type_hint     (GtkWindow           *window);
 182 void       gtk_window_set_destroy_with_parent  (GtkWindow           *window,
 183                                                 gboolean             setting);
 184 gboolean   gtk_window_get_destroy_with_parent  (GtkWindow           *window);
 185
 186 void       gtk_window_set_resizable            (GtkWindow           *window,
 187                                                 gboolean             resizable);
 188 gboolean   gtk_window_get_resizable            (GtkWindow           *window);
 189
 190 void       gtk_window_set_gravity              (GtkWindow           *window,
 191                                                 GdkGravity           gravity);
 192 GdkGravity gtk_window_get_gravity              (GtkWindow           *window);
 193
 194
 195 void       gtk_window_set_geometry_hints       (GtkWindow           *window,
 196                                                 GtkWidget           *geometry_widget,
 197                                                 GdkGeometry         *geometry,
 198                                                 GdkWindowHints       geom_mask);
 199
 200 /* gtk_window_set_has_frame () must be called before realizing the window_*/
 201 void       gtk_window_set_has_frame            (GtkWindow *window,
 202                                                 gboolean   setting);
 203 gboolean   gtk_window_get_has_frame            (GtkWindow *window);
 204 void       gtk_window_set_frame_dimensions     (GtkWindow *window,
 205                                                 gint       left,
 206                                                 gint       top,
 207                                                 gint       right,
 208                                                 gint       bottom);
 209 void       gtk_window_get_frame_dimensions     (GtkWindow *window,
 210                                                 gint      *left,
 211                                                 gint      *top,
 212                                                 gint      *right,
 213                                                 gint      *bottom);
 214 void       gtk_window_set_decorated            (GtkWindow *window,
 215                                                 gboolean   setting);
 216 gboolean   gtk_window_get_decorated            (GtkWindow *window);
 217
 218 void       gtk_window_set_icon_list                (GtkWindow  *window,
 219                                                     GList      *list);
 220 GList*     gtk_window_get_icon_list                (GtkWindow  *window);
 221 void       gtk_window_set_icon                     (GtkWindow  *window,
 222                                                     GdkPixbuf  *icon);
 223 GdkPixbuf* gtk_window_get_icon                     (GtkWindow  *window);
 224 void       gtk_window_set_default_icon_list        (GList      *list);
 225 GList*     gtk_window_get_default_icon_list        (void);
 226
 227 /* If window is set modal, input will be grabbed when show and released when hide */
 228 void       gtk_window_set_modal      (GtkWindow *window,
 229                                       gboolean   modal);
 230 gboolean   gtk_window_get_modal      (GtkWindow *window);
 231 GList*     gtk_window_list_toplevels (void);
 232
 233 void     gtk_window_add_mnemonic          (GtkWindow       *window,
 234                                            guint            keyval,
 235                                            GtkWidget       *target);
 236 void     gtk_window_remove_mnemonic       (GtkWindow       *window,
 237                                            guint            keyval,
 238                                            GtkWidget       *target);
 239 gboolean gtk_window_mnemonic_activate     (GtkWindow       *window,
 240                                            guint            keyval,
 241                                            GdkModifierType  modifier);
 242 void     gtk_window_set_mnemonic_modifier (GtkWindow       *window,
 243                                            GdkModifierType  modifier);
 244 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
 245
 246 void     gtk_window_present       (GtkWindow *window);
 247 void     gtk_window_iconify       (GtkWindow *window);
 248 void     gtk_window_deiconify     (GtkWindow *window);
 249 void     gtk_window_stick         (GtkWindow *window);
 250 void     gtk_window_unstick       (GtkWindow *window);
 251 void     gtk_window_maximize      (GtkWindow *window);
 252 void     gtk_window_unmaximize    (GtkWindow *window);
 253
 254 void gtk_window_begin_resize_drag (GtkWindow     *window,
 255                                    GdkWindowEdge  edge,
 256                                    gint           button,
 257                                    gint           root_x,
 258                                    gint           root_y,
 259                                    guint32        timestamp);
 260 void gtk_window_begin_move_drag   (GtkWindow     *window,
 261                                    gint           button,
 262                                    gint           root_x,
 263                                    gint           root_y,
 264                                    guint32        timestamp);
 265
 266 #ifndef GTK_DISABLE_DEPRECATED
 267 void       gtk_window_set_policy               (GtkWindow           *window,
 268                                                 gint                 allow_shrink,
 269                                                 gint                 allow_grow,
 270                                                 gint                 auto_shrink);
 271 #define gtk_window_position                     gtk_window_set_position
 272 #endif /* GTK_DISABLE_DEPRECATED */
 273
 274 /* Set initial default size of the window (does not constrain user
 275  * resize operations)
 276  */
 277 void     gtk_window_set_default_size (GtkWindow   *window,
 278                                       gint         width,
 279                                       gint         height);
 280 void     gtk_window_get_default_size (GtkWindow   *window,
 281                                       gint        *width,
 282                                       gint        *height);
 283 void     gtk_window_resize           (GtkWindow   *window,
 284                                       gint         width,
 285                                       gint         height);
 286 void     gtk_window_get_size         (GtkWindow   *window,
 287                                       gint        *width,
 288                                       gint        *height);
 289 void     gtk_window_move             (GtkWindow   *window,
 290                                       gint         x,
 291                                       gint         y);
 292 void     gtk_window_get_position     (GtkWindow   *window,
 293                                       gint        *root_x,
 294                                       gint        *root_y);
 295 gboolean gtk_window_parse_geometry   (GtkWindow   *window,
 296                                       const gchar *geometry);
 297
 298 /* Ignore this unless you are writing a GUI builder */
 299 void     gtk_window_reshow_with_initial_size (GtkWindow *window);
 300
 301 /* Window groups
 302  */
 303 GType            gtk_window_group_get_type      (void) G_GNUC_CONST;
 304
 305 GtkWindowGroup * gtk_window_group_new           (void);
 306 void             gtk_window_group_add_window    (GtkWindowGroup     *window_group,
 307                                                  GtkWindow          *window);
 308 void             gtk_window_group_remove_window (GtkWindowGroup     *window_group,
 309                                                  GtkWindow          *window);
 310
 311 /* --- internal functions --- */
 312 void            _gtk_window_internal_set_focus (GtkWindow *window,
 313                                                 GtkWidget *focus);
 314 void            gtk_window_remove_embedded_xid (GtkWindow *window,
 315                                                 guint      xid);
 316 void            gtk_window_add_embedded_xid    (GtkWindow *window,
 317                                                 guint      xid);
 318 void            _gtk_window_reposition         (GtkWindow *window,
 319                                                 gint       x,
 320                                                 gint       y);
 321 void            _gtk_window_constrain_size     (GtkWindow *window,
 322                                                 gint       width,
 323                                                 gint       height,
 324                                                 gint      *new_width,
 325                                                 gint      *new_height);
 326 GtkWindowGroup *_gtk_window_get_group          (GtkWindow *window);
 327
 328 /* --- internal (GtkAcceleratable) --- */
 329 gboolean        _gtk_window_query_nonaccels     (GtkWindow      *window,
 330                                                  guint           accel_key,
 331                                                  GdkModifierType accel_mods);
 332
 333 #ifdef __cplusplus
 334 }
 335 #endif /* __cplusplus */
 336
 337
 338 #endif /* __GTK_WINDOW_H__ */