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

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

#include <gtkmm/treedragdest.h>

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

Public Member Functions

 TreeDragDest (TreeDragDest && src) noexcept
 
TreeDragDestoperator= (TreeDragDest && src) noexcept
 
 ~TreeDragDest () noexcept override
 
GtkTreeDragDest * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkTreeDragDest * gobj () const
 Provides access to the underlying C GObject. More...
 
bool drag_data_received (const TreeModel::Path & dest, const Glib::ValueBase & value)
 Asks the Gtk::TreeDragDest to insert a row before the path dest, deriving the contents of the row from value. More...
 
bool row_drop_possible (const TreeModel::Path & dest_path, const Glib::ValueBase & value) const
 Determines whether a drop is possible before the given dest_path, at the same depth as dest_path. 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

 TreeDragDest ()
 You should derive from this class to use it. More...
 
virtual bool drag_data_received_vfunc (const TreeModel::Path & dest, const Glib::ValueBase & value)
 
virtual bool row_drop_possible_vfunc (const TreeModel::Path & dest, const Glib::ValueBase & value) const
 

Related Functions

(Note that these are not member functions.)

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

Detailed Description

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

Deprecated:
4.10: List views use widgets to display their contents. You can use Gtk::DropTarget to implement a drop destination.

Constructor & Destructor Documentation

◆ TreeDragDest() [1/2]

Gtk::TreeDragDest::TreeDragDest ( )
protected

You should derive from this class to use it.

◆ TreeDragDest() [2/2]

Gtk::TreeDragDest::TreeDragDest ( TreeDragDest &&  src)
noexcept

◆ ~TreeDragDest()

Gtk::TreeDragDest::~TreeDragDest ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

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

◆ drag_data_received()

bool Gtk::TreeDragDest::drag_data_received ( const TreeModel::Path dest,
const Glib::ValueBase &  value 
)

Asks the Gtk::TreeDragDest to insert a row before the path dest, deriving the contents of the row from value.

If dest is outside the tree so that inserting before it is impossible, false will be returned. Also, false may be returned if the new row is not created for some model-specific reason. Should robustly handle a dest no longer found in the model!

Deprecated: 4.10: Use list models instead

Parameters
destRow to drop in front of.
valueData to drop.
Returns
Whether a new row was created before position dest.

◆ drag_data_received_vfunc()

virtual bool Gtk::TreeDragDest::drag_data_received_vfunc ( const TreeModel::Path dest,
const Glib::ValueBase &  value 
)
protectedvirtual

◆ get_type()

static GType Gtk::TreeDragDest::get_type ( )
static

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

◆ gobj() [1/2]

GtkTreeDragDest* Gtk::TreeDragDest::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkTreeDragDest* Gtk::TreeDragDest::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ operator=()

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

◆ row_drop_possible()

bool Gtk::TreeDragDest::row_drop_possible ( const TreeModel::Path dest_path,
const Glib::ValueBase &  value 
) const

Determines whether a drop is possible before the given dest_path, at the same depth as dest_path.

i.e., can we drop the data in value at that location. dest_path does not have to exist; the return value will almost certainly be false if the parent of dest_path doesn’t exist, though.

Deprecated: 4.10: Use list models instead

Parameters
dest_pathDestination row.
valueThe data being dropped.
Returns
true if a drop is possible before dest_path.

◆ row_drop_possible_vfunc()

virtual bool Gtk::TreeDragDest::row_drop_possible_vfunc ( const TreeModel::Path dest,
const Glib::ValueBase &  value 
) const
protectedvirtual

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::TreeDragDest > wrap ( GtkTreeDragDest *  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.