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