47b07c25d22e8d8ff4e5d9019429f43c4b29565b
[people/lynusvaz/gpxe.git] / src / include / gpxe / editbox.h
1 #ifndef _GPXE_EDITBOX_H
2 #define _GPXE_EDITBOX_H
3
4 /** @file
5  *
6  * Editable text box widget
7  *
8  */
9
10 #include <curses.h>
11 #include <gpxe/editstring.h>
12
13 /** An editable text box widget */
14 struct edit_box {
15         /** Editable string */
16         struct edit_string string;
17         /** Containing window */
18         WINDOW *win;
19         /** Row */
20         unsigned int row;
21         /** Starting column */
22         unsigned int col;
23         /** Width */
24         unsigned int width;
25         /** First displayed character */
26         unsigned int first;
27 };
28
29 extern void init_editbox ( struct edit_box *box, char *buf, size_t len,
30                            WINDOW *win, unsigned int row, unsigned int col,
31                            unsigned int width ) 
32                            __attribute__ (( nonnull (1, 2) ));
33 extern void draw_editbox ( struct edit_box *box ) __nonnull;
34 static inline int __pure edit_editbox ( struct edit_box *box, int key ) __nonnull;
35
36 /**
37  * Edit text box widget
38  *
39  * @v box               Editable text box widget
40  * @v key               Key pressed by user
41  * @ret key             Key returned to application, or zero
42  *
43  * You must call draw_editbox() to update the display after calling
44  * edit_editbox().
45  *
46  */
47 static inline int edit_editbox ( struct edit_box *box, int key ) {
48         return edit_string ( &box->string, key );
49 }
50
51 #endif /* _GPXE_EDITBOX_H */