2 * This file is part of DisOrder.
3 * Copyright (C) 2006-2008 Richard Kettlewell
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 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file disobedience/disobedience.h
21 * @brief Header file for Disobedience, the DisOrder GTK+ client
24 #ifndef DISOBEDIENCE_H
25 #define DISOBEDIENCE_H
46 #include "trackname.h"
49 #include "configuration.h"
51 #include "selection.h"
55 #include <gdk-pixbuf/gdk-pixbuf.h>
57 /* Types ------------------------------------------------------------------- */
61 struct progress_window
;
63 /** @brief Callback data structure
65 * This program is extremely heavily callback-driven. Rather than have
66 * numerous different callback structures we have a single one which can be
67 * interpreted adequately both by success and error handlers.
70 void (*onerror
)(struct callbackdata
*cbd
,
72 const char *msg
); /* called on error */
74 const char *key
; /* gtkqueue.c op_part_lookup */
75 struct choosenode
*choosenode
; /* gtkchoose.c got_files/got_dirs */
76 struct queuelike
*ql
; /* gtkqueue.c queuelike_completed */
77 struct prefdata
*f
; /* properties.c */
78 const char *user
; /* users.c */
80 const char *user
, *email
; /* users.c */
85 /** @brief Per-tab callbacks
87 * Some of the options in the main menu depend on which tab is displayed, so we
88 * have some callbacks to set them appropriately.
91 int (*properties_sensitive
)(GtkWidget
*tab
);
92 int (*selectall_sensitive
)(GtkWidget
*tab
);
93 int (*selectnone_sensitive
)(GtkWidget
*tab
);
94 void (*properties_activate
)(GtkWidget
*tab
);
95 void (*selectall_activate
)(GtkWidget
*tab
);
96 void (*selectnone_activate
)(GtkWidget
*tab
);
99 /** @brief Button definitions */
102 void (*clicked
)(GtkButton
*button
, gpointer userdata
);
107 /* Variables --------------------------------------------------------------- */
109 extern GMainLoop
*mainloop
;
110 extern GtkWidget
*toplevel
; /* top level window */
111 extern GtkWidget
*report_label
; /* label for progress indicator */
112 extern GtkWidget
*tabs
; /* main tabs */
113 extern disorder_eclient
*client
; /* main client */
115 extern unsigned long last_state
; /* last reported state */
116 extern int playing
; /* true if playing some track */
117 extern int volume_l
, volume_r
; /* current volume */
118 extern double goesupto
; /* volume upper bound */
119 extern int choosealpha
; /* break up choose by letter */
120 extern GtkTooltips
*tips
;
121 extern int rtp_supported
;
122 extern int rtp_is_running
;
123 extern GtkItemFactory
*mainmenufactory
;
125 extern const disorder_eclient_log_callbacks log_callbacks
;
127 typedef void monitor_callback(void *u
);
129 /* Functions --------------------------------------------------------------- */
131 disorder_eclient
*gtkclient(void);
132 /* Configure C for use in GTK+ programs */
134 void popup_protocol_error(int code
,
136 /* Report an error */
138 void properties(int ntracks
, const char **tracks
);
139 /* Pop up a properties window for a list of tracks */
141 void properties_reset(void);
143 GtkWidget
*scroll_widget(GtkWidget
*child
);
144 /* Wrap a widget up for scrolling */
146 GdkPixbuf
*find_image(const char *name
);
147 /* Get the pixbuf for an image. Returns a null pointer if it cannot be
150 void popup_msg(GtkMessageType mt
, const char *msg
);
151 void popup_submsg(GtkWidget
*parent
, GtkMessageType mt
, const char *msg
);
153 void fpopup_msg(GtkMessageType mt
, const char *fmt
, ...);
155 struct progress_window
*progress_window_new(const char *title
);
156 /* Pop up a progress window */
158 void progress_window_progress(struct progress_window
*pw
,
161 /* Report current progress */
163 GtkWidget
*iconbutton(const char *path
, const char *tip
);
165 GtkWidget
*create_buttons(struct button
*buttons
,
167 GtkWidget
*create_buttons_box(struct button
*buttons
,
171 void register_monitor(monitor_callback
*callback
,
174 /* Register a state monitor */
176 /** @brief Type signature for a reset callback */
177 typedef void reset_callback(void);
179 void register_reset(reset_callback
*callback
);
180 /* Register a reset callback */
184 void all_update(void);
185 /* Update everything */
189 GtkWidget
*menubar(GtkWidget
*w
);
190 /* Create the menu bar */
192 void menu_update(int page
);
193 /* Called whenever the main menu might need to change. PAGE is the current
194 * page if known or -1 otherwise. */
199 GtkWidget
*control_widget(void);
200 /* Make the controls widget */
202 void volume_update(void);
203 /* Called whenever we think the volume control has changed */
205 void control_monitor(void *u
);
207 extern int suppress_actions
;
209 /* Queue/Recent/Added */
211 GtkWidget
*queue_widget(void);
212 GtkWidget
*recent_widget(void);
213 GtkWidget
*added_widget(void);
214 /* Create widgets for displaying the queue, the recently played list and the
215 * newly added tracks list */
217 void queue_update(void);
218 void recent_update(void);
219 void added_update(void);
220 /* Called whenever we think the queue, recent or newly-added list might have
223 void queue_select_all(struct queuelike
*ql
);
224 void queue_select_none(struct queuelike
*ql
);
225 /* Select all/none on some queue */
227 void queue_properties(struct queuelike
*ql
);
228 /* Pop up properties of selected items in some queue */
230 int queued(const char *track
);
231 /* Return nonzero iff TRACK is queued or playing */
233 void namepart_update(const char *track
,
236 /* Called when a namepart might have changed */
241 GtkWidget
*choose_widget(void);
242 /* Create a widget for choosing tracks */
244 void choose_update(void);
245 /* Called when we think the choose tree might need updating */
249 void login_box(void);
251 GtkWidget
*login_window
;
253 /* User management */
255 void manage_users(void);
259 void popup_help(void);
263 int rtp_running(void);
264 void start_rtp(void);
269 void init_styles(void);
270 extern GtkStyle
*layout_style
;
271 extern GtkStyle
*title_style
;
272 extern GtkStyle
*even_style
;
273 extern GtkStyle
*odd_style
;
274 extern GtkStyle
*active_style
;
275 extern GtkStyle
*tool_style
;
276 extern GtkStyle
*search_style
;
277 extern GtkStyle
*drag_style
;
279 extern const char *browser
;
281 void save_settings(void);
282 void load_settings(void);
283 void set_tool_colors(GtkWidget
*w
);
284 void popup_settings(void);
286 /* Widget leakage debugging rubbish ---------------------------------------- */
289 #define NW(what) do { \
290 if(++current##what % 100 > max##what) { \
291 fprintf(stderr, "%s:%d: %d %s\n", \
292 __FILE__, __LINE__, current##what, #what); \
293 max##what = current##what; \
296 #define WT(what) static int current##what, max##what
297 #define DW(what) (--current##what)
299 #define NW(what) do { } while(0)
300 #define DW(what) do { } while(0)
301 #define WT(what) struct neverused
305 extern const char *mtag
;
306 #define MTAG(x) do { mtag = x; } while(0)
307 #define MTAG_PUSH(x) do { const char *save_mtag = mtag; mtag = x; (void)0
308 #define MTAG_POP() mtag = save_mtag; } while(0)
310 #define MTAG(x) do { } while(0)
311 #define MTAG_PUSH(x) do {} while(0)
312 #define MTAG_POP() do {} while(0)
315 #endif /* DISOBEDIENCE_H */