git.ozlabs.org Git - petitboot/blob - ui/ncurses/nc-helpscreen.h

   1 /*
   2  *  Copyright (C) 2013 IBM Corporation
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; version 2 of the License.
   7  *
   8  *  This program is distributed in the hope that it will be useful,
   9  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  *  GNU General Public License for more details.
  12  *
  13  *  You should have received a copy of the GNU General Public License
  14  *  along with this program; if not, write to the Free Software
  15  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  16  */
  17
  18 #ifndef _NC_HELPSCREEN_H
  19 #define _NC_HELPSCREEN_H
  20
  21 struct help_screen;
  22 struct cui;
  23
  24 /* Container struct for type-safety; we need to use gettext() before
  25  * displaying the untranslated string. */
  26 struct help_text {
  27         const char *text;
  28 };
  29
  30 #define define_help_text(s) { .text = s }
  31
  32 struct nc_scr *help_screen_scr(struct help_screen *screen);
  33 struct nc_scr *help_screen_return_scr(struct help_screen *screen);
  34
  35 struct help_screen *help_screen_init(struct cui *cui,
  36                 struct nc_scr *current_scr,
  37                 const char *title_suffix,
  38                 const struct help_text *text,
  39                 void (*on_exit)(struct cui *));
  40
  41
  42 #endif /* defined _NC_HELPSCREEN_H */