]> Pileus Git - ~andy/gtk/blobdiff - gdk/gdkwindow.h
Add and use gdk_window_is_toplevel when possible
[~andy/gtk] / gdk / gdkwindow.h
index 9a6d4c0155085c4ba189373eec8c732814346eac..a3297d24ad7cf34cfe357afe49ae712ee5513c59 100644 (file)
@@ -1,17 +1,46 @@
+/* GDK - The GIMP Drawing Kit
+ * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+/*
+ * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
+ * file for a list of people on the GTK+ Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ */
+
+#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
+#error "Only <gdk/gdk.h> can be included directly."
+#endif
+
 #ifndef __GDK_WINDOW_H__
 #define __GDK_WINDOW_H__
 
 #include <gdk/gdkdrawable.h>
 #include <gdk/gdktypes.h>
-#include <gdk/gdkwindow.h>
 #include <gdk/gdkevents.h>
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+G_BEGIN_DECLS
 
-typedef struct _GdkGeometry           GdkGeometry;
-typedef struct _GdkWindowAttr        GdkWindowAttr;
+typedef struct _GdkGeometry          GdkGeometry;
+typedef struct _GdkWindowAttr        GdkWindowAttr;
+typedef struct _GdkPointerHooks      GdkPointerHooks;
+typedef struct _GdkWindowRedirect    GdkWindowRedirect;
 
 /* Classes of windows.
  *   InputOutput: Almost every window should be of this type. Such windows
@@ -48,7 +77,8 @@ typedef enum
   GDK_WINDOW_CHILD,
   GDK_WINDOW_DIALOG,
   GDK_WINDOW_TEMP,
-  GDK_WINDOW_FOREIGN
+  GDK_WINDOW_FOREIGN,
+  GDK_WINDOW_OFFSCREEN
 } GdkWindowType;
 
 /* Window attribute mask values.
@@ -61,14 +91,15 @@ typedef enum
  */
 typedef enum
 {
-  GDK_WA_TITLE   = 1 << 1,
-  GDK_WA_X       = 1 << 2,
-  GDK_WA_Y       = 1 << 3,
-  GDK_WA_CURSOR          = 1 << 4,
-  GDK_WA_COLORMAP = 1 << 5,
-  GDK_WA_VISUAL          = 1 << 6,
-  GDK_WA_WMCLASS  = 1 << 7,
-  GDK_WA_NOREDIR  = 1 << 8
+  GDK_WA_TITLE    = 1 << 1,
+  GDK_WA_X        = 1 << 2,
+  GDK_WA_Y        = 1 << 3,
+  GDK_WA_CURSOR           = 1 << 4,
+  GDK_WA_COLORMAP  = 1 << 5,
+  GDK_WA_VISUAL           = 1 << 6,
+  GDK_WA_WMCLASS   = 1 << 7,
+  GDK_WA_NOREDIR   = 1 << 8,
+  GDK_WA_TYPE_HINT = 1 << 9
 } GdkWindowAttributesType;
 
 /* Size restriction enumeration.
@@ -81,7 +112,9 @@ typedef enum
   GDK_HINT_BASE_SIZE   = 1 << 3,
   GDK_HINT_ASPECT      = 1 << 4,
   GDK_HINT_RESIZE_INC  = 1 << 5,
-  GDK_HINT_WIN_GRAVITY = 1 << 6
+  GDK_HINT_WIN_GRAVITY = 1 << 6,
+  GDK_HINT_USER_POS    = 1 << 7,
+  GDK_HINT_USER_SIZE   = 1 << 8
 } GdkWindowHints;
 
 
@@ -101,11 +134,20 @@ typedef enum
 {
   GDK_WINDOW_TYPE_HINT_NORMAL,
   GDK_WINDOW_TYPE_HINT_DIALOG,
-  GDK_WINDOW_TYPE_HINT_MENU,
-  GDK_WINDOW_TYPE_HINT_TOOLBAR
+  GDK_WINDOW_TYPE_HINT_MENU,           /* Torn off menu */
+  GDK_WINDOW_TYPE_HINT_TOOLBAR,
+  GDK_WINDOW_TYPE_HINT_SPLASHSCREEN,
+  GDK_WINDOW_TYPE_HINT_UTILITY,
+  GDK_WINDOW_TYPE_HINT_DOCK,
+  GDK_WINDOW_TYPE_HINT_DESKTOP,
+  GDK_WINDOW_TYPE_HINT_DROPDOWN_MENU,  /* A drop down menu (from a menubar) */
+  GDK_WINDOW_TYPE_HINT_POPUP_MENU,     /* A popup menu (from right-click) */
+  GDK_WINDOW_TYPE_HINT_TOOLTIP,
+  GDK_WINDOW_TYPE_HINT_NOTIFICATION,
+  GDK_WINDOW_TYPE_HINT_COMBO,
+  GDK_WINDOW_TYPE_HINT_DND
 } GdkWindowTypeHint;
 
