apps/plugins/text_viewer/tv_screen_pos.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_SCREEN_POS_H
  24 #define PLUGIN_TEXT_VIEWER_SCREEN_POS_H
  25
  26 struct tv_screen_pos {
  27     off_t file_pos;
  28     int page;
  29     int line;
  30 };
  31
  32 /*
  33  * return the current position
  34  *
  35  * return
  36  *     the pointer which is stored the current position
  37  */
  38 const struct tv_screen_pos *tv_get_screen_pos(void);
  39
  40 /*
  41  * set the current position
  42  *
  43  * [In] pos
  44  *         the pointer which is stored the current position
  45  */
  46 void tv_set_screen_pos(const struct tv_screen_pos *pos);
  47
  48 /*
  49  * the current position set to the given structure
  50  *
  51  * [Out] pos
  52  *         the pointer in order to store the current position
  53  */
  54 void tv_copy_screen_pos(struct tv_screen_pos *pos);
  55
  56 #endif