src/list_window.h

   1 #ifndef LIST_WINDOW_H
   2 #define LIST_WINDOW_H
   3
   4 #include "../config.h"
   5 #include "command.h"
   6
   7 #include <ncurses.h>
   8 #include <glib.h>
   9
  10 #define LW_ROW(lw) (lw ? lw->selected-lw->start :  0)
  11
  12 #define LW_HIDE_CURSOR    0x01
  13
  14 typedef const char *(*list_window_callback_fn_t)(unsigned index,
  15                                                  int *highlight,
  16                                                  void *data);
  17
  18 typedef struct list_window {
  19         WINDOW *w;
  20         unsigned rows, cols;
  21
  22         unsigned start;
  23         unsigned selected;
  24         unsigned xoffset;
  25         int repaint;
  26         int flags;
  27 } list_window_t;
  28
  29 typedef struct list_window_state {
  30         GList *list;
  31 } list_window_state_t;
  32
  33
  34 /* create a new list window */
  35 struct list_window *list_window_init(WINDOW *w,
  36                                      unsigned width, unsigned height);
  37
  38 /* destroy a list window (returns NULL) */
  39 void list_window_free(struct list_window *lw);
  40
  41 /* reset a list window (selected=0, start=0) */
  42 void list_window_reset(struct list_window *lw);
  43
  44 /* paint a list window */
  45 void list_window_paint(struct list_window *lw,
  46                        list_window_callback_fn_t callback,
  47                        void *callback_data);
  48
  49 /* perform basic list window commands (movement) */
  50 int list_window_cmd(struct list_window *lw, unsigned rows, command_t cmd);
  51
  52 /**
  53  * Scroll the window.  Returns non-zero if the command has been
  54  * consumed.
  55  */
  56 int
  57 list_window_scroll_cmd(struct list_window *lw, unsigned rows, command_t cmd);
  58
  59 #ifdef HAVE_GETMOUSE
  60 /**
  61  * The mouse was clicked.  Check if the list should be scrolled
  62  * Returns non-zero if the mouse event has been handled.
  63  */
  64 int
  65 list_window_mouse(struct list_window *lw, unsigned rows,
  66                   unsigned long bstate, int y);
  67 #endif
  68
  69 void
  70 list_window_center(struct list_window *lw, unsigned rows, unsigned n);
  71
  72 /* select functions */
  73 void list_window_set_selected(struct list_window *lw, unsigned n);
  74 void list_window_check_selected(struct list_window *lw, unsigned length);
  75
  76 /* find a string in a list window */
  77 int  list_window_find(struct list_window *lw,
  78                       list_window_callback_fn_t callback,
  79                       void *callback_data,
  80                       const char *str,
  81                       int wrap);
  82
  83 /* find a string in a list window (reversed) */
  84 int
  85 list_window_rfind(struct list_window *lw,
  86                   list_window_callback_fn_t callback,
  87                   void *callback_data,
  88                   const char *str,
  89                   int wrap,
  90                   unsigned rows);
  91
  92 /* list window states */
  93 list_window_state_t *list_window_init_state(void);
  94 void list_window_free_state(list_window_state_t *state);
  95 void list_window_push_state(list_window_state_t *state,
  96                             struct list_window *lw);
  97 bool list_window_pop_state(list_window_state_t *state, struct list_window *lw);
  98
  99
 100
 101 #endif