1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>gtkmm: Gtk::TreeDragSource Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.3 -->
13
<table cellspacing="0" cellpadding="0">
15
<tr style="height: 56px;">
16
<td style="padding-left: 0.5em;">
17
<div id="projectname">gtkmm <span id="projectnumber">2.24.2</span></div>
23
<div id="navrow1" class="tabs">
25
<li><a href="index.html"><span>Main Page</span></a></li>
26
<li><a href="pages.html"><span>Related Pages</span></a></li>
27
<li><a href="modules.html"><span>Modules</span></a></li>
28
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
29
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
32
<div id="navrow2" class="tabs2">
34
<li><a href="annotated.html"><span>Class List</span></a></li>
35
<li><a href="classes.html"><span>Class Index</span></a></li>
36
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
37
<li><a href="functions.html"><span>Class Members</span></a></li>
40
<div id="nav-path" class="navpath">
42
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
43
<li class="navelem"><a class="el" href="classGtk_1_1TreeDragSource.html">TreeDragSource</a> </li>
49
<a href="#pub-methods">Public Member Functions</a> |
50
<a href="#pub-static-methods">Static Public Member Functions</a> |
51
<a href="#pro-methods">Protected Member Functions</a> |
52
<a href="#related">Related Functions</a> </div>
53
<div class="headertitle">
54
<h1>Gtk::TreeDragSource Class Reference<div class="ingroups"><a class="el" href="group__TreeView.html">TreeView Classes</a></div></h1> </div>
56
<div class="contents">
57
<!-- doxytag: class="Gtk::TreeDragSource" --><!-- doxytag: inherits="Glib::Interface" --><div class="dynheader">
58
Inheritance diagram for Gtk::TreeDragSource:</div>
59
<div class="dyncontent">
60
<div class="center"><img src="classGtk_1_1TreeDragSource__inherit__graph.png" border="0" usemap="#Gtk_1_1TreeDragSource_inherit__map" alt="Inheritance graph"/></div>
61
<map name="Gtk_1_1TreeDragSource_inherit__map" id="Gtk_1_1TreeDragSource_inherit__map">
62
<area shape="rect" id="node9" href="classGtk_1_1ListStore.html" title="Thist is a list model for use with a Gtk::TreeView widget." alt="" coords="5,326,107,357"/><area shape="rect" id="node11" href="classGtk_1_1TreeStore.html" title="Gtk::TreeStore" alt="" coords="131,326,237,357"/><area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="68,166,172,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="60,86,180,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="67,6,173,37"/></map>
63
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
64
<div class="dynheader">
65
Collaboration diagram for Gtk::TreeDragSource:</div>
66
<div class="dyncontent">
67
<div class="center"><img src="classGtk_1_1TreeDragSource__coll__graph.png" border="0" usemap="#Gtk_1_1TreeDragSource_coll__map" alt="Collaboration graph"/></div>
68
<map name="Gtk_1_1TreeDragSource_coll__map" id="Gtk_1_1TreeDragSource_coll__map">
69
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="25,166,129,197"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="17,86,137,117"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="24,6,131,37"/></map>
70
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
72
<p><a href="classGtk_1_1TreeDragSource-members.html">List of all members.</a></p>
73
<table class="memberdecls">
74
<tr><td colspan="2"><h2><a name="pub-methods"></a>
75
Public Member Functions</h2></td></tr>
76
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#a97767090763331fa58f0f09a1e0c3849">~TreeDragSource</a> ()</td></tr>
77
<tr><td class="memItemLeft" align="right" valign="top">GtkTreeDragSource* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#a7e32effaee58d75b30a8c2c2c69320be">gobj</a> ()</td></tr>
78
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a7e32effaee58d75b30a8c2c2c69320be"></a><br/></td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top">const GtkTreeDragSource* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#a5241622c40f47a7e4df5168de9b5ea41">gobj</a> () const </td></tr>
80
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a5241622c40f47a7e4df5168de9b5ea41"></a><br/></td></tr>
81
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#abe13358cc36fdadda320e7b0b06d751d">row_draggable</a> (const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& path) const </td></tr>
82
<tr><td class="mdescLeft"> </td><td class="mdescRight">Asks the <a class="el" href="classGtk_1_1TreeDragSource.html">Gtk::TreeDragSource</a> whether a particular row can be used as the source of a DND operation. <a href="#abe13358cc36fdadda320e7b0b06d751d"></a><br/></td></tr>
83
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#ab14bbca3f8d82eff7f1d83923274371d">drag_data_get</a> (const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& path, <a class="el" href="classGtk_1_1SelectionData.html">SelectionData</a>& selection_data)</td></tr>
84
<tr><td class="mdescLeft"> </td><td class="mdescRight">Asks the <a class="el" href="classGtk_1_1TreeDragSource.html">Gtk::TreeDragSource</a> to fill in <em>selection_data</em> with a representation of the row at <em>path</em>. <a href="#ab14bbca3f8d82eff7f1d83923274371d"></a><br/></td></tr>
85
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#a71bcc9882e954d3b1ca1c7b636143657">drag_data_delete</a> (const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& path)</td></tr>
86
<tr><td class="mdescLeft"> </td><td class="mdescRight">Asks the <a class="el" href="classGtk_1_1TreeDragSource.html">Gtk::TreeDragSource</a> to delete the row at <em>path</em>, because it was moved somewhere else via drag-and-drop. <a href="#a71bcc9882e954d3b1ca1c7b636143657"></a><br/></td></tr>
87
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
88
Static Public Member Functions</h2></td></tr>
89
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#a4e0a8df1dbbb370748f9bffdc6623482">add_interface</a> (GType gtype_implementer)</td></tr>
90
<tr><td colspan="2"><h2><a name="pro-methods"></a>
91
Protected Member Functions</h2></td></tr>
92
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#af2790a3d849cdbb88dc4875fbaf11065">row_draggable_vfunc</a> (const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& path) const </td></tr>
93
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#a3fa298d39dd760a792e46532456fd2c2">drag_data_get_vfunc</a> (const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& path, <a class="el" href="classGtk_1_1SelectionData.html">SelectionData</a>& selection_data) const </td></tr>
94
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#a34849cb405c5a97999f749a59c08cda3">drag_data_delete_vfunc</a> (const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& path)</td></tr>
95
<tr><td colspan="2"><h2><a name="related"></a>
96
Related Functions</h2></td></tr>
97
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
98
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TreeDragSource.html">Gtk::TreeDragSource</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1TreeDragSource.html#a2a6695148d1b0af9b11607363df4eec3">wrap</a> (GtkTreeDragSource* object, bool take_copy=false)</td></tr>
99
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a2a6695148d1b0af9b11607363df4eec3"></a><br/></td></tr>
101
<hr/><h2>Constructor & Destructor Documentation</h2>
102
<a class="anchor" id="a97767090763331fa58f0f09a1e0c3849"></a><!-- doxytag: member="Gtk::TreeDragSource::~TreeDragSource" ref="a97767090763331fa58f0f09a1e0c3849" args="()" -->
103
<div class="memitem">
104
<div class="memproto">
105
<table class="memname">
107
<td class="memname">virtual Gtk::TreeDragSource::~TreeDragSource </td>
109
<td class="paramname"></td><td>)</td>
110
<td><code> [virtual]</code></td>
118
<hr/><h2>Member Function Documentation</h2>
119
<a class="anchor" id="a4e0a8df1dbbb370748f9bffdc6623482"></a><!-- doxytag: member="Gtk::TreeDragSource::add_interface" ref="a4e0a8df1dbbb370748f9bffdc6623482" args="(GType gtype_implementer)" -->
120
<div class="memitem">
121
<div class="memproto">
122
<table class="memname">
124
<td class="memname">static void Gtk::TreeDragSource::add_interface </td>
126
<td class="paramtype">GType </td>
127
<td class="paramname"><em>gtype_implementer</em></td><td>)</td>
128
<td><code> [static]</code></td>
136
<a class="anchor" id="a71bcc9882e954d3b1ca1c7b636143657"></a><!-- doxytag: member="Gtk::TreeDragSource::drag_data_delete" ref="a71bcc9882e954d3b1ca1c7b636143657" args="(const TreeModel::Path &path)" -->
137
<div class="memitem">
138
<div class="memproto">
139
<table class="memname">
141
<td class="memname">bool Gtk::TreeDragSource::drag_data_delete </td>
143
<td class="paramtype">const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& </td>
144
<td class="paramname"><em>path</em></td><td>)</td>
151
<p>Asks the <a class="el" href="classGtk_1_1TreeDragSource.html">Gtk::TreeDragSource</a> to delete the row at <em>path</em>, because it was moved somewhere else via drag-and-drop. </p>
152
<p>Returns <code>false</code> if the deletion fails because <em>path</em> no longer exists, or for some model-specific reason. Should robustly handle a <em>path</em> no longer found in the model! </p>
153
<dl><dt><b>Parameters:</b></dt><dd>
154
<table class="params">
155
<tr><td class="paramname">path</td><td>Row that was being dragged. </td></tr>
159
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the row was successfully deleted. </dd></dl>
163
<a class="anchor" id="a34849cb405c5a97999f749a59c08cda3"></a><!-- doxytag: member="Gtk::TreeDragSource::drag_data_delete_vfunc" ref="a34849cb405c5a97999f749a59c08cda3" args="(const TreeModel::Path &path)" -->
164
<div class="memitem">
165
<div class="memproto">
166
<table class="memname">
168
<td class="memname">virtual bool Gtk::TreeDragSource::drag_data_delete_vfunc </td>
170
<td class="paramtype">const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& </td>
171
<td class="paramname"><em>path</em></td><td>)</td>
172
<td><code> [protected, virtual]</code></td>
180
<a class="anchor" id="ab14bbca3f8d82eff7f1d83923274371d"></a><!-- doxytag: member="Gtk::TreeDragSource::drag_data_get" ref="ab14bbca3f8d82eff7f1d83923274371d" args="(const TreeModel::Path &path, SelectionData &selection_data)" -->
181
<div class="memitem">
182
<div class="memproto">
183
<table class="memname">
185
<td class="memname">bool Gtk::TreeDragSource::drag_data_get </td>
187
<td class="paramtype">const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& </td>
188
<td class="paramname"><em>path</em>, </td>
191
<td class="paramkey"></td>
193
<td class="paramtype"><a class="el" href="classGtk_1_1SelectionData.html">SelectionData</a>& </td>
194
<td class="paramname"><em>selection_data</em> </td>
205
<p>Asks the <a class="el" href="classGtk_1_1TreeDragSource.html">Gtk::TreeDragSource</a> to fill in <em>selection_data</em> with a representation of the row at <em>path</em>. </p>
206
<p><em>selection_data->target</em> gives the required type of the data. Should robustly handle a <em>path</em> no longer found in the model! </p>
207
<dl><dt><b>Parameters:</b></dt><dd>
208
<table class="params">
209
<tr><td class="paramname">path</td><td>Row that was dragged. </td></tr>
210
<tr><td class="paramname">selection_data</td><td>A <a class="el" href="classGtk_1_1SelectionData.html">Gtk::SelectionData</a> to fill with data from the dragged row. </td></tr>
214
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if data of the required type was provided. </dd></dl>
218
<a class="anchor" id="a3fa298d39dd760a792e46532456fd2c2"></a><!-- doxytag: member="Gtk::TreeDragSource::drag_data_get_vfunc" ref="a3fa298d39dd760a792e46532456fd2c2" args="(const TreeModel::Path &path, SelectionData &selection_data) const " -->
219
<div class="memitem">
220
<div class="memproto">
221
<table class="memname">
223
<td class="memname">virtual bool Gtk::TreeDragSource::drag_data_get_vfunc </td>
225
<td class="paramtype">const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& </td>
226
<td class="paramname"><em>path</em>, </td>
229
<td class="paramkey"></td>
231
<td class="paramtype"><a class="el" href="classGtk_1_1SelectionData.html">SelectionData</a>& </td>
232
<td class="paramname"><em>selection_data</em> </td>
237
<td></td><td> const<code> [protected, virtual]</code></td>
245
<a class="anchor" id="a7e32effaee58d75b30a8c2c2c69320be"></a><!-- doxytag: member="Gtk::TreeDragSource::gobj" ref="a7e32effaee58d75b30a8c2c2c69320be" args="()" -->
246
<div class="memitem">
247
<div class="memproto">
248
<table class="memname">
250
<td class="memname">GtkTreeDragSource* Gtk::TreeDragSource::gobj </td>
252
<td class="paramname"></td><td>)</td>
253
<td><code> [inline]</code></td>
259
<p>Provides access to the underlying C GObject. </p>
261
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html#a969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.</p>
263
<p>Reimplemented in <a class="el" href="classGtk_1_1ListStore.html#a5086758716b9f34a5219b1387aebe59c">Gtk::ListStore</a>, and <a class="el" href="classGtk_1_1TreeStore.html#a1f6405d80c3b1e4a9672a69f6c13f6f6">Gtk::TreeStore</a>.</p>
267
<a class="anchor" id="a5241622c40f47a7e4df5168de9b5ea41"></a><!-- doxytag: member="Gtk::TreeDragSource::gobj" ref="a5241622c40f47a7e4df5168de9b5ea41" args="() const " -->
268
<div class="memitem">
269
<div class="memproto">
270
<table class="memname">
272
<td class="memname">const GtkTreeDragSource* Gtk::TreeDragSource::gobj </td>
274
<td class="paramname"></td><td>)</td>
275
<td> const<code> [inline]</code></td>
281
<p>Provides access to the underlying C GObject. </p>
283
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html#a70a443071a69d3372c2cdd7128a91ed1">Glib::Interface</a>.</p>
285
<p>Reimplemented in <a class="el" href="classGtk_1_1ListStore.html#a8d0844616280900206a77aaec2c546d7">Gtk::ListStore</a>, and <a class="el" href="classGtk_1_1TreeStore.html#adecedf7e9f77e9aa8e7eb44990fd8a74">Gtk::TreeStore</a>.</p>
289
<a class="anchor" id="abe13358cc36fdadda320e7b0b06d751d"></a><!-- doxytag: member="Gtk::TreeDragSource::row_draggable" ref="abe13358cc36fdadda320e7b0b06d751d" args="(const TreeModel::Path &path) const " -->
290
<div class="memitem">
291
<div class="memproto">
292
<table class="memname">
294
<td class="memname">bool Gtk::TreeDragSource::row_draggable </td>
296
<td class="paramtype">const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& </td>
297
<td class="paramname"><em>path</em></td><td>)</td>
304
<p>Asks the <a class="el" href="classGtk_1_1TreeDragSource.html">Gtk::TreeDragSource</a> whether a particular row can be used as the source of a DND operation. </p>
305
<p>If the source doesn't implement this interface, the row is assumed draggable. </p>
306
<dl><dt><b>Parameters:</b></dt><dd>
307
<table class="params">
308
<tr><td class="paramname">path</td><td>Row on which user is initiating a drag. </td></tr>
312
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if the row can be dragged. </dd></dl>
316
<a class="anchor" id="af2790a3d849cdbb88dc4875fbaf11065"></a><!-- doxytag: member="Gtk::TreeDragSource::row_draggable_vfunc" ref="af2790a3d849cdbb88dc4875fbaf11065" args="(const TreeModel::Path &path) const " -->
317
<div class="memitem">
318
<div class="memproto">
319
<table class="memname">
321
<td class="memname">virtual bool Gtk::TreeDragSource::row_draggable_vfunc </td>
323
<td class="paramtype">const <a class="el" href="classGtk_1_1TreePath.html">TreeModel::Path</a>& </td>
324
<td class="paramname"><em>path</em></td><td>)</td>
325
<td> const<code> [protected, virtual]</code></td>
333
<hr/><h2>Friends And Related Function Documentation</h2>
334
<a class="anchor" id="a2a6695148d1b0af9b11607363df4eec3"></a><!-- doxytag: member="Gtk::TreeDragSource::wrap" ref="a2a6695148d1b0af9b11607363df4eec3" args="(GtkTreeDragSource *object, bool take_copy=false)" -->
335
<div class="memitem">
336
<div class="memproto">
337
<table class="memname">
339
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1TreeDragSource.html">Gtk::TreeDragSource</a> > wrap </td>
341
<td class="paramtype">GtkTreeDragSource * </td>
342
<td class="paramname"><em>object</em>, </td>
345
<td class="paramkey"></td>
347
<td class="paramtype">bool </td>
348
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
353
<td></td><td><code> [related]</code></td>
359
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
360
<dl><dt><b>Parameters:</b></dt><dd>
361
<table class="params">
362
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
363
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
367
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
371
<hr/>The documentation for this class was generated from the following file:<ul>
372
<li>gtkmm/treedragsource.h</li>
375
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 8 2011 13:31:48 for gtkmm by 
376
<a href="http://www.doxygen.org/index.html">
377
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
added
removed
share/doc/gtkmm-2.4/reference/html/classGtk_1_1TreeDragSource.html
