gtkmm: Gtk::TreeDragDest Class Reference

gtkmm 3.24.11

Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Symbols | List of all members
Gtk::TreeDragDest Class Reference
TreeView Classes

`#include <gtkmm/treedragdest.h>`

Inheritance diagram for Gtk::TreeDragDest:
[legend]

## Public Member Functions
| TreeDragDest (TreeDragDest && src) noexcept
TreeDragDest & | operator= (TreeDragDest && src) noexcept
| ~TreeDragDest () noexcept override
GtkTreeDragDest * | gobj ()
| Provides access to the underlying C GObject.
const GtkTreeDragDest * | gobj () const
| Provides access to the underlying C GObject.
bool | drag_data_received (const TreeModel::Path & dest, const SelectionData & selection_data)
| Asks the Gtk::TreeDragDest to insert a row before the path dest, deriving the contents of the row from selection_data.
bool | row_drop_possible (const TreeModel::Path & dest_path, const SelectionData & selection_data) const
| Determines whether a drop is possible before the given dest_path, at the same depth as dest_path.

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

## Protected Member Functions
| TreeDragDest ()
| You should derive from this class to use it.
virtual bool | drag_data_received_vfunc (const TreeModel::Path & dest, const SelectionData & selection_data)
virtual bool | row_drop_possible_vfunc (const TreeModel::Path & dest, const SelectionData & selection_data) const

## Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gtk::TreeDragDest > | wrap (GtkTreeDragDest * object, bool take_copy=false)
| A Glib::wrap() method for this object.

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

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

## ◆ drag_data_received()

bool Gtk::TreeDragDest::drag_data_received | ( | const TreeModel::Path & | dest,
|  | const SelectionData & | selection_data )

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

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!

Parameters

  dest | Row to drop in front of.
  selection_data | Data 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 SelectionData & | selection_data )
| protectedvirtual

## ◆ get_type()

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 SelectionData & | selection_data ) 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 selection_data 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.

Parameters

  dest_path | Destination row.
  selection_data | The data being dragged.

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 SelectionData & | selection_data ) const
| protectedvirtual

## Friends And Related Symbol Documentation

## ◆ wrap()

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