apps/plugins/text_viewer/tv_action.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_ACTION_H
  24 #define PLUGIN_TEXT_VIEWER_ACTION_H
  25
  26 #include "tv_menu.h"
  27
  28 /* horizontal scroll mode */
  29 enum
  30 {
  31     TV_HORIZONTAL_SCROLL_COLUMN = 0, /* left/right one column */
  32     TV_HORIZONTAL_SCROLL_SCREEN, /* left/right one screen */
  33     TV_HORIZONTAL_SCROLL_PREFS,  /* left/right follows the settings */
  34 };
  35
  36 /*vertical scroll mode */
  37 enum
  38 {
  39     TV_VERTICAL_SCROLL_LINE = 0,   /* up/down one line */
  40     TV_VERTICAL_SCROLL_PAGE,   /* up/down one page */
  41     TV_VERTICAL_SCROLL_PREFS,  /* up/down follows the settings */
  42 };
  43
  44 /*
  45  * initialize the action module
  46  *
  47  * [In/Out] buf
  48  *          the start pointer of the buffer
  49  *
  50  * [In/Out] size
  51  *          buffer size
  52  *
  53  * return
  54  *     true  initialize success
  55  *     false initialize failure
  56  */
  57 bool tv_init_action(unsigned char **buf, size_t *bufsize);
  58
  59 /*
  60  * finalize modules
  61  */
  62 void tv_exit(void);
  63
  64 /*
  65  * load the file
  66  *
  67  * [In] file
  68  *          read file name
  69  *
  70  * return
  71  *     true  load success
  72  *     false load failure
  73  */
  74 bool tv_load_file(const unsigned char *file);
  75
  76 /* draw the current page */
  77 void tv_draw(void);
  78
  79 /*
  80  * scroll up
  81  *
  82  * [In] mode
  83  *          scroll mode
  84  */
  85 void tv_scroll_up(unsigned mode);
  86
  87 /*
  88  * scroll down
  89  *
  90  * [In] mode
  91  *          scroll mode
  92  */
  93 void tv_scroll_down(unsigned mode);
  94
  95 /*
  96  * scroll left
  97  *
  98  * [In] mode
  99  *          scroll mode
 100  */
 101 void tv_scroll_left(unsigned mode);
 102
 103 /*
 104  * scroll right
 105  *
 106  * [In] mode
 107  *          scroll mode
 108  */
 109 void tv_scroll_right(unsigned mode);
 110
 111 /* jump to the top */
 112 void tv_top(void);
 113
 114 /* jump to the bottom */
 115 void tv_bottom(void);
 116
 117 /*
 118  * display menu
 119  *
 120  * return
 121  *     the following value returns
 122  *         TV_MENU_RESULT_EXIT_MENU     menu exit and continue this plugin
 123  *         TV_MENU_RESULT_EXIT_PLUGIN   request to exit this plugin
 124  *         TV_MENU_RESULT_ATTACHED_USB  connect USB cable
 125  */
 126 unsigned tv_menu(void);
 127
 128 /* add or remove the bookmark to the current position */
 129 void tv_add_or_remove_bookmark(void);
 130
 131 #endif