Class
RBSource
Description [src]
abstract class RB.Source : RB.DisplayPage
implements Atk.ImplementorIface, Gtk.Buildable, Gtk.Orientable {
priv: RBSourcePrivate*
}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.
Instance methods
rb_source_add_uri
Adds an entry corresponding to the URI to the source. The
title and genre parameters are not really used.
rb_source_bind_settings
Binds the source’s GSettings instance to the given widgets. Should be called
from the source’s constructed method.
rb_source_can_add_to_queue
Determines whether the source can add the selected entries to the play queue.
rb_source_can_copy
Determines whether the source supports the copy part of a copy-and-paste operation.
rb_source_can_cut
Determines whether the source supporst the typical cut (as in cut-and-paste) operation.
rb_source_can_delete
Determines whether the source allows the user to delete a selected set of entries.
rb_source_can_move_to_trash
Determines whether the source allows the user to trash the files backing a selected set of entries.
rb_source_can_show_properties
Determines whether the source can display a properties window for the currently selected entry (or set of entries).
rb_source_create_search_action
Creates a GAction representing the selected search type for source.
The action is stateful. Its state is a string containing the name of
a registered search instance. If the source has a settings instance,
it will be updated when the state changes. Changes coming from the
settings instance are ignored. If the source doesn’t have a settings
instance, it should set a default state on the action at some point.
rb_source_cut
Removes the currently selected entries from the source and returns them so they can be pasted into another source.
rb_source_gather_selected_properties
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.
rb_source_get_delete_label
Returns a translated label for the ‘delete’ menu item, allowing sources to better describe what happens to deleted entries. Playlists, for example, return “Remove from Playlist” here.
rb_source_get_property_views
Returns a list containing the RBPropertyView instances for the
source, if any.
rb_source_handle_eos
Determines how EOS events should be handled when playing entries from the source.
rb_source_move_to_trash
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.
rb_source_notify_playback_status_changed
Source implementations call this when their playback status changes.
rb_source_paste
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.
rb_source_search
Updates the source with new search text. The source should recreate the database query that feeds into the browser (if any).
rb_source_set_hidden_when_empty
Enables or disables automatic hiding of the source when there are no entries in it.
rb_source_try_playlist
Determines whether playback URIs for entries in the source should be parsed as playlists rather than just played.
rb_source_update_play_statistics
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.
rb_source_uri_is_source
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.
rb_source_want_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.
Methods inherited from RBDisplayPage (12)
rb_display_page_activate
Called when the page is activated (double clicked, etc.) in the page tree.
rb_display_page_can_remove
Called to check whether the user is able to remove the page.
rb_display_page_delete_thyself
This is called when the page should delete itself. The ‘deleted’ signal will be emitted, which removes the page from the page model. This will not actually dispose of the page object, so reference counting must still be handled correctly.
rb_display_page_deselected
Called when the page is deselected in the page tree.
rb_display_page_get_config_widget
Source implementations can use this to return an optional configuration widget. The widget will be displayed in a page in the preferences dialog.
rb_display_page_get_status
Retrieves status details for the page.
rb_display_page_notify_status_changed
Page implementations call this when their status bar information changes.
rb_display_page_receive_drag
rb_display_page_remove
Called when the user requests removal of a page.
rb_display_page_selectable
Checks if page can be selected.
rb_display_page_selected
Called when the page is selected in the page tree.
rb_display_page_set_icon_name
Sets the icon for the page to the specified icon name.
Methods inherited from GtkBox (13)
gtk_box_get_baseline_position
Gets the value set by gtk_box_set_baseline_position().
gtk_box_get_center_widget
Retrieves the center widget of the box.
gtk_box_get_homogeneous
Returns whether the box is homogeneous (all children are the same size). See gtk_box_set_homogeneous().
gtk_box_get_spacing
Gets the value set by gtk_box_set_spacing().
gtk_box_pack_end
Adds child to box, packed with reference to the end of box.
The child is packed after (away from end of) any other child
packed with reference to the end of box.
gtk_box_pack_start
Adds child to box, packed with reference to the start of box.
The child is packed after any other child packed with reference
to the start of box.
gtk_box_query_child_packing
Obtains information about how child is packed into box.
gtk_box_reorder_child
Moves child to a new position in the list of box children.
The list contains widgets packed #GTK_PACK_START
as well as widgets packed #GTK_PACK_END, in the order that these
widgets were added to box.
gtk_box_set_baseline_position
Sets the baseline position of a box. This affects
only horizontal boxes with at least one baseline aligned
child. If there is more vertical space available than requested,
and the baseline is not allocated by the parent then
position is used to allocate the baseline wrt the
extra space available.
gtk_box_set_center_widget
Sets a center widget; that is a child widget that will be centered with respect to the full width of the box, even if the children at either side take up different amounts of space.
gtk_box_set_child_packing
Sets the way child is packed into box.
gtk_box_set_homogeneous
Sets the GtkBox:homogeneous property of box, controlling
whether or not all children of box are given equal space
in the box.
gtk_box_set_spacing
Sets the GtkBox:spacing property of box, which is the
number of pixels to place between children of box.
Methods inherited from GtkContainer (33)
Please see GtkContainer for a full list of methods.
Methods inherited from GtkBuildable (10)
gtk_buildable_add_child
Adds a child to buildable. type is an optional string
describing how the child should be added.
gtk_buildable_construct_child
Constructs a child of buildable with the name name.
gtk_buildable_custom_finished
This is similar to gtk_buildable_parser_finished() but is
called once for each custom tag handled by the buildable.
gtk_buildable_custom_tag_end
This is called at the end of each custom element handled by the buildable.
gtk_buildable_custom_tag_start
This is called for each unknown element under <child>.
gtk_buildable_get_internal_child
Get the internal child called childname of the buildable object.
gtk_buildable_get_name
Gets the name of the buildable object.
gtk_buildable_parser_finished
Called when the builder finishes the parsing of a
[GtkBuilder UI definition][BUILDER-UI].
Note that this will be called once for each time
gtk_builder_add_from_file() or gtk_builder_add_from_string()
is called on a builder.
gtk_buildable_set_buildable_property
Sets the property name name to value on the buildable object.
gtk_buildable_set_name
Sets the name of the buildable object.
Methods inherited from GtkOrientable (2)
gtk_orientable_get_orientation
Retrieves the orientation of the orientable.
gtk_orientable_set_orientation
Sets the orientation of the orientable.
Properties
RB.Source:base-query-model
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.
RB.Source:hidden-when-empty
If TRUE, the source will not be displayed in the source list when it contains no entries.
RB.Source:load-status
Indicates whether the source is not loaded, is currently loading data, or is fully loaded.
RB.Source:playlist-menu
A GMenu instance to attach to the ‘add to playlist’ item in the edit menu. If NULL, the item will be disabled.
RB.Source:query-model
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.
RB.Source:settings
The GSettings instance storing settings for the source. The instance must
have a schema of org.gnome.Rhythmbox.Source.
RB.Source:show-browser
Whether the browser widget for the source (if any) should be displayed. This should be overridden in sources that include a browser widget.
RB.Source:toolbar-menu
A GMenu instance describing the contents of a toolbar to display at
the top of the source. The RBSource class doesn’t actually display
the toolbar anywhere. Adding the toolbar to a container is the
responsibility of a subclass such as RBBrowserSource.
Properties inherited from RBDisplayPage (7)
RB.DisplayPage:icon
Icon to display in the page tree.
RB.DisplayPage:name
Page name as displayed in the tree.
RB.DisplayPage:parent
The parent page in the tree (may be NULL).
RB.DisplayPage:plugin
The plugin that created this page.
RB.DisplayPage:selected
TRUE when the page is selected in the page tree.
RB.DisplayPage:shell
The rhythmbox shell object.
RB.DisplayPage:visibility
If FALSE, the page will not be displayed in the tree.
Properties inherited from GtkBox (3)
Gtk.Box:baseline-position
Gtk.Box:homogeneous
Gtk.Box:spacing
Properties inherited from GtkContainer (3)
Gtk.Container:border-width
Gtk.Container:child
Gtk.Container:resize-mode
Properties inherited from GtkWidget (39)
Gtk.Widget:app-paintable
Gtk.Widget:can-default
Gtk.Widget:can-focus
Gtk.Widget:composite-child
Gtk.Widget:double-buffered
Whether the widget is double buffered.
Gtk.Widget:events
Gtk.Widget:expand
Whether to expand in both directions. Setting this sets both GtkWidget:hexpand and GtkWidget:vexpand.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space, see GtkAlign.
Gtk.Widget:has-default
Gtk.Widget:has-focus
Gtk.Widget:has-tooltip
Enables or disables the emission of GtkWidget::query-tooltip on widget.
A value of TRUE indicates that widget can have a tooltip, in this case
the widget will be queried using GtkWidget::query-tooltip to determine
whether it will provide a tooltip or not.
Gtk.Widget:height-request
Gtk.Widget:hexpand
Whether to expand horizontally. See gtk_widget_set_hexpand().
Gtk.Widget:hexpand-set
Whether to use the GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().
Gtk.Widget:is-focus
Gtk.Widget:margin
Sets all four sides’ margin at once. If read, returns max margin on any side.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.
Gtk.Widget:margin-left
Margin on left side of widget.
Gtk.Widget:margin-right
Margin on right side of widget.
Gtk.Widget:margin-start
Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
Gtk.Widget:no-show-all
Gtk.Widget:opacity
The requested opacity of the widget. See gtk_widget_set_opacity() for
more details about window opacity.
Gtk.Widget:parent
Gtk.Widget:receives-default
Gtk.Widget:scale-factor
The scale factor of the widget. See gtk_widget_get_scale_factor() for
more details about widget scaling.
Gtk.Widget:sensitive
Gtk.Widget:style
The style of the widget, which contains information about how it will look (colors, etc).
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. Also see gtk_tooltip_set_markup().
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space, see GtkAlign.
Gtk.Widget:vexpand
Whether to expand vertically. See gtk_widget_set_vexpand().
Gtk.Widget:vexpand-set
Whether to use the GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().
Gtk.Widget:visible
Gtk.Widget:width-request
Gtk.Widget:window
The widget’s window if it is realized, NULL otherwise.
Properties inherited from GtkOrientable (1)
Gtk.Orientable:orientation
The orientation of the orientable.
Signals
RB.Source::filter-changed
Fires when the user changes the filter, either by changing the contents of the search box or by selecting a different browser entry.
RB.Source::playback-status-changed
Emitted to indicate playback status (buffering etc.) has changed.
Signals inherited from RBDisplayPage (2)
RBDisplayPage::deleted
Emitted when the page is being deleted.
RBDisplayPage::status-changed
Emitted when the page’s status changes.
Signals inherited from GtkContainer (4)
GtkContainer::add
GtkContainer::check-resize
GtkContainer::remove
GtkContainer::set-focus-child
Signals inherited from GtkWidget (69)
GtkWidget::accel-closures-changed
GtkWidget::button-press-event
The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed.
GtkWidget::button-release-event
The ::button-release-event signal will be emitted when a button (typically from a mouse) is released.
GtkWidget::can-activate-accel
Determines whether an accelerator that activates the signal
identified by signal_id can currently be activated.
This signal is present to allow applications and derived
widgets to override the default GtkWidget handling
for determining whether an accelerator can be activated.
GtkWidget::child-notify
The ::child-notify signal is emitted for each [child property][child-properties] that has changed on an object. The signal’s detail holds the property name.
GtkWidget::composited-changed
The ::composited-changed signal is emitted when the composited
status of widgets screen changes.
See gdk_screen_is_composited().
GtkWidget::configure-event
The ::configure-event signal will be emitted when the size, position or
stacking of the widget‘s window has changed.
GtkWidget::damage-event
Emitted when a redirected window belonging to widget gets drawn into.
The region/area members of the event shows what area of the redirected
drawable was drawn into.
GtkWidget::delete-event
The ::delete-event signal is emitted if a user requests that
a toplevel window is closed. The default handler for this signal
destroys the window. Connecting gtk_widget_hide_on_delete() to
this signal will cause the window to be hidden instead, so that
it can later be shown again without reconstructing it.
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold. May result in finalization of the widget if all references are released.
GtkWidget::destroy-event
The ::destroy-event signal is emitted when a GdkWindow is destroyed.
You rarely get this signal, because most widgets disconnect themselves
from their window before they destroy it, so no widget owns the
window at destroy time.
GtkWidget::direction-changed
The ::direction-changed signal is emitted when the text direction of a widget changes.
GtkWidget::drag-begin
The ::drag-begin signal is emitted on the drag source when a drag is started. A typical reason to connect to this signal is to set up a custom drag icon with e.g. gtk_drag_source_set_icon_pixbuf().
GtkWidget::drag-data-delete
The ::drag-data-delete signal is emitted on the drag source when a drag
with the action GDK_ACTION_MOVE is successfully completed. The signal
handler is responsible for deleting the data that has been dropped. What
“delete” means depends on the context of the drag operation.
GtkWidget::drag-data-get
The ::drag-data-get signal is emitted on the drag source when the drop
site requests the data which is dragged. It is the responsibility of
the signal handler to fill data with the data in the format which
is indicated by info. See gtk_selection_data_set() and gtk_selection_data_set_text().
GtkWidget::drag-data-received
The ::drag-data-received signal is emitted on the drop site when the
dragged data has been received. If the data was received in order to
determine whether the drop will be accepted, the handler is expected
to call gdk_drag_status() and not finish the drag.
If the data was received in response to a GtkWidget::drag-drop signal
(and this is the last target to be received), the handler for this
signal is expected to process the received data and then call
gtk_drag_finish(), setting the success parameter depending on
whether the data was processed successfully.
GtkWidget::drag-drop
The ::drag-drop signal is emitted on the drop site when the user drops
the data onto the widget. The signal handler must determine whether
the cursor position is in a drop zone or not. If it is not in a drop
zone, it returns FALSE and no further processing is necessary.
Otherwise, the handler returns TRUE. In this case, the handler must
ensure that gtk_drag_finish() is called to let the source know that
the drop is done. The call to gtk_drag_finish() can be done either
directly or in a GtkWidget::drag-data-received handler which gets
triggered by calling gtk_drag_get_data() to receive the data for one
or more of the supported targets.
GtkWidget::drag-end
The ::drag-end signal is emitted on the drag source when a drag is
finished. A typical reason to connect to this signal is to undo
things done in GtkWidget::drag-begin.
GtkWidget::drag-failed
The ::drag-failed signal is emitted on the drag source when a drag has
failed. The signal handler may hook custom code to handle a failed DnD
operation based on the type of error, it returns TRUE is the failure has
been already handled (not showing the default “drag operation failed”
animation), otherwise it returns FALSE.
GtkWidget::drag-leave
The ::drag-leave signal is emitted on the drop site when the cursor
leaves the widget. A typical reason to connect to this signal is to
undo things done in GtkWidget::drag-motion, e.g. undo highlighting
with gtk_drag_unhighlight().
GtkWidget::drag-motion
The ::drag-motion signal is emitted on the drop site when the user
moves the cursor over the widget during a drag. The signal handler
must determine whether the cursor position is in a drop zone or not.
If it is not in a drop zone, it returns FALSE and no further processing
is necessary. Otherwise, the handler returns TRUE. In this case, the
handler is responsible for providing the necessary information for
displaying feedback to the user, by calling gdk_drag_status().
GtkWidget::draw
This signal is emitted when a widget is supposed to render itself.
The widget‘s top left corner must be painted at the origin of
the passed in context and be sized to the values returned by
gtk_widget_get_allocated_width() and gtk_widget_get_allocated_height().
GtkWidget::enter-notify-event
The ::enter-notify-event will be emitted when the pointer enters
the widget‘s window.
GtkWidget::event
The GTK+ main loop will emit three signals for each GDK event delivered
to a widget: one generic ::event signal, another, more specific,
signal that matches the type of event delivered (e.g.
GtkWidget::key-press-event) and finally a generic
GtkWidget::event-after signal.
GtkWidget::event-after
After the emission of the GtkWidget::event signal and (optionally)
the second more specific signal, ::event-after will be emitted
regardless of the previous two signals handlers return values.
GtkWidget::focus
GtkWidget::focus-in-event
The ::focus-in-event signal will be emitted when the keyboard focus
enters the widget‘s window.
GtkWidget::focus-out-event
The ::focus-out-event signal will be emitted when the keyboard focus
leaves the widget‘s window.
GtkWidget::grab-broken-event
Emitted when a pointer or keyboard grab on a window belonging
to widget gets broken.
GtkWidget::grab-focus
GtkWidget::grab-notify
The ::grab-notify signal is emitted when a widget becomes shadowed by a GTK+ grab (not a pointer or keyboard grab) on another widget, or when it becomes unshadowed due to a grab being removed.
GtkWidget::hide
The ::hide signal is emitted when widget is hidden, for example with gtk_widget_hide().
GtkWidget::hierarchy-changed
The ::hierarchy-changed signal is emitted when the
anchored state of a widget changes. A widget is
“anchored” when its toplevel
ancestor is a GtkWindow. This signal is emitted when
a widget changes from un-anchored to anchored or vice-versa.
GtkWidget::key-press-event
The ::key-press-event signal is emitted when a key is pressed. The signal emission will reoccur at the key-repeat rate when the key is kept pressed.
GtkWidget::key-release-event
The ::key-release-event signal is emitted when a key is released.
GtkWidget::keynav-failed
Gets emitted if keyboard navigation fails.
See gtk_widget_keynav_failed() for details.
GtkWidget::leave-notify-event
The ::leave-notify-event will be emitted when the pointer leaves
the widget‘s window.
GtkWidget::map
The ::map signal is emitted when widget is going to be mapped, that is
when the widget is visible (which is controlled with
gtk_widget_set_visible()) and all its parents up to the toplevel widget
are also visible. Once the map has occurred, GtkWidget::map-event will
be emitted.
GtkWidget::map-event
The ::map-event signal will be emitted when the widget‘s window is
mapped. A window is mapped when it becomes visible on the screen.
GtkWidget::mnemonic-activate
The default handler for this signal activates widget if group_cycling
is FALSE, or just makes widget grab focus if group_cycling is TRUE.
GtkWidget::motion-notify-event
The ::motion-notify-event signal is emitted when the pointer moves
over the widget’s GdkWindow.
GtkWidget::move-focus
GtkWidget::parent-set
The ::parent-set signal is emitted when a new parent has been set on a widget.
GtkWidget::popup-menu
This signal gets emitted whenever a widget should pop up a context
menu. This usually happens through the standard key binding mechanism;
by pressing a certain key while a widget is focused, the user can cause
the widget to pop up a menu. For example, the GtkEntry widget creates
a menu with clipboard commands. See the
[Popup Menu Migration Checklist][checklist-popup-menu]
for an example of how to use this signal.
GtkWidget::property-notify-event
The ::property-notify-event signal will be emitted when a property on
the widget‘s window has been changed or deleted.
GtkWidget::proximity-in-event
To receive this signal the GdkWindow associated to the widget needs
to enable the #GDK_PROXIMITY_IN_MASK mask.
GtkWidget::proximity-out-event
To receive this signal the GdkWindow associated to the widget needs
to enable the #GDK_PROXIMITY_OUT_MASK mask.
GtkWidget::query-tooltip
Emitted when GtkWidget:has-tooltip is TRUE and the hover timeout
has expired with the cursor hovering “above” widget; or emitted when widget got
focus in keyboard mode.
GtkWidget::realize
The ::realize signal is emitted when widget is associated with a
GdkWindow, which means that gtk_widget_realize() has been called or the
widget has been mapped (that is, it is going to be drawn).
GtkWidget::screen-changed
The ::screen-changed signal gets emitted when the screen of a widget has changed.
GtkWidget::scroll-event
The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.
GtkWidget::selection-clear-event
The ::selection-clear-event signal will be emitted when the
the widget‘s window has lost ownership of a selection.
GtkWidget::selection-get
GtkWidget::selection-notify-event
GtkWidget::selection-received
GtkWidget::selection-request-event
The ::selection-request-event signal will be emitted when
another client requests ownership of the selection owned by
the widget‘s window.
GtkWidget::show
The ::show signal is emitted when widget is shown, for example with gtk_widget_show().
GtkWidget::show-help
GtkWidget::size-allocate
GtkWidget::state-changed
The ::state-changed signal is emitted when the widget state changes. See gtk_widget_get_state().
GtkWidget::state-flags-changed
The ::state-flags-changed signal is emitted when the widget state changes, see gtk_widget_get_state_flags().
GtkWidget::style-set
The ::style-set signal is emitted when a new style has been set
on a widget. Note that style-modifying functions like
gtk_widget_modify_base() also cause this signal to be emitted.
GtkWidget::style-updated
The ::style-updated signal is a convenience signal that is emitted when the
GtkStyleContext::changed signal is emitted on the widget‘s associated
GtkStyleContext as returned by gtk_widget_get_style_context().
GtkWidget::touch-event
GtkWidget::unmap
The ::unmap signal is emitted when widget is going to be unmapped, which
means that either it or any of its parents up to the toplevel widget have
been set as hidden.
GtkWidget::unmap-event
The ::unmap-event signal will be emitted when the widget‘s window is
unmapped. A window is unmapped when it becomes invisible on the screen.
GtkWidget::unrealize
The ::unrealize signal is emitted when the GdkWindow associated with
widget is destroyed, which means that gtk_widget_unrealize() has been
called or the widget has been unmapped (that is, it is going to be hidden).
GtkWidget::visibility-notify-event
The ::visibility-notify-event will be emitted when the widget‘s
window is obscured or unobscured.
GtkWidget::window-state-event
The ::window-state-event will be emitted when the state of the
toplevel window associated to the widget changes.
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct RBSourceClass {
RBDisplayPageClass parent;
void (* filter_changed) (
RBSource* source
);
void (* reset_filters) (
RBSource* source
);
RBEntryView* (* get_entry_view) (
RBSource* source
);
GList* (* get_property_views) (
RBSource* source
);
gboolean (* can_rename) (
RBSource* source
);
void (* search) (
RBSource* source,
RBSourceSearch* search,
const char* cur_text,
const char* new_text
);
gboolean (* can_cut) (
RBSource* source
);
gboolean (* can_delete) (
RBSource* source
);
gboolean (* can_move_to_trash) (
RBSource* source
);
gboolean (* can_copy) (
RBSource* source
);
gboolean (* can_paste) (
RBSource* source
);
gboolean (* can_add_to_queue) (
RBSource* source
);
GList* (* cut) (
RBSource* source
);
GList* (* copy) (
RBSource* source
);
RBTrackTransferBatch* (* paste) (
RBSource* source,
GList* entries
);
void (* delete_selected) (
RBSource* source
);
void (* add_to_queue) (
RBSource* source,
RBSource* queue
);
void (* move_to_trash) (
RBSource* source
);
void (* song_properties) (
RBSource* source
);
gboolean (* try_playlist) (
RBSource* source
);
guint (* want_uri) (
RBSource* source,
const char* uri
);
void (* add_uri) (
RBSource* source,
const char* uri,
const char* title,
const char* genre,
RBSourceAddCallback callback,
gpointer data,
GDestroyNotify destroy_data
);
gboolean (* uri_is_source) (
RBSource* source,
const char* uri
);
gboolean (* check_entry_type) (
RBSource* source,
RhythmDBEntry* entry
);
gboolean (* can_pause) (
RBSource* source
);
RBSourceEOFType (* handle_eos) (
RBSource* source
);
void (* get_playback_status) (
RBSource* source,
char** text,
float* progress
);
char* (* get_delete_label) (
RBSource* source
);
}No description available.
Class members
parent: RBDisplayPageClassNo description available.
filter_changed: void (* filter_changed) ( RBSource* source )No description available.
reset_filters: void (* reset_filters) ( RBSource* source )No description available.
get_entry_view: RBEntryView* (* get_entry_view) ( RBSource* source )No description available.
get_property_views: GList* (* get_property_views) ( RBSource* source )No description available.
can_rename: gboolean (* can_rename) ( RBSource* source )No description available.
search: void (* search) ( RBSource* source, RBSourceSearch* search, const char* cur_text, const char* new_text )No description available.
can_cut: gboolean (* can_cut) ( RBSource* source )No description available.
can_delete: gboolean (* can_delete) ( RBSource* source )No description available.
can_move_to_trash: gboolean (* can_move_to_trash) ( RBSource* source )No description available.
can_copy: gboolean (* can_copy) ( RBSource* source )No description available.
can_paste: gboolean (* can_paste) ( RBSource* source )No description available.
can_add_to_queue: gboolean (* can_add_to_queue) ( RBSource* source )No description available.
cut: GList* (* cut) ( RBSource* source )No description available.
copy: GList* (* copy) ( RBSource* source )No description available.
paste: RBTrackTransferBatch* (* paste) ( RBSource* source, GList* entries )No description available.
delete_selected: void (* delete_selected) ( RBSource* source )No description available.
add_to_queue: void (* add_to_queue) ( RBSource* source, RBSource* queue )No description available.
move_to_trash: void (* move_to_trash) ( RBSource* source )No description available.
song_properties: void (* song_properties) ( RBSource* source )No description available.
try_playlist: gboolean (* try_playlist) ( RBSource* source )No description available.
want_uri: guint (* want_uri) ( RBSource* source, const char* uri )No description available.
add_uri: void (* add_uri) ( RBSource* source, const char* uri, const char* title, const char* genre, RBSourceAddCallback callback, gpointer data, GDestroyNotify destroy_data )No description available.
uri_is_source: gboolean (* uri_is_source) ( RBSource* source, const char* uri )No description available.
check_entry_type: gboolean (* check_entry_type) ( RBSource* source, RhythmDBEntry* entry )No description available.
can_pause: gboolean (* can_pause) ( RBSource* source )No description available.
handle_eos: RBSourceEOFType (* handle_eos) ( RBSource* source )No description available.
get_playback_status: void (* get_playback_status) ( RBSource* source, char** text, float* progress )No description available.
get_delete_label: char* (* get_delete_label) ( RBSource* source )No description available.
Virtual methods
RB.SourceClass.add_uri
Adds an entry corresponding to the URI to the source. The
title and genre parameters are not really used.
RB.SourceClass.can_add_to_queue
Determines whether the source can add the selected entries to the play queue.
RB.SourceClass.can_copy
Determines whether the source supports the copy part of a copy-and-paste operation.
RB.SourceClass.can_cut
Determines whether the source supporst the typical cut (as in cut-and-paste) operation.
RB.SourceClass.can_delete
Determines whether the source allows the user to delete a selected set of entries.
RB.SourceClass.can_move_to_trash
Determines whether the source allows the user to trash the files backing a selected set of entries.
RB.SourceClass.cut
Removes the currently selected entries from the source and returns them so they can be pasted into another source.
RB.SourceClass.get_delete_label
Returns a translated label for the ‘delete’ menu item, allowing sources to better describe what happens to deleted entries. Playlists, for example, return “Remove from Playlist” here.
RB.SourceClass.get_property_views
Returns a list containing the RBPropertyView instances for the
source, if any.
RB.SourceClass.handle_eos
Determines how EOS events should be handled when playing entries from the source.
RB.SourceClass.move_to_trash
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.
RB.SourceClass.paste
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.
RB.SourceClass.search
Updates the source with new search text. The source should recreate the database query that feeds into the browser (if any).
RB.SourceClass.try_playlist
Determines whether playback URIs for entries in the source should be parsed as playlists rather than just played.
RB.SourceClass.uri_is_source
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.
RB.SourceClass.want_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.