![]() |
![]() |
![]() |
Rhythmbox Development Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
struct RBSource; struct RBSourceClass; enum RBSourceEOFType; #define RB_SOURCE_ICON_SIZE void rb_source_notify_filter_changed (RBSource *source
); void rb_source_update_play_statistics (RBSource *source
,RhythmDB *db
,RhythmDBEntry *entry
); gboolean rb_source_can_browse (RBSource *source
); char * rb_source_get_browser_key (RBSource *source
); void rb_source_browser_toggled (RBSource *source
,gboolean enabled
); RBEntryView * rb_source_get_entry_view (RBSource *source
); GList * rb_source_get_property_views (RBSource *source
); gboolean rb_source_can_rename (RBSource *source
); void rb_source_search (RBSource *source
,RBSourceSearch *search
,const char *cur_text
,const char *new_text
); void rb_source_reset_filters (RBSource *source
); gboolean rb_source_can_cut (RBSource *source
); gboolean rb_source_can_delete (RBSource *source
); gboolean rb_source_can_move_to_trash (RBSource *source
); gboolean rb_source_can_copy (RBSource *source
); gboolean rb_source_can_paste (RBSource *source
); gboolean rb_source_can_add_to_queue (RBSource *source
); gboolean rb_source_can_show_properties (RBSource *source
); GList * rb_source_cut (RBSource *source
); GList * rb_source_copy (RBSource *source
); RBTrackTransferBatch * rb_source_paste (RBSource *source
,GList *entries
); void rb_source_delete (RBSource *source
); void rb_source_add_to_queue (RBSource *source
,RBSource *queue
); void rb_source_move_to_trash (RBSource *source
); void rb_source_song_properties (RBSource *source
); gboolean rb_source_try_playlist (RBSource *source
); guint rb_source_want_uri (RBSource *source
,const char *uri
); gboolean rb_source_uri_is_source (RBSource *source
,const char *uri
); void rb_source_add_uri (RBSource *source
,const char *uri
,const char *title
,const char *genre
,RBSourceAddCallback callback
,gpointer data
,GDestroyNotify destroy_data
); gboolean rb_source_can_pause (RBSource *source
); RBSourceEOFType rb_source_handle_eos (RBSource *source
); GList * rb_source_get_search_actions (RBSource *source
); GList * rb_source_gather_selected_properties (RBSource *source
,RhythmDBPropType prop
); void rb_source_set_hidden_when_empty (RBSource *source
,gboolean hidden
);
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkBox +----GtkHBox +----RBDisplayPage +----RBSource +----RBPlaylistSource +----RBBrowserSource +----RBImportErrorsSource +----RBMissingFilesSource +----RBStreamingSource
GEnum +----RBSourceEOFType
"base-query-model" RhythmDBQueryModel* : Read "entry-type" RhythmDBEntryType* : Read / Write / Construct Only "hidden-when-empty" gboolean : Read / Write "play-order" RBPlayOrder* : Read "query-model" RhythmDBQueryModel* : Read / Write "search-type" RBSourceSearchType : Read / Write / Construct
This class provides methods for requesting information about the UI capabilities of the source, and defines the expectations that apply to all sources - that they will provide RBEntryView and RhythmDBQueryModel objects, mostly.
Many of the methods on this class come in can_do_x and do_x pairs. When can_do_x always returns FALSE, the class does not need to implement the do_x method.
Useful subclasses include RBBrowserSource, which includes a RBLibraryBrowser and takes care of constructing an RBEntryView too; RBRemovableMediaSource, which takes care of many aspects of implementing a source that represents a removable device; and RBPlaylistSource, which provides functionality for playlist-like sources.
struct RBSourceClass { RBDisplayPageClass parent; /* signals */ void (*filter_changed) (RBSource *source); /* methods */ gboolean (*impl_can_browse) (RBSource *source); char * (*impl_get_browser_key) (RBSource *source); void (*impl_browser_toggled) (RBSource *source, gboolean enabled); RBEntryView * (*impl_get_entry_view) (RBSource *source); GList * (*impl_get_property_views) (RBSource *source); gboolean (*impl_can_rename) (RBSource *source); void (*impl_search) (RBSource *source, RBSourceSearch *search, const char *cur_text, const char *new_text); void (*impl_reset_filters) (RBSource *source); gboolean (*impl_can_cut) (RBSource *source); gboolean (*impl_can_delete) (RBSource *source); gboolean (*impl_can_move_to_trash) (RBSource *source); gboolean (*impl_can_copy) (RBSource *source); gboolean (*impl_can_paste) (RBSource *source); gboolean (*impl_can_add_to_queue)(RBSource *source); GList * (*impl_cut) (RBSource *source); GList * (*impl_copy) (RBSource *source); RBTrackTransferBatch *(*impl_paste) (RBSource *source, GList *entries); void (*impl_delete) (RBSource *source); void (*impl_add_to_queue) (RBSource *source, RBSource *queue); void (*impl_move_to_trash) (RBSource *source); void (*impl_song_properties) (RBSource *source); gboolean (*impl_try_playlist) (RBSource *source); guint (*impl_want_uri) (RBSource *source, const char *uri); void (*impl_add_uri) (RBSource *source, const char *uri, const char *title, const char *genre, RBSourceAddCallback callback, gpointer data, GDestroyNotify destroy_data); gboolean (*impl_uri_is_source) (RBSource *source, const char *uri); gboolean (*impl_can_pause) (RBSource *source); RBSourceEOFType (*impl_handle_eos) (RBSource *source); gboolean (*impl_have_url) (RBSource *source); void (*impl_delete_thyself) (RBSource *source); GList * (*impl_get_search_actions) (RBSource *source); char * (*impl_get_delete_action) (RBSource *source); };
typedef enum { RB_SOURCE_EOF_ERROR, RB_SOURCE_EOF_STOP, RB_SOURCE_EOF_RETRY, RB_SOURCE_EOF_NEXT, } RBSourceEOFType;
void rb_source_notify_filter_changed (RBSource *source
);
Source implementations call this when their filter state changes
|
a RBSource |
void rb_source_update_play_statistics (RBSource *source
,RhythmDB *db
,RhythmDBEntry *entry
);
Updates play count and play time statistics for a database entry. Sources containing entries that do not normally reach EOS should call this for an entry when it is no longer being played.
|
a RBSource |
|
the RhythmDB instance |
|
the RhythmDBEntry to update |
gboolean rb_source_can_browse (RBSource *source
);
Determines whether the source has a browser
|
a RBSource |
Returns : |
TRUE if this source has a browser |
char * rb_source_get_browser_key (RBSource *source
);
Gets the GConf key controlling browser visibility
|
a RBSource |
Returns : |
the GConf key name (allocated) |
void rb_source_browser_toggled (RBSource *source
,gboolean enabled
);
Called when the visibility of the browser changes.
|
a RBSource |
|
TRUE if the browser should be visible |
RBEntryView * rb_source_get_entry_view (RBSource *source
);
Returns the entry view widget for the source.
|
a RBSource |
Returns : |
the RBEntryView instance for the source |
GList * rb_source_get_property_views (RBSource *source
);
Returns a list containing the RBPropertyView instances for the source, if any.
|
a RBSource |
Returns : |
list of property views |
gboolean rb_source_can_rename (RBSource *source
);
Determines whether the source can be renamed.
|
a RBSource. |
Returns : |
TRUE if this source can be renamed |
void rb_source_search (RBSource *source
,RBSourceSearch *search
,const char *cur_text
,const char *new_text
);
Updates the source with new search text. The source should recreate the database query that feeds into the browser (if any).
|
a RBSource |
|
the active RBSourceSearch instance (may be NULL) |
|
the current search text (may be NULL) |
|
the new search text |
void rb_source_reset_filters (RBSource *source
);
Clears all filters (browser selections, etc.) in this source.
|
a RBSource |
gboolean rb_source_can_cut (RBSource *source
);
Determines whether the source supporst the typical cut (as in cut-and-paste) operation.
|
a RBSource |
Returns : |
TRUE if cutting is supported |
gboolean rb_source_can_delete (RBSource *source
);
Determines whether the source allows the user to delete a selected set of entries.
|
a RBSource |
Returns : |
TRUE if deletion is supported |
gboolean rb_source_can_move_to_trash (RBSource *source
);
Determines whether the source allows the user to trash the files backing a selected set of entries.
|
a RBSource |
Returns : |
TRUE if trashing is supported |
gboolean rb_source_can_copy (RBSource *source
);
Determines whether the source supports the copy part of a copy-and-paste operation.
|
a RBSource |
Returns : |
TRUE if copying is supported |
gboolean rb_source_can_paste (RBSource *source
);
Determines whether the source supports paste operations.
|
a RBSource |
Returns : |
TRUE if the pasting is supported |
gboolean rb_source_can_add_to_queue (RBSource *source
);
Determines whether the source can add the selected entries to the play queue.
|
a RBSource |
Returns : |
TRUE if adding to the play queue is supported |
gboolean rb_source_can_show_properties (RBSource *source
);
Determines whether the source can display a properties window for the currently selected entry (or set of entries)
|
a RBSource |
Returns : |
TRUE if showing properties is supported |
GList * rb_source_cut (RBSource *source
);
Removes the currently selected entries from the source and returns them so they can be pasted into another source.
|
a RBSource |
Returns : |
a list of RhythmDBEntry objects cut from the source. |
GList * rb_source_copy (RBSource *source
);
Copies the selected entries to the clipboard.
|
a RBSource |
Returns : |
a list containing the currently selected entries from the source. |
RBTrackTransferBatch * rb_source_paste (RBSource *source
,GList *entries
);
Adds a list of entries previously cut or copied from another source. If the entries are not of the type used by the source, the entries will be copied and possibly converted into an acceptable format. This can be used for transfers to and from devices and network shares.
If the transfer is performed using an RBTrackTransferBatch, the batch object is returned so the caller can monitor the transfer progress. The caller does not own a reference on the batch object.
|
a RBSource |
|
a list of RhythmDBEntry objects to paste in |
Returns : |
the RBTrackTransferBatch used to perform the transfer (if any) |
void rb_source_delete (RBSource *source
);
Deletes the currently selected entries from the source.
|
a RBSource |
void rb_source_add_to_queue (RBSource *source
,RBSource *queue
);
Adds the currently selected entries to the end of the play queue.
void rb_source_move_to_trash (RBSource *source
);
Trashes the files backing the currently selected set of entries. In general, this should use rhythmdb_entry_move_to_trash to perform the actual trash operation.
|
a RBSource |
void rb_source_song_properties (RBSource *source
);
Displays a properties window for the currently selected entries.
|
a RBSource |
gboolean rb_source_try_playlist (RBSource *source
);
Determines whether playback URIs for entries in the source should be parsed as playlists rather than just played.
|
a RBSource |
Returns : |
TRUE to attempt playlist parsing |
guint rb_source_want_uri (RBSource *source
,const char *uri
);
Returns an indication of how much the source wants to handle the specified URI. 100 is the highest usual value, and should only be used when the URI can only be associated with this source. 0 should be used when the URI does not match the source at all.
|
a RBSource |
|
a URI for the source to consider |
Returns : |
value from 0 to 100 indicating how much the source wants this URI. |
gboolean rb_source_uri_is_source (RBSource *source
,const char *uri
);
Checks if the URI matches the source itself. A source should return TRUE here if the URI points to the device that the source represents, for example.
|
a RBSource |
|
a URI for the source to consider |
Returns : |
TRUE if the URI identifies the source itself. |
void rb_source_add_uri (RBSource *source
,const char *uri
,const char *title
,const char *genre
,RBSourceAddCallback callback
,gpointer data
,GDestroyNotify destroy_data
);
Adds an entry corresponding to the URI to the source. The
title
and genre
parameters are not really used.
|
a RBSource |
|
a URI to add |
|
theoretically, the title of the entity the URI points to |
|
theoretically, the genre of the entity the URI points to |
|
a callback function to call when complete |
|
data to pass to the callback |
|
function to call to destroy the callback data |
gboolean rb_source_can_pause (RBSource *source
);
Determines whether playback of entries from the source can be paused.
|
a RBSource |
Returns : |
TRUE if pausing is supported |
RBSourceEOFType rb_source_handle_eos (RBSource *source
);
Determines how EOS events should be handled when playing entries from the source.
|
a RBSource |
Returns : |
EOS event handling type |
GList * rb_source_get_search_actions (RBSource *source
);
Returns a list of UI action names. Buttons for these actions will be added to the search bar. The source must identify the selected search action when constructing a database query for searching
|
a RBSource |
Returns : |
list of search actions |
GList * rb_source_gather_selected_properties (RBSource *source
,RhythmDBPropType prop
);
Returns a list containing the values of the specified property from the selected entries in the source. This is used to implement the 'browse this artist' (etc.) actions.
|
a RBSource |
|
property for which to gather selection |
Returns : |
list of property values |
"base-query-model"
property"base-query-model" RhythmDBQueryModel* : Read
The unfiltered query model for the source, containing all entries in the source. Source classes should override this if they perform filtering based on the search box or a browser.
"entry-type"
property"entry-type" RhythmDBEntryType* : Read / Write / Construct Only
Entry type for entries in this source.
"hidden-when-empty"
property"hidden-when-empty" gboolean : Read / Write
If TRUE, the source will not be displayed in the source list when it contains no entries.
Default value: FALSE
"play-order"
property"play-order" RBPlayOrder* : Read
If the source provides its own play order, it can override this property.
"query-model"
property"query-model" RhythmDBQueryModel* : Read / Write
The current query model for the source. This is used in various places, including the play order, to find the set of entries within the source.
"filter-changed"
signalvoid user_function (RBSource *source,
gpointer user_data) : Run Last
Fires when the user changes the filter, either by changing the contents of the search box or by selecting a different browser entry.
|
the RBSource |
|
user data set when the signal handler was connected. |