chiark / gitweb /
Merge playlist branch against trunk to date.
[disorder] / disobedience / disobedience.h
1 /*
2  * This file is part of DisOrder.
3  * Copyright (C) 2006-2008 Richard Kettlewell
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  * 
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 /** @file disobedience/disobedience.h
19  * @brief Header file for Disobedience, the DisOrder GTK+ client
20  */
21
22 #ifndef DISOBEDIENCE_H
23 #define DISOBEDIENCE_H
24
25 #include "common.h"
26
27 #include <time.h>
28 #include <ctype.h>
29 #include <errno.h>
30 #include <math.h>
31
32 #include "mem.h"
33 #include "log.h"
34 #include "eclient.h"
35 #include "printf.h"
36 #include "cache.h"
37 #include "queue.h"
38 #include "printf.h"
39 #include "vector.h"
40 #include "trackname.h"
41 #include "syscalls.h"
42 #include "defs.h"
43 #include "configuration.h"
44 #include "hash.h"
45 #include "selection.h"
46 #include "kvp.h"
47 #include "eventdist.h"
48 #include "split.h"
49 #include "timeval.h"
50
51 #include <glib.h>
52 #include <gtk/gtk.h>
53 #include <gdk-pixbuf/gdk-pixbuf.h>
54 #include <gdk/gdkkeysyms.h>
55
56 /* Types ------------------------------------------------------------------- */
57
58 struct queuelike;
59 struct choosenode;
60 struct progress_window;
61
62 /** @brief Per-tab callbacks
63  *
64  * Some of the options in the main menu depend on which tab is displayed, so we
65  * have some callbacks to set them appropriately.
66  */
67 struct tabtype {
68   int (*properties_sensitive)(void *extra);
69   int (*selectall_sensitive)(void *extra);
70   int (*selectnone_sensitive)(void *extra);
71   void (*properties_activate)(GtkMenuItem *menuitem,
72                               gpointer user_data);
73   void (*selectall_activate)(GtkMenuItem *menuitem,
74                              gpointer user_data);
75   void (*selectnone_activate)(GtkMenuItem *menuitem,
76                               gpointer user_data);
77   void (*selected)(void);
78   void *extra;
79 };
80
81 /** @brief Button definitions */
82 struct button {
83   const gchar *stock;
84   void (*clicked)(GtkButton *button, gpointer userdata);
85   const char *tip;
86   GtkWidget *widget;
87 };
88
89 /* Variables --------------------------------------------------------------- */
90
91 extern GMainLoop *mainloop;
92 extern GtkWidget *toplevel;             /* top level window */
93 extern GtkWidget *report_label;         /* label for progress indicator */
94 extern GtkWidget *tabs;                 /* main tabs */
95 extern disorder_eclient *client;        /* main client */
96
97 extern unsigned long last_state;        /* last reported state */
98 extern rights_type last_rights;         /* last reported rights bitmap */
99 extern int playing;                     /* true if playing some track */
100 extern int volume_l, volume_r;          /* current volume */
101 extern double goesupto;                 /* volume upper bound */
102 extern int choosealpha;                 /* break up choose by letter */
103 extern GtkTooltips *tips;
104 extern int rtp_supported;
105 extern int rtp_is_running;
106 extern GtkItemFactory *mainmenufactory;
107
108 extern const disorder_eclient_log_callbacks log_callbacks;
109
110 /* Functions --------------------------------------------------------------- */
111
112 disorder_eclient *gtkclient(void);
113 /* Configure C for use in GTK+ programs */
114
115 void popup_protocol_error(int code,
116                           const char *msg);
117 /* Report an error */
118
119 void properties(int ntracks, const char **tracks);
120 /* Pop up a properties window for a list of tracks */
121
122 GtkWidget *scroll_widget(GtkWidget *child);
123 /* Wrap a widget up for scrolling */
124
125 GtkWidget *frame_widget(GtkWidget *w, const char *title);
126
127 GdkPixbuf *find_image(const char *name);
128 /* Get the pixbuf for an image.  Returns a null pointer if it cannot be
129  * found. */
130
131 void popup_msg(GtkMessageType mt, const char *msg);
132 void popup_submsg(GtkWidget *parent, GtkMessageType mt, const char *msg);
133
134 void fpopup_msg(GtkMessageType mt, const char *fmt, ...);
135
136 struct progress_window *progress_window_new(const char *title);
137 /* Pop up a progress window */
138
139 void progress_window_progress(struct progress_window *pw,
140                               int progress,
141                               int limit);
142 /* Report current progress */
143
144 GtkWidget *iconbutton(const char *path, const char *tip);
145
146 GtkWidget *create_buttons(struct button *buttons,
147                           size_t nbuttons);
148 GtkWidget *create_buttons_box(struct button *buttons,
149                               size_t nbuttons,
150                               GtkWidget *box);
151
152 void logged_in(void);
153
154 void all_update(void);
155 /* Update everything */
156
157 /* Main menu */
158
159 GtkWidget *menubar(GtkWidget *w);
160 /* Create the menu bar */
161
162 void users_set_sensitive(int sensitive);
163
164 /* Controls */
165
166 GtkWidget *control_widget(void);
167 /* Make the controls widget */
168
169 extern int suppress_actions;
170
171 /* Queue/Recent/Added */
172
173 GtkWidget *queue_widget(void);
174 GtkWidget *recent_widget(void);
175 GtkWidget *added_widget(void);
176 /* Create widgets for displaying the queue, the recently played list and the
177  * newly added tracks list */
178
179 void queue_select_all(struct queuelike *ql);
180 void queue_select_none(struct queuelike *ql);
181 /* Select all/none on some queue */
182
183 void queue_properties(struct queuelike *ql);
184 /* Pop up properties of selected items in some queue */
185
186 int queued(const char *track);
187 /* Return nonzero iff TRACK is queued or playing */
188
189 extern struct queue_entry *playing_track;
190
191 /* Lookups */
192 const char *namepart(const char *track,
193                      const char *context,
194                      const char *part);
195 long namepart_length(const char *track);
196 char *namepart_resolve(const char *track);
197
198 void namepart_update(const char *track,
199                      const char *context,
200                      const char *part);
201 /* Called when a namepart might have changed */
202
203 /* Choose */
204
205 GtkWidget *choose_widget(void);
206 /* Create a widget for choosing tracks */
207
208 void choose_update(void);
209 /* Called when we think the choose tree might need updating */
210
211 void play_completed(void *v,
212                     const char *err);
213
214 /* Login details */
215
216 void login_box(void);
217
218 GtkWidget *login_window;
219
220 /* User management */
221
222 void manage_users(void);
223
224 /* Help */
225
226 void popup_help(void);
227
228 /* RTP */
229
230 int rtp_running(void);
231 void start_rtp(void);
232 void stop_rtp(void);
233
234 /* Settings */
235
236 void init_styles(void);
237 extern GtkStyle *layout_style;
238 extern GtkStyle *title_style;
239 extern GtkStyle *even_style;
240 extern GtkStyle *odd_style;
241 extern GtkStyle *active_style;
242 extern GtkStyle *tool_style;
243 extern GtkStyle *search_style;
244 extern GtkStyle *drag_style;
245
246 extern const char *browser;
247
248 void save_settings(void);
249 void load_settings(void);
250 void set_tool_colors(GtkWidget *w);
251 void popup_settings(void);
252
253 /* Playlists */
254
255 void playlists_init(void);
256 void edit_playlists(gpointer callback_data,
257                     guint callback_action,
258                     GtkWidget  *menu_item);
259 extern char **playlists;
260 extern int nplaylists;
261 extern GtkWidget *playlists_widget;
262 extern GtkWidget *playlists_menu;
263 extern GtkWidget *editplaylists_widget;
264
265 #endif /* DISOBEDIENCE_H */
266
267 /*
268 Local Variables:
269 c-basic-offset:2
270 comment-column:40
271 fill-column:79
272 indent-tabs-mode:nil
273 End:
274 */