gtcaca-sys 0.1.15

Raw FFI bindings to GTCaca, a libcaca-based terminal UI toolkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

#ifndef _GTCACA_TEXTLIST_H_
#define _GTCACA_TEXTLIST_H_

#include <gtcaca/main.h>
#include <gtcaca/widget.h>

#include <gtcaca/utarray.h>

#define GTCACA_TEXTLIST_MAX 1024

typedef struct _gtcaca_textlist_widget_t gtcaca_textlist_widget_t;

/*
 * Callback definitions
 */
typedef int (*gtcaca_textlist_key_cb_t)(gtcaca_textlist_widget_t *widget, int key, void *userdata);

struct _gtcaca_textlist_widget_t {
  /* Properties shared accross all widgets */
  gtcaca_widget_type_t type;
  unsigned int id;
  int has_focus;
  int is_visible;
  int x;
  int y;
  int width;
  int height;
  uint8_t color_focus_fg;
  uint8_t color_focus_bg;
  uint8_t color_nonfocus_fg;
  uint8_t color_nonfocus_bg;
  gtcaca_widget_t *parent;
  gtcaca_widget_t *children; // Any widget can be a children
  struct _gtcaca_application_widget_t *prev;
  struct _gtcaca_textlist_widget_t *next;

  /* Widget callbacks */
  gtcaca_textlist_key_cb_t private_key_cb; /* Things the widget must do */
  gtcaca_textlist_key_cb_t key_cb;
  void *key_cb_userdata;

  /* Now starts custom widget properties */
  unsigned int selected_item;
  UT_array *list;

  // When we show less than what the widget has
  unsigned int view_size;

  /* Incremental search: press '/' to start typing a query; the list then shows
     only items containing it (case-insensitive) and Up/Down move among the
     matches. Enter/Esc leave search mode. Enabled by default. */
  int  search_enabled;
  int  searching;
  char search_query[128];
  int  search_len;
};

/*
 * Functions
 */
gtcaca_textlist_widget_t *gtcaca_textlist_new(gtcaca_widget_t *parent, int x, int y);
void gtcaca_textlist_widget_set_view_size(gtcaca_textlist_widget_t *widget, unsigned int view_size);
int gtcaca_textlist_key_cb_register(gtcaca_textlist_widget_t *widget, gtcaca_textlist_key_cb_t key_cb, void *userdata);
void gtcaca_textlist_append(gtcaca_textlist_widget_t *textlist, char *item);
void gtcaca_textlist_selection_up(gtcaca_textlist_widget_t *textlist);
void gtcaca_textlist_selection_down(gtcaca_textlist_widget_t *textlist);
char *gtcaca_textlist_get_text_selected(gtcaca_textlist_widget_t *textlist);
void gtcaca_textlist_draw(gtcaca_textlist_widget_t *textlist);
void gtcaca_textlist_clear(gtcaca_textlist_widget_t *textlist);
/* Enable/disable the '/' incremental search (on by default). */
void gtcaca_textlist_set_search_enabled(gtcaca_textlist_widget_t *textlist, int enabled);
/* Whether the widget is currently in search-input mode. */
int  gtcaca_textlist_is_searching(gtcaca_textlist_widget_t *textlist);

#endif // _GTCACA_TEXTLIST_H_