chiark / gitweb /
Merge minimode improvements and a Disobedience bugfix
[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 #include "uaudio.h"
51
52 #include <glib.h>
53 #include <gtk/gtk.h>
54 #include <gdk-pixbuf/gdk-pixbuf.h>
55 #include <gdk/gdkkeysyms.h>
56
57 /* Types ------------------------------------------------------------------- */
58
59 struct queuelike;
60 struct choosenode;
61 struct progress_window;
62
63 /** @brief Per-tab callbacks
64  *
65  * Some of the options in the main menu depend on which tab is displayed, so we
66  * have some callbacks to set them appropriately.
67  */
68 struct tabtype {
69   int (*properties_sensitive)(void *extra);
70   int (*selectall_sensitive)(void *extra);
71   int (*selectnone_sensitive)(void *extra);
72   void (*properties_activate)(GtkMenuItem *menuitem,
73                               gpointer user_data);
74   void (*selectall_activate)(GtkMenuItem *menuitem,
75                              gpointer user_data);
76   void (*selectnone_activate)(GtkMenuItem *menuitem,
77                               gpointer user_data);
78   void (*selected)(void);
79   void *extra;
80 };
81
82 /** @brief Button definitions */
83 struct button {
84   const gchar *stock;
85   void (*clicked)(GtkButton *button, gpointer userdata);
86   const char *tip;
87   GtkWidget *widget;
88   void (*pack)(GtkBox *box,
89                GtkWidget *child,
90                gboolean expand,
91                gboolean fill,
92                guint padding);
93 };
94
95 /* Variables --------------------------------------------------------------- */
96
97 extern GMainLoop *mainloop;
98 extern GtkWidget *toplevel;             /* top level window */
99 extern GtkWidget *report_label;         /* label for progress indicator */
100 extern GtkWidget *tabs;                 /* main tabs */
101 extern disorder_eclient *client;        /* main client */
102
103 extern unsigned long last_state;        /* last reported state */
104 extern rights_type last_rights;         /* last reported rights bitmap */
105 extern int playing;                     /* true if playing some track */
106 extern int volume_l, volume_r;          /* current volume */
107 extern double goesupto;                 /* volume upper bound */
108 extern int choosealpha;                 /* break up choose by letter */
109 extern int rtp_supported;
110 extern int rtp_is_running;
111 extern GtkItemFactory *mainmenufactory;
112 extern const struct uaudio *backend;
113
114 extern const disorder_eclient_log_callbacks log_callbacks;
115
116 /* Functions --------------------------------------------------------------- */
117
118 disorder_eclient *gtkclient(void);
119 /* Configure C for use in GTK+ programs */
120
121 void popup_protocol_error(int code,
122                           const char *msg);
123 /* Report an error */
124
125 void properties(int ntracks, const char **tracks,
126                 GtkWidget *parent);
127 /* Pop up a properties window for a list of tracks */
128
129 GtkWidget *scroll_widget(GtkWidget *child);
130 /* Wrap a widget up for scrolling */
131
132 GtkWidget *frame_widget(GtkWidget *w, const char *title);
133
134 GdkPixbuf *find_image(const char *name);
135 /* Get the pixbuf for an image.  Returns a null pointer if it cannot be
136  * found. */
137
138 void popup_msg(GtkMessageType mt, const char *msg);
139 void popup_submsg(GtkWidget *parent, GtkMessageType mt, const char *msg);
140
141 void fpopup_msg(GtkMessageType mt, const char *fmt, ...);
142
143 struct progress_window *progress_window_new(const char *title,
144                                             GtkWidget *parent);
145 /* Pop up a progress window */
146
147 void progress_window_progress(struct progress_window *pw,
148                               int progress,
149                               int limit);
150 /* Report current progress */
151
152 GtkWidget *iconbutton(const char *path, const char *tip);
153
154 GtkWidget *create_buttons(struct button *buttons,
155                           size_t nbuttons);
156 GtkWidget *create_buttons_box(struct button *buttons,
157                               size_t nbuttons,
158                               GtkWidget *box);
159
160 void logged_in(void);
161
162 void all_update(void);
163 /* Update everything */
164
165 /* Main menu */
166
167 GtkWidget *menubar(GtkWidget *w);
168 /* Create the menu bar */
169 int full_mode;
170
171 void users_set_sensitive(int sensitive);
172
173 /* Controls */
174
175 GtkWidget *control_widget(void);
176 /* Make the controls widget */
177
178 extern int suppress_actions;
179
180 /* Queue/Recent/Added */
181
182 GtkWidget *queue_widget(void);
183 GtkWidget *playing_widget(void);
184 GtkWidget *recent_widget(void);
185 GtkWidget *added_widget(void);
186 /* Create widgets for displaying the queue, the recently played list and the
187  * newly added tracks list */
188
189 void queue_select_all(struct queuelike *ql);
190 void queue_select_none(struct queuelike *ql);
191 /* Select all/none on some queue */
192
193 void queue_properties(struct queuelike *ql);
194 /* Pop up properties of selected items in some queue */
195
196 int queued(const char *track);
197 /* Return nonzero iff TRACK is queued or playing */
198
199 extern struct queue_entry *playing_track;
200
201 /* Lookups */
202 const char *namepart(const char *track,
203                      const char *context,
204                      const char *part);
205 long namepart_length(const char *track);
206 char *namepart_resolve(const char *track);
207
208 void namepart_update(const char *track,
209                      const char *context,
210                      const char *part);
211 /* Called when a namepart might have changed */
212
213 /* Choose */
214
215 GtkWidget *choose_widget(void);
216 /* Create a widget for choosing tracks */
217
218 void choose_update(void);
219 /* Called when we think the choose tree might need updating */
220
221 void play_completed(void *v,
222                     const char *err);
223
224 extern const GtkTargetEntry choose_targets[];
225
226 /* Login details */
227
228 void login_box(void);
229
230 GtkWidget *login_window;
231
232 /* User management */
233
234 void manage_users(void);
235
236 /* Help */
237
238 void popup_help(const char *what);
239
240 /* RTP */
241
242 int rtp_running(void);
243 void start_rtp(void);
244 void stop_rtp(void);
245
246 /* Settings */
247
248 void init_styles(void);
249 extern GtkStyle *layout_style;
250 extern GtkStyle *title_style;
251 extern GtkStyle *even_style;
252 extern GtkStyle *odd_style;
253 extern GtkStyle *active_style;
254 extern GtkStyle *tool_style;
255 extern GtkStyle *search_style;
256 extern GtkStyle *drag_style;
257
258 extern const char *browser;
259
260 void save_settings(void);
261 void load_settings(void);
262 void set_tool_colors(GtkWidget *w);
263 void popup_settings(void);
264
265 /* Playlists */
266
267 void playlists_init(void);
268 void playlist_window_create(gpointer callback_data,
269                             guint callback_action,
270                             GtkWidget  *menu_item);
271 extern char **playlists;
272 extern int nplaylists;
273 extern GtkWidget *menu_playlists_widget;
274 extern GtkWidget *playlists_menu;
275 extern GtkWidget *menu_editplaylists_widget;
276
277 #endif /* DISOBEDIENCE_H */
278
279 /*
280 Local Variables:
281 c-basic-offset:2
282 comment-column:40
283 fill-column:79
284 indent-tabs-mode:nil
285 End:
286 */