-
 /* The next two enumeration values current match the
  * Motif constants. If this is changed, the implementation
  * of gdk_window_set_decorations/gdk_window_set_functions
@@ -178,6 +220,7 @@ struct _GdkWindowAttr
   gchar *wmclass_name;
   gchar *wmclass_class;
   gboolean override_redirect;
+  GdkWindowTypeHint type_hint;
 };
 
 struct _GdkGeometry
@@ -195,6 +238,17 @@ struct _GdkGeometry
   GdkGravity win_gravity;
 };
 
+struct _GdkPointerHooks 
+{
+  GdkWindow* (*get_pointer)       (GdkWindow      *window,
+                                  gint            *x,
+                                  gint            *y,
+                                  GdkModifierType *mask);
+  GdkWindow* (*window_at_pointer) (GdkScreen       *screen, /* unused */
+                                   gint            *win_x,
+                                   gint            *win_y);
+};
+
 typedef struct _GdkWindowObject GdkWindowObject;
 typedef struct _GdkWindowObjectClass GdkWindowObjectClass;
 
@@ -206,6 +260,12 @@ typedef struct _GdkWindowObjectClass GdkWindowObjectClass;
 #define GDK_WINDOW_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_WINDOW, GdkWindowObjectClass))
 #define GDK_WINDOW_OBJECT(object)    ((GdkWindowObject *) GDK_WINDOW (object))
 
+#ifndef GDK_COMPILATION
+/* We used to export all of GdkWindowObject, but we don't want to keep doing so.
+   However, there are various parts of it accessed by macros and other code,
+   so we keep the old exported version public, but in reality it is larger. */
+
+/**** DON'T CHANGE THIS STRUCT, the real version is in gdkinternals.h ****/
 struct _GdkWindowObject
 {
   GdkDrawable parent_instance;
@@ -241,15 +301,25 @@ struct _GdkWindowObject
   guint guffaw_gravity : 1;
   guint input_only : 1;
   guint modal_hint : 1;
+  guint composited : 1;
   
   guint destroyed : 2;
+
+  guint accept_focus : 1;
+  guint focus_on_map : 1;
+  guint shaped : 1;
+  
+  GdkEventMask event_mask;
+
+  guint update_and_descendants_freeze_count;
+
+  GdkWindowRedirect *redirect;
 };
