apps/plugins/text_viewer/tv_preferences.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_PREFERENCES_H
  24 #define PLUGIN_TEXT_VIEWER_PREFERENCES_H
  25
  26 enum {
  27     TV_CALLBACK_OK,
  28     TV_CALLBACK_STOP,
  29     TV_CALLBACK_ERROR,
  30 };
  31
  32 /* word_mode */
  33 enum {
  34     WM_WRAP = 0,
  35     WM_CHOP,
  36 };
  37
  38 /* line_mode */
  39 enum {
  40     LM_NORMAL = 0,
  41     LM_JOIN,
  42     LM_EXPAND,
  43     LM_REFLOW,
  44 };
  45
  46 /* alignment */
  47 enum {
  48     AL_LEFT = 0,
  49     AL_RIGHT,
  50 };
  51
  52 /* horizontal_scroll_mode */
  53 enum {
  54     HS_SCREEN = 0,
  55     HS_COLUMN,
  56 };
  57
  58 /* vertical_scroll_mode */
  59 enum {
  60     VS_PAGE = 0,
  61     VS_LINE,
  62 };
  63
  64 /* narrow_mode */
  65 enum {
  66     NM_PAGE = 0,
  67     NM_TOP_BOTTOM,
  68 };
  69
  70 struct tv_preferences {
  71     unsigned word_mode;
  72     unsigned line_mode;
  73     unsigned alignment;
  74
  75     unsigned encoding;
  76
  77     bool horizontal_scrollbar;
  78     bool vertical_scrollbar;
  79
  80     bool overlap_page_mode;
  81     bool header_mode;
  82     bool footer_mode;
  83     unsigned horizontal_scroll_mode;
  84     unsigned vertical_scroll_mode;
  85
  86     int autoscroll_speed;
  87
  88     int windows;
  89
  90     unsigned narrow_mode;
  91
  92     unsigned indent_spaces;
  93
  94     bool statusbar;
  95
  96 #ifdef HAVE_LCD_BITMAP
  97     unsigned char font_name[MAX_PATH];
  98     struct font *font;
  99 #endif
 100     unsigned char file_name[MAX_PATH];
 101 };
 102
 103 /*
 104  *     global pointer to the preferences (read-only)
 105  */
 106 extern const struct tv_preferences * const preferences;
 107 extern bool preferences_changed;
 108
 109 /*
 110  * change the preferences
 111  *
 112  * [In] new_prefs
 113  *          new preferences
 114  *
 115  * return
 116  *     true  success
 117  *     false error
 118  */
 119 bool tv_set_preferences(const struct tv_preferences *new_prefs);
 120
 121 /*
 122  * copy the preferences
 123  *
 124  * [Out] copy_prefs
 125  *          the preferences in copy destination
 126  */
 127 void tv_copy_preferences(struct tv_preferences *copy_prefs);
 128
 129 /*
 130  * compare the preferences structs (binary)
 131  *
 132  * return
 133  *     true  differs
 134  *     false identical
 135  */
 136 bool tv_compare_preferences(struct tv_preferences *copy_prefs);
 137
 138 /*
 139  * set the default settings
 140  *
 141  * [Out] p
 142  *          the preferences which store the default settings
 143  */
 144 void tv_set_default_preferences(struct tv_preferences *p);
 145
 146 /*
 147  * register the function to be executed when the current preferences is changed
 148  *
 149  * [In] listner
 150  *          the function to be executed when the current preferences is changed
 151  */
 152 void tv_add_preferences_change_listner(int (*listner)(const struct tv_preferences *oldp));
 153
 154 #endif