X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/10e226b3dc53a157ef57f3f9dbc606c70465bdc8..73f1b9f30c98dc525a5b6a540f6f135855d640a0:/disobedience/disobedience.h

diff --git a/disobedience/disobedience.h b/disobedience/disobedience.h
index 6a68b9a..37bdda4 100644
--- a/disobedience/disobedience.h
+++ b/disobedience/disobedience.h
@@ -1,6 +1,6 @@
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2006 Richard Kettlewell
+ * Copyright (C) 2006, 2007 Richard Kettlewell
  *
  * 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
@@ -17,6 +17,9 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file disobedience/disobedience.h
+ * @brief Header file for Disobedience, the DisOrder GTK+ client
+ */
 
 #ifndef DISOBEDIENCE_H
 #define DISOBEDIENCE_H
@@ -55,7 +58,14 @@
 
 struct queuelike;
 struct choosenode;
+struct progress_window;
 
+/** @brief Callback data structure
+ *
+ * This program is extremely heavily callback-driven.  Rather than have
+ * numerous different callback structures we have a single one which can be
+ * interpreted adequately both by success and error handlers.
+ */
 struct callbackdata {
   void (*onerror)(struct callbackdata *cbd,
                   int code,
@@ -68,6 +78,11 @@ struct callbackdata {
   } u;
 };
 
+/** @brief Per-tab callbacks
+ *
+ * Some of the options in the main menu depend on which tab is displayed, so we
+ * have some callbacks to set them appropriately.
+ */
 struct tabtype {
   int (*properties_sensitive)(GtkWidget *tab);
   int (*selectall_sensitive)(GtkWidget *tab);
@@ -75,6 +90,13 @@ struct tabtype {
   void (*selectall_activate)(GtkWidget *tab);
 };
 
+/** @brief Button definitions */
+struct button {
+  const gchar *stock;
+  void (*clicked)(GtkButton *button, gpointer userdata);
+  const char *tip;
+};
+
 /* Variables --------------------------------------------------------------- */
 
 extern GMainLoop *mainloop;
@@ -88,9 +110,12 @@ extern int playing;                     /* true if playing some track */
 extern int volume_l, volume_r;          /* current volume */
 extern double goesupto;                 /* volume upper bound */
 extern int choosealpha;                 /* break up choose by letter */
+extern GtkTooltips *tips;
 
 extern const disorder_eclient_log_callbacks log_callbacks;
 
+typedef void monitor_callback(void *u);
+
 /* Functions --------------------------------------------------------------- */
 
 disorder_eclient *gtkclient(void);
@@ -100,9 +125,11 @@ void popup_protocol_error(int code,
                           const char *msg);
 /* Report an error */
 
-void properties(int ntracks, char **tracks);
+void properties(int ntracks, const char **tracks);
 /* Pop up a properties window for a list of tracks */
 
+void properties_reset(void);
+
 GtkWidget *scroll_widget(GtkWidget *child, const char *name);
 /* Wrap a widget up for scrolling */
 
@@ -113,6 +140,34 @@ GdkPixbuf *find_image(const char *name);
 void popup_error(const char *msg);
 /* Pop up an error message */
 
+void fpopup_error(const char *fmt, ...);
+
+struct progress_window *progress_window_new(const char *title);
+/* Pop up a progress window */
+
+void progress_window_progress(struct progress_window *pw,
+			      int progress,
+			      int limit);
+/* Report current progress */
+
+GtkWidget *iconbutton(const char *path, const char *tip);
+
+GtkWidget *create_buttons(const struct button *buttons,
+                          size_t nbuttons);
+
+void register_monitor(monitor_callback *callback,
+                      void *u,
+                      unsigned long mask);
+/* Register a state monitor */
+
+/** @brief Type signature for a reset callback */
+typedef void reset_callback(void);
+
+void register_reset(reset_callback *callback);
+/* Register a reset callback */
+
+void reset(void);
+
 void all_update(void);
 /* Update everything */
 
@@ -131,19 +186,22 @@ void menu_update(int page);
 GtkWidget *control_widget(void);
 /* Make the controls widget */
 
-void control_update(void);
-/* Called whenever we think the control widget needs changing */
-
+void volume_update(void);
+/* Called whenever we think the volume control has changed */
 
-/* Queue/Recent */
+/* Queue/Recent/Added */
 
 GtkWidget *queue_widget(void);
 GtkWidget *recent_widget(void);
-/* Create widgets for displaying the queue and the recently played list */
+GtkWidget *added_widget(void);
+/* Create widgets for displaying the queue, the recently played list and the
+ * newly added tracks list */
 
 void queue_update(void);
 void recent_update(void);
-/* Called whenever we think the queue or recent list might have chanegd */
+void added_update(void);
+/* Called whenever we think the queue, recent or newly-added list might have
+ * changed */
 
 void queue_select_all(struct queuelike *ql);
 /* Select all on some queue */
@@ -151,9 +209,6 @@ void queue_select_all(struct queuelike *ql);
 void queue_properties(struct queuelike *ql);
 /* Pop up properties of selected items in some queue */
 
-void playing_update(void);
-/* Called whenever we think the currently playing track might have changed */
-
 int queued(const char *track);
 /* Return nonzero iff TRACK is queued or playing */
 
@@ -171,6 +226,8 @@ GtkWidget *choose_widget(void);
 void choose_update(void);
 /* Called when we think the choose tree might need updating */
 
+void login_box(void);
+
 /* Widget leakage debugging rubbish ---------------------------------------- */
 
 #if MDEBUG