Pileus Git - ~andy/gtk/blob - gtk/gtkhandlebox.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  * Copyright (C) 1998 Elliot Lee
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 /*
  22  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  23  * file for a list of people on the GTK+ Team.  See the ChangeLog
  24  * files for a list of changes.  These files are distributed with
  25  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  26  */
  27
  28 /* The GtkHandleBox is to allow widgets to be dragged in and out of
  29  * their parents.
  30  */
  31
  32 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  33 #error "Only <gtk/gtk.h> can be included directly."
  34 #endif
  35
  36 #ifndef __GTK_HANDLE_BOX_H__
  37 #define __GTK_HANDLE_BOX_H__
  38
  39
  40 #include <gdk/gdk.h>
  41 #include <gtk/gtkbin.h>
  42
  43
  44 G_BEGIN_DECLS
  45
  46 #define GTK_TYPE_HANDLE_BOX            (gtk_handle_box_get_type ())
  47 #define GTK_HANDLE_BOX(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_HANDLE_BOX, GtkHandleBox))
  48 #define GTK_HANDLE_BOX_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_HANDLE_BOX, GtkHandleBoxClass))
  49 #define GTK_IS_HANDLE_BOX(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_HANDLE_BOX))
  50 #define GTK_IS_HANDLE_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_HANDLE_BOX))
  51 #define GTK_HANDLE_BOX_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_HANDLE_BOX, GtkHandleBoxClass))
  52
  53
  54 typedef struct _GtkHandleBox       GtkHandleBox;
  55 typedef struct _GtkHandleBoxClass  GtkHandleBoxClass;
  56
  57 struct _GtkHandleBox
  58 {
  59   GtkBin bin;
  60
  61   GdkWindow      *bin_window;   /* parent window for children */
  62   GdkWindow      *float_window;
  63   GtkShadowType   shadow_type;
  64   guint           handle_position : 2;
  65   guint           float_window_mapped : 1;
  66   guint           child_detached : 1;
  67   guint           in_drag : 1;
  68   guint           shrink_on_detach : 1;
  69
  70   signed int      snap_edge : 3; /* -1 == unset */
  71
  72   /* Variables used during a drag
  73    */
  74   gint deskoff_x, deskoff_y; /* Offset between root relative coordinates
  75                               * and deskrelative coordinates */
  76   GtkAllocation   attach_allocation;
  77   GtkAllocation   float_allocation;
  78 };
  79
  80 struct _GtkHandleBoxClass
  81 {
  82   GtkBinClass parent_class;
  83
  84   void  (*child_attached)       (GtkHandleBox   *handle_box,
  85                                  GtkWidget      *child);
  86   void  (*child_detached)       (GtkHandleBox   *handle_box,
  87                                  GtkWidget      *child);
  88
  89   /* Padding for future expansion */
  90   void (*_gtk_reserved1) (void);
  91   void (*_gtk_reserved2) (void);
  92   void (*_gtk_reserved3) (void);
  93   void (*_gtk_reserved4) (void);
  94 };
  95
  96
  97 GType         gtk_handle_box_get_type             (void) G_GNUC_CONST;
  98 GtkWidget*    gtk_handle_box_new                  (void);
  99 void          gtk_handle_box_set_shadow_type      (GtkHandleBox    *handle_box,
 100                                                    GtkShadowType    type);
 101 GtkShadowType gtk_handle_box_get_shadow_type      (GtkHandleBox    *handle_box);
 102 void          gtk_handle_box_set_handle_position  (GtkHandleBox    *handle_box,
 103                                                    GtkPositionType  position);
 104 GtkPositionType gtk_handle_box_get_handle_position(GtkHandleBox    *handle_box);
 105 void          gtk_handle_box_set_snap_edge        (GtkHandleBox    *handle_box,
 106                                                    GtkPositionType  edge);
 107 GtkPositionType gtk_handle_box_get_snap_edge      (GtkHandleBox    *handle_box);
 108
 109 G_END_DECLS
 110
 111 #endif /* __GTK_HANDLE_BOX_H__ */