rockbox/apps/plugins/text_viewer/tv_action.h
Yoshihisa Uchida 2cdf332f01 text viewer: for tv_action and tv_bookmark, the prototype of the initializer is the same arguments as other modules.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27243 a1c6a512-1295-4272-9138-f99709370657
2010-07-02 12:16:47 +00:00

134 lines
3 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2002 Gilles Roux
* 2003 Garrett Derner
* 2010 Yoshihisa Uchida
*
* 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; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef PLUGIN_TEXT_VIEWER_ACTION_H
#define PLUGIN_TEXT_VIEWER_ACTION_H
#include "tv_menu.h"
/* horizontal scroll mode */
enum
{
TV_HORIZONTAL_SCROLL_COLUMN = 0, /* left/right one column */
TV_HORIZONTAL_SCROLL_SCREEN, /* left/right one screen */
TV_HORIZONTAL_SCROLL_PREFS, /* left/right follows the settings */
};
/*vertical scroll mode */
enum
{
TV_VERTICAL_SCROLL_LINE = 0, /* up/down one line */
TV_VERTICAL_SCROLL_PAGE, /* up/down one page */
TV_VERTICAL_SCROLL_PREFS, /* up/down follows the settings */
};
/*
* initialize the action module
*
* [In/Out] buf
* the start pointer of the buffer
*
* [In/Out] size
* buffer size
*
* return
* true initialize success
* false initialize failure
*/
bool tv_init_action(unsigned char **buf, size_t *bufsize);
/*
* finalize modules
*
* [In] parameter
* this argument does not use
*/
void tv_exit(void *parameter);
/*
* load the file
*
* [In] file
* read file name
*
* return
* true load success
* false load failure
*/
bool tv_load_file(const unsigned char *file);
/* draw the current page */
void tv_draw(void);
/*
* scroll up
*
* [In] mode
* scroll mode
*/
void tv_scroll_up(unsigned mode);
/*
* scroll down
*
* [In] mode
* scroll mode
*/
void tv_scroll_down(unsigned mode);
/*
* scroll left
*
* [In] mode
* scroll mode
*/
void tv_scroll_left(unsigned mode);
/*
* scroll right
*
* [In] mode
* scroll mode
*/
void tv_scroll_right(unsigned mode);
/* jump to the top */
void tv_top(void);
/* jump to the bottom */
void tv_bottom(void);
/*
* display menu
*
* return
* the following value returns
* TV_MENU_RESULT_EXIT_MENU menu exit and continue this plugin
* TV_MENU_RESULT_EXIT_PLUGIN request to exit this plugin
* TV_MENU_RESULT_ATTACHED_USB connect USB cable
*/
unsigned tv_menu(void);
/* add or remove the bookmark to the current position */
void tv_add_or_remove_bookmark(void);
#endif