Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

swfilter.h

00001 /******************************************************************************
00002  *  swfilter.h  - definition of class SWFilter used to filter text between
00003  *                              different formats
00004  *
00005  * $Id: swfilter_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
00006  *
00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
00008  *      CrossWire Bible Society
00009  *      P. O. Box 2528
00010  *      Tempe, AZ  85280-2528
00011  *
00012  * This program is free software; you can redistribute it and/or modify it
00013  * under the terms of the GNU General Public License as published by the
00014  * Free Software Foundation version 2.
00015  *
00016  * This program is distributed in the hope that it will be useful, but
00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019  * General Public License for more details.
00020  *
00021  */
00022 
00023 #ifndef SWFILTER_H
00024 #define SWFILTER_H
00025 #include <string>
00026 #include <list>
00027 #include <swkey.h>
00028 
00029 #include <defs.h>
00030 
00034 typedef std::list < std::string > OptionsList;
00035 
00036 
00041 class SWModule;
00042 
00043 class SWDLLEXPORT  SWFilter {
00044 public:
00045        virtual ~SWFilter() {}
00049 //  typedef std::list < std::string > OptionsList;
00053   virtual const char * getOptionName ()
00054   {
00055     return 0;
00056   }
00061   virtual const char * getOptionTip ()
00062   {
00063     return 0;
00064   }
00069   virtual OptionsList getOptionValues ()
00070   {
00071     OptionsList options;
00072     return options;
00073   }
00080   virtual void setOptionValue (const char *)
00081   {
00082   }
00083   virtual const char * getOptionValue ()
00084   {
00085     return 0;
00086   }
00093   virtual char ProcessText(char *text, int maxlen, const SWKey *, const SWModule * = 0)
00094   {
00095     return ProcessText(text, maxlen);
00096   }
00102   virtual char ProcessText(char *text, int maxlen = -1)
00103   {
00104     return ProcessText(text, maxlen, 0);
00105   }
00106 };
00107 
00108 #endif

Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by doxygen1.2.15