swfilter.h

00001 /******************************************************************************
00002  *  swfilter.h  - definition of class SWFilter used to filter text between
00003  *                              different formats
00004  *
00005  * $Id: swfilter.h 1864 2005-11-20 06:06:40Z scribe $
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 
00026 #include <defs.h>
00027 
00028 SWORD_NAMESPACE_START
00029 
00030 class SWKey;
00031 class SWBuf;
00032 class SWModule;
00033 
00034 
00035 class SWModule;
00036 
00041 class SWDLLEXPORT  SWFilter {
00042 public:
00043         virtual ~SWFilter() {}
00044 
00051         virtual char processText(SWBuf &text, const SWKey *key = 0, const SWModule *module = 0) = 0;
00052 };
00053 
00054         SWORD_NAMESPACE_END
00055 #endif