git.ozlabs.org Git - petitboot/blob - ui/ncurses/nc-textscreen.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_TEXTSCREEN_H
  19 #define _NC_TEXTSCREEN_H
  20
  21 #include "types/types.h"
  22 #include "nc-cui.h"
  23
  24 struct text_screen {
  25         struct nc_scr           scr;
  26         struct cui              *cui;
  27         const char              **lines;
  28         int                     n_lines;
  29         int                     n_alloc_lines;
  30         int                     scroll_y;
  31         bool                    need_update;
  32         const char              *help_title;
  33         const struct help_text  *help_text;
  34         void                    (*on_exit)(struct cui *);
  35 };
  36
  37 void text_screen_init(struct text_screen *screen, struct cui *cui,
  38                 const char *title, void (*on_exit)(struct cui *));
  39
  40 struct text_screen *text_screen_from_scr(struct nc_scr *scr);
  41 struct nc_scr *text_screen_scr(struct text_screen *screen);
  42
  43 /* content modification */
  44 void text_screen_clear(struct text_screen *screen);
  45 void text_screen_append_line(struct text_screen *screen,
  46                 const char *fmt, ...) __attribute__((format(printf, 2, 3)));
  47 void text_screen_set_text(struct text_screen *screen, const char *text);
  48 void text_screen_set_help(struct text_screen *screen, const char *title,
  49                 const struct help_text *text);
  50
  51 /* interaction */
  52 void text_screen_process_key(struct nc_scr *scr, int key);
  53 void text_screen_draw(struct text_screen *screen);
  54
  55
  56 #endif /* defined _NC_TEXTSCREEN_H */