GtkAda Reference Manual - Package Gtk.Handle_Box

[Contents] [Back] [Prev] [Up] [Next] [Forward]

# Package Gtk.Handle`_`Box

The Gtk_Handle_Box widget allows a portion of a window to be "torn off". It is a bin widget which 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.

When reattaching, the ghost and float window, must be aligned along one of the edges, the snap edge. This either can be specified by the application programmer explicitely, or GtkAda will pick a reasonable default based on the handle position.

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 detached. 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 Pos_Bottom.

- Gtk.Handle_Box Widget Hierarchy
- Gtk.Handle_Box Signals
- Gtk.Handle_Box Subprograms

## Widget Hierarchy

    GObject                       (see section Package Glib.Object)
    Gtk_Object                    (see section Package Gtk.Object)
       \___ Gtk_Widget            (see section Package Gtk.Widget)
          \___ Gtk_Container      (see section Package Gtk.Container)
             \___ Gtk_Bin         (see section Package Gtk.Bin)
                \___ Gtk_Handle_Box (see section Package Gtk.Handle_Box)

## Signals

- "child-attached" procedure Handler
  (Handle_Box : access Gtk_Handle_Box_Record'Class;
  Widget : access Gtk_Widget_Record'Class);
  Emitted when the contents of the Handle_Box are reattached to the main window. Widget is the child widget of the Handle_Box. (this argument provides no extra information and is here only for backwards-compatibility)
- "child-detached" procedure Handler
  (Handle_Box : access Gtk_Handle_Box_Record'Class;
  Widget : access Gtk_Widget_Record'Class);
  Emitted when the contents of the Handle_Box are detached from the main window. See "child-attached" for drtails on the parameters.

## Subprograms

    procedure Gtk_New
      (Handle_Box         : out    Gtk_Handle_Box);
| Create a new Handle_Box.
    function Get_Type              return Gtk.Gtk_Type;
| Return the internal value associated with a Gtk_Dialog.
    procedure Set_Shadow_Type
      (Handle_Box         : access Gtk_Handle_Box_Record;
       Typ                :        Enums.Gtk_Shadow_Type);
| Set the type of shadow to be drawn around the border of the Handle_Box.
    function Get_Shadow_Type
      (Handle_Box         : access Gtk_Handle_Box_Record)
       return Enums.Gtk_Shadow_Type;
| Return the shadow type of the handle box.
    procedure Set_Handle_Position
      (Handle_Box         : access Gtk_Handle_Box_Record;
       Position           :        Enums.Gtk_Position_Type);
| Set the side of the Handle_Box where the handle is drawn.
    function Get_Handle_Position
      (Handle_Box         : access Gtk_Handle_Box_Record)
       return Enums.Gtk_Position_Type;
| Return the side of the Handle_Box where the handle is drawn.
    procedure Set_Snap_Edge
      (Handle_Box         : access Gtk_Handle_Box_Record;
       Edge               :        Enums.Gtk_Position_Type);
| Set the snap edge of a Handle_Box. The snap edge is the edge of the detached child that must be aligned with the corresponding edge of the "ghost" left behind when the child was detached to reattach the torn-off window. Usually, the snap edge should be chosen so that it stays in the same place on the screen when the Handle_Box is torn off. If the snap edge is not set, then an appropriate value will be guessed from the handle position. If the handle position is Pos_Right or Pos_Left, then the snap edge will be Pos_Top, otherwise it will be Pos_Left.
    function Get_Snap_Edge
      (Handle_Box         : access Gtk_Handle_Box_Record)
       return Enums.Gtk_Position_Type;
| Return the snap edge of a Handle_Box.

[Contents] [Back] [Prev] [Up] [Next] [Forward]