~ubuntu-branches/ubuntu/oneiric/rhythmbox/oneiric

« back to all changes in this revision

Viewing changes to doc/reference/html/RBBrowserSource.html

  • Committer: Bazaar Package Importer
  • Author(s): Rico Tzschichholz
  • Date: 2011-07-29 16:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 191.
  • Revision ID: james.westby@ubuntu.com-20110729164138-wwicy8nqalm18ck7
Tags: upstream-2.90.1~20110802
Import upstream version 2.90.1~20110802

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>RBBrowserSource</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
 
8
<link rel="up" href="ch06.html" title="Sources">
 
9
<link rel="prev" href="RBAutoPlaylistSource.html" title="RBAutoPlaylistSource">
 
10
<link rel="next" href="RBImportErrorsSource.html" title="RBImportErrorsSource">
 
11
<meta name="generator" content="GTK-Doc V1.17 (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="RBAutoPlaylistSource.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch06.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">Rhythmbox Development Reference Manual</th>
 
21
<td><a accesskey="n" href="RBImportErrorsSource.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="#RBBrowserSource.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#RBBrowserSource.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#RBBrowserSource.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#RBBrowserSource.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#RBBrowserSource.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="RBBrowserSource"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="RBBrowserSource.top_of_page"></a>RBBrowserSource</span></h2>
 
40
<p>RBBrowserSource — base class for sources that include genre/artist/album browsers</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="RBBrowserSource.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">struct              <a class="link" href="RBBrowserSource.html#RBBrowserSource-struct" title="struct RBBrowserSource">RBBrowserSource</a>;
 
47
struct              <a class="link" href="RBBrowserSource.html#RBBrowserSourceClass" title="struct RBBrowserSourceClass">RBBrowserSourceClass</a>;
 
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBBrowserSource.html#rb-browser-source-has-drop-support" title="rb_browser_source_has_drop_support ()">rb_browser_source_has_drop_support</a>  (<em class="parameter"><code><a class="link" href="RBBrowserSource.html" title="RBBrowserSource"><span class="type">RBBrowserSource</span></a> *source</code></em>);
 
49
</pre>
 
50
</div>
 
51
<div class="refsect1">
 
52
<a name="RBBrowserSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
53
<pre class="synopsis">
 
54
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
55
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
56
         +----<a href="http://library.gnome.org/devel/gtk/GtkWidget.html">GtkWidget</a>
 
57
               +----<a href="http://library.gnome.org/devel/gtk/GtkContainer.html">GtkContainer</a>
 
58
                     +----<a href="http://library.gnome.org/devel/gtk/GtkBox.html">GtkBox</a>
 
59
                           +----<a href="http://library.gnome.org/devel/gtk/GtkHBox.html">GtkHBox</a>
 
60
                                 +----RBDisplayPage
 
61
                                       +----<a class="link" href="RBSource.html" title="RBSource">RBSource</a>
 
62
                                             +----RBBrowserSource
 
63
                                                   +----<a class="link" href="RBLibrarySource.html" title="RBLibrarySource">RBLibrarySource</a>
 
64
                                                   +----<a class="link" href="RBRemovableMediaSource.html" title="RBRemovableMediaSource">RBRemovableMediaSource</a>
 
65
</pre>
 
66
</div>
 
67
<div class="refsect1">
 
68
<a name="RBBrowserSource.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
69
<p>
 
70
RBBrowserSource implements
 
71
 AtkImplementorIface,  <a href="http://library.gnome.org/devel/gtk/GtkBuildable.html">GtkBuildable</a> and  <a href="http://library.gnome.org/devel/gtk/gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
 
72
</div>
 
73
<div class="refsect1">
 
74
<a name="RBBrowserSource.properties"></a><h2>Properties</h2>
 
75
<pre class="synopsis">
 
76
  "<a class="link" href="RBBrowserSource.html#RBBrowserSource--populate" title='The "populate" property'>populate</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
 
77
</pre>
 
78
</div>
 
79
<div class="refsect1">
 
80
<a name="RBBrowserSource.description"></a><h2>Description</h2>
 
81
<p>
 
82
This class simplifies implementation of sources that include genre/artist/album browsers.
 
83
It also handles searching (using the search box) and a few other UI niceties.
 
84
</p>
 
85
<p>
 
86
Instances of browser sources will use a query that will match all entries of
 
87
the entry type assigned to the source, so it's mostly suited for sources that
 
88
have an entry type of their own.
 
89
</p>
 
90
</div>
 
91
<div class="refsect1">
 
92
<a name="RBBrowserSource.details"></a><h2>Details</h2>
 
93
<div class="refsect2">
 
94
<a name="RBBrowserSource-struct"></a><h3>struct RBBrowserSource</h3>
 
95
<pre class="programlisting">struct RBBrowserSource;</pre>
 
96
<p>
 
97
</p>
 
98
</div>
 
99
<hr>
 
100
<div class="refsect2">
 
101
<a name="RBBrowserSourceClass"></a><h3>struct RBBrowserSourceClass</h3>
 
102
<pre class="programlisting">struct RBBrowserSourceClass {
 
103
        RBSourceClass parent;
 
104
 
 
105
        void            (*impl_pack_paned)              (RBBrowserSource *source, GtkWidget *paned);
 
106
        gboolean (*impl_has_drop_support) (RBBrowserSource *source);
 
107
        void            (*impl_show_entry_popup) (RBBrowserSource *source);
 
108
};
 
109
</pre>
 
110
<p>
 
111
</p>
 
112
</div>
 
113
<hr>
 
114
<div class="refsect2">
 
115
<a name="rb-browser-source-has-drop-support"></a><h3>rb_browser_source_has_drop_support ()</h3>
 
116
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_browser_source_has_drop_support  (<em class="parameter"><code><a class="link" href="RBBrowserSource.html" title="RBBrowserSource"><span class="type">RBBrowserSource</span></a> *source</code></em>);</pre>
 
117
<p>
 
118
This is a virtual method that should be implemented by subclasses.  It returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
 
119
if drag and drop target support for the source should be activated.
 
120
</p>
 
121
<div class="variablelist"><table border="0">
 
122
<col align="left" valign="top">
 
123
<tbody>
 
124
<tr>
 
125
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
 
126
<td>a <a class="link" href="RBBrowserSource.html" title="RBBrowserSource"><span class="type">RBBrowserSource</span></a>
 
127
</td>
 
128
</tr>
 
129
<tr>
 
130
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
131
<td>
 
132
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if drop support should be activated</td>
 
133
</tr>
 
134
</tbody>
 
135
</table></div>
 
136
</div>
 
137
</div>
 
138
<div class="refsect1">
 
139
<a name="RBBrowserSource.property-details"></a><h2>Property Details</h2>
 
140
<div class="refsect2">
 
141
<a name="RBBrowserSource--populate"></a><h3>The <code class="literal">"populate"</code> property</h3>
 
142
<pre class="programlisting">  "populate"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 
143
<p>whether to populate the source.</p>
 
144
<p>Default value: TRUE</p>
 
145
</div>
 
146
</div>
 
147
</div>
 
148
<div class="footer">
 
149
<hr>
 
150
          Generated by GTK-Doc V1.17</div>
 
151
</body>
 
152
</html>
 
 
b'\\ No newline at end of file'