libs/gtkmm2/gtk/src/handlebox.hg

   1  /* $Id: handlebox.hg,v 1.1 2003/01/21 13:40:26 murrayc Exp $ */
   2
   3 /* handlebox.h
   4  *
   5  * Copyright (C) 1998-2002 The gtkmm Development Team
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the Free
  19  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 #include <gtkmm/eventbox.h>
  23 _DEFS(gtkmm,gtk)
  24 _PINCLUDE(gtkmm/private/bin_p.h)
  25
  26 #m4 _CONVERSION(`int',`PositionType',`($2)$3')
  27
  28 namespace Gtk
  29 {
  30
  31 /** A widget for detachable window portions.
  32  *
  33  * The Gtk::HandleBox widget allows a portion of a window to be "torn off".
  34  * It displays its child and a handle that the user can drag to tear off a separate window (the float window) containing the child widget. A thin ghost is drawn in the original location of the handlebox. By dragging the separate window back to its original location, it can be reattached.
  35  * When reattaching, the ghost and float window must be aligned along one of the edges, the snap edge. This can be specified by the application programmer explicitely, or GTK+ will pick a reasonable default based on the handle position.
  36  * To make detaching and reattaching the handlebox as minimally confusing as possible to the user, it is important to set the snap edge so that the snap edge does not move when the handlebox is deattached.
  37  * For instance, if the handlebox is packed at the bottom of a VBox, then when the handlebox is detached, the bottom edge of the handlebox's allocation will remain fixed as the height of the handlebox shrinks, so the snap edge should be set to GTK_POS_BOTTOM.
  38  *
  39  * @ingroup Widgets
  40  * @ingroup Containers
  41  */
  42 class HandleBox : public Bin
  43 {
  44   _CLASS_GTKOBJECT(HandleBox,GtkHandleBox,GTK_HANDLE_BOX,Gtk::Bin,GtkBin)
  45 public:
  46   _CTOR_DEFAULT
  47
  48
  49   _WRAP_METHOD(void set_shadow_type(ShadowType type), gtk_handle_box_set_shadow_type)
  50   _WRAP_METHOD(ShadowType get_shadow_type() const, gtk_handle_box_get_shadow_type)
  51   _WRAP_METHOD(void set_handle_position(PositionType position), gtk_handle_box_set_handle_position)
  52   _WRAP_METHOD(PositionType get_handle_position() const, gtk_handle_box_get_handle_position)
  53   _WRAP_METHOD(void set_snap_edge(PositionType edge), gtk_handle_box_set_snap_edge)
  54   _WRAP_METHOD(PositionType get_snap_edge() const, gtk_handle_box_get_snap_edge)
  55
  56   _WRAP_SIGNAL(void child_attached(Widget* child), "child_attached")
  57   _WRAP_SIGNAL(void child_detached(Widget* child), "child_detached")
  58
  59   _MEMBER_GET_GOBJECT(bin_window, bin_window, Gdk::Window, GdkWindow*)
  60   _MEMBER_GET_GOBJECT(float_window, float_window, Gdk::Window, GdkWindow*)
  61
  62   bool is_child_detached() const;
  63   bool is_float_window_mapped() const;
  64   bool is_in_drag() const;
  65   bool shrinks_on_detach() const;
  66
  67   //_WRAP_PROPERTY("shadow", ShadowType); //deprecated.
  68   _WRAP_PROPERTY("shadow-type", ShadowType)
  69   _WRAP_PROPERTY("handle-position", PositionType)
  70   _WRAP_PROPERTY("snap-edge", PositionType)
  71 };
  72
  73 } /* namespace Gtk */
  74