apps/plugins/text_viewer/tv_settings.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_SETTINGS_H
  24 #define PLUGIN_TEXT_VIEWER_SETTINGS_H
  25
  26 #include "tv_preferences.h"
  27
  28 /*
  29  * load from the global settings file
  30  *
  31  * [Out] prefs
  32  *          the structure which read settings is stored
  33  *
  34  * return
  35  *     true  success
  36  *     false failure
  37  */
  38 bool tv_load_global_settings(struct tv_preferences *prefs);
  39
  40 /*
  41  * save to the global settings file
  42  *
  43  * [In] prefs
  44  *          the structure with settings to save
  45  *
  46  * return
  47  *     true  success
  48  *     false failure
  49  */
  50 bool tv_save_global_settings(const struct tv_preferences *prefs);
  51
  52 /*
  53  * load the settings at each file
  54  *
  55  * [In] file_name
  56  *          the file name of file that wants to read settings
  57  *
  58  * return
  59  *     true  success
  60  *     false failure
  61  */
  62 bool tv_load_settings(const unsigned char *file_name);
  63
  64 /*
  65  * save the settings at each file
  66  * supposed to be called only once at plugin exit
  67  *
  68  * return
  69  *     true  success
  70  *     false failure
  71  */
  72 bool tv_save_settings(void);
  73
  74 #endif