Name
GnomeDockBand -- A widget implementing dock bands.
Synopsis
#include <gnome.h>
struct GnomeDockBand;
struct GnomeDockBandChild;
GtkWidget* gnome_dock_band_new (void);
void gnome_dock_band_set_orientation (GnomeDockBand *band,
GtkOrientation orientation);
GtkOrientation gnome_dock_band_get_orientation
(GnomeDockBand *band);
gboolean gnome_dock_band_insert (GnomeDockBand *band,
GtkWidget *child,
guint offset,
gint position);
gboolean gnome_dock_band_prepend (GnomeDockBand *band,
GtkWidget *child,
guint offset);
gboolean gnome_dock_band_append (GnomeDockBand *band,
GtkWidget *child,
guint offset);
void gnome_dock_band_set_child_offset
(GnomeDockBand *band,
GtkWidget *child,
guint offset);
guint gnome_dock_band_get_child_offset
(GnomeDockBand *band,
GtkWidget *child);
void gnome_dock_band_move_child (GnomeDockBand *band,
GList *old_child,
guint new_num);
guint gnome_dock_band_get_num_children
(GnomeDockBand *band);
void gnome_dock_band_drag_begin (GnomeDockBand *band,
GnomeDockItem *item);
gboolean gnome_dock_band_drag_to (GnomeDockBand *band,
GnomeDockItem *item,
gint x,
gint y);
void gnome_dock_band_drag_end (GnomeDockBand *band,
GnomeDockItem *item);
GnomeDockItem* gnome_dock_band_get_item_by_name
(GnomeDockBand *band,
const char *name,
guint *position_return,
guint *offset_return);
void gnome_dock_band_layout_add (GnomeDockBand *band,
GnomeDockLayout *layout,
GnomeDockPlacement placement,
guint band_num);
|
Description
GnomeDockBand is a widget implementing a "dock band", i.e. a
horizontal or vertical stripe containing dockable widgets.
The application programmer does not normally need to use
GnomeDockBands directly; they are mostly used by the
GnomeDock widget to implement its functionality. For an
explanation of the way dock bands are used within a dock, check out
the documentation for the GnomeDock widget.
Details
struct GnomeDockBandChild
struct GnomeDockBandChild
{
GtkWidget *widget;
/* Maximum (requested) offset from the previous child. */
guint offset;
/* Actual offset. */
guint real_offset;
guint drag_offset;
GtkAllocation drag_allocation;
guint prev_space, foll_space;
guint drag_prev_space, drag_foll_space;
guint max_space_requisition;
}; |
gnome_dock_band_new ()
Create a new GnomeDockBand widget.
gnome_dock_band_set_orientation ()
Set the orientation for band.
gnome_dock_band_get_orientation ()
Retrieve the orientation of the specified band.
gnome_dock_band_insert ()
Add child to band at the specified position, with
the specified offset from the previous item (or from the beginning
of the band, if this is the first item).
gnome_dock_band_prepend ()
Add child to band with the specified offset as the
first element.
gnome_dock_band_append ()
Add child to band with the specified offset as the
last element.
gnome_dock_band_set_child_offset ()
Set the offset for the specified child of band.
gnome_dock_band_get_child_offset ()
Retrieve the offset of child in band.
gnome_dock_band_move_child ()
gnome_dock_band_get_num_children ()
Retrieve the number of children in band.
gnome_dock_band_drag_begin ()
gnome_dock_band_drag_to ()
gnome_dock_band_drag_end ()
gnome_dock_band_get_item_by_name ()
Retrieve a named item from band, and return its
position and offset in *position_return and offset_return.
gnome_dock_band_layout_add ()