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
|
<?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="RBLibrarySource">
<refmeta>
<refentrytitle role="top_of_page" id="RBLibrarySource.top_of_page">rb-library-source</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-library-source</refname>
<refpurpose>main library source, containing all local songs</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBLibrarySource.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBLibrarySource-struct">RBLibrarySource</link>;
<link linkend="RBLibrarySourceClass">RBLibrarySourceClass</link>;
<link linkend="RBSource">RBSource</link>* <link linkend="rb-library-source-new">rb_library_source_new</link> (<link linkend="RBShell">RBShell</link> *shell);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBLibrarySource.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>
+----<link linkend="RBBrowserSource">RBBrowserSource</link>
+----RBLibrarySource
</synopsis>
</refsect1>
<refsect1 id="RBLibrarySource.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
RBLibrarySource implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="RBLibrarySource.description" role="desc">
<title role="desc.title">Description</title>
<para>
The library source contains all local songs that have been imported
into the database.
</para>
<para>
It provides a preferences page for configuring the library location,
the directory structure to use when transferring new files into
the library from another source, and the preferred audio encoding
to use.
</para>
<para>
If multiple library locations are set in GConf, the library source
creates a child source for each location, which will only show
files found under that location.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBLibrarySource.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBLibrarySource-struct" role="struct">
<title>RBLibrarySource</title>
<indexterm zone="RBLibrarySource-struct"><primary>RBLibrarySource</primary></indexterm><programlisting>typedef struct _RBLibrarySource RBLibrarySource;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBLibrarySourceClass" role="struct">
<title>RBLibrarySourceClass</title>
<indexterm zone="RBLibrarySourceClass"><primary>RBLibrarySourceClass</primary></indexterm><programlisting>typedef struct {
RBBrowserSourceClass parent;
} RBLibrarySourceClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-library-source-new" role="function">
<title>rb_library_source_new ()</title>
<indexterm zone="rb-library-source-new"><primary>rb_library_source_new</primary></indexterm><programlisting><link linkend="RBSource">RBSource</link>* rb_library_source_new (<link linkend="RBShell">RBShell</link> *shell);</programlisting>
<para>
Creates and returns the <link linkend="RBLibrarySource"><type>RBLibrarySource</type></link> instance</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>shell</parameter> :</term>
<listitem><simpara> the <link linkend="RBShell"><type>RBShell</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="RBLibrarySource"><type>RBLibrarySource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|