/usr/include/rhythmbox/shell/rb-play-order.h is in rhythmbox-dev 3.0.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 | /*
* Copyright (C) 2003 Jeffrey Yasskin <jyasskin@mail.utexas.edu>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* The Rhythmbox authors hereby grant permission for non-GPL compatible
* GStreamer plugins to be used and distributed together with GStreamer
* and Rhythmbox. This permission is above and beyond the permissions granted
* by the GPL license by which Rhythmbox is covered. If you modify this code
* you may extend this exception to your version of the code, but you are not
* obligated to do so. If you do not wish to do so, delete this exception
* statement from your version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
/*
* RBPlayOrder defines the interface for classes which can control the order
* songs play.
*
* See rb-play-order-*.{h,c} for examples.
*
* Only rb-play-order.c should include the subclasses' headers (and it should
* only use them to instantiate the right subclass). Anyone else who wants to
* use the heirarchy should include rb-play-order.h and call the functions
* defined here.
*
* When you add a new play order, remember to update the long description of
* the state/play_order key in data/org.gnome.rhythmbox.gschema.xml and to add the
* appropriate code to rb_play_order_new().
*/
#ifndef __RB_PLAY_ORDER_H
#define __RB_PLAY_ORDER_H
#include <rhythmdb/rhythmdb.h>
#include <rhythmdb/rhythmdb-query-model.h>
#include <shell/rb-shell-player.h>
G_BEGIN_DECLS
#define RB_TYPE_PLAY_ORDER (rb_play_order_get_type ())
#define RB_PLAY_ORDER(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), RB_TYPE_PLAY_ORDER, RBPlayOrder))
#define RB_PLAY_ORDER_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), RB_TYPE_PLAY_ORDER, RBPlayOrderClass))
#define RB_IS_PLAY_ORDER(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), RB_TYPE_PLAY_ORDER))
#define RB_IS_PLAY_ORDER_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), RB_TYPE_PLAY_ORDER))
#define RB_PLAY_ORDER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), RB_TYPE_PLAY_ORDER, RBPlayOrderClass))
typedef struct _RBPlayOrder RBPlayOrder;
typedef struct _RBPlayOrderClass RBPlayOrderClass;
typedef struct RBPlayOrderPrivate RBPlayOrderPrivate;
struct _RBPlayOrder
{
GObject parent;
RBPlayOrderPrivate *priv;
};
typedef gboolean (*RBPlayOrderQueryFunc) (RBPlayOrder *porder);
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);
};
GType rb_play_order_get_type (void);
void rb_play_order_playing_source_changed (RBPlayOrder *porder,
RBSource *source);
void rb_play_order_query_model_changed (RBPlayOrder *porder);
gboolean rb_play_order_has_next (RBPlayOrder* porder);
RhythmDBEntry * rb_play_order_get_next (RBPlayOrder *porder);
void rb_play_order_go_next (RBPlayOrder *porder);
gboolean rb_play_order_has_previous (RBPlayOrder* porder);
RhythmDBEntry * rb_play_order_get_previous (RBPlayOrder *porder);
void rb_play_order_go_previous (RBPlayOrder *porder);
void rb_play_order_set_playing_entry (RBPlayOrder *porder,
RhythmDBEntry *entry);
RhythmDBEntry * rb_play_order_get_playing_entry (RBPlayOrder *porder);
/* Private utility functions used by play order implementations */
RBShellPlayer * rb_play_order_get_player (RBPlayOrder *porder);
RBSource * rb_play_order_get_source (RBPlayOrder *porder);
RhythmDB * rb_play_order_get_db (RBPlayOrder *porder);
RhythmDBQueryModel * rb_play_order_get_query_model (RBPlayOrder *porder);
gboolean rb_play_order_model_not_empty (RBPlayOrder *porder);
gboolean rb_play_order_player_is_playing (RBPlayOrder *porder);
G_END_DECLS
#endif /* __RB_PLAY_ORDER_H */
|