src/list_window.h

   1 #ifndef LIST_WINDOW_H
   2 #define LIST_WINDOW_H
   3
   4 #include "command.h"
   5
   6 #include <ncurses.h>
   7 #include <glib.h>
   8
   9 #define LW_ROW(lw) (lw ? lw->selected-lw->start :  0)
  10
  11 #define LW_HIDE_CURSOR    0x01
  12
  13 typedef const char *(*list_window_callback_fn_t)(unsigned index,
  14                                                  int *highlight,
  15                                                  void *data);
  16
  17 typedef struct list_window {
  18         WINDOW *w;
  19         unsigned rows, cols;
  20
  21         unsigned start;
  22         unsigned selected;
  23         unsigned xoffset;
  24         int clear;
  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 struct list_window *list_window_free(struct list_window *lw);
  40
  41 /* reset a list window (selected=0, start=0, clear=1) */
  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
  60 /* select functions */
  61 void list_window_set_selected(struct list_window *lw, unsigned n);
  62 void list_window_previous(struct list_window *lw, unsigned length);
  63 void list_window_next(struct list_window *lw, unsigned length);
  64 void list_window_first(struct list_window *lw);
  65 void list_window_last(struct list_window *lw, unsigned length);
  66 void list_window_previous_page(struct list_window *lw);
  67 void list_window_next_page(struct list_window *lw, unsigned length);
  68 void list_window_check_selected(struct list_window *lw, unsigned length);
  69
  70 /* find a string in a list window */
  71 int  list_window_find(struct list_window *lw,
  72                       list_window_callback_fn_t callback,
  73                       void *callback_data,
  74                       const char *str,
  75                       int wrap);
  76
  77 /* find a string in a list window (reversed) */
  78 int
  79 list_window_rfind(struct list_window *lw,
  80                   list_window_callback_fn_t callback,
  81                   void *callback_data,
  82                   const char *str,
  83                   int wrap,
  84                   unsigned rows);
  85
  86 /* list window states */
  87 list_window_state_t *list_window_init_state(void);
  88 list_window_state_t *list_window_free_state(list_window_state_t *state);
  89 void list_window_push_state(list_window_state_t *state,
  90                             struct list_window *lw);
  91 bool list_window_pop_state(list_window_state_t *state, struct list_window *lw);
  92
  93
  94
  95 #endif