~inkscape.dev/inkscape-devlibs/devlibs-gtk3

5 by JazzyNico
Adding gtk2 libraries.
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html>
3
<head>
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>GtkTreeSelection</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
7
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
8
<link rel="up" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
9
<link rel="prev" href="GtkTreeModel.html" title="GtkTreeModel">
10
<link rel="next" href="GtkTreeViewColumn.html" title="GtkTreeViewColumn">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
</head>
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
<tr valign="middle">
17
<td><a accesskey="p" href="GtkTreeModel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="TreeWidgetObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
21
<td><a accesskey="n" href="GtkTreeViewColumn.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
</tr>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#GtkTreeSelection.synopsis" class="shortcut">Top</a>
25
                   | 
26
                  <a href="#GtkTreeSelection.description" class="shortcut">Description</a>
27
                   | 
28
                  <a href="#GtkTreeSelection.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
                   | 
30
                  <a href="#GtkTreeSelection.signals" class="shortcut">Signals</a>
31
</td></tr>
32
</table>
33
<div class="refentry">
34
<a name="GtkTreeSelection"></a><div class="titlepage"></div>
35
<div class="refnamediv"><table width="100%"><tr>
36
<td valign="top">
37
<h2><span class="refentrytitle"><a name="GtkTreeSelection.top_of_page"></a>GtkTreeSelection</span></h2>
38
<p>GtkTreeSelection — The selection object for GtkTreeView</p>
39
</td>
40
<td valign="top" align="right"></td>
41
</tr></table></div>
42
<div class="refsynopsisdiv">
43
<a name="GtkTreeSelection.synopsis"></a><h2>Synopsis</h2>
44
<pre class="synopsis">
45
#include &lt;gtk/gtk.h&gt;
46
47
                    <a class="link" href="GtkTreeSelection.html#GtkTreeSelection-struct" title="GtkTreeSelection">GtkTreeSelection</a>;
48
<span class="returnvalue">gboolean</span>            (<a class="link" href="GtkTreeSelection.html#GtkTreeSelectionFunc" title="GtkTreeSelectionFunc ()">*GtkTreeSelectionFunc</a>)             (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
49
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *model</code></em>,
50
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
51
                                                         <em class="parameter"><code><span class="type">gboolean</span> path_currently_selected</code></em>,
52
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
53
<span class="returnvalue">void</span>                (<a class="link" href="GtkTreeSelection.html#GtkTreeSelectionForeachFunc" title="GtkTreeSelectionForeachFunc ()">*GtkTreeSelectionForeachFunc</a>)      (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *model</code></em>,
54
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
55
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
56
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
57
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-set-mode" title="gtk_tree_selection_set_mode ()">gtk_tree_selection_set_mode</a>         (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
58
                                                         <em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkSelectionMode" title="enum GtkSelectionMode"><span class="type">GtkSelectionMode</span></a> type</code></em>);
59
<a class="link" href="gtk2-Standard-Enumerations.html#GtkSelectionMode" title="enum GtkSelectionMode"><span class="returnvalue">GtkSelectionMode</span></a>    <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-get-mode" title="gtk_tree_selection_get_mode ()">gtk_tree_selection_get_mode</a>         (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);
60
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-set-select-function" title="gtk_tree_selection_set_select_function ()">gtk_tree_selection_set_select_function</a>
61
                                                        (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
62
                                                         <em class="parameter"><code><a class="link" href="GtkTreeSelection.html#GtkTreeSelectionFunc" title="GtkTreeSelectionFunc ()"><span class="type">GtkTreeSelectionFunc</span></a> func</code></em>,
63
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
64
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);
65
<a class="link" href="GtkTreeSelection.html#GtkTreeSelectionFunc" title="GtkTreeSelectionFunc ()"><span class="returnvalue">GtkTreeSelectionFunc</span></a> <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-get-select-function" title="gtk_tree_selection_get_select_function ()">gtk_tree_selection_get_select_function</a>
66
                                                        (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);
67
<span class="returnvalue">gpointer</span>            <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-get-user-data" title="gtk_tree_selection_get_user_data ()">gtk_tree_selection_get_user_data</a>    (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);
68
<a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="returnvalue">GtkTreeView</span></a> *       <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-get-tree-view" title="gtk_tree_selection_get_tree_view ()">gtk_tree_selection_get_tree_view</a>    (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);
69
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-get-selected" title="gtk_tree_selection_get_selected ()">gtk_tree_selection_get_selected</a>     (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
70
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> **model</code></em>,
71
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
72
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-selected-foreach" title="gtk_tree_selection_selected_foreach ()">gtk_tree_selection_selected_foreach</a> (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
73
                                                         <em class="parameter"><code><a class="link" href="GtkTreeSelection.html#GtkTreeSelectionForeachFunc" title="GtkTreeSelectionForeachFunc ()"><span class="type">GtkTreeSelectionForeachFunc</span></a> func</code></em>,
74
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
75
<span class="returnvalue">GList</span> *             <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-get-selected-rows" title="gtk_tree_selection_get_selected_rows ()">gtk_tree_selection_get_selected_rows</a>
76
                                                        (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
77
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> **model</code></em>);
78
<span class="returnvalue">gint</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-count-selected-rows" title="gtk_tree_selection_count_selected_rows ()">gtk_tree_selection_count_selected_rows</a>
79
                                                        (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);
80
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-select-path" title="gtk_tree_selection_select_path ()">gtk_tree_selection_select_path</a>      (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
81
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);
82
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-unselect-path" title="gtk_tree_selection_unselect_path ()">gtk_tree_selection_unselect_path</a>    (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
83
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);
84
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-path-is-selected" title="gtk_tree_selection_path_is_selected ()">gtk_tree_selection_path_is_selected</a> (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
85
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);
86
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-select-iter" title="gtk_tree_selection_select_iter ()">gtk_tree_selection_select_iter</a>      (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
87
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
88
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-unselect-iter" title="gtk_tree_selection_unselect_iter ()">gtk_tree_selection_unselect_iter</a>    (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
89
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
90
<span class="returnvalue">gboolean</span>            <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-iter-is-selected" title="gtk_tree_selection_iter_is_selected ()">gtk_tree_selection_iter_is_selected</a> (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
91
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);
92
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-select-all" title="gtk_tree_selection_select_all ()">gtk_tree_selection_select_all</a>       (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);
93
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-unselect-all" title="gtk_tree_selection_unselect_all ()">gtk_tree_selection_unselect_all</a>     (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);
94
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-select-range" title="gtk_tree_selection_select_range ()">gtk_tree_selection_select_range</a>     (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
95
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *start_path</code></em>,
96
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *end_path</code></em>);
97
<span class="returnvalue">void</span>                <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-unselect-range" title="gtk_tree_selection_unselect_range ()">gtk_tree_selection_unselect_range</a>   (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
98
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *start_path</code></em>,
99
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *end_path</code></em>);
100
</pre>
101
</div>
102
<div class="refsect1">
103
<a name="GtkTreeSelection.object-hierarchy"></a><h2>Object Hierarchy</h2>
104
<pre class="synopsis">
105
  GObject
