path: root/include/plainfootnotes.h

/***************************************************************************
                          plainfootnotes.h  -  description                              
                             -------------------                                         
    begin                : Wed Oct 13 1999                                           
    copyright            : (C) 1999 by The team of BibleTime                         
    email                : info@bibletime.de                                     
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   * 
 *                                                                         *
 ***************************************************************************/

/* $Header: /usr/local/cvsroot/sword/include/plainfootnotes.h,v 1.5 2002/10/01 19:52:40 dglassey Exp $ */
/* $Revision: 1.5 $ */

#ifndef PLAINFOOTNOTES_H
#define PLAINFOOTNOTES_H

#include <defs.h>

#include <swfilter.h>

SWORD_NAMESPACE_START

class SWKey;

/**Shows or hides footnotes in plain text.
  *@author The team of BibleTime
  */
class SWDLLEXPORT PLAINFootnotes:public SWFilter
{
  bool option;
  static const char on[];
  static const char off[];
  static const char optName[];
  static const char optTip[];
  OptionsList options;

public:
    PLAINFootnotes ();
    virtual ~ PLAINFootnotes ();
  virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
  virtual const char *getOptionName ()
  {
    return optName;
  }
  virtual const char *getOptionTip ()
  {
    return optTip;
  }
  virtual void setOptionValue (const char *ival);
  virtual const char *getOptionValue ();
  virtual OptionsList getOptionValues ()
  {
    return options;
  }
};

SWORD_NAMESPACE_END
#endif