Gtk::TreeDragSource Class Reference
[TreeView Classes]

Inherits Glib::Interface.

Inherited by Gtk::ListStore, and Gtk::TreeStore.

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

List of all members.

Public Member Functions

virtual ~TreeDragSource ()
GtkTreeDragSource* gobj ()
 Provides access to the underlying C GObject.
const GtkTreeDragSource* gobj () const
 Provides access to the underlying C GObject.
bool row_draggable (const TreeModel::Path& path) const
 Asks the Gtk::TreeDragSource whether a particular row can be used as the source of a DND operation.
bool drag_data_get (const TreeModel::Path& path, SelectionData& selection_data)
 Asks the Gtk::TreeDragSource to fill in selection_data with a representation of the row at path.
bool drag_data_delete (const TreeModel::Path& path)
 Asks the Gtk::TreeDragSource to delete the row at path, because it was moved somewhere else via drag-and-drop.

Static Public Member Functions

static void add_interface (GType gtype_implementer)

Protected Member Functions

virtual bool row_draggable_vfunc (const TreeModel::Path& path) const
virtual bool drag_data_get_vfunc (const TreeModel::Path& path, SelectionData& selection_data) const
virtual bool drag_data_delete_vfunc (const TreeModel::Path& path)

Related Functions

(Note that these are not member functions.)



Glib::RefPtr< Gtk::TreeDragSourcewrap (GtkTreeDragSource* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Constructor & Destructor Documentation

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

Member Function Documentation

static void Gtk::TreeDragSource::add_interface ( GType  gtype_implementer  )  [static]
bool Gtk::TreeDragSource::drag_data_delete ( const TreeModel::Path path  ) 

Asks the Gtk::TreeDragSource to delete the row at path, because it was moved somewhere else via drag-and-drop.

Returns false if the deletion fails because path no longer exists, or for some model-specific reason. Should robustly handle a path no longer found in the model!

Parameters:
path Row that was being dragged.
Returns:
true if the row was successfully deleted.
virtual bool Gtk::TreeDragSource::drag_data_delete_vfunc ( const TreeModel::Path path  )  [protected, virtual]
bool Gtk::TreeDragSource::drag_data_get ( const TreeModel::Path path,
SelectionData selection_data 
)

Asks the Gtk::TreeDragSource to fill in selection_data with a representation of the row at path.

selection_data->target gives the required type of the data. Should robustly handle a path no longer found in the model!

Parameters:
path Row that was dragged.
selection_data A Gtk::SelectionData to fill with data from the dragged row.
Returns:
true if data of the required type was provided.
virtual bool Gtk::TreeDragSource::drag_data_get_vfunc ( const TreeModel::Path path,
SelectionData selection_data 
) const [protected, virtual]
const GtkTreeDragSource* Gtk::TreeDragSource::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gtk::ListStore, and Gtk::TreeStore.

GtkTreeDragSource* Gtk::TreeDragSource::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gtk::ListStore, and Gtk::TreeStore.

bool Gtk::TreeDragSource::row_draggable ( const TreeModel::Path path  )  const

Asks the Gtk::TreeDragSource whether a particular row can be used as the source of a DND operation.

If the source doesn't implement this interface, the row is assumed draggable.

Parameters:
path Row on which user is initiating a drag.
Returns:
true if the row can be dragged.
virtual bool Gtk::TreeDragSource::row_draggable_vfunc ( const TreeModel::Path path  )  const [protected, virtual]

Friends And Related Function Documentation

Glib::RefPtr< Gtk::TreeDragSource > wrap ( GtkTreeDragSource *  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 Tue May 4 13:22:05 2010 for gtkmm by  doxygen 1.6.1