+#endif
 
 struct _GdkWindowObjectClass
 {
   GdkDrawableClass parent_class;
-
-
 };
 
 /* Windows
@@ -265,6 +335,7 @@ GdkWindow*    gdk_window_at_pointer            (gint          *win_x,
 void          gdk_window_show                  (GdkWindow     *window);
 void          gdk_window_hide                  (GdkWindow     *window);
 void          gdk_window_withdraw              (GdkWindow     *window);
+void          gdk_window_show_unraised         (GdkWindow     *window);
 void          gdk_window_move                  (GdkWindow     *window,
                                                 gint           x,
                                                 gint           y);
@@ -299,15 +370,24 @@ void          gdk_window_set_user_data         (GdkWindow     *window,
                                                 gpointer       user_data);
 void          gdk_window_set_override_redirect (GdkWindow     *window,
                                                 gboolean       override_redirect);
+void          gdk_window_set_accept_focus      (GdkWindow     *window,
+                                               gboolean       accept_focus);
+void          gdk_window_set_focus_on_map      (GdkWindow     *window,
+                                               gboolean       focus_on_map);
 void          gdk_window_add_filter            (GdkWindow     *window,
                                                 GdkFilterFunc  function,
                                                 gpointer       data);
 void          gdk_window_remove_filter         (GdkWindow     *window,
                                                 GdkFilterFunc  function,
                                                 gpointer       data);
-void          gdk_window_scroll                (GdkWindow *window,
-                                                gint       dx,
-                                                gint       dy);
+void          gdk_window_scroll                (GdkWindow     *window,
+                                                gint           dx,
+                                                gint           dy);
+void         gdk_window_move_region           (GdkWindow       *window,
+                                               const GdkRegion *region,
+                                               gint             dx,
+                                               gint             dy);
+gboolean      gdk_window_ensure_native        (GdkWindow       *window);
 
 /* 
  * This allows for making shaped (partially transparent) windows
@@ -315,14 +395,14 @@ void          gdk_window_scroll                (GdkWindow *window,
  *  The shape_mask can be the mask
  *  from gdk_pixmap_create_from_xpm.   Stefan Wille
  */
-void gdk_window_shape_combine_mask  (GdkWindow     *window,
-                                     GdkBitmap     *shape_mask,
-                                     gint           offset_x,
-                                     gint           offset_y);
-void gdk_window_shape_combine_region (GdkWindow            *window,
-                                      GdkRegion     *shape_region,
-                                      gint          offset_x,
-                                      gint          offset_y);
+void gdk_window_shape_combine_mask  (GdkWindow       *window,
+                                     GdkBitmap       *mask,
+                                     gint             x,
+                                     gint             y);
+void gdk_window_shape_combine_region (GdkWindow              *window,
+                                      const GdkRegion *shape_region,
+                                      gint            offset_x,
+                                      gint            offset_y);
 
 /*
  * This routine allows you to quickly take the shapes of all the child windows
@@ -333,6 +413,9 @@ void gdk_window_shape_combine_region (GdkWindow         *window,
  */
 void gdk_window_set_child_shapes (GdkWindow *window);
 
+void gdk_window_set_composited   (GdkWindow *window,
+                                  gboolean   composited);
+
 /*
  * This routine allows you to merge (ie ADD) child shapes to your
  * own window's shape keeping its current shape and ADDING the child
@@ -340,7 +423,19 @@ void gdk_window_set_child_shapes (GdkWindow *window);
  * 
  * - Raster
  */
-void gdk_window_merge_child_shapes (GdkWindow *window);
+void gdk_window_merge_child_shapes         (GdkWindow       *window);
+
+void gdk_window_input_shape_combine_mask   (GdkWindow       *window,
+                                           GdkBitmap       *mask,
+                                           gint             x,
+                                           gint             y);
+void gdk_window_input_shape_combine_region (GdkWindow       *window,
+                                            const GdkRegion *shape_region,
+                                            gint             offset_x,
+                                            gint             offset_y);
+void gdk_window_set_child_input_shapes     (GdkWindow       *window);
+void gdk_window_merge_child_input_shapes   (GdkWindow       *window);
+
 
 /*
  * Check if a window has been shown, and whether all its
@@ -359,8 +454,20 @@ GdkWindowState gdk_window_get_state (GdkWindow *window);
 gboolean gdk_window_set_static_gravities (GdkWindow *window,
                                          gboolean   use_static);   
 
+/* Functions to create/lookup windows from their native equivalents */ 
+#ifndef GDK_MULTIHEAD_SAFE
+GdkWindow*    gdk_window_foreign_new (GdkNativeWindow anid);
+GdkWindow*    gdk_window_lookup      (GdkNativeWindow anid);
+#endif
+GdkWindow    *gdk_window_foreign_new_for_display (GdkDisplay      *display,
+                                                 GdkNativeWindow  anid);
+GdkWindow*    gdk_window_lookup_for_display (GdkDisplay      *display,
+                                            GdkNativeWindow  anid);
+
+
 /* GdkWindow */
 
