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