Ardour  8.7-14-g57a6773833
Gtk::TreeDragSource Class Reference

#include <treedragsource.h>

Inheritance diagram for Gtk::TreeDragSource:
[legend]

Public Member Functions

virtual ~TreeDragSource ()
 
GtkTreeDragSourcegobj ()
 Provides access to the underlying C GObject. More...
 
const GtkTreeDragSourcegobj () const
 Provides access to the underlying C GObject. More...
 
bool row_draggable (const TreeModel::Path &path) const
 
bool drag_data_get (const TreeModel::Path &path, SelectionData &selection_data)
 
bool drag_data_delete (const TreeModel::Path &path)
 

Static Public Member Functions

static void add_interface (GType gtype_implementer)
 
static GType get_type () G_GNUC_CONST
 

Protected Member Functions

 TreeDragSource ()
 
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)
 

Detailed Description

Definition at line 61 of file treedragsource.h.

Constructor & Destructor Documentation

◆ TreeDragSource()

Gtk::TreeDragSource::TreeDragSource ( )
protected

You should derive from this class to use it.

◆ ~TreeDragSource()

virtual Gtk::TreeDragSource::~TreeDragSource ( )
virtual

Member Function Documentation

◆ add_interface()

static void Gtk::TreeDragSource::add_interface ( GType  gtype_implementer)
static

◆ drag_data_delete()

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
pathRow that was being dragged.
Returns
true if the row was successfully deleted.

◆ drag_data_delete_vfunc()

virtual bool Gtk::TreeDragSource::drag_data_delete_vfunc ( const TreeModel::Path path)
protectedvirtual

◆ drag_data_get()

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
pathRow that was dragged.
selection_dataA Gtk::SelectionData to fill with data from the dragged row.
Returns
true if data of the required type was provided.

◆ drag_data_get_vfunc()

virtual bool Gtk::TreeDragSource::drag_data_get_vfunc ( const TreeModel::Path path,
SelectionData selection_data 
) const
protectedvirtual

◆ get_type()

static GType Gtk::TreeDragSource::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

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

Provides access to the underlying C GObject.

Definition at line 119 of file treedragsource.h.

◆ gobj() [2/2]

const GtkTreeDragSource* Gtk::TreeDragSource::gobj ( ) const
inline

Provides access to the underlying C GObject.

Definition at line 122 of file treedragsource.h.

◆ row_draggable()

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
pathRow on which user is initiating a drag.
Returns
true if the row can be dragged.

◆ row_draggable_vfunc()

virtual bool Gtk::TreeDragSource::row_draggable_vfunc ( const TreeModel::Path path) const
protectedvirtual

Reimplemented in PluginTreeStore.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::TreeDragSource > wrap ( GtkTreeDragSource object,
bool  take_copy = false 
)
related

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

Parameters
objectThe C instance.
take_copyFalse 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: