1 files changed, 63 insertions, 0 deletions
diff --git a/include/swfilter.h b/include/swfilter.h
new file mode 100644
index 0000000..4dbba82
--- /dev/null
+++ b/include/swfilter.h
@@ -0,0 +1,63 @@
+/******************************************************************************
+ *
+ *  swfilter.h -	definition of class SWFilter used to filter text between
+ *		       	different formats
+ *
+ * $Id: swfilter.h 2833 2013-06-29 06:40:28Z chrislit $
+ *
+ * Copyright 1997-2013 CrossWire Bible Society (http://www.crosswire.org)
+ *	CrossWire Bible Society
+ *	P. O. Box 2528
+ *	Tempe, AZ  85280-2528
+ *
+ * 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 version 2.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ */
+
+#ifndef SWFILTER_H
+#define SWFILTER_H
+
+#include <defs.h>
+
+SWORD_NAMESPACE_START
+
+class SWKey;
+class SWBuf;
+class SWModule;
+
+
+class SWModule;
+
+/** Base class for all filters in sword.
+* Filters are used to filter/convert text between different formats
+* like GBF, HTML, RTF ...
+*/
+class SWDLLEXPORT  SWFilter {
+public:
+	virtual ~SWFilter() {}
+
+	/** This method processes and appropriately modifies the text given it
+	 *	for a particular filter task
+	 *
+	 * @param text The text to be filtered/converted
+	 * @param key Current key That was used.
+	 * @param module Current module.
+	 * @return 0
+	 */
+	virtual char processText(SWBuf &text, const SWKey *key = 0, const SWModule *module = 0) = 0;
+
+	/** This method can supply a header associated with the processing done with this filter.
+	 *	A typical example is a suggested CSS style block for classed containers.
+	 */
+	virtual const char *getHeader() const { return ""; }
+};
+
+	SWORD_NAMESPACE_END
+#endif