chiark - git - mdw - disorder/blob - disobedience/queue-generic.h

   1 /*
   2  * This file is part of DisOrder
   3  * Copyright (C) 2006-2009 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/queue-generic.h
  19  * @brief Disobedience queue widgets
  20  */
  21 #ifndef QUEUE_GENERIC_H
  22 #define QUEUE_GENERIC_H
  23
  24 /** @brief Definition of a column */
  25 struct queue_column {
  26   /** @brief Column name */
  27   const char *name;
  28
  29   /** @brief Compute value for this column */
  30   const char *(*value)(const struct queue_entry *q,
  31                        const char *data);
  32
  33   /** @brief Passed to value() */
  34   const char *data;
  35
  36   /** @brief Flags word */
  37   unsigned flags;
  38 };
  39
  40 /** @brief Ellipsize column if too wide */
  41 #define COL_ELLIPSIZE 0x0001
  42
  43 /** @brief Set expand property */
  44 #define COL_EXPAND 0x0002
  45
  46 /** @brief Right-algin column */
  47 #define COL_RIGHT 0x0004
  48
  49 /** @brief Definition of a queue-like window */
  50 struct queuelike {
  51
  52   /* Things filled in by the caller: */
  53
  54   /** @brief Name for this tab */
  55   const char *name;
  56
  57   /** @brief Initialization function */
  58   void (*init)(struct queuelike *ql);
  59
  60   /** @brief Columns */
  61   const struct queue_column *columns;
  62
  63   /** @brief Number of columns in this queuelike */
  64   int ncolumns;
  65
  66   /** @brief Items for popup menu */
  67   struct menuitem *menuitems;
  68
  69   /** @brief Number of menu items */
  70   int nmenuitems;
  71
  72   /* Dynamic state: */
  73
  74   /** @brief The head of the queue */
  75   struct queue_entry *q;
  76
  77   /* Things created by the implementation: */
  78
  79   /** @brief The list store */
  80   GtkListStore *store;
  81
  82   /** @brief The tree view */
  83   GtkWidget *view;
  84
  85   /** @brief The selection */
  86   GtkTreeSelection *selection;
  87
  88   /** @brief The popup menu */
  89   GtkWidget *menu;
  90
  91   /** @brief Menu callbacks */
  92   struct tabtype tabtype;
  93
  94   /** @brief Drag-drop callback, or NULL for no drag+drop
  95    * @param ql Owning queuelike
  96    * @param ntracks Number of tracks to be dropped
  97    * @param tracks List of track names
  98    * @param ids List of track IDs
  99    * @param after_me Drop after this or NULL to drop at head
 100    *
 101    * If the rearrangement is impossible then the displayed queue must be put
 102    * back.
 103    */
 104   void (*drop)(struct queuelike *ql, int ntracks, char **tracks, char **ids,
 105                struct queue_entry *after_me);
 106
 107 };
 108
 109 enum {
 110   QUEUEPOINTER_COLUMN,
 111   FOREGROUND_COLUMN,
 112   BACKGROUND_COLUMN,
 113
 114   EXTRA_COLUMNS
 115 };
 116
 117 /* TODO probably need to set "horizontal-separator" to 0, but can't find any
 118  * coherent description of how to set style properties in isolation. */
 119 #define BG_PLAYING 0
 120 #define FG_PLAYING 0
 121
 122 #ifndef BG_PLAYING
 123 # define BG_PLAYING "#e0ffe0"
 124 # define FG_PLAYING "black"
 125 #endif
 126
 127 extern struct queuelike ql_queue;
 128 extern struct queuelike ql_recent;
 129 extern struct queuelike ql_added;
 130
 131 extern time_t last_playing;
 132
 133 int ql_selectall_sensitive(void *extra);
 134 void ql_selectall_activate(GtkMenuItem *menuitem,
 135                            gpointer user_data);
 136 int ql_selectnone_sensitive(void *extra);
 137 void ql_selectnone_activate(GtkMenuItem *menuitem,
 138                             gpointer user_data);
 139 int ql_properties_sensitive(void *extra);
 140 void ql_properties_activate(GtkMenuItem *menuitem,
 141                             gpointer user_data);
 142 int ql_scratch_sensitive(void *extra);
 143 void ql_scratch_activate(GtkMenuItem *menuitem,
 144                          gpointer user_data);
 145 int ql_remove_sensitive(void *extra);
 146 void ql_remove_activate(GtkMenuItem *menuitem,
 147                         gpointer user_data);
 148 int ql_play_sensitive(void *extra);
 149 void ql_play_activate(GtkMenuItem *menuitem,
 150                       gpointer user_data);
 151 int ql_adopt_sensitive(void *extra);
 152 void ql_adopt_activate(GtkMenuItem *menuitem,
 153                        gpointer user_data);
 154 gboolean ql_button_release(GtkWidget *widget,
 155                            GdkEventButton *event,
 156                            gpointer user_data);
 157 GtkWidget *init_queuelike(struct queuelike *ql);
 158 void destroy_queuelike(struct queuelike *ql);
 159 void ql_update_list_store(struct queuelike *ql) ;
 160 void ql_update_row(struct queue_entry *q,
 161                    GtkTreeIter *iter);
 162 void ql_new_queue(struct queuelike *ql,
 163                   struct queue_entry *newq);
 164 const char *column_when(const struct queue_entry *q,
 165                         const char *data);
 166 const char *column_who(const struct queue_entry *q,
 167                        const char *data);
 168 const char *column_namepart(const struct queue_entry *q,
 169                             const char *data);
 170 const char *column_length(const struct queue_entry *q,
 171                           const char *data);
 172 struct tabtype *ql_tabtype(struct queuelike *ql);
 173 struct queue_entry *ql_iter_to_q(GtkTreeModel *model,
 174                                  GtkTreeIter *iter);
 175 struct queue_entry *ql_path_to_q(GtkTreeModel *model,
 176                                  GtkTreePath *path);
 177
 178 #endif /* QUEUE_GENERIC_H */
 179
 180 /*
 181 Local Variables:
 182 c-basic-offset:2
 183 comment-column:40
 184 fill-column:79
 185 indent-tabs-mode:nil
 186 End:
 187 */