Merge from Disobedience branch

[disorder] / disobedience / queue-generic.h

/*
 * This file is part of DisOrder
 * Copyright (C) 2006-2009 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
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
/** @file disobedience/queue-generic.h
 * @brief Disobedience queue widgets
 */
#ifndef QUEUE_GENERIC_H
#define QUEUE_GENERIC_H

/** @brief Definition of a column */
struct queue_column {
  /** @brief Column name */
  const char *name;

  /** @brief Compute value for this column */
  const char *(*value)(const struct queue_entry *q,
                       const char *data);

  /** @brief Passed to value() */
  const char *data;

  /** @brief Flags word */
  unsigned flags;
};

/** @brief Ellipsize column if too wide */
#define COL_ELLIPSIZE 0x0001

/** @brief Set expand property */
#define COL_EXPAND 0x0002

/** @brief Right-algin column */
#define COL_RIGHT 0x0004

/** @brief Definition of a queue-like window */
struct queuelike {

  /* Things filled in by the caller: */

  /** @brief Name for this tab */
  const char *name;
  
  /** @brief Initialization function */
  void (*init)(struct queuelike *ql);

  /** @brief Columns */
  const struct queue_column *columns;

  /** @brief Number of columns in this queuelike */
  int ncolumns;

  /** @brief Items for popup menu */
  struct menuitem *menuitems;

  /** @brief Number of menu items */
  int nmenuitems;

  /* Dynamic state: */

  /** @brief The head of the queue */
  struct queue_entry *q;

  /* Things created by the implementation: */
  
  /** @brief The list store */
  GtkListStore *store;

  /** @brief The tree view */
  GtkWidget *view;

  /** @brief The selection */
  GtkTreeSelection *selection;
  
  /** @brief The popup menu */
  GtkWidget *menu;

  /** @brief Menu callbacks */
  struct tabtype tabtype;

  /** @brief Drag-drop callback, or NULL for no drag+drop
   * @param ql Owning queuelike
   * @param ntracks Number of tracks to be dropped
   * @param tracks List of track names
   * @param ids List of track IDs
   * @param after_me Drop after this or NULL to drop at head
   *
   * If the rearrangement is impossible then the displayed queue must be put
   * back.
   */
  void (*drop)(struct queuelike *ql, int ntracks, char **tracks, char **ids,
               struct queue_entry *after_me);

  /** @brief Source target list */
  const GtkTargetEntry *drag_source_targets;

  /** @brief Drag source actions */
  GdkDragAction drag_source_actions;
  
  /** @brief Destination target list */
  const GtkTargetEntry *drag_dest_targets;

  /** @brief Drag destination actions */
  GdkDragAction drag_dest_actions;
  
};

enum {
  PLAYABLE_TRACKS_ID,
  QUEUED_TRACKS_ID,
  PLAYLIST_TRACKS_ID
};

#define PLAYABLE_TRACKS (char *)"text/x-disorder-playable-tracks"
#define QUEUED_TRACKS (char *)"text/x-disorder-queued-tracks"
#define PLAYLIST_TRACKS (char *)"text/x-disorder-playlist-tracks"

enum {
  QUEUEPOINTER_COLUMN,
  FOREGROUND_COLUMN,
  BACKGROUND_COLUMN,

  EXTRA_COLUMNS
};

#define BG_PLAYING "#e0ffe0"
#define FG_PLAYING "black"

extern struct queuelike ql_queue;
extern struct queuelike ql_recent;
extern struct queuelike ql_added;

extern time_t last_playing;

int ql_selectall_sensitive(void *extra);
void ql_selectall_activate(GtkMenuItem *menuitem,
                           gpointer user_data);
int ql_selectnone_sensitive(void *extra);
void ql_selectnone_activate(GtkMenuItem *menuitem,
                            gpointer user_data);
int ql_properties_sensitive(void *extra);
void ql_properties_activate(GtkMenuItem *menuitem,
                            gpointer user_data);
int ql_scratch_sensitive(void *extra);
void ql_scratch_activate(GtkMenuItem *menuitem,
                         gpointer user_data);
int ql_remove_sensitive(void *extra);
void ql_remove_activate(GtkMenuItem *menuitem,
                        gpointer user_data);
int ql_play_sensitive(void *extra);
void ql_play_activate(GtkMenuItem *menuitem,
                      gpointer user_data);
int ql_adopt_sensitive(void *extra);
void ql_adopt_activate(GtkMenuItem *menuitem,
                       gpointer user_data);
gboolean ql_button_release(GtkWidget *widget,
                           GdkEventButton *event,
                           gpointer user_data);
GtkWidget *init_queuelike(struct queuelike *ql);
void destroy_queuelike(struct queuelike *ql);
void ql_update_list_store(struct queuelike *ql) ;
void ql_update_row(struct queue_entry *q,
                   GtkTreeIter *iter);
void ql_new_queue(struct queuelike *ql,
                  struct queue_entry *newq);
const char *column_when(const struct queue_entry *q,
                        const char *data);
const char *column_who(const struct queue_entry *q,
                       const char *data);
const char *column_namepart(const struct queue_entry *q,
                            const char *data);
const char *column_length(const struct queue_entry *q,
                          const char *data);
struct tabtype *ql_tabtype(struct queuelike *ql);
struct queue_entry *ql_iter_to_q(GtkTreeModel *model,
                                 GtkTreeIter *iter);
struct queue_entry *ql_path_to_q(GtkTreeModel *model,
                                 GtkTreePath *path);

#endif /* QUEUE_GENERIC_H */

/*
Local Variables:
c-basic-offset:2
comment-column:40
fill-column:79
indent-tabs-mode:nil
End:
*/