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