![]() |
![]() |
![]() |
Rhythmbox Development Reference Manual | ![]() |
---|---|---|---|---|
#include <rb-library-browser.h> RBLibraryBrowser; RBLibraryBrowserClass; RBLibraryBrowser* rb_library_browser_new (RhythmDB *db, RhythmDBEntryType entry_type); void rb_library_browser_set_model (RBLibraryBrowser *widget, RhythmDBQueryModel *model, gboolean query_pending); gboolean rb_library_browser_reset (RBLibraryBrowser *widget); RhythmDBQuery* rb_library_browser_construct_query (RBLibraryBrowser *widget); GList* rb_library_browser_get_property_views (RBLibraryBrowser *widget); RBPropertyView* rb_library_browser_get_property_view (RBLibraryBrowser *widget, RhythmDBPropType type); gboolean rb_library_browser_has_selection (RBLibraryBrowser *widget); void rb_library_browser_set_selection (RBLibraryBrowser *widget, RhythmDBPropType type, GList *selection);
GObject +----GInitiallyUnowned +----GtkObject +----GtkWidget +----GtkContainer +----GtkBox +----GtkHBox +----RBLibraryBrowser
"db" RhythmDB* : Read / Write / Construct Only "entry-type" RhythmDBEntryType* : Read / Write / Construct Only "input-model" RhythmDBQueryModel* : Read "output-model" RhythmDBQueryModel* : Read
This widget contains a set of RBPropertyViews backed by RhythmDBPropertyModels and constructs a chain of RhythmDBQueryModels to perform filtering of the entries in a source.
It operates on an input query model, containing the full set of entries that may be displayed in the source, and produces an output query model containing those entries that match the current selection.
When the selection in any of the property views changes, or when rb_library_browser_reset or rb_library_browser_set_selection are called to manipulate the selection, the query chain is rebuilt asynchronously to update the property views.
RBLibraryBrowser* rb_library_browser_new (RhythmDB *db, RhythmDBEntryType entry_type);
|
the RhythmDB instance |
|
the entry type to use in the browser |
Returns : |
a new RBLibraryBrowser |
void rb_library_browser_set_model (RBLibraryBrowser *widget, RhythmDBQueryModel *model, gboolean query_pending);
Specifies a new input query model for the browser. This should be the query model constructed from the current search text, or the basic query model for the source if there is no search text.
|
a RBLibraryBrowser |
|
the new input RhythmDBQueryModel |
|
if TRUE, the caller promises to run a query to populate the input query model. |
gboolean rb_library_browser_reset (RBLibraryBrowser *widget);
Clears all selections in the browser.
|
a RBLibraryBrowser |
Returns : |
TRUE if anything was changed |
RhythmDBQuery* rb_library_browser_construct_query (RBLibraryBrowser *widget);
Constructs a RhythmDBQuery from the current selections in the browser.
|
a RBLibraryBrowser |
Returns : |
a RhythmDBQuery constructed from the current selection. |
GList* rb_library_browser_get_property_views (RBLibraryBrowser *widget);
|
a RBLibraryBrowser |
Returns : |
a GList containing the RBPropertyViews in the browser. |
RBPropertyView* rb_library_browser_get_property_view (RBLibraryBrowser *widget, RhythmDBPropType type);
|
a RBLibraryBrowser |
|
the property |
Returns : |
the RBPropertyView for the specified property, or NULL if there isn't one |
gboolean rb_library_browser_has_selection (RBLibraryBrowser *widget);
|
a RBLibraryBrowser |
Returns : |
TRUE if any items in the browser are selected. |
void rb_library_browser_set_selection (RBLibraryBrowser *widget, RhythmDBPropType type, GList *selection);
Replaces any current selection for the specified property.
|
a RBLibraryBrowser |
|
the property for which to set the selection |
|
a list of strings to select |
"entry-type"
property"entry-type" RhythmDBEntryType* : Read / Write / Construct Only
The type of entries to use in the browser.
"input-model"
property"input-model" RhythmDBQueryModel* : Read
This RhythmDBQueryModel defines the set of entries that the browser filters. This property is not writeable. To set a new input query model, use rb_library_browser_set_model.
"output-model"
property"output-model" RhythmDBQueryModel* : Read
This RhythmDBQueryModel contains the filtered set of entries. It is a subset of the entries contained in the input model. This should be used as the model backing the source's entry view.
Sources using this widget should connect to the notify signal for this property, updating their entry view when it changes.