+#ifndef GDK_DISABLE_DEPRECATED
 void         gdk_window_set_hints       (GdkWindow       *window,
                                          gint             x,
                                          gint             y,
@@ -369,34 +476,48 @@ void            gdk_window_set_hints       (GdkWindow       *window,
                                          gint             max_width,
                                          gint             max_height,
                                          gint             flags);
-void          gdk_window_set_type_hint   (GdkWindow       *window,
-                                         GdkWindowTypeHint hint);
-void          gdk_window_set_modal_hint  (GdkWindow       *window,
-                                         gboolean         modal);
-void          gdk_window_set_geometry_hints (GdkWindow        *window,
-                                            GdkGeometry      *geometry,
-                                            GdkWindowHints    flags);
-void          gdk_set_sm_client_id         (const gchar *sm_client_id);
-
-void         gdk_window_begin_paint_rect   (GdkWindow    *window,
-                                            GdkRectangle *rectangle);
-void         gdk_window_begin_paint_region (GdkWindow    *window,
-                                            GdkRegion    *region);
-void         gdk_window_end_paint          (GdkWindow    *window);
+#endif
+void              gdk_window_set_type_hint (GdkWindow        *window,
+                                            GdkWindowTypeHint hint);
+GdkWindowTypeHint gdk_window_get_type_hint (GdkWindow        *window);
+
+void          gdk_window_set_modal_hint   (GdkWindow       *window,
+                                           gboolean         modal);
+
+void gdk_window_set_skip_taskbar_hint (GdkWindow *window,
+                                       gboolean   skips_taskbar);
+void gdk_window_set_skip_pager_hint   (GdkWindow *window,
+                                       gboolean   skips_pager);
+void gdk_window_set_urgency_hint      (GdkWindow *window,
+                                      gboolean   urgent);
+
+void          gdk_window_set_geometry_hints (GdkWindow          *window,
+                                            const GdkGeometry  *geometry,
+                                            GdkWindowHints      geom_mask);
+void          gdk_set_sm_client_id          (const gchar        *sm_client_id);
+
+void         gdk_window_begin_paint_rect   (GdkWindow          *window,
+                                            const GdkRectangle *rectangle);
+void         gdk_window_begin_paint_region (GdkWindow          *window,
+                                            const GdkRegion    *region);
+void         gdk_window_end_paint          (GdkWindow          *window);
 
 void         gdk_window_set_title         (GdkWindow     *window,
                                            const gchar   *title);
 void          gdk_window_set_role          (GdkWindow       *window,
                                            const gchar     *role);
+void          gdk_window_set_startup_id    (GdkWindow       *window,
+                                           const gchar     *startup_id);                                         
 void          gdk_window_set_transient_for (GdkWindow       *window, 
-                                           GdkWindow       *leader);
+                                           GdkWindow       *parent);
 void         gdk_window_set_background  (GdkWindow       *window,
-                                         GdkColor        *color);
+                                         const GdkColor  *color);
 void         gdk_window_set_back_pixmap (GdkWindow       *window,
                                          GdkPixmap       *pixmap,
                                          gboolean         parent_relative);
 void         gdk_window_set_cursor      (GdkWindow       *window,
                                          GdkCursor       *cursor);
