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
  33 #ifndef __GTK_HANDLE_BOX_H__
  34 #define __GTK_HANDLE_BOX_H__
  35
  36
  37 #include <gdk/gdk.h>
  38 #include <gtk/gtkbin.h>
  39
  40
  41 G_BEGIN_DECLS
  42
  43 #define GTK_TYPE_HANDLE_BOX            (gtk_handle_box_get_type ())
  44 #define GTK_HANDLE_BOX(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_HANDLE_BOX, GtkHandleBox))
  45 #define GTK_HANDLE_BOX_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_HANDLE_BOX, GtkHandleBoxClass))
  46 #define GTK_IS_HANDLE_BOX(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_HANDLE_BOX))
  47 #define GTK_IS_HANDLE_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_HANDLE_BOX))
  48 #define GTK_HANDLE_BOX_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_HANDLE_BOX, GtkHandleBoxClass))
  49
  50
  51 typedef struct _GtkHandleBox       GtkHandleBox;
  52 typedef struct _GtkHandleBoxClass  GtkHandleBoxClass;
  53
  54 struct _GtkHandleBox
  55 {
  56   GtkBin bin;
  57
  58   GdkWindow      *bin_window;   /* parent window for children */
  59   GdkWindow      *float_window;
  60   GtkShadowType   shadow_type;
  61   guint           handle_position : 2;
  62   guint           float_window_mapped : 1;
  63   guint           child_detached : 1;
  64   guint           in_drag : 1;
  65   guint           shrink_on_detach : 1;
  66
  67   signed int      snap_edge : 3; /* -1 == unset */
  68
  69   /* Variables used during a drag
  70    */
  71   gint deskoff_x, deskoff_y; /* Offset between root relative coordinates
  72                               * and deskrelative coordinates */
  73   GtkAllocation   attach_allocation;
  74   GtkAllocation   float_allocation;
  75 };
  76
  77 struct _GtkHandleBoxClass
  78 {
  79   GtkBinClass parent_class;
  80
  81   void  (*child_attached)       (GtkHandleBox   *handle_box,
  82                                  GtkWidget      *child);
  83   void  (*child_detached)       (GtkHandleBox   *handle_box,
  84                                  GtkWidget      *child);
  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
  94 GType         gtk_handle_box_get_type             (void) G_GNUC_CONST;
  95 GtkWidget*    gtk_handle_box_new                  (void);
  96 void          gtk_handle_box_set_shadow_type      (GtkHandleBox    *handle_box,
  97                                                    GtkShadowType    type);
  98 GtkShadowType gtk_handle_box_get_shadow_type      (GtkHandleBox    *handle_box);
  99 void          gtk_handle_box_set_handle_position  (GtkHandleBox    *handle_box,
 100                                                    GtkPositionType  position);
 101 GtkPositionType gtk_handle_box_get_handle_position(GtkHandleBox    *handle_box);
 102 void          gtk_handle_box_set_snap_edge        (GtkHandleBox    *handle_box,
 103                                                    GtkPositionType  edge);
 104 GtkPositionType gtk_handle_box_get_snap_edge      (GtkHandleBox    *handle_box);
 105
 106 G_END_DECLS
 107
 108 #endif /* __GTK_HANDLE_BOX_H__ */