apps/plugins/text_viewer/tv_window.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 Gilles Roux
  11  *               2003 Garrett Derner
  12  *               2010 Yoshihisa Uchida
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  20  * KIND, either express or implied.
  21  *
  22  ****************************************************************************/
  23 #ifndef PLUGIN_TEXT_VIEWER_WINDOW_H
  24 #define PLUGIN_TEXT_VIEWER_WINDOW_H
  25
  26 /*
  27  * initialize the window module
  28  *
  29  * [In/Out] buf
  30  *          the start pointer of the buffer
  31  *
  32  * [In/Out] size
  33  *          enabled buffer size
  34  *
  35  * return
  36  *     true  initialize success
  37  *     false initialize failure
  38  */
  39 bool tv_init_window(unsigned char **buf, size_t *bufsize);
  40
  41 /* finalize the window module */
  42 void tv_finalize_window(void);
  43
  44 /* draw the display */
  45 void tv_draw_window(void);
  46
  47 /* traverse all lines of the current page */
  48 bool tv_traverse_lines(void);
  49
  50 /*
  51  * move to the window
  52  *
  53  * new position
  54  *     new window: the current window + window_delta
  55  *     new column: the current column + column_delta
  56  *
  57  * [In] window_delta
  58  *          variation of the window
  59  *
  60  * [In] column_delta
  61  *          variation of the column
  62  *
  63  */
  64 void tv_move_window(int window_delta, int column_delta);
  65
  66 #endif