+GdkCursor    *gdk_window_get_cursor      (GdkWindow       *window);
 void         gdk_window_get_user_data   (GdkWindow       *window,
                                          gpointer        *data);
 void         gdk_window_get_geometry    (GdkWindow       *window,
@@ -411,9 +532,19 @@ void             gdk_window_get_position    (GdkWindow       *window,
 gint         gdk_window_get_origin      (GdkWindow       *window,
                                          gint            *x,
                                          gint            *y);
+void         gdk_window_get_root_coords (GdkWindow       *window,
+                                         gint             x,
+                                         gint             y,
+                                         gint            *root_x,
+                                         gint            *root_y);
+
+#if !defined (GDK_DISABLE_DEPRECATED) || defined (GTK_COMPILATION) || defined (GDK_COMPILATION)
+/* Used by gtk_handle_box_button_changed () */
 gboolean      gdk_window_get_deskrelative_origin (GdkWindow      *window,
                                          gint            *x,
                                          gint            *y);
+#endif
+
 void         gdk_window_get_root_origin (GdkWindow       *window,
                                          gint            *x,
                                          gint            *y);
@@ -432,7 +563,7 @@ GdkEventMask  gdk_window_get_events  (GdkWindow       *window);
 void         gdk_window_set_events      (GdkWindow       *window,
                                          GdkEventMask     event_mask);
 
-gboolean      gdk_window_set_icon_list   (GdkWindow       *window,
+void          gdk_window_set_icon_list   (GdkWindow       *window,
                                          GList           *pixbufs);
 void         gdk_window_set_icon        (GdkWindow       *window, 
                                          GdkWindow       *icon_window,
@@ -442,21 +573,32 @@ void            gdk_window_set_icon_name   (GdkWindow       *window,
                                          const gchar     *name);
 void         gdk_window_set_group       (GdkWindow       *window, 
                                          GdkWindow       *leader);
+GdkWindow*    gdk_window_get_group      (GdkWindow       *window);
 void         gdk_window_set_decorations (GdkWindow       *window,
                                          GdkWMDecoration  decorations);
 gboolean      gdk_window_get_decorations (GdkWindow       *window,
                                          GdkWMDecoration *decorations);
 void         gdk_window_set_functions   (GdkWindow       *window,
                                          GdkWMFunction    functions);
+#if !defined(GDK_MULTIHEAD_SAFE) && !defined(GDK_DISABLE_DEPRECATED)
 GList *       gdk_window_get_toplevels   (void);
+#endif
 
+void          gdk_window_beep            (GdkWindow       *window);
 void          gdk_window_iconify         (GdkWindow       *window);
 void          gdk_window_deiconify       (GdkWindow       *window);
 void          gdk_window_stick           (GdkWindow       *window);
 void          gdk_window_unstick         (GdkWindow       *window);
 void          gdk_window_maximize        (GdkWindow       *window);
 void          gdk_window_unmaximize      (GdkWindow       *window);
-
+void          gdk_window_fullscreen      (GdkWindow       *window);
+void          gdk_window_unfullscreen    (GdkWindow       *window);
+void          gdk_window_set_keep_above  (GdkWindow       *window,
+                                          gboolean         setting);
+void          gdk_window_set_keep_below  (GdkWindow       *window,
+                                          gboolean         setting);
+void          gdk_window_set_opacity     (GdkWindow       *window,
+                                          gdouble          opacity);
 void          gdk_window_register_dnd    (GdkWindow       *window);
 
 void gdk_window_begin_resize_drag (GdkWindow     *window,
@@ -472,17 +614,24 @@ void gdk_window_begin_move_drag   (GdkWindow     *window,
                                    guint32        timestamp);
 
 /* Interface for dirty-region queueing */
-void       gdk_window_invalidate_rect     (GdkWindow    *window,
-                                          GdkRectangle *rect,
-                                          gboolean      invalidate_children);
-void       gdk_window_invalidate_region   (GdkWindow    *window,
-                                          GdkRegion    *region,
-                                          gboolean      invalidate_children);
+void       gdk_window_invalidate_rect           (GdkWindow          *window,
+                                                const GdkRectangle *rect,
+                                                gboolean            invalidate_children);
+void       gdk_window_invalidate_region         (GdkWindow          *window,
+                                                const GdkRegion    *region,
+                                                gboolean            invalidate_children);
+void       gdk_window_invalidate_maybe_recurse  (GdkWindow          *window,
+                                                const GdkRegion    *region,
+                                                gboolean (*child_func) (GdkWindow *, gpointer),
+                                                gpointer   user_data);
 GdkRegion *gdk_window_get_update_area     (GdkWindow    *window);
 
 void       gdk_window_freeze_updates      (GdkWindow    *window);
 void       gdk_window_thaw_updates        (GdkWindow    *window);
 
+void       gdk_window_freeze_toplevel_updates_libgtk_only (GdkWindow *window);
+void       gdk_window_thaw_toplevel_updates_libgtk_only   (GdkWindow *window);
+
 void       gdk_window_process_all_updates (void);
 void       gdk_window_process_updates     (GdkWindow    *window,
                                           gboolean      update_children);
@@ -497,8 +646,51 @@ void       gdk_window_constrain_size      (GdkGeometry  *geometry,
                                            gint         *new_width,
                                            gint         *new_height);
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+void gdk_window_get_internal_paint_info (GdkWindow    *window,
+                                        GdkDrawable **real_drawable,
+                                        gint         *x_offset,
+                                        gint         *y_offset);
+
+void gdk_window_enable_synchronized_configure (GdkWindow *window);
+void gdk_window_configure_finished            (GdkWindow *window);
+
+#ifndef GDK_MULTIHEAD_SAFE
+GdkPointerHooks *gdk_set_pointer_hooks (const GdkPointerHooks *new_hooks);   
+#endif /* GDK_MULTIHEAD_SAFE */
+
+GdkWindow *gdk_get_default_root_window (void);
+
+/* Offscreen redirection */
+GdkPixmap *gdk_offscreen_window_get_pixmap     (GdkWindow     *window);
+void       gdk_offscreen_window_set_embedder   (GdkWindow     *window,
+                                               GdkWindow     *embedder);
+GdkWindow *gdk_offscreen_window_get_embedder   (GdkWindow     *window);
+void       gdk_window_geometry_changed         (GdkWindow     *window);
+
+void       gdk_window_redirect_to_drawable   (GdkWindow     *window,
+                                              GdkDrawable   *drawable,
+                                              gint           src_x,
+                                              gint           src_y,
+                                              gint           dest_x,
+                                              gint           dest_y,
+                                              gint           width,
+                                              gint           height);
+void       gdk_window_remove_redirection     (GdkWindow     *window);
+
+#ifndef GDK_DISABLE_DEPRECATED
+#define GDK_ROOT_PARENT()             (gdk_get_default_root_window ())
+#define gdk_window_get_size            gdk_drawable_get_size
+#define gdk_window_get_type            gdk_window_get_window_type
+#define gdk_window_get_colormap        gdk_drawable_get_colormap
+#define gdk_window_set_colormap        gdk_drawable_set_colormap
+#define gdk_window_get_visual          gdk_drawable_get_visual
+#define gdk_window_ref                 gdk_drawable_ref
+#define gdk_window_unref               gdk_drawable_unref
+
+#define gdk_window_copy_area(drawable,gc,x,y,source_drawable,source_x,source_y,width,height) \
+   gdk_draw_pixmap(drawable,gc,source_drawable,source_x,source_y,x,y,width,height)
+#endif /* GDK_DISABLE_DEPRECATED */
+
+G_END_DECLS
 
 #endif /* __GDK_WINDOW_H__ */