1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::TreeDragSource Class Reference</h1>A GtkTreeDragSource C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="treednd_8hh-source.html">gfc/gtk/treednd.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::TreeDragSource:
<p><center><img src="classGFC_1_1Gtk_1_1TreeDragSource.png" usemap="#GFC::Gtk::TreeDragSource_map" border="0" alt=""></center>
<map name="GFC::Gtk::TreeDragSource_map">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInterface.html" alt="GFC::G::TypeInterface" shape="rect" coords="259,112,422,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="259,56,422,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="259,0,422,24">
<area href="classGFC_1_1Gtk_1_1ListStore.html" alt="GFC::Gtk::ListStore" shape="rect" coords="0,224,163,248">
<area href="classGFC_1_1Gtk_1_1TreeModelFilter.html" alt="GFC::Gtk::TreeModelFilter" shape="rect" coords="173,224,336,248">
<area href="classGFC_1_1Gtk_1_1TreeModelSort.html" alt="GFC::Gtk::TreeModelSort" shape="rect" coords="346,224,509,248">
<area href="classGFC_1_1Gtk_1_1TreeStore.html" alt="GFC::Gtk::TreeStore" shape="rect" coords="519,224,682,248">
</map>
<a href="classGFC_1_1Gtk_1_1TreeDragSource-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z961_0" doxytag="GFC::Gtk::TreeDragSource::gtk_tree_drag_source" ></a>
GtkTreeDragSource * <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html#z961_0">gtk_tree_drag_source</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkTreeDragSource structure. <br></dl><li><a class="anchor" name="z961_1" doxytag="GFC::Gtk::TreeDragSource::operator GtkTreeDragSource *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html#z961_1">operator GtkTreeDragSource *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html">TreeDragSource</a> to a GtkTreeDragSource pointer. <br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html#z961_2">row_draggable</a> (const <a class="el" href="classGFC_1_1Gtk_1_1TreePath.html">TreePath</a> &path) const
<dl class="el"><dd class="mdescRight">Determines whether a particular row can be used as the source of a DND operation. <a href="#z961_2"></a><br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li>bool <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html#z962_0">drag_data_delete</a> (<a class="el" href="classGFC_1_1Gtk_1_1TreePath.html">TreePath</a> &path)
<dl class="el"><dd class="mdescRight">Asks the <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html">TreeDragSource</a> to delete the row at <em>path</em>, because it was moved somewhere else via drag-and-drop. <a href="#z962_0"></a><br></dl><li>bool <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html#z962_1">drag_data_get</a> (const <a class="el" href="classGFC_1_1Gtk_1_1TreePath.html">TreePath</a> &path, <a class="el" href="classGFC_1_1Gtk_1_1SelectionData.html">SelectionData</a> &selection_data)
<dl class="el"><dd class="mdescRight">Asks the <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html">TreeDragSource</a> to fill in selection_data with a representation of the row at <em>path</em>. <a href="#z962_1"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z960_0" doxytag="GFC::Gtk::TreeDragSource::TreeDragSource" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html#z960_0">TreeDragSource</a> ()
<dl class="el"><dd class="mdescRight">Constructs a new <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html">TreeDragSource</a> object. <br></dl><li><a class="anchor" name="z960_1" doxytag="GFC::Gtk::TreeDragSource::~TreeDragSource" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html#z960_1">~TreeDragSource</a> ()=0
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkTreeDragSource C++ wrapper class.
<p>
GTK+ supports Drag-and-Drop in tree views with a high-level and a low-level API.<p>
The low-level API consists of the GTK+ DND API, augmented by some treeview utility functions: <a class="el" href="classGFC_1_1Gtk_1_1TreeView.html#z1011_40">Gtk::TreeView::set_drag_dest_row()</a>, <a class="el" href="classGFC_1_1Gtk_1_1TreeView.html#z1010_22">Gtk::TreeView::get_drag_dest_row()</a>, <a class="el" href="classGFC_1_1Gtk_1_1TreeView.html#z1010_23">Gtk::TreeView::get_dest_row_at_pos()</a> and <a class="el" href="classGFC_1_1Gtk_1_1TreeView.html#z1011_41">Gtk::TreeView::create_row_drag_icon()</a>. This API leaves a lot of flexibility, but nothing is done automatically, and implementing advanced features like hover-to-open-rows or autoscrolling on top of this API is a lot of work.<p>
On the other hand, if you write to the high-level <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html">TreeDragSource</a> and <a class="el" href="classGFC_1_1Gtk_1_1TreeDragDest.html">TreeDragDest</a> API, then all the bookkeeping of rows is done for you, as well as things like hover-to-open and auto-scroll. The <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html">TreeDragSource</a> interface is implemented by <a class="el" href="classGFC_1_1Gtk_1_1TreeModelSort.html">Gtk::TreeModelSort</a>, <a class="el" href="classGFC_1_1Gtk_1_1TreeStore.html">Gtk::TreeStore</a>, <a class="el" href="classGFC_1_1Gtk_1_1ListStore.html">Gtk::ListStore</a> and <a class="el" href="classGFC_1_1Gtk_1_1TreeModelFilter.html">Gtk::TreeModelFilter</a>. The <a class="el" href="classGFC_1_1Gtk_1_1TreeDragDest.html">TreeDragDest</a> interface is implemented by <a class="el" href="classGFC_1_1Gtk_1_1TreeStore.html">Gtk::TreeStore</a> and <a class="el" href="classGFC_1_1Gtk_1_1ListStore.html">Gtk::ListStore</a>.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z962_0" doxytag="GFC::Gtk::TreeDragSource::drag_data_delete" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::TreeDragSource::drag_data_delete </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1TreePath.html">TreePath</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>path</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Asks the <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html">TreeDragSource</a> to delete the row at <em>path</em>, because it was moved somewhere else via drag-and-drop.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>path</em> </td><td>The row that was being dragged. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the row was successfully deleted.</dd></dl>
<br>
Returns <em>false</em> 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! </td>
</tr>
</table>
<a class="anchor" name="z962_1" doxytag="GFC::Gtk::TreeDragSource::drag_data_get" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::TreeDragSource::drag_data_get </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1TreePath.html">TreePath</a> & </td>
<td class="mdname" nowrap> <em>path</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap><a class="el" href="classGFC_1_1Gtk_1_1SelectionData.html">SelectionData</a> & </td>
<td class="mdname" nowrap> <em>selection_data</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Asks the <a class="el" href="classGFC_1_1Gtk_1_1TreeDragSource.html">TreeDragSource</a> to fill in selection_data with a representation of the row at <em>path</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>path</em> </td><td>The row that was dragged. </td></tr>
<tr><td></td><td valign=top><em>selection_data</em> </td><td>A <a class="el" href="classGFC_1_1Gtk_1_1SelectionData.html">Gtk::SelectionData</a> to fill with data from the dragged row </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if data of the required type was provided.</dd></dl>
<br>
Note, selection_data->get_target() gives the required type of the data. Should robustly handle a path no longer found in the model! </td>
</tr>
</table>
<a class="anchor" name="z961_2" doxytag="GFC::Gtk::TreeDragSource::row_draggable" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool GFC::Gtk::TreeDragSource::row_draggable </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classGFC_1_1Gtk_1_1TreePath.html">TreePath</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>path</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Determines whether a particular row can be used as the source of a DND operation.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>path</em> </td><td>The row on which user is initiating a drag. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the row can be dragged.</dd></dl>
<br>
If the source doesn't implement this interface, the row is assumed draggable. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="treednd_8hh-source.html">treednd.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:43 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
