1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="RBImportErrorsSource">
<refmeta>
<refentrytitle role="top_of_page" id="RBImportErrorsSource.top_of_page">RBImportErrorsSource</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>RBImportErrorsSource</refname>
<refpurpose>source for displaying import errors</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBImportErrorsSource.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBImportErrorsSource-struct">RBImportErrorsSource</link>;
<link linkend="RBImportErrorsSourceClass">RBImportErrorsSourceClass</link>;
<link linkend="RBSource">RBSource</link>* <link linkend="rb-import-errors-source-new">rb_import_errors_source_new</link> (<link linkend="RBShell">RBShell</link> *shell,
<link linkend="RhythmDBEntryType">RhythmDBEntryType</link> entry_type);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBImportErrorsSource.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBox">GtkBox</link>
+----<link linkend="GtkHBox">GtkHBox</link>
+----<link linkend="RBSource">RBSource</link>
+----RBImportErrorsSource
</synopsis>
</refsect1>
<refsect1 id="RBImportErrorsSource.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
RBImportErrorsSource implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="RBImportErrorsSource.description" role="desc">
<title role="desc.title">Description</title>
<para>
This source is used to display the names of files that could not
be imported into the library, along with any error messages from
the import process. When there are no import errors to display,
the source is hidden.
</para>
<para>
The source allows the user to delete the import error entries,
and to move the files to the trash.
</para>
<para>
When a file import fails, a <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> is created with a
specific entry type for import errors. This source uses a query
model that matches all such import error entries.
</para>
<para>
To keep import errors from removable devices separate from those
from the main library, multiple import error sources can be created,
with separate entry types. The generic audio player plugin, for
example, creates an import error source for each device and inserts
it into the source list as a child of the main source for the device.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBImportErrorsSource.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBImportErrorsSource-struct" role="struct">
<title>RBImportErrorsSource</title>
<indexterm zone="RBImportErrorsSource-struct"><primary>RBImportErrorsSource</primary></indexterm><programlisting>typedef struct _RBImportErrorsSource RBImportErrorsSource;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBImportErrorsSourceClass" role="struct">
<title>RBImportErrorsSourceClass</title>
<indexterm zone="RBImportErrorsSourceClass"><primary>RBImportErrorsSourceClass</primary></indexterm><programlisting>typedef struct {
RBSourceClass parent;
} RBImportErrorsSourceClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-import-errors-source-new" role="function">
<title>rb_import_errors_source_new ()</title>
<indexterm zone="rb-import-errors-source-new"><primary>rb_import_errors_source_new</primary></indexterm><programlisting><link linkend="RBSource">RBSource</link>* rb_import_errors_source_new (<link linkend="RBShell">RBShell</link> *shell,
<link linkend="RhythmDBEntryType">RhythmDBEntryType</link> entry_type);</programlisting>
<para>
Creates a new source for displaying import errors of the
specified type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>shell</parameter> :</term>
<listitem><simpara> the <link linkend="RBShell"><type>RBShell</type></link> instance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry_type</parameter> :</term>
<listitem><simpara> the entry type to display in the source
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new import error source
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
