]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkwindow.h
filechooserbutton: Do not propagate state from the dialog unless it is active
[~andy/gtk] / gtk / gtkwindow.h
index 8b7b5c3c02eb4ca106fb079fd6473e5aa49324ca..7b0c0dc5e5f08dbb198e021bff8da635d48aeaf7 100644 (file)
  * 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.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
  * 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/. 
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
 #ifndef __GTK_WINDOW_H__
 #define __GTK_WINDOW_H__
 
 
-#include <gdk/gdk.h>
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
+#include <gtk/gtkapplication.h>
 #include <gtk/gtkaccelgroup.h>
 #include <gtk/gtkbin.h>
-#include <gtk/gtkenums.h>
-#include <gtk/gtkwidget.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
 
+G_BEGIN_DECLS
 
 #define GTK_TYPE_WINDOW                        (gtk_window_get_type ())
-#define GTK_WINDOW(obj)                        (GTK_CHECK_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
-#define GTK_WINDOW_CLASS(klass)                (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
-#define GTK_IS_WINDOW(obj)             (GTK_CHECK_TYPE ((obj), GTK_TYPE_WINDOW))
-#define GTK_IS_WINDOW_CLASS(klass)     (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
-#define GTK_WINDOW_GET_CLASS(obj)       (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_WINDOW, GtkWindowClass))
+#define GTK_WINDOW(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_WINDOW, GtkWindow))
+#define GTK_WINDOW_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_WINDOW, GtkWindowClass))
+#define GTK_IS_WINDOW(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_WINDOW))
+#define GTK_IS_WINDOW_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WINDOW))
+#define GTK_WINDOW_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_WINDOW, GtkWindowClass))
 
-
-typedef struct _GtkWindow             GtkWindow;
+typedef struct _GtkWindowPrivate      GtkWindowPrivate;
 typedef struct _GtkWindowClass        GtkWindowClass;
 typedef struct _GtkWindowGeometryInfo GtkWindowGeometryInfo;
 typedef struct _GtkWindowGroup        GtkWindowGroup;
 typedef struct _GtkWindowGroupClass   GtkWindowGroupClass;
+typedef struct _GtkWindowGroupPrivate GtkWindowGroupPrivate;
 
 struct _GtkWindow
 {
   GtkBin bin;
 
-  gchar *title;
-  gchar *wmclass_name;
-  gchar *wmclass_class;
-  gchar *wm_role;
-
-  GtkWidget *focus_widget;
-  GtkWidget *default_widget;
-  GtkWindow *transient_parent;
-  GtkWindowGeometryInfo *geometry_info;
-  GdkWindow *frame;
-  GtkWindowGroup *group;
-
-  guint16 resize_count;
-
-  GtkWindowType type : 4;
-  guint has_user_ref_count : 1;
-  guint has_focus : 1;
-  guint allow_shrink : 1;
-  guint allow_grow : 1;
-  guint auto_shrink : 1;
-  guint handling_resize : 1;
-  guint position : 2;
-
-  /* The following flag is initially TRUE when a window is mapped.
-   * and will be set to FALSE after it is first positioned.
-   * It is also temporarily reset when the window's size changes.
-   * 
-   * When TRUE, we move the window to the position the app set.
-   */
-  guint use_uposition : 1;
-  guint modal : 1;
-  guint destroy_with_parent : 1;
-  
-  guint has_frame : 1;
-
-  /* gtk_window_iconify() called before realization */
-  guint iconify_initially : 1;
-  guint stick_initially : 1;
-  guint maximize_initially : 1;
-  guint decorated : 1;
-  
-  GdkWindowTypeHint type_hint : 3;
-  GdkGravity gravity : 5;
-  
-  guint frame_left;
-  guint frame_top;
-  guint frame_right;
-  guint frame_bottom;
-  
-  GdkModifierType mnemonic_modifier;
+  GtkWindowPrivate *priv;
 };
 
 struct _GtkWindowClass
