swfilter.h Source File

00001 /******************************************************************************
-00002  *  swfilter.h  - definition of class SWFilter used to filter text between
-00003  *                              different formats
-00004  *
-00005  * $Id: swfilter.h-source.html,v 1.10 2001/05/25 10:44:22 jansorg 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 SWDLLEXPORT  SWFilter {
-00042 public:
-00043        virtual ~SWFilter() {}
-00047 //  typedef std::list < std::string > OptionsList;
-00051   virtual const char * getOptionName ()
-00052   {
-00053     return 0;
-00054   }
-00059   virtual const char * getOptionTip ()
-00060   {
-00061     return 0;
-00062   }
-00067   virtual OptionsList getOptionValues ()
-00068   {
-00069     OptionsList options;
-00070     return options;
-00071   }
-00078   virtual void setOptionValue (const char *)
-00079   {
-00080   }
-00081   virtual const char * getOptionValue ()
-00082   {
-00083     return 0;
-00084   }
-00091   virtual char ProcessText(char *text, int maxlen, const SWKey *)
-00092   {
-00093     return ProcessText(text, maxlen);
-00094   }
-00100   virtual char ProcessText(char *text, int maxlen = -1)
-00101   {
-00102     return ProcessText(text, maxlen, 0);
-00103   }
-00104 };
-00105 
-00106 #endif
-