rb_play_order_playing_source_changed ()

void
rb_play_order_playing_source_changed (RBPlayOrder *porder,
                                      RBSource *source);

Sets the playing RBSource for the play order. Should be called by RBShellPlayer when the active source changes. Subclasses should implement playing_source_changed() to make any necessary changes.

rb_play_order_query_model_changed ()

void
rb_play_order_query_model_changed (RBPlayOrder *porder);

Updates the RhythmDBQueryModel instance for the play order. Called from the RBSource notify signal handler, and also from rb_play_order_source_changed. Subclasses should implement query_model_changed() to make any necessary adjustments if they store any state based on the contents of the RhythmDBQueryModel.

rb_play_order_has_next ()

gboolean
rb_play_order_has_next (RBPlayOrder *porder);

If there is no current playing entry, returns true if the play order is non-empty.

rb_play_order_get_next ()

RhythmDBEntry *
rb_play_order_get_next (RBPlayOrder *porder);

Returns the next entry in the play order, or the first if not currently playing.

rb_play_order_go_next ()

void
rb_play_order_go_next (RBPlayOrder *porder);

Moves to the next entry in the play order. If not currently playing, sets the first entry in the play order as the playing entry.

rb_play_order_has_previous ()

gboolean
rb_play_order_has_previous (RBPlayOrder *porder);

Returns TRUE if there is an entry before the current entry in the play order. If not currently playing, returns FALSE.

rb_play_order_get_previous ()

RhythmDBEntry *
rb_play_order_get_previous (RBPlayOrder *porder);

Returns the previous entry in the play order, or NULL if not currently playing.

rb_play_order_go_previous ()

void
rb_play_order_go_previous (RBPlayOrder *porder);

Moves to the previous entry in the play order. If not currently playing, does nothing.

rb_play_order_set_playing_entry ()

void
rb_play_order_set_playing_entry (RBPlayOrder *porder,
                                 RhythmDBEntry *entry);

Sets the playing entry in the play order.

rb_play_order_get_playing_entry ()

RhythmDBEntry *
rb_play_order_get_playing_entry (RBPlayOrder *porder);

Returns the current playing entry in the play order.

rb_play_order_get_player ()

RBShellPlayer *
rb_play_order_get_player (RBPlayOrder *porder);

Only for use by RBPlayOrder subclasses.

rb_play_order_get_source ()

RBSource *
rb_play_order_get_source (RBPlayOrder *porder);

Only for use by RBPlayOrder subclasses.

rb_play_order_get_db ()

RhythmDB *
rb_play_order_get_db (RBPlayOrder *porder);

Only for use by RBPlayOrder subclasses.

rb_play_order_get_query_model ()

RhythmDBQueryModel *
rb_play_order_get_query_model (RBPlayOrder *porder);

Only for use by RBPlayOrder subclasses.

rb_play_order_model_not_empty ()

gboolean
rb_play_order_model_not_empty (RBPlayOrder *porder);

Returns TRUE if the RhythmDBQueryModel is not empty. Can be used to implement has_next and has_previous for play orders that have no beginning or end.

rb_play_order_player_is_playing ()

gboolean
rb_play_order_player_is_playing (RBPlayOrder *porder);

Returns TRUE if there is a current playing entry in the play order.

struct RBPlayOrder

struct RBPlayOrder;

struct RBPlayOrderClass

struct RBPlayOrderClass {
	GObjectClass parent_class;

	/* EVENTS */
	void (*playing_source_changed) (RBPlayOrder *porder);
	void (*db_changed) (RBPlayOrder *porder, RhythmDB *new_db);
	void (*playing_entry_changed) (RBPlayOrder *porder, RhythmDBEntry *old_entry, RhythmDBEntry *new_entry);
	void (*entry_added) (RBPlayOrder *porder, RhythmDBEntry *entry);
	void (*entry_removed) (RBPlayOrder *porder, RhythmDBEntry *entry);
	void (*query_model_changed) (RBPlayOrder *porder);
	void (*db_entry_deleted) (RBPlayOrder *porder, RhythmDBEntry *entry);
	void (*playing_entry_removed) (RBPlayOrder *porder, RhythmDBEntry *entry);

	/* QUERIES */
	/*
	 * Returns whether there is a next song. This controls the next
	 * button's sensitivity. If not implemented, defaults to
	 * get_next()!=NULL.
	 *
	 * Must not change any visible state.
	 */
	gboolean (*has_next) (RBPlayOrder* porder);
	/*
	 * get_next() must return the next song to play. It's called when a
	 * song finishes, when the user clicks the next button, and when the
	 * user clicks play after playback is stopped.
	 *
	 * get_next() is also used to find the first song. You can figure out
	 * whether the player is currently playing by calling
	 * rb_play_order_player_is_playing(porder).
	 *
	 * Must not change any visible state.
	 */
	RhythmDBEntry* (*get_next) (RBPlayOrder* porder);
	/*
	 * Tells the play order that the user has moved to the next song.
	 * Should be called before the EntryView::playing-entry property is
	 * changed.
	 */
	void (*go_next) (RBPlayOrder* porder);
	/*
	 * Returns whether there is a previous song. This controls the previous
	 * button's sensitivity. If not implemented, defaults to
	 * get_previous()!=NULL.
	 *
	 * Must not change any visible state.
	 */
	gboolean (*has_previous) (RBPlayOrder* porder);
	/*
	 * get_previous() must return the previous song to play. It's called
	 * when the user clicks the previous button within 2 seconds of the
	 * beginning of a song.
	 *
	 * Must not change any visible state.
	 */
	RhythmDBEntry* (*get_previous) (RBPlayOrder* porder);
	/*
	 * Tells the play order that the user has moved to the previous song.
	 * Should be called before the EntryView::playing-entry property is
	 * changed.
	 */
	void (*go_previous) (RBPlayOrder* porder);

	/* SIGNALS */
	void (*have_next_previous_changed) (RBPlayOrder *porder, gboolean have_next, gboolean have_previous);
};

The “player” property

  “player”                   RBShellPlayer *

The RBShellPlayer instance

Flags: Read / Write / Construct Only

The “playing-entry” property

  “playing-entry”            RhythmDBEntry *

The current playing RhythmDBEntry

Flags: Read / Write

The “have-next-previous-changed” signal

void
user_function (RBPlayOrder *porder,
               gboolean     have_next,
               gboolean     have_previous,
               gpointer     user_data)

Emitted as a hint to suggest that the sensitivity of next/previous buttons may need to be updated.

Flags: Run Last