← Back to branch summary

~timo-jyrinki/ubuntu/utopic/rhythmbox/enable_grilo_rhythmbox

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-entry-view.xml

Tags: upstream-0.11.99.1
Import upstream version 0.11.99.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-entry-view.xml
11
11
<refnamediv>
12
12
<refname>RBEntryView</refname>
13
13
<refpurpose>a <link linkend="GtkTreeView"><type>GtkTreeView</type></link> for displaying track listings</refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
14
</refnamediv>
16
15
 
17
16
<refsynopsisdiv id="RBEntryView.synopsis" role="synopsis">
21
20
                    <link linkend="RBEntryView-struct">RBEntryView</link>;
22
21
                    <link linkend="RBEntryViewClass">RBEntryViewClass</link>;
23
22
enum                <link linkend="RBEntryViewColumn">RBEntryViewColumn</link>;
24
 
<link linkend="RBEntryView">RBEntryView</link>*        <link linkend="rb-entry-view-new">rb_entry_view_new</link>                   (<link linkend="RhythmDB">RhythmDB</link> *db,
 
23
<link linkend="RBEntryView">RBEntryView</link> *       <link linkend="rb-entry-view-new">rb_entry_view_new</link>                   (<link linkend="RhythmDB">RhythmDB</link> *db,
25
24
                                                         <link linkend="GObject">GObject</link> *shell_player,
26
25
                                                         const <link linkend="char">char</link> *sort_key,
27
26
                                                         <link linkend="gboolean">gboolean</link> is_drag_source,
53
52
<link linkend="gboolean">gboolean</link>            <link linkend="rb-entry-view-have-selection">rb_entry_view_have_selection</link>        (<link linkend="RBEntryView">RBEntryView</link> *view);
54
53
<link linkend="gboolean">gboolean</link>            <link linkend="rb-entry-view-have-complete-selection">rb_entry_view_have_complete_selection</link>
55
54
                                                        (<link linkend="RBEntryView">RBEntryView</link> *view);
56
 
<link linkend="GList">GList</link>*              <link linkend="rb-entry-view-get-selected-entries">rb_entry_view_get_selected_entries</link>  (<link linkend="RBEntryView">RBEntryView</link> *view);
 
55
<link linkend="GList">GList</link> *             <link linkend="rb-entry-view-get-selected-entries">rb_entry_view_get_selected_entries</link>  (<link linkend="RBEntryView">RBEntryView</link> *view);
57
56
<link linkend="void">void</link>                <link linkend="rb-entry-view-select-all">rb_entry_view_select_all</link>            (<link linkend="RBEntryView">RBEntryView</link> *view);
58
57
<link linkend="void">void</link>                <link linkend="rb-entry-view-select-none">rb_entry_view_select_none</link>           (<link linkend="RBEntryView">RBEntryView</link> *view);
59
58
<link linkend="void">void</link>                <link linkend="rb-entry-view-select-entry">rb_entry_view_select_entry</link>          (<link linkend="RBEntryView">RBEntryView</link> *view,
73
72
<link linkend="void">void</link>                <link linkend="rb-entry-view-set-sorting-order">rb_entry_view_set_sorting_order</link>     (<link linkend="RBEntryView">RBEntryView</link> *view,
74
73
                                                         const <link linkend="char">char</link> *column_name,
75
74
                                                         <link linkend="gint">gint</link> sort_order);
76
 
<link linkend="char">char</link>*               <link linkend="rb-entry-view-get-sorting-type">rb_entry_view_get_sorting_type</link>      (<link linkend="RBEntryView">RBEntryView</link> *view);
 
75
<link linkend="char">char</link> *              <link linkend="rb-entry-view-get-sorting-type">rb_entry_view_get_sorting_type</link>      (<link linkend="RBEntryView">RBEntryView</link> *view);
77
76
<link linkend="void">void</link>                <link linkend="rb-entry-view-set-sorting-type">rb_entry_view_set_sorting_type</link>      (<link linkend="RBEntryView">RBEntryView</link> *view,
78
77
                                                         const <link linkend="char">char</link> *sorttype);
79
78
<link linkend="void">void</link>                <link linkend="rb-entry-view-set-fixed-column-width">rb_entry_view_set_fixed_column_width</link>
81
80
                                                         <link linkend="GtkTreeViewColumn">GtkTreeViewColumn</link> *column,
82
81
                                                         <link linkend="GtkCellRenderer">GtkCellRenderer</link> *renderer,
83
82
                                                         const <link linkend="gchar">gchar</link> **strings);
84
 
const <link linkend="char">char</link>*         <link linkend="rb-entry-view-get-time-date-column-sample">rb_entry_view_get_time_date_column_sample</link>
 
83
const <link linkend="char">char</link> *        <link linkend="rb-entry-view-get-time-date-column-sample">rb_entry_view_get_time_date_column_sample</link>
85
84
                                                        (void);
86
85
<link linkend="void">void</link>                <link linkend="rb-entry-view-resort-model">rb_entry_view_resort_model</link>          (<link linkend="RBEntryView">RBEntryView</link> *view);
87
86
</synopsis>
99
98
                                 +----<link linkend="GtkScrolledWindow">GtkScrolledWindow</link>
100
99
                                       +----RBEntryView
101
100
</synopsis>
102
 
 
103
101
</refsect1>
104
102
 
105
103
 
109
107
<para>
110
108
RBEntryView implements
111
109
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
112
 
 
113
110
</refsect1>
114
111
 
115
112
 
168
165
it is watched and updated.  The sort settings consist of a column name
169
166
and an order (ascending or descending).</para>
170
167
<para>
171
 
 
172
168
</para>
173
169
</refsect1>
174
170
 
176
172
<title role="details.title">Details</title>
177
173
<refsect2 id="RBEntryView-struct" role="struct">
178
174
<title>RBEntryView</title>
179
 
<indexterm zone="RBEntryView-struct"><primary>RBEntryView</primary></indexterm><programlisting>typedef struct _RBEntryView RBEntryView;</programlisting>
 
175
<indexterm zone="RBEntryView-struct"><primary sortas="RBEntryView">RBEntryView</primary></indexterm><programlisting>typedef struct _RBEntryView RBEntryView;</programlisting>
180
176
<para>
181
 
 
182
177
</para></refsect2>
183
178
<refsect2 id="RBEntryViewClass" role="struct">
184
179
<title>RBEntryViewClass</title>
185
 
<indexterm zone="RBEntryViewClass"><primary>RBEntryViewClass</primary></indexterm><programlisting>typedef struct {
 
180
<indexterm zone="RBEntryViewClass"><primary sortas="RBEntryViewClass">RBEntryViewClass</primary></indexterm><programlisting>typedef struct {
186
181
        GtkScrolledWindowClass parent;
187
182
 
188
183
        void (*entry_added)             (RBEntryView *view, RhythmDBEntry *entry);
199
194
} RBEntryViewClass;
200
195
</programlisting>
201
196
<para>
202
 
 
203
197
</para></refsect2>
204
198
<refsect2 id="RBEntryViewColumn" role="enum">
205
199
<title>enum RBEntryViewColumn</title>
206
 
<indexterm zone="RBEntryViewColumn"><primary>RBEntryViewColumn</primary></indexterm><programlisting>typedef enum {
 
200
<indexterm zone="RBEntryViewColumn"><primary sortas="RBEntryViewColumn">RBEntryViewColumn</primary></indexterm><programlisting>typedef enum {
207
201
        RB_ENTRY_VIEW_COL_TRACK_NUMBER,
208
202
        RB_ENTRY_VIEW_COL_TITLE,
209
203
        RB_ENTRY_VIEW_COL_ARTIST,
227
221
The predefined column names map directly to the <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> properties
228
222
the columns display.</para>
229
223
<para>
230
 
 
231
224
</para></refsect2>
232
225
<refsect2 id="rb-entry-view-new" role="function">
233
226
<title>rb_entry_view_new ()</title>
234
 
<indexterm zone="rb-entry-view-new"><primary>rb_entry_view_new</primary></indexterm><programlisting><link linkend="RBEntryView">RBEntryView</link>*        rb_entry_view_new                   (<link linkend="RhythmDB">RhythmDB</link> *db,
 
227
<indexterm zone="rb-entry-view-new"><primary sortas="rb_entry_view_new">rb_entry_view_new</primary></indexterm><programlisting><link linkend="RBEntryView">RBEntryView</link> *       rb_entry_view_new                   (<link linkend="RhythmDB">RhythmDB</link> *db,
235
228
                                                         <link linkend="GObject">GObject</link> *shell_player,
236
229
                                                         const <link linkend="char">char</link> *sort_key,
237
230
                                                         <link linkend="gboolean">gboolean</link> is_drag_source,
244
237
to transfer tracks between the filesystem and removable devices, and to add tracks
245
238
to playlists.</para>
246
239
<para>
247
 
 
248
240
</para><variablelist role="params">
249
 
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
 
241
<varlistentry><term><parameter>db</parameter>&#160;:</term>
250
242
<listitem><simpara> the <link linkend="RhythmDB"><type>RhythmDB</type></link> instance
251
243
</simpara></listitem></varlistentry>
252
 
<varlistentry><term><parameter>shell_player</parameter>&nbsp;:</term>
 
244
<varlistentry><term><parameter>shell_player</parameter>&#160;:</term>
253
245
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link> instance
254
246
</simpara></listitem></varlistentry>
255
 
<varlistentry><term><parameter>sort_key</parameter>&nbsp;:</term>
 
247
<varlistentry><term><parameter>sort_key</parameter>&#160;:</term>
256
248
<listitem><simpara> the GConf key controlling the sort order for the view
257
249
</simpara></listitem></varlistentry>
258
 
<varlistentry><term><parameter>is_drag_source</parameter>&nbsp;:</term>
 
250
<varlistentry><term><parameter>is_drag_source</parameter>&#160;:</term>
259
251
<listitem><simpara> if TRUE, the view should act as a drag and drop data source
260
252
</simpara></listitem></varlistentry>
261
 
<varlistentry><term><parameter>is_drag_dest</parameter>&nbsp;:</term>
 
253
<varlistentry><term><parameter>is_drag_dest</parameter>&#160;:</term>
262
254
<listitem><simpara> if TRUE, the view should act as a drag and drop destination
263
255
</simpara></listitem></varlistentry>
264
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new entry view
 
256
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new entry view
265
257
</simpara></listitem></varlistentry>
266
258
</variablelist></refsect2>
267
259
<refsect2 id="rb-entry-view-append-column" role="function">
268
260
<title>rb_entry_view_append_column ()</title>
269
 
<indexterm zone="rb-entry-view-append-column"><primary>rb_entry_view_append_column</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_append_column         (<link linkend="RBEntryView">RBEntryView</link> *view,
 
261
<indexterm zone="rb-entry-view-append-column"><primary sortas="rb_entry_view_append_column">rb_entry_view_append_column</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_append_column         (<link linkend="RBEntryView">RBEntryView</link> *view,
270
262
                                                         <link linkend="RBEntryViewColumn">RBEntryViewColumn</link> coltype,
271
263
                                                         <link linkend="gboolean">gboolean</link> always_visible);</programlisting>
272
264
<para>
276
268
This should only be used when it is vital for the purpose of the 
277
269
source that the column be visible.</para>
278
270
<para>
279
 
 
280
271
</para><variablelist role="params">
281
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
272
<varlistentry><term><parameter>view</parameter>&#160;:</term>
282
273
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
283
274
</simpara></listitem></varlistentry>
284
 
<varlistentry><term><parameter>coltype</parameter>&nbsp;:</term>
 
275
<varlistentry><term><parameter>coltype</parameter>&#160;:</term>
285
276
<listitem><simpara> type of column to append
286
277
</simpara></listitem></varlistentry>
287
 
<varlistentry><term><parameter>always_visible</parameter>&nbsp;:</term>
 
278
<varlistentry><term><parameter>always_visible</parameter>&#160;:</term>
288
279
<listitem><simpara> if TRUE, ignore the user's column visibility settings
289
280
</simpara></listitem></varlistentry>
290
281
</variablelist></refsect2>
291
282
<refsect2 id="rb-entry-view-append-column-custom" role="function">
292
283
<title>rb_entry_view_append_column_custom ()</title>
293
 
<indexterm zone="rb-entry-view-append-column-custom"><primary>rb_entry_view_append_column_custom</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_append_column_custom  (<link linkend="RBEntryView">RBEntryView</link> *view,
 
284
<indexterm zone="rb-entry-view-append-column-custom"><primary sortas="rb_entry_view_append_column_custom">rb_entry_view_append_column_custom</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_append_column_custom  (<link linkend="RBEntryView">RBEntryView</link> *view,
294
285
                                                         <link linkend="GtkTreeViewColumn">GtkTreeViewColumn</link> *column,
295
286
                                                         const <link linkend="char">char</link> *title,
296
287
                                                         const <link linkend="char">char</link> *key,
300
291
<para>
301
292
Appends a custom column to the entry view.</para>
302
293
<para>
303
 
 
304
294
</para><variablelist role="params">
305
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
295
<varlistentry><term><parameter>view</parameter>&#160;:</term>
306
296
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
307
297
</simpara></listitem></varlistentry>
308
 
<varlistentry><term><parameter>column</parameter>&nbsp;:</term>
 
298
<varlistentry><term><parameter>column</parameter>&#160;:</term>
309
299
<listitem><simpara> a <link linkend="GtkTreeViewColumn"><type>GtkTreeViewColumn</type></link> to append
310
300
</simpara></listitem></varlistentry>
311
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
301
<varlistentry><term><parameter>title</parameter>&#160;:</term>
312
302
<listitem><simpara> title for the column (translated)
313
303
</simpara></listitem></varlistentry>
314
 
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
304
<varlistentry><term><parameter>key</parameter>&#160;:</term>
315
305
<listitem><simpara> sort key for the column (not translated)
316
306
</simpara></listitem></varlistentry>
317
 
<varlistentry><term><parameter>sort_func</parameter>&nbsp;:</term>
 
307
<varlistentry><term><parameter>sort_func</parameter>&#160;:</term>
318
308
<listitem><simpara> comparison function to use for sorting on the column
319
309
</simpara></listitem></varlistentry>
320
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
310
<varlistentry><term><parameter>data</parameter>&#160;:</term>
321
311
<listitem><simpara> data to pass to the sort function
322
312
</simpara></listitem></varlistentry>
323
 
<varlistentry><term><parameter>data_destroy</parameter>&nbsp;:</term>
 
313
<varlistentry><term><parameter>data_destroy</parameter>&#160;:</term>
324
314
<listitem><simpara> function to use to destroy the sort data
325
315
</simpara></listitem></varlistentry>
326
316
</variablelist></refsect2>
327
317
<refsect2 id="rb-entry-view-insert-column-custom" role="function">
328
318
<title>rb_entry_view_insert_column_custom ()</title>
329
 
<indexterm zone="rb-entry-view-insert-column-custom"><primary>rb_entry_view_insert_column_custom</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_insert_column_custom  (<link linkend="RBEntryView">RBEntryView</link> *view,
 
319
<indexterm zone="rb-entry-view-insert-column-custom"><primary sortas="rb_entry_view_insert_column_custom">rb_entry_view_insert_column_custom</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_insert_column_custom  (<link linkend="RBEntryView">RBEntryView</link> *view,
330
320
                                                         <link linkend="GtkTreeViewColumn">GtkTreeViewColumn</link> *column,
331
321
                                                         const <link linkend="char">char</link> *title,
332
322
                                                         const <link linkend="char">char</link> *key,
337
327
<para>
338
328
Inserts a custom column at the specified position.</para>
339
329
<para>
340
 
 
341
330
</para><variablelist role="params">
342
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
331
<varlistentry><term><parameter>view</parameter>&#160;:</term>
343
332
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
344
333
</simpara></listitem></varlistentry>
345
 
<varlistentry><term><parameter>column</parameter>&nbsp;:</term>
 
334
<varlistentry><term><parameter>column</parameter>&#160;:</term>
346
335
<listitem><simpara> a <link linkend="GtkTreeViewColumn"><type>GtkTreeViewColumn</type></link> to append
347
336
</simpara></listitem></varlistentry>
348
 
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
337
<varlistentry><term><parameter>title</parameter>&#160;:</term>
349
338
<listitem><simpara> title for the column (translated)
350
339
</simpara></listitem></varlistentry>
351
 
<varlistentry><term><parameter>key</parameter>&nbsp;:</term>
 
340
<varlistentry><term><parameter>key</parameter>&#160;:</term>
352
341
<listitem><simpara> sort key for the column (not translated)
353
342
</simpara></listitem></varlistentry>
354
 
<varlistentry><term><parameter>sort_func</parameter>&nbsp;:</term>
 
343
<varlistentry><term><parameter>sort_func</parameter>&#160;:</term>
355
344
<listitem><simpara> comparison function to use for sorting on the column
356
345
</simpara></listitem></varlistentry>
357
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
346
<varlistentry><term><parameter>data</parameter>&#160;:</term>
358
347
<listitem><simpara> data to pass to the sort function
359
348
</simpara></listitem></varlistentry>
360
 
<varlistentry><term><parameter>data_destroy</parameter>&nbsp;:</term>
 
349
<varlistentry><term><parameter>data_destroy</parameter>&#160;:</term>
361
350
<listitem><simpara> function to use to destroy the sort data
362
351
</simpara></listitem></varlistentry>
363
 
<varlistentry><term><parameter>position</parameter>&nbsp;:</term>
 
352
<varlistentry><term><parameter>position</parameter>&#160;:</term>
364
353
<listitem><simpara> position at which to insert the column (-1 to insert at the end)
365
354
</simpara></listitem></varlistentry>
366
355
</variablelist></refsect2>
367
356
<refsect2 id="rb-entry-view-set-columns-clickable" role="function">
368
357
<title>rb_entry_view_set_columns_clickable ()</title>
369
 
<indexterm zone="rb-entry-view-set-columns-clickable"><primary>rb_entry_view_set_columns_clickable</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_columns_clickable (<link linkend="RBEntryView">RBEntryView</link> *view,
 
358
<indexterm zone="rb-entry-view-set-columns-clickable"><primary sortas="rb_entry_view_set_columns_clickable">rb_entry_view_set_columns_clickable</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_columns_clickable (<link linkend="RBEntryView">RBEntryView</link> *view,
370
359
                                                         <link linkend="gboolean">gboolean</link> clickable);</programlisting>
371
360
<para>
372
361
Makes the headers for sortable columns (those for which a sort function was
373
362
provided) clickable, so the user can set the sort order.</para>
374
363
<para>
375
 
 
376
364
</para><variablelist role="params">
377
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
365
<varlistentry><term><parameter>view</parameter>&#160;:</term>
378
366
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
379
367
</simpara></listitem></varlistentry>
380
 
<varlistentry><term><parameter>clickable</parameter>&nbsp;:</term>
 
368
<varlistentry><term><parameter>clickable</parameter>&#160;:</term>
381
369
<listitem><simpara> if TRUE, sortable columns will be made clickable
382
370
</simpara></listitem></varlistentry>
383
371
</variablelist></refsect2>
384
372
<refsect2 id="rb-entry-view-set-model" role="function">
385
373
<title>rb_entry_view_set_model ()</title>
386
 
<indexterm zone="rb-entry-view-set-model"><primary>rb_entry_view_set_model</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_model             (<link linkend="RBEntryView">RBEntryView</link> *view,
 
374
<indexterm zone="rb-entry-view-set-model"><primary sortas="rb_entry_view_set_model">rb_entry_view_set_model</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_model             (<link linkend="RBEntryView">RBEntryView</link> *view,
387
375
                                                         <link linkend="RhythmDBQueryModel">RhythmDBQueryModel</link> *model);</programlisting>
388
376
<para>
389
377
Replaces the model backing the entry view.</para>
390
378
<para>
391
 
 
392
379
</para><variablelist role="params">
393
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
380
<varlistentry><term><parameter>view</parameter>&#160;:</term>
394
381
<listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link>
395
382
</simpara></listitem></varlistentry>
396
 
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
383
<varlistentry><term><parameter>model</parameter>&#160;:</term>
397
384
<listitem><simpara> the new <link linkend="RhythmDBQueryModel"><type>RhythmDBQueryModel</type></link> to use for the view
398
385
</simpara></listitem></varlistentry>
399
386
</variablelist></refsect2>
400
387
<refsect2 id="rb-entry-view-set-state" role="function">
401
388
<title>rb_entry_view_set_state ()</title>
402
 
<indexterm zone="rb-entry-view-set-state"><primary>rb_entry_view_set_state</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_state             (<link linkend="RBEntryView">RBEntryView</link> *view,
 
389
<indexterm zone="rb-entry-view-set-state"><primary sortas="rb_entry_view_set_state">rb_entry_view_set_state</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_state             (<link linkend="RBEntryView">RBEntryView</link> *view,
403
390
                                                         <link linkend="RBEntryViewState">RBEntryViewState</link> state);</programlisting>
404
391
<para>
405
392
Sets the icon to be drawn in the 'playing' column next to the
407
394
should be used when the source containing the entry view is playing,
408
395
and RB_ENTRY_VIEW_NOT_PLAYING otherwise.</para>
409
396
<para>
410
 
 
411
397
</para><variablelist role="params">
412
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
398
<varlistentry><term><parameter>view</parameter>&#160;:</term>
413
399
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
414
400
</simpara></listitem></varlistentry>
415
 
<varlistentry><term><parameter>state</parameter>&nbsp;:</term>
 
401
<varlistentry><term><parameter>state</parameter>&#160;:</term>
416
402
<listitem><simpara> the new playing entry state
417
403
</simpara></listitem></varlistentry>
418
404
</variablelist></refsect2>
419
405
<refsect2 id="rb-entry-view-have-selection" role="function">
420
406
<title>rb_entry_view_have_selection ()</title>
421
 
<indexterm zone="rb-entry-view-have-selection"><primary>rb_entry_view_have_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rb_entry_view_have_selection        (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
 
407
<indexterm zone="rb-entry-view-have-selection"><primary sortas="rb_entry_view_have_selection">rb_entry_view_have_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rb_entry_view_have_selection        (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
422
408
<para>
423
409
</para>
424
410
<para>
425
 
 
426
411
</para><variablelist role="params">
427
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
412
<varlistentry><term><parameter>view</parameter>&#160;:</term>
428
413
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
429
414
</simpara></listitem></varlistentry>
430
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if one or more rows are selected in the view
 
415
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if one or more rows are selected in the view
431
416
</simpara></listitem></varlistentry>
432
417
</variablelist></refsect2>
433
418
<refsect2 id="rb-entry-view-have-complete-selection" role="function">
434
419
<title>rb_entry_view_have_complete_selection ()</title>
435
 
<indexterm zone="rb-entry-view-have-complete-selection"><primary>rb_entry_view_have_complete_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rb_entry_view_have_complete_selection
 
420
<indexterm zone="rb-entry-view-have-complete-selection"><primary sortas="rb_entry_view_have_complete_selection">rb_entry_view_have_complete_selection</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rb_entry_view_have_complete_selection
436
421
                                                        (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
437
422
<para>
438
423
</para>
439
424
<para>
440
 
 
441
425
</para><variablelist role="params">
442
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
426
<varlistentry><term><parameter>view</parameter>&#160;:</term>
443
427
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
444
428
</simpara></listitem></varlistentry>
445
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if all rows in the view are selected
 
429
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if all rows in the view are selected
446
430
</simpara></listitem></varlistentry>
447
431
</variablelist></refsect2>
448
432
<refsect2 id="rb-entry-view-get-selected-entries" role="function">
449
433
<title>rb_entry_view_get_selected_entries ()</title>
450
 
<indexterm zone="rb-entry-view-get-selected-entries"><primary>rb_entry_view_get_selected_entries</primary></indexterm><programlisting><link linkend="GList">GList</link>*              rb_entry_view_get_selected_entries  (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
 
434
<indexterm zone="rb-entry-view-get-selected-entries"><primary sortas="rb_entry_view_get_selected_entries">rb_entry_view_get_selected_entries</primary></indexterm><programlisting><link linkend="GList">GList</link> *             rb_entry_view_get_selected_entries  (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
451
435
<para>
452
436
</para>
453
437
<para>
454
 
 
455
438
</para><variablelist role="params">
456
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
439
<varlistentry><term><parameter>view</parameter>&#160;:</term>
457
440
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
458
441
</simpara></listitem></varlistentry>
459
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> containing the currently selected entries in the view
 
442
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GList"><type>GList</type></link> containing the currently selected entries in the view
460
443
 (must be freed)
461
444
</simpara></listitem></varlistentry>
462
445
</variablelist></refsect2>
463
446
<refsect2 id="rb-entry-view-select-all" role="function">
464
447
<title>rb_entry_view_select_all ()</title>
465
 
<indexterm zone="rb-entry-view-select-all"><primary>rb_entry_view_select_all</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_select_all            (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
 
448
<indexterm zone="rb-entry-view-select-all"><primary sortas="rb_entry_view_select_all">rb_entry_view_select_all</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_select_all            (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
466
449
<para>
467
450
Selects all rows in the view</para>
468
451
<para>
469
 
 
470
452
</para><variablelist role="params">
471
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
453
<varlistentry><term><parameter>view</parameter>&#160;:</term>
472
454
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
473
455
</simpara></listitem></varlistentry>
474
456
</variablelist></refsect2>
475
457
<refsect2 id="rb-entry-view-select-none" role="function">
476
458
<title>rb_entry_view_select_none ()</title>
477
 
<indexterm zone="rb-entry-view-select-none"><primary>rb_entry_view_select_none</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_select_none           (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
 
459
<indexterm zone="rb-entry-view-select-none"><primary sortas="rb_entry_view_select_none">rb_entry_view_select_none</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_select_none           (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
478
460
<para>
479
461
Deselects all rows in the view.</para>
480
462
<para>
481
 
 
482
463
</para><variablelist role="params">
483
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
464
<varlistentry><term><parameter>view</parameter>&#160;:</term>
484
465
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
485
466
</simpara></listitem></varlistentry>
486
467
</variablelist></refsect2>
487
468
<refsect2 id="rb-entry-view-select-entry" role="function">
488
469
<title>rb_entry_view_select_entry ()</title>
489
 
<indexterm zone="rb-entry-view-select-entry"><primary>rb_entry_view_select_entry</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_select_entry          (<link linkend="RBEntryView">RBEntryView</link> *view,
 
470
<indexterm zone="rb-entry-view-select-entry"><primary sortas="rb_entry_view_select_entry">rb_entry_view_select_entry</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_select_entry          (<link linkend="RBEntryView">RBEntryView</link> *view,
490
471
                                                         <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);</programlisting>
491
472
<para>
492
473
If the specified entry is present in the view, it is added
493
474
to the selection.</para>
494
475
<para>
495
 
 
496
476
</para><variablelist role="params">
497
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
477
<varlistentry><term><parameter>view</parameter>&#160;:</term>
498
478
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
499
479
</simpara></listitem></varlistentry>
500
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
480
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
501
481
<listitem><simpara> a <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to select
502
482
</simpara></listitem></varlistentry>
503
483
</variablelist></refsect2>
504
484
<refsect2 id="rb-entry-view-get-entry-contained" role="function">
505
485
<title>rb_entry_view_get_entry_contained ()</title>
506
 
<indexterm zone="rb-entry-view-get-entry-contained"><primary>rb_entry_view_get_entry_contained</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rb_entry_view_get_entry_contained   (<link linkend="RBEntryView">RBEntryView</link> *view,
 
486
<indexterm zone="rb-entry-view-get-entry-contained"><primary sortas="rb_entry_view_get_entry_contained">rb_entry_view_get_entry_contained</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rb_entry_view_get_entry_contained   (<link linkend="RBEntryView">RBEntryView</link> *view,
507
487
                                                         <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);</programlisting>
508
488
<para>
509
489
</para>
510
490
<para>
511
 
 
512
491
</para><variablelist role="params">
513
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
492
<varlistentry><term><parameter>view</parameter>&#160;:</term>
514
493
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
515
494
</simpara></listitem></varlistentry>
516
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
495
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
517
496
<listitem><simpara> a <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to check
518
497
</simpara></listitem></varlistentry>
519
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the entry is present in the view
 
498
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the entry is present in the view
520
499
</simpara></listitem></varlistentry>
521
500
</variablelist></refsect2>
522
501
<refsect2 id="rb-entry-view-get-entry-visible" role="function">
523
502
<title>rb_entry_view_get_entry_visible ()</title>
524
 
<indexterm zone="rb-entry-view-get-entry-visible"><primary>rb_entry_view_get_entry_visible</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rb_entry_view_get_entry_visible     (<link linkend="RBEntryView">RBEntryView</link> *view,
 
503
<indexterm zone="rb-entry-view-get-entry-visible"><primary sortas="rb_entry_view_get_entry_visible">rb_entry_view_get_entry_visible</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rb_entry_view_get_entry_visible     (<link linkend="RBEntryView">RBEntryView</link> *view,
525
504
                                                         <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);</programlisting>
526
505
<para>
527
506
</para>
528
507
<para>
529
 
 
530
508
</para><variablelist role="params">
531
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
509
<varlistentry><term><parameter>view</parameter>&#160;:</term>
532
510
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
533
511
</simpara></listitem></varlistentry>
534
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
512
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
535
513
<listitem><simpara> a <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to check
536
514
</simpara></listitem></varlistentry>
537
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the entry is present in the view and is currently visible
 
515
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the entry is present in the view and is currently visible
538
516
</simpara></listitem></varlistentry>
539
517
</variablelist></refsect2>
540
518
<refsect2 id="rb-entry-view-scroll-to-entry" role="function">
541
519
<title>rb_entry_view_scroll_to_entry ()</title>
542
 
<indexterm zone="rb-entry-view-scroll-to-entry"><primary>rb_entry_view_scroll_to_entry</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_scroll_to_entry       (<link linkend="RBEntryView">RBEntryView</link> *view,
 
520
<indexterm zone="rb-entry-view-scroll-to-entry"><primary sortas="rb_entry_view_scroll_to_entry">rb_entry_view_scroll_to_entry</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_scroll_to_entry       (<link linkend="RBEntryView">RBEntryView</link> *view,
543
521
                                                         <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);</programlisting>
544
522
<para>
545
523
If the specified entry is present in the view, the view will be
546
524
scrolled so that the entry is visible.</para>
547
525
<para>
548
 
 
549
526
</para><variablelist role="params">
550
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
527
<varlistentry><term><parameter>view</parameter>&#160;:</term>
551
528
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
552
529
</simpara></listitem></varlistentry>
553
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
530
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
554
531
<listitem><simpara> a <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to scroll to
555
532
</simpara></listitem></varlistentry>
556
533
</variablelist></refsect2>
557
534
<refsect2 id="rb-entry-view-enable-drag-source" role="function">
558
535
<title>rb_entry_view_enable_drag_source ()</title>
559
 
<indexterm zone="rb-entry-view-enable-drag-source"><primary>rb_entry_view_enable_drag_source</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_enable_drag_source    (<link linkend="RBEntryView">RBEntryView</link> *view,
 
536
<indexterm zone="rb-entry-view-enable-drag-source"><primary sortas="rb_entry_view_enable_drag_source">rb_entry_view_enable_drag_source</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_enable_drag_source    (<link linkend="RBEntryView">RBEntryView</link> *view,
560
537
                                                         const <link linkend="GtkTargetEntry">GtkTargetEntry</link> *targets,
561
538
                                                         <link linkend="int">int</link> n_targets);</programlisting>
562
539
<para>
563
540
Enables the entry view to act as a data source for drag an drop operations,
564
541
using a specified set of data targets.</para>
565
542
<para>
566
 
 
567
543
</para><variablelist role="params">
568
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
544
<varlistentry><term><parameter>view</parameter>&#160;:</term>
569
545
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
570
546
</simpara></listitem></varlistentry>
571
 
<varlistentry><term><parameter>targets</parameter>&nbsp;:</term>
 
547
<varlistentry><term><parameter>targets</parameter>&#160;:</term>
572
548
<listitem><simpara> an array of <link linkend="GtkTargetEntry"><type>GtkTargetEntry</type></link> structures defining the drag data targets
573
549
</simpara></listitem></varlistentry>
574
 
<varlistentry><term><parameter>n_targets</parameter>&nbsp;:</term>
 
550
<varlistentry><term><parameter>n_targets</parameter>&#160;:</term>
575
551
<listitem><simpara> the number of entries in the target array
576
552
</simpara></listitem></varlistentry>
577
553
</variablelist></refsect2>
578
554
<refsect2 id="rb-entry-view-get-sorting-order" role="function">
579
555
<title>rb_entry_view_get_sorting_order ()</title>
580
 
<indexterm zone="rb-entry-view-get-sorting-order"><primary>rb_entry_view_get_sorting_order</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_get_sorting_order     (<link linkend="RBEntryView">RBEntryView</link> *view,
 
556
<indexterm zone="rb-entry-view-get-sorting-order"><primary sortas="rb_entry_view_get_sorting_order">rb_entry_view_get_sorting_order</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_get_sorting_order     (<link linkend="RBEntryView">RBEntryView</link> *view,
581
557
                                                         <link linkend="char">char</link> **column_name,
582
558
                                                         <link linkend="gint">gint</link> *sort_order);</programlisting>
583
559
<para>
584
560
Retrieves the sort settings for the view.</para>
585
561
<para>
586
 
 
587
562
</para><variablelist role="params">
588
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
563
<varlistentry><term><parameter>view</parameter>&#160;:</term>
589
564
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
590
565
</simpara></listitem></varlistentry>
591
 
<varlistentry><term><parameter>column_name</parameter>&nbsp;:</term>
 
566
<varlistentry><term><parameter>column_name</parameter>&#160;:</term>
592
567
<listitem><simpara> returns the sort column name
593
568
</simpara></listitem></varlistentry>
594
 
<varlistentry><term><parameter>sort_order</parameter>&nbsp;:</term>
 
569
<varlistentry><term><parameter>sort_order</parameter>&#160;:</term>
595
570
<listitem><simpara> returns the sort ordering as a <link linkend="GtkSortType"><type>GtkSortType</type></link> value
596
571
</simpara></listitem></varlistentry>
597
572
</variablelist></refsect2>
598
573
<refsect2 id="rb-entry-view-set-sorting-order" role="function">
599
574
<title>rb_entry_view_set_sorting_order ()</title>
600
 
<indexterm zone="rb-entry-view-set-sorting-order"><primary>rb_entry_view_set_sorting_order</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_sorting_order     (<link linkend="RBEntryView">RBEntryView</link> *view,
 
575
<indexterm zone="rb-entry-view-set-sorting-order"><primary sortas="rb_entry_view_set_sorting_order">rb_entry_view_set_sorting_order</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_sorting_order     (<link linkend="RBEntryView">RBEntryView</link> *view,
601
576
                                                         const <link linkend="char">char</link> *column_name,
602
577
                                                         <link linkend="gint">gint</link> sort_order);</programlisting>
603
578
<para>
604
579
Sets the sort order for the entry view.</para>
605
580
<para>
606
 
 
607
581
</para><variablelist role="params">
608
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
582
<varlistentry><term><parameter>view</parameter>&#160;:</term>
609
583
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
610
584
</simpara></listitem></varlistentry>
611
 
<varlistentry><term><parameter>column_name</parameter>&nbsp;:</term>
 
585
<varlistentry><term><parameter>column_name</parameter>&#160;:</term>
612
586
<listitem><simpara> name of the column to sort on
613
587
</simpara></listitem></varlistentry>
614
 
<varlistentry><term><parameter>sort_order</parameter>&nbsp;:</term>
 
588
<varlistentry><term><parameter>sort_order</parameter>&#160;:</term>
615
589
<listitem><simpara> order to sort in, as a <link linkend="GtkSortOrder"><type>GtkSortOrder</type></link>
616
590
</simpara></listitem></varlistentry>
617
591
</variablelist></refsect2>
618
592
<refsect2 id="rb-entry-view-get-sorting-type" role="function">
619
593
<title>rb_entry_view_get_sorting_type ()</title>
620
 
<indexterm zone="rb-entry-view-get-sorting-type"><primary>rb_entry_view_get_sorting_type</primary></indexterm><programlisting><link linkend="char">char</link>*               rb_entry_view_get_sorting_type      (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
 
594
<indexterm zone="rb-entry-view-get-sorting-type"><primary sortas="rb_entry_view_get_sorting_type">rb_entry_view_get_sorting_type</primary></indexterm><programlisting><link linkend="char">char</link> *              rb_entry_view_get_sorting_type      (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
621
595
<para>
622
596
Constructs a string that describes the sort settings for the entry view.
623
597
This consists of a column name and an order ('ascending' or 'descending')
624
598
separated by a comma.</para>
625
599
<para>
626
 
 
627
600
</para><variablelist role="params">
628
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
601
<varlistentry><term><parameter>view</parameter>&#160;:</term>
629
602
<listitem><simpara> an <link linkend="RBEntryView"><type>RBEntryView</type></link>
630
603
</simpara></listitem></varlistentry>
631
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> sort order description (must be freed)
 
604
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> sort order description (must be freed)
632
605
</simpara></listitem></varlistentry>
633
606
</variablelist></refsect2>
634
607
<refsect2 id="rb-entry-view-set-sorting-type" role="function">
635
608
<title>rb_entry_view_set_sorting_type ()</title>
636
 
<indexterm zone="rb-entry-view-set-sorting-type"><primary>rb_entry_view_set_sorting_type</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_sorting_type      (<link linkend="RBEntryView">RBEntryView</link> *view,
 
609
<indexterm zone="rb-entry-view-set-sorting-type"><primary sortas="rb_entry_view_set_sorting_type">rb_entry_view_set_sorting_type</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_sorting_type      (<link linkend="RBEntryView">RBEntryView</link> *view,
637
610
                                                         const <link linkend="char">char</link> *sorttype);</programlisting>
638
611
<para>
639
612
Changes the sort order for the entry view.  The sort order
640
613
description must be a column name, followed by a comma, followed
641
614
by an order description ('ascending' or 'descending').</para>
642
615
<para>
643
 
 
644
616
</para><variablelist role="params">
645
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
617
<varlistentry><term><parameter>view</parameter>&#160;:</term>
646
618
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
647
619
</simpara></listitem></varlistentry>
648
 
<varlistentry><term><parameter>sorttype</parameter>&nbsp;:</term>
 
620
<varlistentry><term><parameter>sorttype</parameter>&#160;:</term>
649
621
<listitem><simpara> sort order description
650
622
</simpara></listitem></varlistentry>
651
623
</variablelist></refsect2>
652
624
<refsect2 id="rb-entry-view-set-fixed-column-width" role="function">
653
625
<title>rb_entry_view_set_fixed_column_width ()</title>
654
 
<indexterm zone="rb-entry-view-set-fixed-column-width"><primary>rb_entry_view_set_fixed_column_width</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_fixed_column_width
 
626
<indexterm zone="rb-entry-view-set-fixed-column-width"><primary sortas="rb_entry_view_set_fixed_column_width">rb_entry_view_set_fixed_column_width</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_set_fixed_column_width
655
627
                                                        (<link linkend="RBEntryView">RBEntryView</link> *view,
656
628
                                                         <link linkend="GtkTreeViewColumn">GtkTreeViewColumn</link> *column,
657
629
                                                         <link linkend="GtkCellRenderer">GtkCellRenderer</link> *renderer,
661
633
a column.  This is important for performance reasons, as having the
662
634
tree view measure the strings in each of 20000 rows is very slow.</para>
663
635
<para>
664
 
 
665
636
</para><variablelist role="params">
666
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
637
<varlistentry><term><parameter>view</parameter>&#160;:</term>
667
638
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link>
668
639
</simpara></listitem></varlistentry>
669
 
<varlistentry><term><parameter>column</parameter>&nbsp;:</term>
 
640
<varlistentry><term><parameter>column</parameter>&#160;:</term>
670
641
<listitem><simpara> the column to set the width for
671
642
</simpara></listitem></varlistentry>
672
 
<varlistentry><term><parameter>renderer</parameter>&nbsp;:</term>
 
643
<varlistentry><term><parameter>renderer</parameter>&#160;:</term>
673
644
<listitem><simpara> a temporary cell renderer to use
674
645
</simpara></listitem></varlistentry>
675
 
<varlistentry><term><parameter>strings</parameter>&nbsp;:</term>
 
646
<varlistentry><term><parameter>strings</parameter>&#160;:</term>
676
647
<listitem><simpara> a NULL-terminated array of strings that will be displayed in the column
677
648
</simpara></listitem></varlistentry>
678
649
</variablelist></refsect2>
679
650
<refsect2 id="rb-entry-view-get-time-date-column-sample" role="function">
680
651
<title>rb_entry_view_get_time_date_column_sample ()</title>
681
 
<indexterm zone="rb-entry-view-get-time-date-column-sample"><primary>rb_entry_view_get_time_date_column_sample</primary></indexterm><programlisting>const <link linkend="char">char</link>*         rb_entry_view_get_time_date_column_sample
 
652
<indexterm zone="rb-entry-view-get-time-date-column-sample"><primary sortas="rb_entry_view_get_time_date_column_sample">rb_entry_view_get_time_date_column_sample</primary></indexterm><programlisting>const <link linkend="char">char</link> *        rb_entry_view_get_time_date_column_sample
682
653
                                                        (void);</programlisting>
683
654
<para>
684
655
Returns a sample string for use in columns displaying times
685
656
and dates in 'friendly' form (see <parameter>rb_utf_friendly_time</parameter>).
686
657
For use with <parameter>rb_entry_view_set_fixed_column_width</parameter>.</para>
687
658
<para>
688
 
 
689
659
</para><variablelist role="params">
690
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> sample date string
 
660
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> sample date string
691
661
</simpara></listitem></varlistentry>
692
662
</variablelist></refsect2>
693
663
<refsect2 id="rb-entry-view-resort-model" role="function">
694
664
<title>rb_entry_view_resort_model ()</title>
695
 
<indexterm zone="rb-entry-view-resort-model"><primary>rb_entry_view_resort_model</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_resort_model          (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
 
665
<indexterm zone="rb-entry-view-resort-model"><primary sortas="rb_entry_view_resort_model">rb_entry_view_resort_model</primary></indexterm><programlisting><link linkend="void">void</link>                rb_entry_view_resort_model          (<link linkend="RBEntryView">RBEntryView</link> *view);</programlisting>
696
666
<para>
697
667
Resorts the entries in the entry view.  Mostly to be used
698
668
when a new model is associated with the view.</para>
699
669
<para>
700
 
 
701
670
</para><variablelist role="params">
702
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
671
<varlistentry><term><parameter>view</parameter>&#160;:</term>
703
672
<listitem><simpara> a <link linkend="RBEntryView"><type>RBEntryView</type></link> to resort
704
673
</simpara></listitem></varlistentry>
705
674
</variablelist></refsect2>
707
676
</refsect1>
708
677
<refsect1 id="RBEntryView.property-details" role="property_details">
709
678
<title role="property_details.title">Property Details</title>
710
 
<refsect2 id="RBEntryView--db"><title>The <literal>&quot;db&quot;</literal> property</title>
711
 
<indexterm zone="RBEntryView--db"><primary>RBEntryView:db</primary></indexterm><programlisting>  &quot;db&quot;                       <link linkend="RhythmDB">RhythmDB</link>*             : Read / Write / Construct Only</programlisting>
 
679
<refsect2 id="RBEntryView--db" role="property"><title>The <literal>&quot;db&quot;</literal> property</title>
 
680
<indexterm zone="RBEntryView--db"><primary sortas="RBEntryView:db">RBEntryView:db</primary></indexterm><programlisting>  &quot;db&quot;                       <link linkend="RhythmDB">RhythmDB</link>*             : Read / Write / Construct Only</programlisting>
712
681
<para>
713
682
<link linkend="RhythmDB"><type>RhythmDB</type></link> instance</para>
714
683
<para>
715
 
 
716
684
</para></refsect2>
717
 
<refsect2 id="RBEntryView--is-drag-dest"><title>The <literal>&quot;is-drag-dest&quot;</literal> property</title>
718
 
<indexterm zone="RBEntryView--is-drag-dest"><primary>RBEntryView:is-drag-dest</primary></indexterm><programlisting>  &quot;is-drag-dest&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
 
685
<refsect2 id="RBEntryView--is-drag-dest" role="property"><title>The <literal>&quot;is-drag-dest&quot;</literal> property</title>
 
686
<indexterm zone="RBEntryView--is-drag-dest"><primary sortas="RBEntryView:is-drag-dest">RBEntryView:is-drag-dest</primary></indexterm><programlisting>  &quot;is-drag-dest&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
719
687
<para>
720
688
If TRUE, the view acts as a destination for drag and drop operations.</para>
721
689
<para>
722
 
 
723
690
</para><para>Default value: FALSE</para>
724
691
</refsect2>
725
 
<refsect2 id="RBEntryView--is-drag-source"><title>The <literal>&quot;is-drag-source&quot;</literal> property</title>
726
 
<indexterm zone="RBEntryView--is-drag-source"><primary>RBEntryView:is-drag-source</primary></indexterm><programlisting>  &quot;is-drag-source&quot;           <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
 
692
<refsect2 id="RBEntryView--is-drag-source" role="property"><title>The <literal>&quot;is-drag-source&quot;</literal> property</title>
 
693
<indexterm zone="RBEntryView--is-drag-source"><primary sortas="RBEntryView:is-drag-source">RBEntryView:is-drag-source</primary></indexterm><programlisting>  &quot;is-drag-source&quot;           <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
727
694
<para>
728
695
If TRUE, the view acts as a data source for drag and drop operations.</para>
729
696
<para>
730
 
 
731
697
</para><para>Default value: FALSE</para>
732
698
</refsect2>
733
 
<refsect2 id="RBEntryView--model"><title>The <literal>&quot;model&quot;</literal> property</title>
734
 
<indexterm zone="RBEntryView--model"><primary>RBEntryView:model</primary></indexterm><programlisting>  &quot;model&quot;                    <link linkend="RhythmDBQueryModel">RhythmDBQueryModel</link>*   : Read / Write</programlisting>
 
699
<refsect2 id="RBEntryView--model" role="property"><title>The <literal>&quot;model&quot;</literal> property</title>
 
700
<indexterm zone="RBEntryView--model"><primary sortas="RBEntryView:model">RBEntryView:model</primary></indexterm><programlisting>  &quot;model&quot;                    <link linkend="RhythmDBQueryModel">RhythmDBQueryModel</link>*   : Read / Write</programlisting>
735
701
<para>
736
702
The <link linkend="RhythmDBQueryModel"><type>RhythmDBQueryModel</type></link> backing the view</para>
737
703
<para>
738
 
 
739
704
</para></refsect2>
740
 
<refsect2 id="RBEntryView--playing-state"><title>The <literal>&quot;playing-state&quot;</literal> property</title>
741
 
<indexterm zone="RBEntryView--playing-state"><primary>RBEntryView:playing-state</primary></indexterm><programlisting>  &quot;playing-state&quot;            <link linkend="gint">gint</link>                  : Read / Write</programlisting>
 
705
<refsect2 id="RBEntryView--playing-state" role="property"><title>The <literal>&quot;playing-state&quot;</literal> property</title>
 
706
<indexterm zone="RBEntryView--playing-state"><primary sortas="RBEntryView:playing-state">RBEntryView:playing-state</primary></indexterm><programlisting>  &quot;playing-state&quot;            <link linkend="gint">gint</link>                  : Read / Write</programlisting>
742
707
<para>
743
708
Determines the icon to show in the 'playing' column next to the current
744
709
playing entry.</para>
745
710
<para>
746
 
 
747
711
</para><para>Allowed values: [0,2]</para>
748
712
<para>Default value: 0</para>
749
713
</refsect2>
750
 
<refsect2 id="RBEntryView--shell-player"><title>The <literal>&quot;shell-player&quot;</literal> property</title>
751
 
<indexterm zone="RBEntryView--shell-player"><primary>RBEntryView:shell-player</primary></indexterm><programlisting>  &quot;shell-player&quot;             <link linkend="RBShellPlayer">RBShellPlayer</link>*        : Read / Write / Construct Only</programlisting>
 
714
<refsect2 id="RBEntryView--shell-player" role="property"><title>The <literal>&quot;shell-player&quot;</literal> property</title>
 
715
<indexterm zone="RBEntryView--shell-player"><primary sortas="RBEntryView:shell-player">RBEntryView:shell-player</primary></indexterm><programlisting>  &quot;shell-player&quot;             <link linkend="RBShellPlayer">RBShellPlayer</link>*        : Read / Write / Construct Only</programlisting>
752
716
<para>
753
717
<link linkend="RBShellPlayer"><type>RBShellPlayer</type></link> instance</para>
754
718
<para>
755
 
 
756
719
</para></refsect2>
757
 
<refsect2 id="RBEntryView--sort-key"><title>The <literal>&quot;sort-key&quot;</literal> property</title>
758
 
<indexterm zone="RBEntryView--sort-key"><primary>RBEntryView:sort-key</primary></indexterm><programlisting>  &quot;sort-key&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
 
720
<refsect2 id="RBEntryView--sort-key" role="property"><title>The <literal>&quot;sort-key&quot;</literal> property</title>
 
721
<indexterm zone="RBEntryView--sort-key"><primary sortas="RBEntryView:sort-key">RBEntryView:sort-key</primary></indexterm><programlisting>  &quot;sort-key&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
759
722
<para>
760
723
The GConf key that controls the sort order for the view</para>
761
724
<para>
762
 
 
763
725
</para><para>Default value: ""</para>
764
726
</refsect2>
765
 
 
766
727
</refsect1>
767
728
 
768
729
<refsect1 id="RBEntryView.signal-details" role="signals">
769
730
<title role="signals.title">Signal Details</title>
770
 
<refsect2 id="RBEntryView-entries-replaced"><title>The <literal>&quot;entries-replaced&quot;</literal> signal</title>
771
 
<indexterm zone="RBEntryView-entries-replaced"><primary>RBEntryView::entries-replaced</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
 
731
<refsect2 id="RBEntryView-entries-replaced" role="signal"><title>The <literal>&quot;entries-replaced&quot;</literal> signal</title>
 
732
<indexterm zone="RBEntryView-entries-replaced"><primary sortas="RBEntryView::entries-replaced">RBEntryView::entries-replaced</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
772
733
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last</programlisting>
773
734
<para>
774
735
Emitted when the model backing the entry view is replaced.</para>
775
736
<para>
776
 
 
777
737
</para><variablelist role="params">
778
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
738
<varlistentry><term><parameter>view</parameter>&#160;:</term>
779
739
<listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link>
780
740
</simpara></listitem></varlistentry>
781
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
741
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
782
742
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
783
 
</variablelist></refsect2><refsect2 id="RBEntryView-entry-activated"><title>The <literal>&quot;entry-activated&quot;</literal> signal</title>
784
 
<indexterm zone="RBEntryView-entry-activated"><primary>RBEntryView::entry-activated</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link>   *view,
 
743
</variablelist></refsect2><refsect2 id="RBEntryView-entry-activated" role="signal"><title>The <literal>&quot;entry-activated&quot;</literal> signal</title>
 
744
<indexterm zone="RBEntryView-entry-activated"><primary sortas="RBEntryView::entry-activated">RBEntryView::entry-activated</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link>   *view,
785
745
                                                        <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
786
746
                                                        <link linkend="gpointer">gpointer</link>       user_data)      : Run Last</programlisting>
787
747
<para>
788
748
Emitted when an entry in the view is activated (by double clicking
789
749
or by various key presses)</para>
790
750
<para>
791
 
 
792
751
</para><variablelist role="params">
793
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
752
<varlistentry><term><parameter>view</parameter>&#160;:</term>
794
753
<listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link>
795
754
</simpara></listitem></varlistentry>
796
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
755
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
797
756
<listitem><simpara> the <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> that was activated
798
757
</simpara></listitem></varlistentry>
799
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
758
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
800
759
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
801
 
</variablelist></refsect2><refsect2 id="RBEntryView-entry-added"><title>The <literal>&quot;entry-added&quot;</literal> signal</title>
802
 
<indexterm zone="RBEntryView-entry-added"><primary>RBEntryView::entry-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link>   *view,
 
760
</variablelist></refsect2><refsect2 id="RBEntryView-entry-added" role="signal"><title>The <literal>&quot;entry-added&quot;</literal> signal</title>
 
761
<indexterm zone="RBEntryView-entry-added"><primary sortas="RBEntryView::entry-added">RBEntryView::entry-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link>   *view,
803
762
                                                        <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
804
763
                                                        <link linkend="gpointer">gpointer</link>       user_data)      : Run Last</programlisting>
805
764
<para>
806
765
Emitted when an entry is added to the view</para>
807
766
<para>
808
 
 
809
767
</para><variablelist role="params">
810
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
768
<varlistentry><term><parameter>view</parameter>&#160;:</term>
811
769
<listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link>
812
770
</simpara></listitem></varlistentry>
813
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
771
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
814
772
<listitem><simpara> the <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> that was added
815
773
</simpara></listitem></varlistentry>
816
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
774
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
817
775
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
818
 
</variablelist></refsect2><refsect2 id="RBEntryView-entry-deleted"><title>The <literal>&quot;entry-deleted&quot;</literal> signal</title>
819
 
<indexterm zone="RBEntryView-entry-deleted"><primary>RBEntryView::entry-deleted</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link>   *view,
 
776
</variablelist></refsect2><refsect2 id="RBEntryView-entry-deleted" role="signal"><title>The <literal>&quot;entry-deleted&quot;</literal> signal</title>
 
777
<indexterm zone="RBEntryView-entry-deleted"><primary sortas="RBEntryView::entry-deleted">RBEntryView::entry-deleted</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link>   *view,
820
778
                                                        <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
821
779
                                                        <link linkend="gpointer">gpointer</link>       user_data)      : Run Last</programlisting>
822
780
<para>
823
781
Emitted when an entry has been removed from the view</para>
824
782
<para>
825
 
 
826
783
</para><variablelist role="params">
827
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
784
<varlistentry><term><parameter>view</parameter>&#160;:</term>
828
785
<listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link>
829
786
</simpara></listitem></varlistentry>
830
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
787
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
831
788
<listitem><simpara> the <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> that was removed
832
789
</simpara></listitem></varlistentry>
833
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
790
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
834
791
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
835
 
</variablelist></refsect2><refsect2 id="RBEntryView-have-selection-changed"><title>The <literal>&quot;have-selection-changed&quot;</literal> signal</title>
836
 
<indexterm zone="RBEntryView-have-selection-changed"><primary>RBEntryView::have-selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
 
792
</variablelist></refsect2><refsect2 id="RBEntryView-have-selection-changed" role="signal"><title>The <literal>&quot;have-selection-changed&quot;</literal> signal</title>
 
793
<indexterm zone="RBEntryView-have-selection-changed"><primary sortas="RBEntryView::have-selection-changed">RBEntryView::have-selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
837
794
                                                        <link linkend="gboolean">gboolean</link>     have_selection,
838
795
                                                        <link linkend="gpointer">gpointer</link>     user_data)           : Run Last</programlisting>
839
796
<para>
840
797
Emitted when the user first selects a row, or when no rows are selected
841
798
any more.</para>
842
799
<para>
843
 
 
844
800
</para><variablelist role="params">
845
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
801
<varlistentry><term><parameter>view</parameter>&#160;:</term>
846
802
<listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link>
847
803
</simpara></listitem></varlistentry>
848
 
<varlistentry><term><parameter>have_selection</parameter>&nbsp;:</term>
 
804
<varlistentry><term><parameter>have_selection</parameter>&#160;:</term>
849
805
<listitem><simpara> TRUE if one or more rows are selected
850
806
</simpara></listitem></varlistentry>
851
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
807
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
852
808
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
853
 
</variablelist></refsect2><refsect2 id="RBEntryView-selection-changed"><title>The <literal>&quot;selection-changed&quot;</literal> signal</title>
854
 
<indexterm zone="RBEntryView-selection-changed"><primary>RBEntryView::selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
 
809
</variablelist></refsect2><refsect2 id="RBEntryView-selection-changed" role="signal"><title>The <literal>&quot;selection-changed&quot;</literal> signal</title>
 
810
<indexterm zone="RBEntryView-selection-changed"><primary sortas="RBEntryView::selection-changed">RBEntryView::selection-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
855
811
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last</programlisting>
856
812
<para>
857
813
Emitted when the set of selected entries changes</para>
858
814
<para>
859
 
 
860
815
</para><variablelist role="params">
861
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
816
<varlistentry><term><parameter>view</parameter>&#160;:</term>
862
817
<listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link>
863
818
</simpara></listitem></varlistentry>
864
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
819
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
865
820
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
866
 
</variablelist></refsect2><refsect2 id="RBEntryView-show-popup"><title>The <literal>&quot;show-popup&quot;</literal> signal</title>
867
 
<indexterm zone="RBEntryView-show-popup"><primary>RBEntryView::show-popup</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
 
821
</variablelist></refsect2><refsect2 id="RBEntryView-show-popup" role="signal"><title>The <literal>&quot;show-popup&quot;</literal> signal</title>
 
822
<indexterm zone="RBEntryView-show-popup"><primary sortas="RBEntryView::show-popup">RBEntryView::show-popup</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
868
823
                                                        <link linkend="gboolean">gboolean</link>     over_entry,
869
824
                                                        <link linkend="gpointer">gpointer</link>     user_data)       : Run Last</programlisting>
870
825
<para>
871
826
Emitted when the user performs an action that should result in a
872
 
popup menu appearing.  If the action was a mouse button click, 
 
827
popup menu appearing.  If the action was a mouse button click,
873
828
over_entry is FALSE if the mouse pointer was in the blank space after
874
829
the last row in the view.  If the action was a key press, over_entry
875
830
is FALSE if no rows in the view are selected.</para>
876
831
<para>
877
 
 
878
832
</para><variablelist role="params">
879
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
833
<varlistentry><term><parameter>view</parameter>&#160;:</term>
880
834
<listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link>
881
835
</simpara></listitem></varlistentry>
882
 
<varlistentry><term><parameter>over_entry</parameter>&nbsp;:</term>
 
836
<varlistentry><term><parameter>over_entry</parameter>&#160;:</term>
883
837
<listitem><simpara> if TRUE, the popup request was made while pointing
884
838
at an entry in the view
885
839
</simpara></listitem></varlistentry>
886
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
840
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
887
841
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
888
 
</variablelist></refsect2><refsect2 id="RBEntryView-sort-order-changed"><title>The <literal>&quot;sort-order-changed&quot;</literal> signal</title>
889
 
<indexterm zone="RBEntryView-sort-order-changed"><primary>RBEntryView::sort-order-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
 
842
</variablelist></refsect2><refsect2 id="RBEntryView-sort-order-changed" role="signal"><title>The <literal>&quot;sort-order-changed&quot;</literal> signal</title>
 
843
<indexterm zone="RBEntryView-sort-order-changed"><primary sortas="RBEntryView::sort-order-changed">RBEntryView::sort-order-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="RBEntryView">RBEntryView</link> *view,
890
844
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last</programlisting>
891
845
<para>
892
846
Emitted when the user changes the sort order for the view</para>
893
847
<para>
894
 
 
895
848
</para><variablelist role="params">
896
 
<varlistentry><term><parameter>view</parameter>&nbsp;:</term>
 
849
<varlistentry><term><parameter>view</parameter>&#160;:</term>
897
850
<listitem><simpara> the <link linkend="RBEntryView"><type>RBEntryView</type></link>
898
851
</simpara></listitem></varlistentry>
899
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
852
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
900
853
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
901
854
</variablelist></refsect2>
902
855
</refsect1>