106
   +----GtkTreeSelection
107
</pre>
108
</div>
109
<div class="refsect1">
110
<a name="GtkTreeSelection.signals"></a><h2>Signals</h2>
111
<pre class="synopsis">
112
  "<a class="link" href="GtkTreeSelection.html#GtkTreeSelection-changed" title='The "changed" signal'>changed</a>"                                        : <code class="literal">Run First</code>
113
</pre>
114
</div>
115
<div class="refsect1">
116
<a name="GtkTreeSelection.description"></a><h2>Description</h2>
117
<p>
118
The <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> object is a helper object to manage the selection
119
for a <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> widget.  The <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> object is
120
automatically created when a new <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> widget is created, and
121
cannot exist independentally of this widget.  The primary reason the
122
<a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> objects exists is for cleanliness of code and API.
123
That is, there is no conceptual reason all these functions could not be
124
methods on the <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> widget instead of a separate function.
125
</p>
126
<p>
127
The <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> object is gotten from a <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> by calling
128
<a class="link" href="GtkTreeView.html#gtk-tree-view-get-selection" title="gtk_tree_view_get_selection ()"><code class="function">gtk_tree_view_get_selection()</code></a>.  It can be manipulated to check the
129
selection status of the tree, as well as select and deselect individual
130
rows.  Selection is done completely view side.  As a result, multiple
131
views of the same model can have completely different selections.
132
Additionally, you cannot change the selection of a row on the model that
133
is not currently displayed by the view without expanding its parents
134
first.
135
</p>
136
<p>
137
One of the important things to remember when monitoring the selection of
138
a view is that the <a class="link" href="GtkTreeSelection.html#GtkTreeSelection-changed" title='The "changed" signal'><span class="type">"changed"</span></a> signal is mostly a hint.  That is, it may
139
only emit one signal when a range of rows is selected.  Additionally, it
140
may on occasion emit a ::changed signal when nothing has happened
141
(mostly as a result of programmers calling select_row on an already
142
selected row).
143
</p>
144
</div>
145
<div class="refsect1">
146
<a name="GtkTreeSelection.details"></a><h2>Details</h2>
147
<div class="refsect2">
148
<a name="GtkTreeSelection-struct"></a><h3>GtkTreeSelection</h3>
149
<pre class="programlisting">typedef struct _GtkTreeSelection GtkTreeSelection;</pre>
150
<p>
151
</p>
152
</div>
153
<hr>
154
<div class="refsect2">
155
<a name="GtkTreeSelectionFunc"></a><h3>GtkTreeSelectionFunc ()</h3>
156
<pre class="programlisting"><span class="returnvalue">gboolean</span>            (*GtkTreeSelectionFunc)             (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
157
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *model</code></em>,
158
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
159
                                                         <em class="parameter"><code><span class="type">gboolean</span> path_currently_selected</code></em>,
160
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
161
<p>
162
A function used by <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-set-select-function" title="gtk_tree_selection_set_select_function ()"><code class="function">gtk_tree_selection_set_select_function()</code></a> to filter
163
whether or not a row may be selected.  It is called whenever a row's
164
state might change.  A return value of <code class="literal">TRUE</code> indicates to <em class="parameter"><code>selection</code></em>
165
that it is okay to change the selection.
166
</p>
167
<div class="variablelist"><table border="0" class="variablelist">
168
<colgroup>
169
<col align="left" valign="top">
170
<col>
171
</colgroup>
172
<tbody>
173
<tr>
174
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
175
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>
176
</td>
177
</tr>
178
<tr>
179
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
180
<td>A <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> being viewed</td>
181
</tr>
182
<tr>
183
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
184
<td>The <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> of the row in question</td>
185
</tr>
186
<tr>
187
<td><p><span class="term"><em class="parameter"><code>path_currently_selected</code></em> :</span></p></td>
188
<td>
189
<code class="literal">TRUE</code>, if the path is currently selected</td>
190
</tr>
191
<tr>
192
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
193
<td>user data</td>
194
</tr>
195
<tr>
196
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
197
<td>
198
<code class="literal">TRUE</code>, if the selection state of the row can be toggled</td>
199
</tr>
200
</tbody>
201
</table></div>
202
</div>
203
<hr>
204
<div class="refsect2">
205
<a name="GtkTreeSelectionForeachFunc"></a><h3>GtkTreeSelectionForeachFunc ()</h3>
206
<pre class="programlisting"><span class="returnvalue">void</span>                (*GtkTreeSelectionForeachFunc)      (<em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> *model</code></em>,
207
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>,
208
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>,
209
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
210
<p>
211
A function used by <a class="link" href="GtkTreeSelection.html#gtk-tree-selection-selected-foreach" title="gtk_tree_selection_selected_foreach ()"><code class="function">gtk_tree_selection_selected_foreach()</code></a> to map all
212
selected rows.  It will be called on every selected row in the view.
213
</p>
214
<div class="variablelist"><table border="0" class="variablelist">
215
<colgroup>
216
<col align="left" valign="top">
217
<col>
218
</colgroup>
219
<tbody>
220
<tr>
221
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
222
<td>The <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> being viewed</td>
223
</tr>
224
<tr>
225
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
226
<td>The <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> of a selected row</td>
227
</tr>
228
<tr>
229
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
230
<td>A <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> pointing to a selected row</td>
231
</tr>
232
<tr>
233
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
234
<td>user data</td>
235
</tr>
236
</tbody>
237
</table></div>
238
</div>
239
<hr>
240
<div class="refsect2">
241
<a name="gtk-tree-selection-set-mode"></a><h3>gtk_tree_selection_set_mode ()</h3>
242
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_set_mode         (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
243
                                                         <em class="parameter"><code><a class="link" href="gtk2-Standard-Enumerations.html#GtkSelectionMode" title="enum GtkSelectionMode"><span class="type">GtkSelectionMode</span></a> type</code></em>);</pre>
244
<p>
245
Sets the selection mode of the <em class="parameter"><code>selection</code></em>.  If the previous type was
246
<a class="link" href="gtk2-Standard-Enumerations.html#GTK-SELECTION-MULTIPLE:CAPS"><span class="type">GTK_SELECTION_MULTIPLE</span></a>, then the anchor is kept selected, if it was
247
previously selected.
248
</p>
249
<div class="variablelist"><table border="0" class="variablelist">
250
<colgroup>
251
<col align="left" valign="top">
252
<col>
253
</colgroup>
254
<tbody>
255
<tr>
256
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
257
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
258
</tr>
259
<tr>
260
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
261
<td>The selection mode</td>
262
</tr>
263
</tbody>
264
</table></div>
265
</div>
266
<hr>
267
<div class="refsect2">
268
<a name="gtk-tree-selection-get-mode"></a><h3>gtk_tree_selection_get_mode ()</h3>
269
<pre class="programlisting"><a class="link" href="gtk2-Standard-Enumerations.html#GtkSelectionMode" title="enum GtkSelectionMode"><span class="returnvalue">GtkSelectionMode</span></a>    gtk_tree_selection_get_mode         (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);</pre>
270
<p>
271
Gets the selection mode for <em class="parameter"><code>selection</code></em>. See
272
<a class="link" href="GtkTreeSelection.html#gtk-tree-selection-set-mode" title="gtk_tree_selection_set_mode ()"><code class="function">gtk_tree_selection_set_mode()</code></a>.
273
</p>
274
<div class="variablelist"><table border="0" class="variablelist">
275
<colgroup>
276
<col align="left" valign="top">
277
<col>
278
</colgroup>
279
<tbody>
280
<tr>
281
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
282
<td>a <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>
283
</td>
284
</tr>
285
<tr>
286
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
287
<td>the current selection mode</td>
288
</tr>
289
</tbody>
290
</table></div>
291
</div>
292
<hr>
293
<div class="refsect2">
294
<a name="gtk-tree-selection-set-select-function"></a><h3>gtk_tree_selection_set_select_function ()</h3>
295
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_set_select_function
296
                                                        (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
297
                                                         <em class="parameter"><code><a class="link" href="GtkTreeSelection.html#GtkTreeSelectionFunc" title="GtkTreeSelectionFunc ()"><span class="type">GtkTreeSelectionFunc</span></a> func</code></em>,
298
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
299
                                                         <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre>
300
<p>
301
Sets the selection function.  If set, this function is called before any node
302
is selected or unselected, giving some control over which nodes are selected.
303
The select function should return <code class="literal">TRUE</code> if the state of the node may be toggled,
304
and <code class="literal">FALSE</code> if the state of the node should be left unchanged.
305
</p>
306
<div class="variablelist"><table border="0" class="variablelist">
307
<colgroup>
308
<col align="left" valign="top">
309
<col>
310
</colgroup>
311
<tbody>
312
<tr>
313
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
314
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
315
</tr>
316
<tr>
317
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
318
<td>The selection function.</td>
319
</tr>
320
<tr>
321
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
322
<td>The selection function's data.</td>
323
</tr>
324
<tr>
325
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
326
<td>The destroy function for user data.  May be NULL.</td>
327
</tr>
328
</tbody>
329
</table></div>
330
</div>
331
<hr>
332
<div class="refsect2">
333
<a name="gtk-tree-selection-get-select-function"></a><h3>gtk_tree_selection_get_select_function ()</h3>
334
<pre class="programlisting"><a class="link" href="GtkTreeSelection.html#GtkTreeSelectionFunc" title="GtkTreeSelectionFunc ()"><span class="returnvalue">GtkTreeSelectionFunc</span></a> gtk_tree_selection_get_select_function
335
                                                        (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);</pre>
336
<p>
337
Returns the current selection function.
338
</p>
339
<div class="variablelist"><table border="0" class="variablelist">
340
<colgroup>
341
<col align="left" valign="top">
342
<col>
343
</colgroup>
344
<tbody>
345
<tr>
346
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
347
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
348
</tr>
349
<tr>
350
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
351
<td>The function.</td>
352
</tr>
353
</tbody>
354
</table></div>
355
<p class="since">Since 2.14</p>
356
</div>
357
<hr>
358
<div class="refsect2">
359
<a name="gtk-tree-selection-get-user-data"></a><h3>gtk_tree_selection_get_user_data ()</h3>
360
<pre class="programlisting"><span class="returnvalue">gpointer</span>            gtk_tree_selection_get_user_data    (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);</pre>
361
<p>
362
Returns the user data for the selection function.
363
</p>
364
<div class="variablelist"><table border="0" class="variablelist">
365
<colgroup>
366
<col align="left" valign="top">
367
<col>
368
</colgroup>
369
<tbody>
370
<tr>
371
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
372
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
373
</tr>
374
<tr>
375
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
376
<td>The user data.</td>
377
</tr>
378
</tbody>
379
</table></div>
380
</div>
381
<hr>
382
<div class="refsect2">
383
<a name="gtk-tree-selection-get-tree-view"></a><h3>gtk_tree_selection_get_tree_view ()</h3>
384
<pre class="programlisting"><a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="returnvalue">GtkTreeView</span></a> *       gtk_tree_selection_get_tree_view    (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);</pre>
385
<p>
386
Returns the tree view associated with <em class="parameter"><code>selection</code></em>.
387
</p>
388
<div class="variablelist"><table border="0" class="variablelist">
389
<colgroup>
390
<col align="left" valign="top">
391
<col>
392
</colgroup>
393
<tbody>
394
<tr>
395
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
396
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>
397
</td>
398
</tr>
399
<tr>
400
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
401
<td>A <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
402
</td>
403
</tr>
404
</tbody>
405
</table></div>
406
</div>
407
<hr>
408
<div class="refsect2">
409
<a name="gtk-tree-selection-get-selected"></a><h3>gtk_tree_selection_get_selected ()</h3>
410
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_tree_selection_get_selected     (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
411
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> **model</code></em>,
412
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
413
<p>
414
Sets <em class="parameter"><code>iter</code></em> to the currently selected node if <em class="parameter"><code>selection</code></em> is set to
415
<a class="link" href="gtk2-Standard-Enumerations.html#GTK-SELECTION-SINGLE:CAPS"><span class="type">GTK_SELECTION_SINGLE</span></a> or <a class="link" href="gtk2-Standard-Enumerations.html#GTK-SELECTION-BROWSE:CAPS"><span class="type">GTK_SELECTION_BROWSE</span></a>.  <em class="parameter"><code>iter</code></em> may be NULL if you
416
just want to test if <em class="parameter"><code>selection</code></em> has any selected nodes.  <em class="parameter"><code>model</code></em> is filled
417
with the current model as a convenience.  This function will not work if you
418
use <em class="parameter"><code>selection</code></em> is <a class="link" href="gtk2-Standard-Enumerations.html#GTK-SELECTION-MULTIPLE:CAPS"><span class="type">GTK_SELECTION_MULTIPLE</span></a>.
419
</p>
420
<div class="variablelist"><table border="0" class="variablelist">
421
<colgroup>
422
<col align="left" valign="top">
423
<col>
424
</colgroup>
425
<tbody>
426
<tr>
427
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
428
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
429
</tr>
430
<tr>
431
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
432
<td>A pointer to set to the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>, or NULL. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
433
</td>
434
</tr>
435
<tr>
436
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
437
<td>The <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>, or NULL. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
438
</td>
439
</tr>
440
<tr>
441
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
442
<td>TRUE, if there is a selected node.</td>
443
</tr>
444
</tbody>
445
</table></div>
446
</div>
447
<hr>
448
<div class="refsect2">
449
<a name="gtk-tree-selection-selected-foreach"></a><h3>gtk_tree_selection_selected_foreach ()</h3>
450
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_selected_foreach (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
451
                                                         <em class="parameter"><code><a class="link" href="GtkTreeSelection.html#GtkTreeSelectionForeachFunc" title="GtkTreeSelectionForeachFunc ()"><span class="type">GtkTreeSelectionForeachFunc</span></a> func</code></em>,
452
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
453
<p>
454
Calls a function for each selected node. Note that you cannot modify
455
the tree or selection from within this function. As a result,
456
<a class="link" href="GtkTreeSelection.html#gtk-tree-selection-get-selected-rows" title="gtk_tree_selection_get_selected_rows ()"><code class="function">gtk_tree_selection_get_selected_rows()</code></a> might be more useful.
457
</p>
458
<div class="variablelist"><table border="0" class="variablelist">
459
<colgroup>
460
<col align="left" valign="top">
461
<col>
462
</colgroup>
463
<tbody>
464
<tr>
465
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
466
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
467
</tr>
468
<tr>
469
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
470
<td>The function to call for each selected node. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
471
</td>
472
</tr>
473
<tr>
474
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
475
<td>user data to pass to the function.</td>
476
</tr>
477
</tbody>
478
</table></div>
479
</div>
480
<hr>
481
<div class="refsect2">
482
<a name="gtk-tree-selection-get-selected-rows"></a><h3>gtk_tree_selection_get_selected_rows ()</h3>
483
<pre class="programlisting"><span class="returnvalue">GList</span> *             gtk_tree_selection_get_selected_rows
484
                                                        (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
485
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> **model</code></em>);</pre>
486
<p>
487
Creates a list of path of all selected rows. Additionally, if you are
488
planning on modifying the model after calling this function, you may
489
want to convert the returned list into a list of <a class="link" href="GtkTreeModel.html#GtkTreeRowReference" title="GtkTreeRowReference"><span class="type">GtkTreeRowReference</span></a>s.
490
To do this, you can use <a class="link" href="GtkTreeModel.html#gtk-tree-row-reference-new" title="gtk_tree_row_reference_new ()"><code class="function">gtk_tree_row_reference_new()</code></a>.
491
</p>
492
<p>
493
To free the return value, use:
494
</p>
495
<div class="informalexample">
496
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
497
    <tbody>
498
      <tr>
499
        <td class="listing_lines" align="right"><pre>1
500
2</pre></td>
501
        <td class="listing_code"><pre class="programlisting"><span class="function">g_list_foreach</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">list</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">GFunc</span><span class="symbol">)</span><span class="normal"> <a href="GtkTreeModel.html#gtk-tree-path-free">gtk_tree_path_free</a></span><span class="symbol">,</span><span class="normal"> <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
502
<span class="function">g_list_free</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">list</span><span class="symbol">);</span></pre></td>
503
      </tr>
504
    </tbody>
505
  </table>
506
</div>
507
508
<p>
509
</p>
510
<div class="variablelist"><table border="0" class="variablelist">
511
<colgroup>
512
<col align="left" valign="top">
513
<col>
514
</colgroup>
515
<tbody>
516
<tr>
517
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
518
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
519
</tr>
520
<tr>
521
<td><p><span class="term"><em class="parameter"><code>model</code></em> :</span></p></td>
522
<td>A pointer to set to the <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
523
</td>
524
</tr>
525
<tr>
526
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
527
<td>A <span class="type">GList</span> containing a <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> for each selected row. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GtkTreePath][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
528
</td>
529
</tr>
530
</tbody>
531
</table></div>
532
<p class="since">Since 2.2</p>
533
</div>
534
<hr>
535
<div class="refsect2">
536
<a name="gtk-tree-selection-count-selected-rows"></a><h3>gtk_tree_selection_count_selected_rows ()</h3>
537
<pre class="programlisting"><span class="returnvalue">gint</span>                gtk_tree_selection_count_selected_rows
538
                                                        (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);</pre>
539
<p>
540
Returns the number of rows that have been selected in <em class="parameter"><code>tree</code></em>.
541
</p>
542
<div class="variablelist"><table border="0" class="variablelist">
543
<colgroup>
544
<col align="left" valign="top">
545
<col>
546
</colgroup>
547
<tbody>
548
<tr>
549
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
550
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
551
</tr>
552
<tr>
553
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
554
<td>The number of rows selected.</td>
555
</tr>
556
</tbody>
557
</table></div>
558
<p class="since">Since 2.2</p>
559
</div>
560
<hr>
561
<div class="refsect2">
562
<a name="gtk-tree-selection-select-path"></a><h3>gtk_tree_selection_select_path ()</h3>
563
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_select_path      (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
564
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
565
<p>
566
Select the row at <em class="parameter"><code>path</code></em>.
567
</p>
568
<div class="variablelist"><table border="0" class="variablelist">
569
<colgroup>
570
<col align="left" valign="top">
571
<col>
572
</colgroup>
573
<tbody>
574
<tr>
575
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
576
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
577
</tr>
578
<tr>
579
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
580
<td>The <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> to be selected.</td>
581
</tr>
582
</tbody>
583
</table></div>
584
</div>
585
<hr>
586
<div class="refsect2">
587
<a name="gtk-tree-selection-unselect-path"></a><h3>gtk_tree_selection_unselect_path ()</h3>
588
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_unselect_path    (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
589
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
590
<p>
591
Unselects the row at <em class="parameter"><code>path</code></em>.
592
</p>
593
<div class="variablelist"><table border="0" class="variablelist">
594
<colgroup>
595
<col align="left" valign="top">
596
<col>
597
</colgroup>
598
<tbody>
599
<tr>
600
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
601
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
602
</tr>
603
<tr>
604
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
605
<td>The <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> to be unselected.</td>
606
</tr>
607
</tbody>
608
</table></div>
609
</div>
610
<hr>
611
<div class="refsect2">
612
<a name="gtk-tree-selection-path-is-selected"></a><h3>gtk_tree_selection_path_is_selected ()</h3>
613
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_tree_selection_path_is_selected (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
614
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *path</code></em>);</pre>
615
<p>
616
Returns <code class="literal">TRUE</code> if the row pointed to by <em class="parameter"><code>path</code></em> is currently selected.  If <em class="parameter"><code>path</code></em>
617
does not point to a valid location, <code class="literal">FALSE</code> is returned
618
</p>
619
<div class="variablelist"><table border="0" class="variablelist">
620
<colgroup>
621
<col align="left" valign="top">
622
<col>
623
</colgroup>
624
<tbody>
625
<tr>
626
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
627
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
628
</tr>
629
<tr>
630
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
631
<td>A <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> to check selection on.</td>
632
</tr>
633
<tr>
634
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
635
<td>
636
<code class="literal">TRUE</code> if <em class="parameter"><code>path</code></em> is selected.</td>
637
</tr>
638
</tbody>
639
</table></div>
640
</div>
641
<hr>
642
<div class="refsect2">
643
<a name="gtk-tree-selection-select-iter"></a><h3>gtk_tree_selection_select_iter ()</h3>
644
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_select_iter      (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
645
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
646
<p>
647
Selects the specified iterator.
648
</p>
649
<div class="variablelist"><table border="0" class="variablelist">
650
<colgroup>
651
<col align="left" valign="top">
652
<col>
653
</colgroup>
654
<tbody>
655
<tr>
656
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
657
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
658
</tr>
659
<tr>
660
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
661
<td>The <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to be selected.</td>
662
</tr>
663
</tbody>
664
</table></div>
665
</div>
666
<hr>
667
<div class="refsect2">
668
<a name="gtk-tree-selection-unselect-iter"></a><h3>gtk_tree_selection_unselect_iter ()</h3>
669
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_unselect_iter    (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
670
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
671
<p>
672
Unselects the specified iterator.
673
</p>
674
<div class="variablelist"><table border="0" class="variablelist">
675
<colgroup>
676
<col align="left" valign="top">
677
<col>
678
</colgroup>
679
<tbody>
680
<tr>
681
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
682
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
683
</tr>
684
<tr>
685
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
686
<td>The <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> to be unselected.</td>
687
</tr>
688
</tbody>
689
</table></div>
690
</div>
691
<hr>
692
<div class="refsect2">
693
<a name="gtk-tree-selection-iter-is-selected"></a><h3>gtk_tree_selection_iter_is_selected ()</h3>
694
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_tree_selection_iter_is_selected (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
695
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> *iter</code></em>);</pre>
696
<p>
697
Returns <code class="literal">TRUE</code> if the row at <em class="parameter"><code>iter</code></em> is currently selected.
698
</p>
699
<div class="variablelist"><table border="0" class="variablelist">
700
<colgroup>
701
<col align="left" valign="top">
702
<col>
703
</colgroup>
704
<tbody>
705
<tr>
706
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
707
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>
708
</td>
709
</tr>
710
<tr>
711
<td><p><span class="term"><em class="parameter"><code>iter</code></em> :</span></p></td>
712
<td>A valid <a class="link" href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a>
713
</td>
714
</tr>
715
<tr>
716
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
717
<td>
718
<code class="literal">TRUE</code>, if <em class="parameter"><code>iter</code></em> is selected</td>
719
</tr>
720
</tbody>
721
</table></div>
722
</div>
723
<hr>
724
<div class="refsect2">
725
<a name="gtk-tree-selection-select-all"></a><h3>gtk_tree_selection_select_all ()</h3>
726
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_select_all       (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);</pre>
727
<p>
728
Selects all the nodes. <em class="parameter"><code>selection</code></em> must be set to <a class="link" href="gtk2-Standard-Enumerations.html#GTK-SELECTION-MULTIPLE:CAPS"><span class="type">GTK_SELECTION_MULTIPLE</span></a>
729
mode.
730
</p>
731
<div class="variablelist"><table border="0" class="variablelist">
732
<colgroup>
733
<col align="left" valign="top">
734
<col>
735
</colgroup>
736
<tbody><tr>
737
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
738
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
739
</tr></tbody>
740
</table></div>
741
</div>
742
<hr>
743
<div class="refsect2">
744
<a name="gtk-tree-selection-unselect-all"></a><h3>gtk_tree_selection_unselect_all ()</h3>
745
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_unselect_all     (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>);</pre>
746
<p>
747
Unselects all the nodes.
748
</p>
749
<div class="variablelist"><table border="0" class="variablelist">
750
<colgroup>
751
<col align="left" valign="top">
752
<col>
753
</colgroup>
754
<tbody><tr>
755
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
756
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
757
</tr></tbody>
758
</table></div>
759
</div>
760
<hr>
761
<div class="refsect2">
762
<a name="gtk-tree-selection-select-range"></a><h3>gtk_tree_selection_select_range ()</h3>
763
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_select_range     (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
764
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *start_path</code></em>,
765
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *end_path</code></em>);</pre>
766
<p>
767
Selects a range of nodes, determined by <em class="parameter"><code>start_path</code></em> and <em class="parameter"><code>end_path</code></em> inclusive.
768
<em class="parameter"><code>selection</code></em> must be set to <a class="link" href="gtk2-Standard-Enumerations.html#GTK-SELECTION-MULTIPLE:CAPS"><span class="type">GTK_SELECTION_MULTIPLE</span></a> mode.
769
</p>
770
<div class="variablelist"><table border="0" class="variablelist">
771
<colgroup>
772
<col align="left" valign="top">
773
<col>
774
</colgroup>
775
<tbody>
776
<tr>
777
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
778
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
779
</tr>
780
<tr>
781
<td><p><span class="term"><em class="parameter"><code>start_path</code></em> :</span></p></td>
782
<td>The initial node of the range.</td>
783
</tr>
784
<tr>
785
<td><p><span class="term"><em class="parameter"><code>end_path</code></em> :</span></p></td>
786
<td>The final node of the range.</td>
787
</tr>
788
</tbody>
789
</table></div>
790
</div>
791
<hr>
792
<div class="refsect2">
793
<a name="gtk-tree-selection-unselect-range"></a><h3>gtk_tree_selection_unselect_range ()</h3>
794
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_tree_selection_unselect_range   (<em class="parameter"><code><a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *selection</code></em>,
795
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *start_path</code></em>,
796
                                                         <em class="parameter"><code><a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> *end_path</code></em>);</pre>
797
<p>
798
Unselects a range of nodes, determined by <em class="parameter"><code>start_path</code></em> and <em class="parameter"><code>end_path</code></em>
799
inclusive.
800
</p>
801
<div class="variablelist"><table border="0" class="variablelist">
802
<colgroup>
803
<col align="left" valign="top">
804
<col>
805
</colgroup>
806
<tbody>
807
<tr>
808
<td><p><span class="term"><em class="parameter"><code>selection</code></em> :</span></p></td>
809
<td>A <a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a>.</td>
810
</tr>
811
<tr>
812
<td><p><span class="term"><em class="parameter"><code>start_path</code></em> :</span></p></td>
813
<td>The initial node of the range.</td>
814
</tr>
815
<tr>
816
<td><p><span class="term"><em class="parameter"><code>end_path</code></em> :</span></p></td>
817
<td>The initial node of the range.</td>
818
</tr>
819
</tbody>
820
</table></div>
821
<p class="since">Since 2.2</p>
822
</div>
823
</div>
824
<div class="refsect1">
825
<a name="GtkTreeSelection.signal-details"></a><h2>Signal Details</h2>
826
<div class="refsect2">
827
<a name="GtkTreeSelection-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
828
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GtkTreeSelection.html" title="GtkTreeSelection"><span class="type">GtkTreeSelection</span></a> *treeselection,
829
                                                        <span class="type">gpointer</span>          user_data)          : <code class="literal">Run First</code></pre>
830
<p>
831
Emitted whenever the selection has (possibly) changed.  Please note that
832
this signal is mostly a hint.  It may only be emitted once when a range
833
of rows are selected, and it may occasionally be emitted when nothing
834
has happened.
835
</p>
836
<div class="variablelist"><table border="0" class="variablelist">
837
<colgroup>
838
<col align="left" valign="top">
839
<col>
840
</colgroup>
841
<tbody>
842
<tr>
843
<td><p><span class="term"><em class="parameter"><code>treeselection</code></em> :</span></p></td>
844
<td>the object which received the signal.</td>
845
</tr>
846
<tr>
847
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
848
<td>user data set when the signal handler was connected.</td>
849
</tr>
850
</tbody>
851
</table></div>
852
</div>
853
</div>
854
<div class="refsect1">
855
<a name="GtkTreeSelection.see-also"></a><h2>See Also</h2>
856
<p>
857
<a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>, <a class="link" href="GtkTreeViewColumn.html" title="GtkTreeViewColumn"><span class="type">GtkTreeViewColumn</span></a>, <span class="type">GtkTreeDnd</span>, <span class="type">GtkTreeMode</span>, <a class="link" href="GtkTreeSortable.html" title="GtkTreeSortable"><span class="type">GtkTreeSortable</span></a>, <a class="link" href="GtkTreeModelSort.html" title="GtkTreeModelSort"><span class="type">GtkTreeModelSort</span></a>, <a class="link" href="GtkListStore.html" title="GtkListStore"><span class="type">GtkListStore</span></a>, <a class="link" href="GtkTreeStore.html" title="GtkTreeStore"><span class="type">GtkTreeStore</span></a>, <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>, <a class="link" href="GtkCellEditable.html" title="GtkCellEditable"><span class="type">GtkCellEditable</span></a>, <a class="link" href="GtkCellRendererPixbuf.html" title="GtkCellRendererPixbuf"><span class="type">GtkCellRendererPixbuf</span></a>, <a class="link" href="GtkCellRendererText.html" title="GtkCellRendererText"><span class="type">GtkCellRendererText</span></a>, <a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>
858
</p>
859
</div>
860
</div>
861
<div class="footer">
862
<hr>
863
          Generated by GTK-Doc V1.18</div>
864
</body>
865
</html>