ui/ncurses: Add support for help screens

Add a textscreen-based help screen system, triggered from the cui
module's cui_show_help()

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

1 files changed, 31 insertions, 0 deletions

diff --git a/ui/ncurses/nc-helpscreen.h b/ui/ncurses/nc-helpscreen.h
new file mode 100644
index 0000000..f104411
--- /dev/null
+++ b/ui/ncurses/nc-helpscreen.h
@@ -0,0 +1,31 @@
+/*
+ *  Copyright (C) 2013 IBM Corporation
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; version 2 of the License.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef _NC_HELPSCREEN_H
+#define _NC_HELPSCREEN_H
+
+struct help_screen;
+
+struct nc_scr *help_screen_scr(struct help_screen *screen);
+struct nc_scr *help_screen_return_scr(struct help_screen *screen);
+
+struct help_screen *help_screen_init(struct cui *cui,
+		struct nc_scr *current_scr,
+		const char *title_suffix, const char *text,
+		void (*on_exit)(struct cui *));
+
+#endif /* defined _NC_HELPSCREEN_H */