gtkmm  4.8.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::TreeDragSource Class Reference

Interface for Drag-and-Drop sources in Gtk::TreeView. More...

#include <gtkmm/treedragsource.h>

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

Public Member Functions

 TreeDragSource (TreeDragSource && src) noexcept
 
TreeDragSourceoperator= (TreeDragSource && src) noexcept
 
 ~TreeDragSource () noexcept override
 
GtkTreeDragSource * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkTreeDragSource * gobj () const
 Provides access to the underlying C GObject. More...
 
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. More...
 
Glib::RefPtr< Gdk::ContentProviderdrag_data_get (const TreeModel::Path & path) const
 Asks the Gtk::TreeDragSource to return a Gdk::ContentProvider representing the row at path. More...
 
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. More...
 

Static Public Member Functions

static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

 TreeDragSource ()
 You should derive from this class to use it. More...
 
virtual bool row_draggable_vfunc (const TreeModel::Path & path) const
 
virtual Glib::RefPtr< Gdk::ContentProviderdrag_data_get_vfunc (const TreeModel::Path & path) 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. More...
 

Detailed Description

Interface for Drag-and-Drop sources in Gtk::TreeView.

Deprecated:
4.10: List views use widgets to display their contents. You can use Gtk::DragSource to implement a drag source.

Constructor & Destructor Documentation

◆ TreeDragSource() [1/2]

Gtk::TreeDragSource::TreeDragSource ( )
protected

You should derive from this class to use it.

◆ TreeDragSource() [2/2]

Gtk::TreeDragSource::TreeDragSource ( TreeDragSource &&  src)
noexcept

◆ ~TreeDragSource()

Gtk::TreeDragSource::~TreeDragSource ( )
overridenoexcept

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!

Deprecated: 4.10: Use list models instead

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

Glib::RefPtr<Gdk::ContentProvider> Gtk::TreeDragSource::drag_data_get ( const TreeModel::Path path) const

Asks the Gtk::TreeDragSource to return a Gdk::ContentProvider representing the row at path.

Should robustly handle a path no longer found in the model!

Deprecated: 4.10: Use list models instead

Parameters
pathRow that was dragged.
Returns
A Gdk::ContentProvider for the given path.

◆ drag_data_get_vfunc()

virtual Glib::RefPtr<Gdk::ContentProvider> Gtk::TreeDragSource::drag_data_get_vfunc ( const TreeModel::Path path) 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.

◆ gobj() [2/2]

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

Provides access to the underlying C GObject.

◆ operator=()

TreeDragSource& Gtk::TreeDragSource::operator= ( TreeDragSource &&  src)
noexcept

◆ 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.

Deprecated: 4.10: Use list models instead

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

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.