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

#ifndef _GTCACA_CUSTOM_H_
#define _GTCACA_CUSTOM_H_

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

/*
 * The "custom" widget is a canvas escape hatch: it owns a rectangle of the
 * screen and delegates both drawing and key handling to caller-supplied
 * callbacks.  It lets bindings (and C callers) render arbitrary content with
 * the low-level caca canvas primitives without having to add a bespoke widget
 * type to the toolkit -- ideal for a hex grid, a template tree, or any bespoke
 * view.
 */

typedef struct _gtcaca_custom_widget_t gtcaca_custom_widget_t;

typedef void (*gtcaca_custom_draw_cb_t)(gtcaca_custom_widget_t *widget, void *userdata);
typedef int  (*gtcaca_custom_key_cb_t)(gtcaca_custom_widget_t *widget, int key, void *userdata);

struct _gtcaca_custom_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;
  struct _gtcaca_custom_widget_t *prev;
  struct _gtcaca_custom_widget_t *next;

  /* Now starts custom widget properties */
  gtcaca_custom_draw_cb_t draw_cb;
  void *draw_cb_userdata;
  gtcaca_custom_key_cb_t key_cb;
  void *key_cb_userdata;
  int focusable;   /* participates in tab focus when non-zero (default 1) */
};

gtcaca_custom_widget_t *gtcaca_custom_new(gtcaca_widget_t *parent, int x, int y, int width, int height);
void gtcaca_custom_free(gtcaca_custom_widget_t *widget);
void gtcaca_custom_draw(gtcaca_custom_widget_t *widget);
void gtcaca_custom_set_draw_cb(gtcaca_custom_widget_t *widget, gtcaca_custom_draw_cb_t cb, void *userdata);
void gtcaca_custom_set_key_cb(gtcaca_custom_widget_t *widget, gtcaca_custom_key_cb_t cb, void *userdata);
void gtcaca_custom_set_focusable(gtcaca_custom_widget_t *widget, int focusable);

#endif // _GTCACA_CUSTOM_H_