~ubuntu-branches/ubuntu/quantal/rhythmbox/quantal-proposed

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Didier Roche
  • Date: 2012-01-17 16:56:40 UTC
  • mfrom: (1.1.62)
  • Revision ID: package-import@ubuntu.com-20120117165640-pr034mkhmti3efh6
Tags: 2.95-0ubuntu1
* New upstream release:
  - wrong shortcut for Show / Hide the Queue Sidebar (LP: #461279)
* debian/watch:
  - update to latest url    
* debian/patches/00_fix_for_glib_2.32.patch:
  - was taken upstream, removed

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch05.html" title="Shell">
9
9
<link rel="prev" href="RBShellPreferences.html" title="RBShellPreferences">
10
10
<link rel="next" href="rhythmbox-RBSourceHeader.html" title="RBSourceHeader">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
47
47
<a name="RBShell.synopsis"></a><h2>Synopsis</h2>
48
48
<pre class="synopsis">struct              <a class="link" href="RBShell.html#RBShell-struct" title="struct RBShell">RBShell</a>;
49
49
struct              <a class="link" href="RBShell.html#RBShellClass" title="struct RBShellClass">RBShellClass</a>;
50
 
<a class="link" href="RBShell.html" title="RBShell"><span class="returnvalue">RBShell</span></a> *           <a class="link" href="RBShell.html#rb-shell-new" title="rb_shell_new ()">rb_shell_new</a>                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> autostarted</code></em>,
 
50
<a class="link" href="RBShell.html" title="RBShell"><span class="returnvalue">RBShell</span></a> *           <a class="link" href="RBShell.html#rb-shell-new" title="rb_shell_new ()">rb_shell_new</a>                        (<em class="parameter"><code><span class="type">gboolean</span> autostarted</code></em>,
51
51
                                                         <em class="parameter"><code><span class="type">int</span> *argc</code></em>,
52
52
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);
53
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBShell.html#rb-shell-present" title="rb_shell_present ()">rb_shell_present</a>                    (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
53
<span class="returnvalue">gboolean</span>            <a class="link" href="RBShell.html#rb-shell-present" title="rb_shell_present ()">rb_shell_present</a>                    (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
54
54
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>,
55
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
55
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
56
56
<a class="link" href="RBSource.html" title="RBSource"><span class="returnvalue">RBSource</span></a> *          <a class="link" href="RBShell.html#rb-shell-guess-source-for-uri" title="rb_shell_guess_source_for_uri ()">rb_shell_guess_source_for_uri</a>       (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
57
57
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>);
58
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBShell.html#rb-shell-add-uri" title="rb_shell_add_uri ()">rb_shell_add_uri</a>                    (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
58
<span class="returnvalue">gboolean</span>            <a class="link" href="RBShell.html#rb-shell-add-uri" title="rb_shell_add_uri ()">rb_shell_add_uri</a>                    (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
59
59
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
60
60
                                                         <em class="parameter"><code>const <span class="type">char</span> *title</code></em>,
61
61
                                                         <em class="parameter"><code>const <span class="type">char</span> *genre</code></em>,
62
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
63
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBShell.html#rb-shell-load-uri" title="rb_shell_load_uri ()">rb_shell_load_uri</a>                   (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
62
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
63
<span class="returnvalue">gboolean</span>            <a class="link" href="RBShell.html#rb-shell-load-uri" title="rb_shell_load_uri ()">rb_shell_load_uri</a>                   (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
64
64
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
65
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> play</code></em>,
66
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
65
                                                         <em class="parameter"><code><span class="type">gboolean</span> play</code></em>,
 
66
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
67
67
<span class="returnvalue">void</span>                <a class="link" href="RBShell.html#rb-shell-toggle-visibility" title="rb_shell_toggle_visibility ()">rb_shell_toggle_visibility</a>          (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);
68
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBShell.html#rb-shell-get-song-properties" title="rb_shell_get_song_properties ()">rb_shell_get_song_properties</a>        (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
68
<span class="returnvalue">gboolean</span>            <a class="link" href="RBShell.html#rb-shell-get-song-properties" title="rb_shell_get_song_properties ()">rb_shell_get_song_properties</a>        (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
69
69
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
70
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **properties</code></em>,
71
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
72
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBShell.html#rb-shell-set-song-property" title="rb_shell_set_song_property ()">rb_shell_set_song_property</a>          (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
70
                                                         <em class="parameter"><code><span class="type">GHashTable</span> **properties</code></em>,
 
71
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
72
<span class="returnvalue">gboolean</span>            <a class="link" href="RBShell.html#rb-shell-set-song-property" title="rb_shell_set_song_property ()">rb_shell_set_song_property</a>          (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
73
73
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
74
74
                                                         <em class="parameter"><code>const <span class="type">char</span> *propname</code></em>,
75
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
76
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
77
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBShell.html#rb-shell-quit" title="rb_shell_quit ()">rb_shell_quit</a>                       (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
78
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
79
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBShell.html#rb-shell-do-notify" title="rb_shell_do_notify ()">rb_shell_do_notify</a>                  (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
80
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> requested</code></em>,
81
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
75
                                                         <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>,
 
76
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
77
<span class="returnvalue">gboolean</span>            <a class="link" href="RBShell.html#rb-shell-quit" title="rb_shell_quit ()">rb_shell_quit</a>                       (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
78
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
79
<span class="returnvalue">gboolean</span>            <a class="link" href="RBShell.html#rb-shell-do-notify" title="rb_shell_do_notify ()">rb_shell_do_notify</a>                  (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
80
                                                         <em class="parameter"><code><span class="type">gboolean</span> requested</code></em>,
 
81
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
82
82
<span class="returnvalue">void</span>                <a class="link" href="RBShell.html#rb-shell-register-entry-type-for-source" title="rb_shell_register_entry_type_for_source ()">rb_shell_register_entry_type_for_source</a>
83
83
                                                        (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
84
84
                                                         <em class="parameter"><code><a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *source</code></em>,
85
85
                                                         <em class="parameter"><code><a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a> *type</code></em>);
86
86
<a class="link" href="RBSource.html" title="RBSource"><span class="returnvalue">RBSource</span></a> *          <a class="link" href="RBShell.html#rb-shell-get-source-by-entry-type" title="rb_shell_get_source_by_entry_type ()">rb_shell_get_source_by_entry_type</a>   (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
87
87
                                                         <em class="parameter"><code><a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a> *type</code></em>);
88
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBShell.html#rb-shell-get-party-mode" title="rb_shell_get_party_mode ()">rb_shell_get_party_mode</a>             (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);
 
88
<span class="returnvalue">gboolean</span>            <a class="link" href="RBShell.html#rb-shell-get-party-mode" title="rb_shell_get_party_mode ()">rb_shell_get_party_mode</a>             (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);
89
89
<span class="returnvalue">void</span>                <a class="link" href="RBShell.html#rb-shell-add-widget" title="rb_shell_add_widget ()">rb_shell_add_widget</a>                 (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
90
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
90
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>,
91
91
                                                         <em class="parameter"><code><span class="type">RBShellUILocation</span> location</code></em>,
92
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> expand</code></em>,
93
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fill</code></em>);
 
92
                                                         <em class="parameter"><code><span class="type">gboolean</span> expand</code></em>,
 
93
                                                         <em class="parameter"><code><span class="type">gboolean</span> fill</code></em>);
94
94
<span class="returnvalue">void</span>                <a class="link" href="RBShell.html#rb-shell-remove-widget" title="rb_shell_remove_widget ()">rb_shell_remove_widget</a>              (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
95
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
95
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>,
96
96
                                                         <em class="parameter"><code><span class="type">RBShellUILocation</span> location</code></em>);
97
97
</pre>
98
98
</div>
99
99
<div class="refsect1">
100
100
<a name="RBShell.object-hierarchy"></a><h2>Object Hierarchy</h2>
101
101
<pre class="synopsis">
102
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
103
 
   +----<a href="http://library.gnome.org/devel/gio/unstable/GApplication.html">GApplication</a>
104
 
         +----<a href="http://library.gnome.org/devel/gtk/GtkApplication.html">GtkApplication</a>
 
102
  GObject
 
103
   +----GApplication
 
104
         +----GtkApplication
105
105
               +----RBShell
106
106
</pre>
107
107
</div>
109
109
<a name="RBShell.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
110
110
<p>
111
111
RBShell implements
112
 
 <a href="http://library.gnome.org/devel/gio/unstable/GActionGroup.html">GActionGroup</a> and  <a href="http://library.gnome.org/devel/gio/unstable/GActionMap.html">GActionMap</a>.</p>
 
112
 GActionGroup.</p>
113
113
</div>
114
114
<div class="refsect1">
115
115
<a name="RBShell.properties"></a><h2>Properties</h2>
116
116
<pre class="synopsis">
117
 
  "<a class="link" href="RBShell.html#RBShell--autostarted" title='The "autostarted" property'>autostarted</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only
 
117
  "<a class="link" href="RBShell.html#RBShell--autostarted" title='The "autostarted" property'>autostarted</a>"              <span class="type">gboolean</span>              : Read / Write / Construct Only
118
118
  "<a class="link" href="RBShell.html#RBShell--clipboard" title='The "clipboard" property'>clipboard</a>"                <a class="link" href="RBShellClipboard.html" title="RBShellClipboard"><span class="type">RBShellClipboard</span></a>*     : Read
119
119
  "<a class="link" href="RBShell.html#RBShell--db" title='The "db" property'>db</a>"                       <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a>*             : Read
120
 
  "<a class="link" href="RBShell.html#RBShell--disable-plugins" title='The "disable-plugins" property'>disable-plugins</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only
 
120
  "<a class="link" href="RBShell.html#RBShell--disable-plugins" title='The "disable-plugins" property'>disable-plugins</a>"          <span class="type">gboolean</span>              : Read / Write / Construct Only
121
121
  "<a class="link" href="RBShell.html#RBShell--display-page-model" title='The "display-page-model" property'>display-page-model</a>"       <span class="type">RBDisplayPageModel</span>*   : Read
122
122
  "<a class="link" href="RBShell.html#RBShell--display-page-tree" title='The "display-page-tree" property'>display-page-tree</a>"        <span class="type">RBDisplayPageTree</span>*    : Read
123
 
  "<a class="link" href="RBShell.html#RBShell--dry-run" title='The "dry-run" property'>dry-run</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only
 
123
  "<a class="link" href="RBShell.html#RBShell--dry-run" title='The "dry-run" property'>dry-run</a>"                  <span class="type">gboolean</span>              : Read / Write / Construct Only
124
124
  "<a class="link" href="RBShell.html#RBShell--library-source" title='The "library-source" property'>library-source</a>"           <a class="link" href="RBLibrarySource.html" title="RBLibrarySource"><span class="type">RBLibrarySource</span></a>*      : Read
125
 
  "<a class="link" href="RBShell.html#RBShell--no-registration" title='The "no-registration" property'>no-registration</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only
126
 
  "<a class="link" href="RBShell.html#RBShell--no-update" title='The "no-update" property'>no-update</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only
 
125
  "<a class="link" href="RBShell.html#RBShell--no-registration" title='The "no-registration" property'>no-registration</a>"          <span class="type">gboolean</span>              : Read / Write / Construct Only
 
126
  "<a class="link" href="RBShell.html#RBShell--no-update" title='The "no-update" property'>no-update</a>"                <span class="type">gboolean</span>              : Read / Write / Construct Only
127
127
  "<a class="link" href="RBShell.html#RBShell--playlist-manager" title='The "playlist-manager" property'>playlist-manager</a>"         <a class="link" href="RBPlaylistManager.html" title="RBPlaylistManager"><span class="type">RBPlaylistManager</span></a>*    : Read
128
 
  "<a class="link" href="RBShell.html#RBShell--playlists-file" title='The "playlists-file" property'>playlists-file</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
128
  "<a class="link" href="RBShell.html#RBShell--playlists-file" title='The "playlists-file" property'>playlists-file</a>"           <span class="type">gchar</span>*                : Read / Write / Construct Only
129
129
  "<a class="link" href="RBShell.html#RBShell--prefs" title='The "prefs" property'>prefs</a>"                    <a class="link" href="RBShellPreferences.html" title="RBShellPreferences"><span class="type">RBShellPreferences</span></a>*   : Read
130
130
  "<a class="link" href="RBShell.html#RBShell--queue-source" title='The "queue-source" property'>queue-source</a>"             <a class="link" href="RBPlayQueueSource.html" title="RBPlayQueueSource"><span class="type">RBPlayQueueSource</span></a>*    : Read
131
131
  "<a class="link" href="RBShell.html#RBShell--removable-media-manager" title='The "removable-media-manager" property'>removable-media-manager</a>"  <a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager"><span class="type">RBRemovableMediaManager</span></a>*  : Read
132
 
  "<a class="link" href="RBShell.html#RBShell--rhythmdb-file" title='The "rhythmdb-file" property'>rhythmdb-file</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
 
132
  "<a class="link" href="RBShell.html#RBShell--rhythmdb-file" title='The "rhythmdb-file" property'>rhythmdb-file</a>"            <span class="type">gchar</span>*                : Read / Write / Construct Only
133
133
  "<a class="link" href="RBShell.html#RBShell--selected-page" title='The "selected-page" property'>selected-page</a>"            <span class="type">RBDisplayPage</span>*        : Read
134
134
  "<a class="link" href="RBShell.html#RBShell--shell-player" title='The "shell-player" property'>shell-player</a>"             <a class="link" href="RBShellPlayer.html" title="RBShellPlayer"><span class="type">RBShellPlayer</span></a>*        : Read
135
135
  "<a class="link" href="RBShell.html#RBShell--track-transfer-queue" title='The "track-transfer-queue" property'>track-transfer-queue</a>"     <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a>*  : Read
136
 
  "<a class="link" href="RBShell.html#RBShell--ui-manager" title='The "ui-manager" property'>ui-manager</a>"               <a href="http://library.gnome.org/devel/gtk/GtkUIManager.html"><span class="type">GtkUIManager</span></a>*         : Read
137
 
  "<a class="link" href="RBShell.html#RBShell--visibility" title='The "visibility" property'>visibility</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
138
 
  "<a class="link" href="RBShell.html#RBShell--window" title='The "window" property'>window</a>"                   <a href="http://library.gnome.org/devel/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a>*            : Read
 
136
  "<a class="link" href="RBShell.html#RBShell--ui-manager" title='The "ui-manager" property'>ui-manager</a>"               <span class="type">GtkUIManager</span>*         : Read
 
137
  "<a class="link" href="RBShell.html#RBShell--visibility" title='The "visibility" property'>visibility</a>"               <span class="type">gboolean</span>              : Read / Write
 
138
  "<a class="link" href="RBShell.html#RBShell--window" title='The "window" property'>window</a>"                   <span class="type">GtkWindow</span>*            : Read
139
139
</pre>
140
140
</div>
141
141
<div class="refsect1">
142
142
<a name="RBShell.signals"></a><h2>Signals</h2>
143
143
<pre class="synopsis">
144
 
  "<a class="link" href="RBShell.html#RBShell-create-song-info" title='The "create-song-info" signal'>create-song-info</a>"                               : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
145
 
  "<a class="link" href="RBShell.html#RBShell-notify-custom" title='The "notify-custom" signal'>notify-custom</a>"                                  : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
146
 
  "<a class="link" href="RBShell.html#RBShell-notify-playing-entry" title='The "notify-playing-entry" signal'>notify-playing-entry</a>"                           : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
147
 
  "<a class="link" href="RBShell.html#RBShell-visibility-changed" title='The "visibility-changed" signal'>visibility-changed</a>"                             : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
148
 
  "<a class="link" href="RBShell.html#RBShell-visibility-changing" title='The "visibility-changing" signal'>visibility-changing</a>"                            : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
 
144
  "<a class="link" href="RBShell.html#RBShell-create-song-info" title='The "create-song-info" signal'>create-song-info</a>"                               : <code class="literal">Run Last</code>
 
145
  "<a class="link" href="RBShell.html#RBShell-notify-custom" title='The "notify-custom" signal'>notify-custom</a>"                                  : <code class="literal">Run Last</code>
 
146
  "<a class="link" href="RBShell.html#RBShell-notify-playing-entry" title='The "notify-playing-entry" signal'>notify-playing-entry</a>"                           : <code class="literal">Run Last</code>
 
147
  "<a class="link" href="RBShell.html#RBShell-visibility-changed" title='The "visibility-changed" signal'>visibility-changed</a>"                             : <code class="literal">Run Last</code>
 
148
  "<a class="link" href="RBShell.html#RBShell-visibility-changing" title='The "visibility-changing" signal'>visibility-changing</a>"                            : <code class="literal">Run Last</code>
149
149
</pre>
150
150
</div>
151
151
<div class="refsect1">
184
184
<hr>
185
185
<div class="refsect2">
186
186
<a name="rb-shell-new"></a><h3>rb_shell_new ()</h3>
187
 
<pre class="programlisting"><a class="link" href="RBShell.html" title="RBShell"><span class="returnvalue">RBShell</span></a> *           rb_shell_new                        (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> autostarted</code></em>,
 
187
<pre class="programlisting"><a class="link" href="RBShell.html" title="RBShell"><span class="returnvalue">RBShell</span></a> *           rb_shell_new                        (<em class="parameter"><code><span class="type">gboolean</span> autostarted</code></em>,
188
188
                                                         <em class="parameter"><code><span class="type">int</span> *argc</code></em>,
189
189
                                                         <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);</pre>
190
190
<p>
197
197
<tr>
198
198
<td><p><span class="term"><em class="parameter"><code>autostarted</code></em> :</span></p></td>
199
199
<td>
200
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if autostarted by the session manager</td>
 
200
<code class="literal">TRUE</code> if autostarted by the session manager</td>
201
201
</tr>
202
202
<tr>
203
203
<td><p><span class="term"><em class="parameter"><code>argc</code></em> :</span></p></td>
217
217
<hr>
218
218
<div class="refsect2">
219
219
<a name="rb-shell-present"></a><h3>rb_shell_present ()</h3>
220
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_shell_present                    (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
220
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_shell_present                    (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
221
221
                                                         <em class="parameter"><code><span class="type">guint32</span> timestamp</code></em>,
222
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
222
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
223
223
<p>
224
 
Attempts to display the main window to the user.  See <a href="http://library.gnome.org/devel/gtk/GtkWindow.html#gtk-window-present"><span class="type">gtk_window_present</span></a> for details.
 
224
Attempts to display the main window to the user.  See <span class="type">gtk_window_present</span> for details.
225
225
</p>
226
226
<div class="variablelist"><table border="0">
227
227
<col align="left" valign="top">
279
279
<hr>
280
280
<div class="refsect2">
281
281
<a name="rb-shell-add-uri"></a><h3>rb_shell_add_uri ()</h3>
282
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_shell_add_uri                    (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
282
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_shell_add_uri                    (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
283
283
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
284
284
                                                         <em class="parameter"><code>const <span class="type">char</span> *title</code></em>,
285
285
                                                         <em class="parameter"><code>const <span class="type">char</span> *genre</code></em>,
286
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
286
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
287
287
<p>
288
288
Adds the specified URI to the Rhythmbox database.  Whether the
289
289
title and genre specified are actually used is up to the source
323
323
<hr>
324
324
<div class="refsect2">
325
325
<a name="rb-shell-load-uri"></a><h3>rb_shell_load_uri ()</h3>
326
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_shell_load_uri                   (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
326
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_shell_load_uri                   (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
327
327
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
328
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> play</code></em>,
329
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
328
                                                         <em class="parameter"><code><span class="type">gboolean</span> play</code></em>,
 
329
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
330
330
<p>
331
331
Loads a URI representing a single song, a directory, a playlist, or
332
332
an internet radio station, and optionally starts playing it.
385
385
<hr>
386
386
<div class="refsect2">
387
387
<a name="rb-shell-get-song-properties"></a><h3>rb_shell_get_song_properties ()</h3>
388
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_shell_get_song_properties        (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
388
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_shell_get_song_properties        (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
389
389
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
390
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **properties</code></em>,
391
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
390
                                                         <em class="parameter"><code><span class="type">GHashTable</span> **properties</code></em>,
 
391
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
392
392
<p>
393
393
Gathers and returns all metadata (including extra metadata such as album
394
394
art URIs and lyrics) for the specified URI.
416
416
<tr>
417
417
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
418
418
<td>
419
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the URI is found in the database</td>
 
419
<code class="literal">TRUE</code> if the URI is found in the database</td>
420
420
</tr>
421
421
</tbody>
422
422
</table></div>
424
424
<hr>
425
425
<div class="refsect2">
426
426
<a name="rb-shell-set-song-property"></a><h3>rb_shell_set_song_property ()</h3>
427
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_shell_set_song_property          (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
427
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_shell_set_song_property          (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
428
428
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
429
429
                                                         <em class="parameter"><code>const <span class="type">char</span> *propname</code></em>,
430
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
431
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
430
                                                         <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>,
 
431
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
432
432
<p>
433
433
Attempts to set a property of a database entry identified by its URI.
434
434
If the URI identifies a file and the property is one associated with a
461
461
<tr>
462
462
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
463
463
<td>
464
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the property was set successfully.</td>
 
464
<code class="literal">TRUE</code> if the property was set successfully.</td>
465
465
</tr>
466
466
</tbody>
467
467
</table></div>
469
469
<hr>
470
470
<div class="refsect2">
471
471
<a name="rb-shell-quit"></a><h3>rb_shell_quit ()</h3>
472
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_shell_quit                       (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
473
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
472
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_shell_quit                       (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
473
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
474
474
<p>
475
475
Begins the process of shutting down Rhythmbox.  This function will
476
476
return.  The error parameter and return value only exist because this
498
498
<hr>
499
499
<div class="refsect2">
500
500
<a name="rb-shell-do-notify"></a><h3>rb_shell_do_notify ()</h3>
501
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_shell_do_notify                  (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
502
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> requested</code></em>,
503
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
501
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_shell_do_notify                  (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
 
502
                                                         <em class="parameter"><code><span class="type">gboolean</span> requested</code></em>,
 
503
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
504
504
<p>
505
505
Displays a notification of the current playing track.
506
506
</p>
514
514
</tr>
515
515
<tr>
516
516
<td><p><span class="term"><em class="parameter"><code>requested</code></em> :</span></p></td>
517
 
<td>if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the notification was requested by some explicit user action</td>
 
517
<td>if <code class="literal">TRUE</code>, the notification was requested by some explicit user action</td>
518
518
</tr>
519
519
<tr>
520
520
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
591
591
<hr>
592
592
<div class="refsect2">
593
593
<a name="rb-shell-get-party-mode"></a><h3>rb_shell_get_party_mode ()</h3>
594
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_shell_get_party_mode             (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);</pre>
 
594
<pre class="programlisting"><span class="returnvalue">gboolean</span>            rb_shell_get_party_mode             (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>);</pre>
595
595
<p>
596
 
Returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the shell is in party mode
 
596
Returns <code class="literal">TRUE</code> if the shell is in party mode
597
597
</p>
598
598
<div class="variablelist"><table border="0">
599
599
<col align="left" valign="top">
606
606
<tr>
607
607
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
608
608
<td>
609
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the shell is in party mode</td>
 
609
<code class="literal">TRUE</code> if the shell is in party mode</td>
610
610
</tr>
611
611
</tbody>
612
612
</table></div>
615
615
<div class="refsect2">
616
616
<a name="rb-shell-add-widget"></a><h3>rb_shell_add_widget ()</h3>
617
617
<pre class="programlisting"><span class="returnvalue">void</span>                rb_shell_add_widget                 (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
618
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
618
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>,
619
619
                                                         <em class="parameter"><code><span class="type">RBShellUILocation</span> location</code></em>,
620
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> expand</code></em>,
621
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> fill</code></em>);</pre>
 
620
                                                         <em class="parameter"><code><span class="type">gboolean</span> expand</code></em>,
 
621
                                                         <em class="parameter"><code><span class="type">gboolean</span> fill</code></em>);</pre>
622
622
<p>
623
 
Adds a widget to the main Rhythmbox window.  See <a href="http://library.gnome.org/devel/gtk/GtkBox.html#gtk-box-pack-start"><span class="type">gtk_box_pack_start</span></a> for
 
623
Adds a widget to the main Rhythmbox window.  See <span class="type">gtk_box_pack_start</span> for
624
624
details on how the expand and fill parameters work.
625
625
</p>
626
626
<div class="variablelist"><table border="0">
633
633
</tr>
634
634
<tr>
635
635
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
636
 
<td>the <a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> to insert into the main window</td>
 
636
<td>the <span class="type">GtkWidget</span> to insert into the main window</td>
637
637
</tr>
638
638
<tr>
639
639
<td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
654
654
<div class="refsect2">
655
655
<a name="rb-shell-remove-widget"></a><h3>rb_shell_remove_widget ()</h3>
656
656
<pre class="programlisting"><span class="returnvalue">void</span>                rb_shell_remove_widget              (<em class="parameter"><code><a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell</code></em>,
657
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> *widget</code></em>,
 
657
                                                         <em class="parameter"><code><span class="type">GtkWidget</span> *widget</code></em>,
658
658
                                                         <em class="parameter"><code><span class="type">RBShellUILocation</span> location</code></em>);</pre>
659
659
<p>
660
660
Removes a widget added with <a class="link" href="RBShell.html#rb-shell-add-widget" title="rb_shell_add_widget ()"><span class="type">rb_shell_add_widget</span></a> from the main window.
669
669
</tr>
670
670
<tr>
671
671
<td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
672
 
<td>the <a href="http://library.gnome.org/devel/gtk/GtkWidget.html"><span class="type">GtkWidget</span></a> to remove from the main window</td>
 
672
<td>the <span class="type">GtkWidget</span> to remove from the main window</td>
673
673
</tr>
674
674
<tr>
675
675
<td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
683
683
<a name="RBShell.property-details"></a><h2>Property Details</h2>
684
684
<div class="refsect2">
685
685
<a name="RBShell--autostarted"></a><h3>The <code class="literal">"autostarted"</code> property</h3>
686
 
<pre class="programlisting">  "autostarted"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only</pre>
 
686
<pre class="programlisting">  "autostarted"              <span class="type">gboolean</span>              : Read / Write / Construct Only</pre>
687
687
<p>
688
688
Whether Rhythmbox was automatically started by the session manager
689
689
</p>
708
708
<hr>
709
709
<div class="refsect2">
710
710
<a name="RBShell--disable-plugins"></a><h3>The <code class="literal">"disable-plugins"</code> property</h3>
711
 
<pre class="programlisting">  "disable-plugins"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only</pre>
 
711
<pre class="programlisting">  "disable-plugins"          <span class="type">gboolean</span>              : Read / Write / Construct Only</pre>
712
712
<p>
713
 
If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, disable plugins
 
713
If <code class="literal">TRUE</code>, disable plugins
714
714
</p>
715
715
<p>Default value: FALSE</p>
716
716
</div>
733
733
<hr>
734
734
<div class="refsect2">
735
735
<a name="RBShell--dry-run"></a><h3>The <code class="literal">"dry-run"</code> property</h3>
736
 
<pre class="programlisting">  "dry-run"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only</pre>
 
736
<pre class="programlisting">  "dry-run"                  <span class="type">gboolean</span>              : Read / Write / Construct Only</pre>
737
737
<p>
738
738
If TRUE, don't write back file metadata changes.
739
739
</p>
750
750
<hr>
751
751
<div class="refsect2">
752
752
<a name="RBShell--no-registration"></a><h3>The <code class="literal">"no-registration"</code> property</h3>
753
 
<pre class="programlisting">  "no-registration"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only</pre>
 
753
<pre class="programlisting">  "no-registration"          <span class="type">gboolean</span>              : Read / Write / Construct Only</pre>
754
754
<p>
755
 
If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, disable single-instance features.
 
755
If <code class="literal">TRUE</code>, disable single-instance features.
756
756
</p>
757
757
<p>Default value: FALSE</p>
758
758
</div>
759
759
<hr>
760
760
<div class="refsect2">
761
761
<a name="RBShell--no-update"></a><h3>The <code class="literal">"no-update"</code> property</h3>
762
 
<pre class="programlisting">  "no-update"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct Only</pre>
 
762
<pre class="programlisting">  "no-update"                <span class="type">gboolean</span>              : Read / Write / Construct Only</pre>
763
763
<p>
764
 
If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, don't update the database.
 
764
If <code class="literal">TRUE</code>, don't update the database.
765
765
</p>
766
766
<p>Default value: FALSE</p>
767
767
</div>
776
776
<hr>
777
777
<div class="refsect2">
778
778
<a name="RBShell--playlists-file"></a><h3>The <code class="literal">"playlists-file"</code> property</h3>
779
 
<pre class="programlisting">  "playlists-file"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
779
<pre class="programlisting">  "playlists-file"           <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
780
780
<p>
781
781
The path to the playlist file
782
782
</p>
809
809
<hr>
810
810
<div class="refsect2">
811
811
<a name="RBShell--rhythmdb-file"></a><h3>The <code class="literal">"rhythmdb-file"</code> property</h3>
812
 
<pre class="programlisting">  "rhythmdb-file"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
 
812
<pre class="programlisting">  "rhythmdb-file"            <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
813
813
<p>
814
814
The path to the rhythmdb file
815
815
</p>
842
842
<hr>
843
843
<div class="refsect2">
844
844
<a name="RBShell--ui-manager"></a><h3>The <code class="literal">"ui-manager"</code> property</h3>
845
 
<pre class="programlisting">  "ui-manager"               <a href="http://library.gnome.org/devel/gtk/GtkUIManager.html"><span class="type">GtkUIManager</span></a>*         : Read</pre>
 
845
<pre class="programlisting">  "ui-manager"               <span class="type">GtkUIManager</span>*         : Read</pre>
846
846
<p>
847
 
The <a href="http://library.gnome.org/devel/gtk/GtkUIManager.html"><span class="type">GtkUIManager</span></a> instance
 
847
The <span class="type">GtkUIManager</span> instance
848
848
</p>
849
849
</div>
850
850
<hr>
851
851
<div class="refsect2">
852
852
<a name="RBShell--visibility"></a><h3>The <code class="literal">"visibility"</code> property</h3>
853
 
<pre class="programlisting">  "visibility"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
853
<pre class="programlisting">  "visibility"               <span class="type">gboolean</span>              : Read / Write</pre>
854
854
<p>
855
855
Whether the main window is currently visible.
856
856
</p>
859
859
<hr>
860
860
<div class="refsect2">
861
861
<a name="RBShell--window"></a><h3>The <code class="literal">"window"</code> property</h3>
862
 
<pre class="programlisting">  "window"                   <a href="http://library.gnome.org/devel/gtk/GtkWindow.html"><span class="type">GtkWindow</span></a>*            : Read</pre>
 
862
<pre class="programlisting">  "window"                   <span class="type">GtkWindow</span>*            : Read</pre>
863
863
<p>
864
864
The main Rhythmbox window.
865
865
</p>
871
871
<a name="RBShell-create-song-info"></a><h3>The <code class="literal">"create-song-info"</code> signal</h3>
872
872
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a>    *shell,
873
873
                                                        <a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a> *song_info,
874
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>    multi,
875
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>    user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
874
                                                        <span class="type">gboolean</span>    multi,
 
875
                                                        <span class="type">gpointer</span>    user_data)      : <code class="literal">Run Last</code></pre>
876
876
<p>
877
877
Emitted when creating a new <a class="link" href="RBSongInfo.html" title="RBSongInfo"><span class="type">RBSongInfo</span></a> window.  Signal handlers can
878
878
add pages to the song info window notebook to display additional
892
892
</tr>
893
893
<tr>
894
894
<td><p><span class="term"><em class="parameter"><code>multi</code></em> :</span></p></td>
895
 
<td>if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the song info window is for multiple entries</td>
 
895
<td>if <code class="literal">TRUE</code>, the song info window is for multiple entries</td>
896
896
</tr>
897
897
<tr>
898
898
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
905
905
<div class="refsect2">
906
906
<a name="RBShell-notify-custom"></a><h3>The <code class="literal">"notify-custom"</code> signal</h3>
907
907
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell,
908
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>    timeout,
909
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>   *primary,
910
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>   *secondary,
911
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>   *image_uri,
912
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> requested,
913
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
908
                                                        <span class="type">guint</span>    timeout,
 
909
                                                        <span class="type">gchar</span>   *primary,
 
910
                                                        <span class="type">gchar</span>   *secondary,
 
911
                                                        <span class="type">gchar</span>   *image_uri,
 
912
                                                        <span class="type">gboolean</span> requested,
 
913
                                                        <span class="type">gpointer</span> user_data)      : <code class="literal">Run Last</code></pre>
914
914
<p>
915
915
Emitted when a custom notification should be displayed to the user.
916
916
</p>
940
940
</tr>
941
941
<tr>
942
942
<td><p><span class="term"><em class="parameter"><code>requested</code></em> :</span></p></td>
943
 
<td>if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the notification was triggered by an explicit user action</td>
 
943
<td>if <code class="literal">TRUE</code>, the notification was triggered by an explicit user action</td>
944
944
</tr>
945
945
<tr>
946
946
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
953
953
<div class="refsect2">
954
954
<a name="RBShell-notify-playing-entry"></a><h3>The <code class="literal">"notify-playing-entry"</code> signal</h3>
955
955
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell,
956
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> arg1,
957
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
956
                                                        <span class="type">gboolean</span> arg1,
 
957
                                                        <span class="type">gpointer</span> user_data)      : <code class="literal">Run Last</code></pre>
958
958
<p>
959
959
Emitted when a notification should be displayed showing the current
960
960
playing entry.
978
978
<div class="refsect2">
979
979
<a name="RBShell-visibility-changed"></a><h3>The <code class="literal">"visibility-changed"</code> signal</h3>
980
980
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell,
981
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> visibile,
982
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
981
                                                        <span class="type">gboolean</span> visibile,
 
982
                                                        <span class="type">gpointer</span> user_data)      : <code class="literal">Run Last</code></pre>
983
983
<p>
984
984
Emitted after the visibility of the main Rhythmbox window has
985
985
changed.
1006
1006
<hr>
1007
1007
<div class="refsect2">
1008
1008
<a name="RBShell-visibility-changing"></a><h3>The <code class="literal">"visibility-changing"</code> signal</h3>
1009
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell,
1010
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> initial,
1011
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> visible,
1012
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)      : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
 
1009
<pre class="programlisting"><span class="returnvalue">gboolean</span>            user_function                      (<a class="link" href="RBShell.html" title="RBShell"><span class="type">RBShell</span></a> *shell,
 
1010
                                                        <span class="type">gboolean</span> initial,
 
1011
                                                        <span class="type">gboolean</span> visible,
 
1012
                                                        <span class="type">gpointer</span> user_data)      : <code class="literal">Run Last</code></pre>
1013
1013
<p>
1014
1014
Emitted before the visibility of the main window changes.  The return
1015
1015
value overrides the visibility setting.  If multiple signal handlers
1025
1025
</tr>
1026
1026
<tr>
1027
1027
<td><p><span class="term"><em class="parameter"><code>initial</code></em> :</span></p></td>
1028
 
<td>if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, this is the initial visibility for the window</td>
 
1028
<td>if <code class="literal">TRUE</code>, this is the initial visibility for the window</td>
1029
1029
</tr>
1030
1030
<tr>
1031
1031
<td><p><span class="term"><em class="parameter"><code>visible</code></em> :</span></p></td>
1042
1042
</div>
1043
1043
<div class="footer">
1044
1044
<hr>
1045
 
          Generated by GTK-Doc V1.18.1</div>
 
1045
          Generated by GTK-Doc V1.18</div>
1046
1046
</body>
1047
1047
</html>
 
 
b'\\ No newline at end of file'