[editbox] Allow for password widgets that do not display their contents
[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         /** Flags */
28         unsigned int flags;
29 };
30
31 /** Editable text box widget flags */
32 enum edit_box_flags {
33         /** Show stars instead of contents (for password widgets) */
34         EDITBOX_STARS = 0x0001,
35 };
36
37 extern void init_editbox ( struct edit_box *box, char *buf, size_t len,
38                            WINDOW *win, unsigned int row, unsigned int col,
39                            unsigned int width, unsigned int flags )
40                            __attribute__ (( nonnull (1, 2) ));
41 extern void draw_editbox ( struct edit_box *box ) __nonnull;
42 static inline int edit_editbox ( struct edit_box *box, int key ) __nonnull;
43
44 /**
45  * Edit text box widget
46  *
47  * @v box               Editable text box widget
48  * @v key               Key pressed by user
49  * @ret key             Key returned to application, or zero
50  *
51  * You must call draw_editbox() to update the display after calling
52  * edit_editbox().
53  *
54  */
55 static inline int edit_editbox ( struct edit_box *box, int key ) {
56         return edit_string ( &box->string, key );
57 }
58
59 #endif /* _GPXE_EDITBOX_H */