| Gnome User Interface Library Reference Manual | |||
|---|---|---|---|
| <<< Previous Page | Home | Up | Next Page >>> |
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.
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;
}; |
GtkWidget* gnome_dock_band_new (void); |
Create a new GnomeDockBand widget.
| Returns : | The new GnomeDockBand widget. |
void gnome_dock_band_set_orientation (GnomeDockBand *band, GtkOrientation orientation); |
Set the orientation for band.
| band : | A GnomeDockBand widget |
| orientation : | New orientation for band |
GtkOrientation gnome_dock_band_get_orientation (GnomeDockBand *band); |
Retrieve the orientation of the specified band.
| band : | A GnomeDockBand widget |
| Returns : | The orientation of band. |
gboolean gnome_dock_band_insert (GnomeDockBand *band, GtkWidget *child, guint offset, gint position); |
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).
| band : | A GnomeDockBand widget |
| child : | The widget to be added to band |
| offset : | Offset from the previous item |
| position : | Position within the band |
| Returns : | TRUE if successful, FALSE if the operation fails. |
gboolean gnome_dock_band_prepend (GnomeDockBand *band, GtkWidget *child, guint offset); |
Add child to band with the specified offset as the first element.
| band : | A GnomeDockBand widget |
| child : | A widget to be added to band |
| offset : | Offset (in pixels) from the beginning of the band |
| Returns : | TRUE if successful, FALSE if the operation fails. |
gboolean gnome_dock_band_append (GnomeDockBand *band, GtkWidget *child, guint offset); |
Add child to band with the specified offset as the last element.
| band : | A GnomeDockBand widget |
| child : | A widget to be added to band |
| offset : | Offset (in pixels) from the last item of the band |
| Returns : | TRUE if successful, FALSE if the operation fails. |
void gnome_dock_band_set_child_offset
(GnomeDockBand *band,
GtkWidget *child,
guint offset); |
Set the offset for the specified child of band.
| band : | A GnomeDockBand widget |
| child : | Child of band whose offset must be changed |
| offset : | New offset value for child |
guint gnome_dock_band_get_child_offset (GnomeDockBand *band, GtkWidget *child); |
Retrieve the offset of child in band.
| band : | A GnomeDockBand widget |
| child : | Child of band whose offset must be retrieved |
| Returns : | The offset of child. |
void gnome_dock_band_move_child (GnomeDockBand *band, GList *old_child, guint new_num); |
| band : | |
| old_child : | |
| new_num : |
guint gnome_dock_band_get_num_children (GnomeDockBand *band); |
Retrieve the number of children in band.
| band : | A GnomeDockBand widget |
| Returns : | The number of children in band. |
void gnome_dock_band_drag_begin (GnomeDockBand *band, GnomeDockItem *item); |
| band : | |
| item : |
gboolean gnome_dock_band_drag_to (GnomeDockBand *band, GnomeDockItem *item, gint x, gint y); |
| band : | |
| item : | |
| x : | |
| y : | |
| Returns : |
void gnome_dock_band_drag_end (GnomeDockBand *band, GnomeDockItem *item); |
| band : | |
| item : |
GnomeDockItem* gnome_dock_band_get_item_by_name (GnomeDockBand *band, const char *name, guint *position_return, guint *offset_return); |
Retrieve a named item from band, and return its position and offset in *position_return and offset_return.
| band : | A GnomeDockBand widget |
| name : | Name of the child to be retrieved |
| position_return : | Pointer to a variable holding the position of the named child |
| offset_return : | Pointer to a variable holding the offset of the named child |
| Returns : | The child whose name is name, or NULL if no child of band has such name. |
void gnome_dock_band_layout_add (GnomeDockBand *band, GnomeDockLayout *layout, GnomeDockPlacement placement, guint band_num); |
| band : | |
| layout : | |
| placement : | |
| band_num : |