Gtk::ToolPalette Class Reference
[WidgetsContainer Widgets]

A ToolPalette allows you to add ToolItems to a palette-like container with various categories and drag and drop support. More...

Inherits Gtk::Container, and Gtk::Orientable.

Collaboration diagram for Gtk::ToolPalette:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~ToolPalette ()
GtkToolPalette* gobj ()
 Provides access to the underlying C GtkObject.
const GtkToolPalette* gobj () const
 Provides access to the underlying C GtkObject.
 ToolPalette ()
void set_group_position (ToolItemGroup& group, int position)
void set_exclusive (ToolItemGroup& group, bool exclusive)
void set_expand (ToolItemGroup& group, bool expand=true)
int get_group_position (ToolItemGroup& group) const
bool get_exclusive (ToolItemGroup& group) const
bool get_expand (ToolItemGroup& group)
void set_icon_size (IconSize icon_size)
void unset_icon_size ()
void set_style (ToolbarStyle style)
void unset_style ()
IconSize get_icon_size ()
ToolbarStyle get_style () const
 Simply an accessor function that returns widget->style.
ToolItemget_drop_item (int x, int y)
ToolItemGroupget_drop_group (int x, int y)
const ToolItemGroupget_drop_group (int x, int y) const
ToolItemget_drag_item (const SelectionData& selection)
const ToolItemget_drag_item (const SelectionData& selection) const
void set_drag_source (ToolPaletteDragTargets targets)
void add_drag_dest (Gtk::Widget& widget, DestDefaults flags, ToolPaletteDragTargets targets, Gdk::DragAction actions)
Adjustmentget_hadjustment ()
const Adjustmentget_hadjustment () const
Adjustmentget_vadjustment ()
const Adjustmentget_vadjustment () const

Static Public Member Functions

static TargetEntry get_drag_target_item ()
static TargetEntry get_drag_target_group ()

Related Functions

(Note that these are not member functions.)



Gtk::ToolPalettewrap (GtkToolPalette* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

A ToolPalette allows you to add ToolItems to a palette-like container with various categories and drag and drop support.

ToolItems cannot be added directly to a ToolPalette - instead they are added to a ToolItemGroup which can than be added to a ToolPalette. To add a ToolItemGroup to a ToolPalette, use Gtk::Container::add().

The easiest way to use drag and drop with ToolPalette is to call add_drag_dest() with the desired drag source palette and the desired drag target widget. Then get_drag_item() can be used to get the dragged item in the "drag-data-received" signal handler of the drag target.


Constructor & Destructor Documentation

virtual Gtk::ToolPalette::~ToolPalette (  )  [virtual]
Gtk::ToolPalette::ToolPalette (  ) 

Member Function Documentation

void Gtk::ToolPalette::add_drag_dest ( Gtk::Widget widget,
DestDefaults  flags,
ToolPaletteDragTargets  targets,
Gdk::DragAction  actions 
)
const ToolItem* Gtk::ToolPalette::get_drag_item ( const SelectionData selection  )  const
ToolItem* Gtk::ToolPalette::get_drag_item ( const SelectionData selection  ) 
static TargetEntry Gtk::ToolPalette::get_drag_target_group (  )  [static]
static TargetEntry Gtk::ToolPalette::get_drag_target_item (  )  [static]
const ToolItemGroup* Gtk::ToolPalette::get_drop_group ( int  x,
int  y 
) const
ToolItemGroup* Gtk::ToolPalette::get_drop_group ( int  x,
int  y 
)
ToolItem* Gtk::ToolPalette::get_drop_item ( int  x,
int  y 
)
bool Gtk::ToolPalette::get_exclusive ( ToolItemGroup group  )  const
bool Gtk::ToolPalette::get_expand ( ToolItemGroup group  ) 
int Gtk::ToolPalette::get_group_position ( ToolItemGroup group  )  const
const Adjustment* Gtk::ToolPalette::get_hadjustment (  )  const
Adjustment* Gtk::ToolPalette::get_hadjustment (  ) 
IconSize Gtk::ToolPalette::get_icon_size (  ) 
ToolbarStyle Gtk::ToolPalette::get_style (  )  const

Simply an accessor function that returns widget->style.

Returns:
The widget's Gtk::Style.

Reimplemented from Gtk::Widget.

const Adjustment* Gtk::ToolPalette::get_vadjustment (  )  const
Adjustment* Gtk::ToolPalette::get_vadjustment (  ) 
const GtkToolPalette* Gtk::ToolPalette::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Container.

GtkToolPalette* Gtk::ToolPalette::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Container.

void Gtk::ToolPalette::set_drag_source ( ToolPaletteDragTargets  targets  ) 
void Gtk::ToolPalette::set_exclusive ( ToolItemGroup group,
bool  exclusive 
)
void Gtk::ToolPalette::set_expand ( ToolItemGroup group,
bool  expand = true 
)
void Gtk::ToolPalette::set_group_position ( ToolItemGroup group,
int  position 
)
void Gtk::ToolPalette::set_icon_size ( IconSize  icon_size  ) 
void Gtk::ToolPalette::set_style ( ToolbarStyle  style  ) 
void Gtk::ToolPalette::unset_icon_size (  ) 
void Gtk::ToolPalette::unset_style (  ) 

Reimplemented from Gtk::Widget.


Friends And Related Function Documentation

Gtk::ToolPalette* wrap ( GtkToolPalette *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

Generated on Mon Jan 4 14:29:46 2010 for gtkmm by  doxygen 1.6.1