ui/ncurses: Add help facility to text screens

Signed-off-by: Jeremy Kerr <jk@ozlabs.org>

2 files changed, 17 insertions, 0 deletions

diff --git a/ui/ncurses/nc-textscreen.c b/ui/ncurses/nc-textscreen.c
index 891c8a1..d5b894e 100644
--- a/ui/ncurses/nc-textscreen.c
+++ b/ui/ncurses/nc-textscreen.c
@@ -150,6 +150,11 @@ void text_screen_process_key(struct nc_scr *scr, int key)
 	case KEY_UP:
 		text_screen_scroll(screen, key);
 		break;
+	case 'h':
+		if (screen->help_text)
+			cui_show_help(screen->cui, screen->help_title,
+					screen->help_text);
+		break;
 	default:
 		break;
 	}
@@ -166,6 +171,14 @@ struct nc_scr *text_screen_scr(struct text_screen *screen)
 	return &screen->scr;
 }
 
+void text_screen_set_help(struct text_screen *screen, const char *title,
+		const char *text)
+{
+	screen->help_title = title;
+	screen->help_text = text;
+	screen->scr.frame.help = "x=exit h=help";
+}
+
 static int text_screen_post(struct nc_scr *scr)
 {
 	nc_scr_frame_draw(scr);
diff --git a/ui/ncurses/nc-textscreen.h b/ui/ncurses/nc-textscreen.h
index 8afcf49..72b8c8a 100644
--- a/ui/ncurses/nc-textscreen.h
+++ b/ui/ncurses/nc-textscreen.h
@@ -28,6 +28,8 @@ struct text_screen {
 	int		n_lines;
 	int		n_alloc_lines;
 	int		scroll_y;
+	const char	*help_title;
+	const char	*help_text;
 	void		(*on_exit)(struct cui *);
 };
 
@@ -42,6 +44,8 @@ void text_screen_clear(struct text_screen *screen);
 void text_screen_append_line(struct text_screen *screen,
 		const char *fmt, ...) __attribute__((format(printf, 2, 3)));
 void text_screen_set_text(struct text_screen *screen, const char *text);
+void text_screen_set_help(struct text_screen *screen, const char *title,
+		const char *text);
 
 /* interaction */
 void text_screen_process_key(struct nc_scr *scr, int key);