home · contact · privacy
Improved error handling, more error catching, error messages.
[plomrogue] / src / wincontrol.h
1 /* wincontrol.h
2  *
3  * Routines that build on top of the windows library to provide a simple window
4  * management API to the game.
5  */
6
7 #ifndef WINCONTROL_H
8 #define WINCONTROL_H
9
10
11
12 #include <stdint.h> /* for uint8_t */
13 struct Win;
14 struct WinMeta;
15 struct World;
16
17
18
19 /* Wrapper around init_win() that reads the desired window size and title from a
20  * file at the path prefixing the provided win name "w_name" with
21  * "config/windows/". "f"() is the window drawing function (Win._draw()).
22  */
23 extern struct Win * init_win_from_file(struct World * world, char * w_name,
24                                        void (* f) (struct Win *));
25
26
27
28
29 /* Toggle windows in world->wins in the order desribed by the first line of
30  * config/windows/toggled_win_order, wherein each character may correspond to
31  * one hardcoded window.
32  */
33 extern void sorted_wintoggle(struct World * world);
34
35
36
37 /* Toggle display of a window "win".
38  *
39  * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
40  */
41 extern uint8_t toggle_window(struct WinMeta * win_meta, struct Win * win);
42
43
44
45 /* Try to scroll virtual screen left ("dir" = "-") or right ("dir" = "+"),
46  * subject to the limitations provided by the window manager via
47  * reset_pad_offset().
48  */
49 extern void scroll_pad(struct WinMeta * win_meta, char dir);
50
51
52
53 /* Try to grow or shrink the active window horizontally ("change" = "*"/"_") or
54  * vertically ("change = "+"/"-") by one cell size, subject to the limitations
55  * provided by the window manager via resize_active_win().
56  *
57  * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
58  */
59 extern uint8_t growshrink_active_window(struct WinMeta * win_meta, char change);
60
61
62
63 #endif