@@ -114,16 +62,19 @@ struct _GtkWindowClass
   GtkBinClass parent_class;
 
   void     (* set_focus)   (GtkWindow *window,
-                           GtkWidget *focus);
-  gboolean (* frame_event) (GtkWidget *widget,
-                           GdkEvent  *event);
+                            GtkWidget *focus);
 
   /* G_SIGNAL_ACTION signals for keybindings */
 
-  void     (* activate_focus)          (GtkWindow       *window);
-  void     (* activate_default)        (GtkWindow       *window);
-  void     (* move_focus)              (GtkWindow       *window,
-                                        GtkDirectionType direction);  
+  void     (* activate_focus)   (GtkWindow *window);
+  void     (* activate_default) (GtkWindow *window);
+  void    (* keys_changed)     (GtkWindow *window);
+
+  /* Padding for future expansion */
+  void (*_gtk_reserved1) (void);
+  void (*_gtk_reserved2) (void);
+  void (*_gtk_reserved3) (void);
+  void (*_gtk_reserved4) (void);
 };
 
 #define GTK_TYPE_WINDOW_GROUP             (gtk_window_group_get_type ())
@@ -137,25 +88,33 @@ struct _GtkWindowGroup
 {
   GObject parent_instance;
 
-  GSList *grabs;
+  GtkWindowGroupPrivate *priv;
 };
 
 struct _GtkWindowGroupClass
 {
   GObjectClass parent_class;
+
+  /* Padding for future expansion */
+  void (*_gtk_reserved1) (void);
+  void (*_gtk_reserved2) (void);
+  void (*_gtk_reserved3) (void);
+  void (*_gtk_reserved4) (void);
 };
 
-GtkType    gtk_window_get_type                 (void) G_GNUC_CONST;
+GType      gtk_window_get_type                 (void) G_GNUC_CONST;
 GtkWidget* gtk_window_new                      (GtkWindowType        type);
 void       gtk_window_set_title                (GtkWindow           *window,
                                                const gchar         *title);
-G_CONST_RETURN gchar *gtk_window_get_title     (GtkWindow           *window);
+const gchar * gtk_window_get_title             (GtkWindow           *window);
 void       gtk_window_set_wmclass              (GtkWindow           *window,
                                                const gchar         *wmclass_name,
                                                const gchar         *wmclass_class);
 void       gtk_window_set_role                 (GtkWindow           *window,
                                                 const gchar         *role);
