Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gtk::HandleBox Class Reference

A GtkHandleBox C++ wrapper class. More...

#include <xfc/gtk/handlebox.hh>

Inheritance diagram for Xfc::Gtk::HandleBox:

Xfc::Gtk::Bin Xfc::Gtk::Container Xfc::Gtk::Widget Xfc::Gtk::Object Xfc::Atk::Implementor Xfc::G::Object Xfc::G::TypeInterface Xfc::G::TypeInstance Xfc::G::TypeInstance Xfc::Trackable Xfc::Trackable List of all members.

Signal Prototypes

Public Member Functions

Accessors
Methods
Signal Proxies

Detailed Description

A GtkHandleBox C++ wrapper class.

The HandleBox 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 GTK+ 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 deattached. 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.


Constructor & Destructor Documentation

Xfc::Gtk::HandleBox::HandleBox ( GtkHandleBox *  handle_box,
bool  owns_reference = false 
) [explicit, protected]

Construct a new HandleBox from an existing GtkHandleBox.

Parameters:
handle_box A pointer to a GtkHandleBox.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The handle_box can be a newly created GtkHandleBox or an existing GtkHandleBox (see G::Object::Object).

Xfc::Gtk::HandleBox::HandleBox ( ShadowType  shadow_type = SHADOW_OUT  )  [explicit]

Construct a new HandleBox with the specified shadow type drawn around the border.

Parameters:
shadow_type The shadow type.

Xfc::Gtk::HandleBox::HandleBox ( GtkHandleBox *  handle_box,
bool  owns_reference = false 
) [explicit, protected]

Construct a new HandleBox from an existing GtkHandleBox.

Parameters:
handle_box A pointer to a GtkHandleBox.
owns_reference Set false if the initial reference count is floating, set true if it's not.
The handle_box can be a newly created GtkHandleBox or an existing GtkHandleBox (see G::Object::Object).

Xfc::Gtk::HandleBox::HandleBox ( ShadowType  shadow_type = SHADOW_OUT  )  [explicit]

Construct a new HandleBox with the specified shadow type drawn around the border.

Parameters:
shadow_type The shadow type.


Member Function Documentation

void Xfc::Gtk::HandleBox::set_shadow_type ( ShadowType  type  ) 

Sets the type of shadow to be drawn around the border of the handle box.

Parameters:
type The shadow type.

void Xfc::Gtk::HandleBox::set_handle_position ( PositionType  position  ) 

Sets the side of the handlebox where the handle is drawn.

Parameters:
position The side of the handlebox where the handle should be drawn.

void Xfc::Gtk::HandleBox::set_snap_edge ( PositionType  edge  ) 

Sets the snap edge of a handlebox.

Parameters:
edge The snap edge.
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 handlebox 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.


Member Data Documentation

const ChildAttachedSignalType Xfc::Gtk::HandleBox::child_attached_signal [static, protected]

Child attached signal (see signal_child_attached()).

Calls a slot with the signature:

< void function(Gtk::Widget& widget);
< // child: The child widget of the handlebox.
<

const ChildDetachedSignalType Xfc::Gtk::HandleBox::child_detached_signal [static, protected]

Child detached signal (see signal_child_detached()).

Calls a slot with the signature:

< void function(Gtk::Widget& widget);
< // child: The child widget of the handlebox.
<


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3