Class Index | Cross Index | Namespace Index |
Moveable Container
Contained in: Gnome
Derived from:
Gtk::Container
Derived by:
none
#include <gtk--/dock.h>
public function member index: |
||
Dock | (); | |
void | add_floating_item | (DockItem& widget, gint x, gint y, GtkOrientation orientation); |
bool | add_from_layout | (DockLayout& layout); |
void | add_item | (DockItem& item, GnomeDockPlacement placement, guint band_num, gint position, guint offset, bool in_new_band); |
void | allow_floating_items | (bool enable); |
Gtk::Widget* | get_client_area | (); |
DockItem* | get_item_by_name | (const Gtk::string& name, GnomeDockPlacement& placement_return, guint& num_band_return, guint& band_position_return, guint& offset_return); |
DockLayout* | get_layout | (); |
static GtkType | get_type | (); |
GnomeDock* | gtkobj | (); |
const GnomeDock* | gtkobj | () const; |
static bool | isA | (Gtk::Object* checkcast); |
void | set_client_area | (Gtk::Widget& widget); |
virtual | ~Dock | (); |
protected function member index: |
||
explicit | Dock | (GnomeDock* castitem); |
void | initialize_class | (); |
virtual void | layout_changed_impl | (); |
private function member index: |
||
Dock | (const Dock&); | |
Dock& | operator = | (const Dock&); |
Every GnomeDock contains a widget called the "client area". On the four sides of the client area, there are four "dock areas", which can contain an arbitrary number of dockable widgets. All the dockable widgets should be GnomeDockItem widgets; the GnomeDockItem widget can in turn contain any kind of widget, and implements the dragging functionality: every GnomeDockItem has a handle that users can use to move them within the dock, or even move them outside it, so that they become "floating items".
Every "dock area" is implemented by means of zero or more "dock bands": a dock band is a horizontal or vertical stripe containing one or more dock items, and is implemented by the GnomeDockBand widget. Items are ordered from top to bottom in vertical bands, and from left to right in horizontal bands. Every dock item in a band is given an offset value that defines the distance, in pixels, from the previous item in the same band; if the item is first in the band, the offset defines the distance from the start of the band.
As a consequence, the position of an item in the dock can be specified
by means of the following values: a "placement" specifying what area is
being used (top, bottom, left, right), a "band number" specifying the
number of the band within the specified area, a "position" within the
band and a "offset" from the previous item in the same band.