chiark / gitweb /
random play menu item
[disorder] / disobedience / menu.c
index 45693853cb92be39efd68c5d2e69636b52435ccb..fcf9e9f2cd49c818950aabdaa0195071563666f5 100644 (file)
@@ -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
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file disobedience/menu.c
+ * @brief Main menu
+ */
 
 #include "disobedience.h"
 
 static GtkWidget *selectall_widget;
 static GtkWidget *properties_widget;
 
+/** @brief Main menu widgets */
+GtkItemFactory *mainmenufactory;
+
 static void about_popup_got_version(void *v, const char *value);
 
+/** @brief Called when the quit option is activated
+ *
+ * Just exits.
+ */
 static void quit_program(gpointer attribute((unused)) callback_data,
                          guint attribute((unused)) callback_action,
                          GtkWidget attribute((unused)) *menu_item) {
@@ -33,6 +43,11 @@ static void quit_program(gpointer attribute((unused)) callback_data,
 }
 
 /* TODO can we have a single parameterized callback for all these */
+
+/** @brief Called when the select all option is activated
+ *
+ * Calls the per-tab select all function.
+ */
 static void select_all(gpointer attribute((unused)) callback_data,
                        guint attribute((unused)) callback_action,
                        GtkWidget attribute((unused)) *menu_item) {
@@ -43,6 +58,10 @@ static void select_all(gpointer attribute((unused)) callback_data,
   t->selectall_activate(tab);
 }
 
+/** @brief Called when the track properties option is activated
+ *
+ * Calls the per-tab properties function.
+ */
 static void properties_item(gpointer attribute((unused)) callback_data,
                             guint attribute((unused)) callback_action,
                             GtkWidget attribute((unused)) *menu_item) {
@@ -53,6 +72,19 @@ static void properties_item(gpointer attribute((unused)) callback_data,
   t->properties_activate(tab);
 }
 
+/** @brief Called when the login option is activated */
+static void login(gpointer attribute((unused)) callback_data,
+                  guint attribute((unused)) callback_action,
+                  GtkWidget attribute((unused)) *menu_item) {
+  login_box();
+}
+
+/** @brief Update menu state
+ *
+ * Determines option sensitivity according to the current tab and adjusts the
+ * widgets accordingly.  Knows about @ref DISORDER_CONNECTED so the callbacks
+ * need not.
+ */
 void menu_update(int page) {
   GtkWidget *tab = gtk_notebook_get_nth_page
     (GTK_NOTEBOOK(tabs),
@@ -62,11 +94,12 @@ void menu_update(int page) {
   assert(t != 0);
   gtk_widget_set_sensitive(properties_widget,
                            (t->properties_sensitive(tab)
-                            && disorder_eclient_connected(client)));
+                            && (disorder_eclient_state(client) & DISORDER_CONNECTED)));
   gtk_widget_set_sensitive(selectall_widget,
                            t->selectall_sensitive(tab));
 }
-     
+   
+/** @brief Fetch version in order to display the about... popup */
 static void about_popup(gpointer attribute((unused)) callback_data,
                         guint attribute((unused)) callback_action,
                         GtkWidget attribute((unused)) *menu_item) {
@@ -78,6 +111,7 @@ static void about_popup(gpointer attribute((unused)) callback_data,
                            0);
 }
 
+/** @brief Callde when version arrives, displays about... popup */
 static void about_popup_got_version(void attribute((unused)) *v,
                                     const char *value) {
   GtkWidget *w;
@@ -102,40 +136,120 @@ static void about_popup_got_version(void attribute((unused)) *v,
   gtk_widget_destroy(w);
 }
 
+/** @brief Create the menu bar widget */
 GtkWidget *menubar(GtkWidget *w) {
   static const GtkItemFactoryEntry entries[] = {
-    { (char *)"/File", 0,  0, 0, (char *)"<Branch>", 0 },
-    { (char *)"/File/Quit Disobedience", (char *)"<CTRL>Q", quit_program, 0,
-      (char *)"<StockItem>", GTK_STOCK_QUIT },
-    { (char *)"/Edit", 0,  0, 0, (char *)"<Branch>", 0 },
-    { (char *)"/Edit/Select all tracks", (char *)"<CTRL>A", select_all, 0,
-      0, 0 },
-    { (char *)"/Edit/Track properties", 0, properties_item, 0,
-      0, 0 },
-    { (char *)"/Help", 0,  0, 0, (char *)"<Branch>", 0 },
-    { (char *)"/Help/About DisOrder", 0,  about_popup, 0,
-      (char *)"<StockItem>", GTK_STOCK_ABOUT },
+    {
+      (char *)"/File",                  /* path */
+      0,                                /* accelerator */
+      0,                                /* callback */
+      0,                                /* callback_action */
+      (char *)"<Branch>",               /* item_type */
+      0                                 /* extra_data */
+    },
+    { 
+      (char *)"/File/Login",            /* path */
+      (char *)"<CTRL>L",                /* accelerator */
+      login,                            /* callback */
+      0,                                /* callback_action */
+      0,                                /* item_type */
+      0                                 /* extra_data */
+    },
+    {
+      (char *)"/File/Quit Disobedience", /* path */
+      (char *)"<CTRL>Q",                /* accelerator */
+      quit_program,                     /* callback */
+      0,                                /* callback_action */
+      (char *)"<StockItem>",            /* item_type */
+      GTK_STOCK_QUIT                    /* extra_data */
+    },
+    
+    {
+      (char *)"/Edit",                  /* path */
+      0,                                /* accelerator */
+      0,                                /* callback */
+      0,                                /* callback_action */
+      (char *)"<Branch>",               /* item_type */
+      0                                 /* extra_data */
+    },
+    {
+      (char *)"/Edit/Select all tracks", /* path */
+      (char *)"<CTRL>A",                /* accelerator */
+      select_all,                       /* callback */
+      0,                                /* callback_action */
+      0,                                /* item_type */
+      0                                 /* extra_data */
+    },
+    {
+      (char *)"/Edit/Track properties", /* path */
+      0,                                /* accelerator */
+      properties_item,                  /* callback */
+      0,                                /* callback_action */
+      0,                                /* item_type */
+      0                                 /* extra_data */
+    },
+    
+    {
+      (char *)"/Control",               /* path */
+      0,                                /* accelerator */
+      0,                                /* callback */
+      0,                                /* callback_action */
+      (char *)"<Branch>",               /* item_type */
+      0                                 /* extra_data */
+    },
+    {
+      (char *)"/Control/Scratch",       /* path */
+      (char *)"<CTRL>S",                /* accelerator */
+      0,                                /* callback */
+      0,                                /* callback_action */
+      0,                                /* item_type */
+      0                                 /* extra_data */
+    },
+    {
+      (char *)"/Control/Random play",   /* path */
+      (char *)"<CTRL>R",                /* accelerator */
+      0,                                /* callback */
+      0,                                /* callback_action */
+      (char *)"<CheckItem>",            /* item_type */
+      0                                 /* extra_data */
+    },
+    
+    {
+      (char *)"/Help",                  /* path */
+      0,                                /* accelerator */
+      0,                                /* callback */
+      0,                                /* callback_action */
+      (char *)"<Branch>",               /* item_type */
+      0                                 /* extra_data */
+    },
+    {
+      (char *)"/Help/About DisOrder",   /* path */
+      0,                                /* accelerator */
+      about_popup,                      /* callback */
+      0,                                /* callback_action */
+      (char *)"<StockItem>",            /* item_type */
+      GTK_STOCK_ABOUT                   /* extra_data */
+    },
   };
 
-  GtkItemFactory *itemfactory;
   GtkAccelGroup *accel = gtk_accel_group_new();
 
   D(("add_menubar"));
   /* TODO: item factories are deprecated in favour of some XML thing */
-  itemfactory = gtk_item_factory_new(GTK_TYPE_MENU_BAR, "<GdisorderMain>",
-                                     accel);
-  gtk_item_factory_create_items(itemfactory,
+  mainmenufactory = gtk_item_factory_new(GTK_TYPE_MENU_BAR, "<GdisorderMain>",
+                                         accel);
+  gtk_item_factory_create_items(mainmenufactory,
                                 sizeof entries / sizeof *entries,
                                 (GtkItemFactoryEntry *)entries,
                                 0);
   gtk_window_add_accel_group(GTK_WINDOW(w), accel);
-  selectall_widget = gtk_item_factory_get_widget(itemfactory,
+  selectall_widget = gtk_item_factory_get_widget(mainmenufactory,
                                                 "<GdisorderMain>/Edit/Select all tracks");
-  properties_widget = gtk_item_factory_get_widget(itemfactory,
+  properties_widget = gtk_item_factory_get_widget(mainmenufactory,
                                                  "<GdisorderMain>/Edit/Track properties");
   assert(selectall_widget != 0);
   assert(properties_widget != 0);
-  return gtk_item_factory_get_widget(itemfactory,
+  return gtk_item_factory_get_widget(mainmenufactory,
                                      "<GdisorderMain>");
   /* menu bar had better not expand vertically if the window is too big */
 }