-G_CONST_RETURN gchar *gtk_window_get_role      (GtkWindow           *window);
+void       gtk_window_set_startup_id           (GtkWindow           *window,
+                                                const gchar         *startup_id);
+const gchar * gtk_window_get_role              (GtkWindow           *window);
 void       gtk_window_add_accel_group          (GtkWindow           *window,
                                                GtkAccelGroup       *accel_group);
 void       gtk_window_remove_accel_group       (GtkWindow           *window,
@@ -163,21 +122,65 @@ void       gtk_window_remove_accel_group       (GtkWindow           *window,
 void       gtk_window_set_position             (GtkWindow           *window,
                                                GtkWindowPosition    position);
 gboolean   gtk_window_activate_focus          (GtkWindow           *window);
+void       gtk_window_set_focus                (GtkWindow           *window,
+                                               GtkWidget           *focus);
+GtkWidget *gtk_window_get_focus                (GtkWindow           *window);
+void       gtk_window_set_default              (GtkWindow           *window,
+                                               GtkWidget           *default_widget);
+GtkWidget *gtk_window_get_default_widget       (GtkWindow           *window);
 gboolean   gtk_window_activate_default        (GtkWindow           *window);
 
 void       gtk_window_set_transient_for        (GtkWindow           *window, 
                                                GtkWindow           *parent);
 GtkWindow *gtk_window_get_transient_for        (GtkWindow           *window);
+GDK_AVAILABLE_IN_3_4
+void       gtk_window_set_attached_to          (GtkWindow           *window, 
+                                                GtkWidget           *attach_widget);
+GDK_AVAILABLE_IN_3_4
+GtkWidget *gtk_window_get_attached_to          (GtkWindow           *window);
+GDK_DEPRECATED_IN_3_8_FOR(gtk_widget_set_opacity)
+void       gtk_window_set_opacity              (GtkWindow           *window, 
+                                               gdouble              opacity);
+GDK_DEPRECATED_IN_3_8_FOR(gtk_widget_get_opacity)
+gdouble    gtk_window_get_opacity              (GtkWindow           *window);
 void       gtk_window_set_type_hint            (GtkWindow           *window, 
                                                GdkWindowTypeHint    hint);
 GdkWindowTypeHint gtk_window_get_type_hint     (GtkWindow           *window);
+void       gtk_window_set_skip_taskbar_hint    (GtkWindow           *window,
+                                                gboolean             setting);
+gboolean   gtk_window_get_skip_taskbar_hint    (GtkWindow           *window);
+void       gtk_window_set_skip_pager_hint      (GtkWindow           *window,
+                                                gboolean             setting);
+gboolean   gtk_window_get_skip_pager_hint      (GtkWindow           *window);
+void       gtk_window_set_urgency_hint         (GtkWindow           *window,
+                                                gboolean             setting);
+gboolean   gtk_window_get_urgency_hint         (GtkWindow           *window);
+void       gtk_window_set_accept_focus         (GtkWindow           *window,
+                                                gboolean             setting);
+gboolean   gtk_window_get_accept_focus         (GtkWindow           *window);
+void       gtk_window_set_focus_on_map         (GtkWindow           *window,
+                                                gboolean             setting);
+gboolean   gtk_window_get_focus_on_map         (GtkWindow           *window);
 void       gtk_window_set_destroy_with_parent  (GtkWindow           *window,
                                                 gboolean             setting);
 gboolean   gtk_window_get_destroy_with_parent  (GtkWindow           *window);
+GDK_AVAILABLE_IN_3_4
+void       gtk_window_set_hide_titlebar_when_maximized (GtkWindow   *window,
+                                                        gboolean     setting);
+GDK_AVAILABLE_IN_3_4
+gboolean   gtk_window_get_hide_titlebar_when_maximized (GtkWindow   *window);
+void       gtk_window_set_mnemonics_visible    (GtkWindow           *window,
+                                                gboolean             setting);
+gboolean   gtk_window_get_mnemonics_visible    (GtkWindow           *window);
+GDK_AVAILABLE_IN_3_2
+void       gtk_window_set_focus_visible        (GtkWindow           *window,
+                                                gboolean             setting);
+GDK_AVAILABLE_IN_3_2
+gboolean   gtk_window_get_focus_visible        (GtkWindow           *window);
 
-void       gtk_window_set_resizeable           (GtkWindow           *window,
-                                                gboolean             resizeable);
-gboolean   gtk_window_get_resizeable           (GtkWindow           *window);
+void       gtk_window_set_resizable            (GtkWindow           *window,
+                                                gboolean             resizable);
+gboolean   gtk_window_get_resizable            (GtkWindow           *window);
 
 void       gtk_window_set_gravity              (GtkWindow           *window,
                                                 GdkGravity           gravity);
@@ -189,29 +192,49 @@ void       gtk_window_set_geometry_hints       (GtkWindow           *window,
                                                GdkGeometry         *geometry,
                                                GdkWindowHints       geom_mask);
 
-/* gtk_window_set_has_frame () must be called before realizing the window_*/
-void       gtk_window_set_has_frame            (GtkWindow *window, 
-                                               gboolean   setting);
-gboolean   gtk_window_get_has_frame            (GtkWindow *window);
-void       gtk_window_set_frame_dimensions     (GtkWindow *window, 
-                                               gint       left,
-                                               gint       top,
-                                               gint       right,
-                                               gint       bottom);
-void       gtk_window_get_frame_dimensions     (GtkWindow *window, 
-                                               gint      *left,
-                                               gint      *top,
-                                               gint      *right,
-                                               gint      *bottom);
+void      gtk_window_set_screen               (GtkWindow           *window,
+                                               GdkScreen           *screen);
+GdkScreen* gtk_window_get_screen              (GtkWindow           *window);
+
+gboolean   gtk_window_is_active                (GtkWindow           *window);
+gboolean   gtk_window_has_toplevel_focus       (GtkWindow           *window);
+
 void       gtk_window_set_decorated            (GtkWindow *window,
                                                 gboolean   setting);
 gboolean   gtk_window_get_decorated            (GtkWindow *window);
+void       gtk_window_set_deletable            (GtkWindow *window,
+                                                gboolean   setting);
+gboolean   gtk_window_get_deletable            (GtkWindow *window);
+
+void       gtk_window_set_icon_list                (GtkWindow  *window,
+                                                    GList      *list);
+GList*     gtk_window_get_icon_list                (GtkWindow  *window);
+void       gtk_window_set_icon                     (GtkWindow  *window,
+                                                    GdkPixbuf  *icon);
+void       gtk_window_set_icon_name                (GtkWindow   *window,
+                                                   const gchar *name);
+gboolean   gtk_window_set_icon_from_file           (GtkWindow   *window,
+                                                   const gchar *filename,
+                                                   GError     **err);
+GdkPixbuf* gtk_window_get_icon                     (GtkWindow  *window);
+const gchar * gtk_window_get_icon_name             (GtkWindow  *window);
+void       gtk_window_set_default_icon_list        (GList      *list);
+GList*     gtk_window_get_default_icon_list        (void);
+void       gtk_window_set_default_icon             (GdkPixbuf  *icon);
+void       gtk_window_set_default_icon_name        (const gchar *name);
+const gchar * gtk_window_get_default_icon_name     (void);
+gboolean   gtk_window_set_default_icon_from_file   (const gchar *filename,
+                                                   GError     **err);
+
+void       gtk_window_set_auto_startup_notification (gboolean setting);
 
 /* If window is set modal, input will be grabbed when show and released when hide */
 void       gtk_window_set_modal      (GtkWindow *window,
                                      gboolean   modal);
 gboolean   gtk_window_get_modal      (GtkWindow *window);
 GList*     gtk_window_list_toplevels (void);
+void       gtk_window_set_has_user_ref_count (GtkWindow *window,
+                                              gboolean   setting);
 
 void     gtk_window_add_mnemonic          (GtkWindow       *window,
                                           guint            keyval,
@@ -226,13 +249,24 @@ void     gtk_window_set_mnemonic_modifier (GtkWindow       *window,
                                           GdkModifierType  modifier);
 GdkModifierType gtk_window_get_mnemonic_modifier (GtkWindow *window);
 
-void     gtk_window_present       (GtkWindow *window);
+gboolean gtk_window_activate_key          (GtkWindow        *window,
+                                          GdkEventKey      *event);
+gboolean gtk_window_propagate_key_event   (GtkWindow        *window,
+                                          GdkEventKey      *event);
+
+void     gtk_window_present            (GtkWindow *window);
+void     gtk_window_present_with_time  (GtkWindow *window,
+                                       guint32    timestamp);
 void     gtk_window_iconify       (GtkWindow *window);
 void     gtk_window_deiconify     (GtkWindow *window);
 void     gtk_window_stick         (GtkWindow *window);
 void     gtk_window_unstick       (GtkWindow *window);
 void     gtk_window_maximize      (GtkWindow *window);
 void     gtk_window_unmaximize    (GtkWindow *window);
+void     gtk_window_fullscreen    (GtkWindow *window);
+void     gtk_window_unfullscreen  (GtkWindow *window);
+void     gtk_window_set_keep_above    (GtkWindow *window, gboolean setting);
+void     gtk_window_set_keep_below    (GtkWindow *window, gboolean setting);
 
 void gtk_window_begin_resize_drag (GtkWindow     *window,
                                    GdkWindowEdge  edge,
@@ -246,55 +280,74 @@ void gtk_window_begin_move_drag   (GtkWindow     *window,
                                    gint           root_y,
                                    guint32        timestamp);
 
-#ifndef GTK_DISABLE_DEPRECATED
-void       gtk_window_set_policy               (GtkWindow           *window,
-                                               gint                 allow_shrink,
-                                               gint                 allow_grow,
-                                               gint                 auto_shrink);
-#endif
-/* The following differs from gtk_widget_set_usize, in that
- * gtk_widget_set_usize() overrides the requisition, so sets a minimum
- * size, while this only sets the size requested from the WM.
+/* Set initial default size of the window (does not constrain user
+ * resize operations)
  */
-void       gtk_window_set_default_size         (GtkWindow           *window,
-                                               gint                 width,
-                                               gint                 height);
-void       gtk_window_get_default_size         (GtkWindow           *window,
-                                               gint                *width,
-                                               gint                *height);
+void     gtk_window_set_default_size (GtkWindow   *window,
+                                      gint         width,
+                                      gint         height);
+void     gtk_window_get_default_size (GtkWindow   *window,
+                                      gint        *width,
+                                      gint        *height);
+void     gtk_window_resize           (GtkWindow   *window,
+                                      gint         width,
+                                      gint         height);
+void     gtk_window_get_size         (GtkWindow   *window,
+                                      gint        *width,
+                                      gint        *height);
+void     gtk_window_move             (GtkWindow   *window,
+                                      gint         x,
+                                      gint         y);
+void     gtk_window_get_position     (GtkWindow   *window,
+                                      gint        *root_x,
+                                      gint        *root_y);
+gboolean gtk_window_parse_geometry   (GtkWindow   *window,
+                                      const gchar *geometry);
+
+void gtk_window_set_default_geometry (GtkWindow *window,
+                                      gint       width,
+                                      gint       height);
+void gtk_window_resize_to_geometry   (GtkWindow *window,
+                                      gint       width,
+                                      gint       height);
+
+GtkWindowGroup *gtk_window_get_group (GtkWindow   *window);
+gboolean gtk_window_has_group        (GtkWindow   *window);
+
+/* Ignore this unless you are writing a GUI builder */
+void     gtk_window_reshow_with_initial_size (GtkWindow *window);
+
+GtkWindowType gtk_window_get_window_type     (GtkWindow     *window);
 
 /* Window groups
  */
-GType            gtk_window_group_get_type      (void) G_GNUC_CONST;;
+GType            gtk_window_group_get_type      (void) G_GNUC_CONST;
 
 GtkWindowGroup * gtk_window_group_new           (void);
 void             gtk_window_group_add_window    (GtkWindowGroup     *window_group,
                                                 GtkWindow          *window);
 void             gtk_window_group_remove_window (GtkWindowGroup     *window_group,
                                                 GtkWindow          *window);
+GList *          gtk_window_group_list_windows  (GtkWindowGroup     *window_group);
+
+GtkWidget *      gtk_window_group_get_current_grab (GtkWindowGroup *window_group);
+GtkWidget *      gtk_window_group_get_current_device_grab (GtkWindowGroup *window_group,
+                                                           GdkDevice      *device);
 
-/* --- internal functions --- */
-void            gtk_window_set_focus           (GtkWindow *window,
-                                               GtkWidget *focus);
-void            gtk_window_set_default         (GtkWindow *window,
-                                               GtkWidget *defaultw);
-void            gtk_window_remove_embedded_xid (GtkWindow *window,
-                                               guint      xid);
-void            gtk_window_add_embedded_xid    (GtkWindow *window,
-                                               guint      xid);
-void            _gtk_window_reposition         (GtkWindow *window,
-                                               gint       x,
-                                               gint       y);
-void            _gtk_window_constrain_size     (GtkWindow *window,
-                                               gint       width,
-                                               gint       height,
-                                               gint      *new_width,
-                                               gint      *new_height);
-GtkWindowGroup *_gtk_window_get_group          (GtkWindow *window);
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+GtkApplication *gtk_window_get_application      (GtkWindow          *window);
+void            gtk_window_set_application      (GtkWindow          *window,
+                                                 GtkApplication     *application);
 
 
+/* Window grips
+ */
+void     gtk_window_set_has_resize_grip    (GtkWindow    *window,
+                                            gboolean      value);
+gboolean gtk_window_get_has_resize_grip    (GtkWindow    *window);
+gboolean gtk_window_resize_grip_is_visible (GtkWindow    *window);
+gboolean gtk_window_get_resize_grip_area   (GtkWindow    *window,
+                                            GdkRectangle *rect);
+
+G_END_DECLS
+
 #endif /* __GTK_WINDOW_H__ */