diff options
Diffstat (limited to 'include/swfilter.h')
| -rw-r--r-- | include/swfilter.h | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/include/swfilter.h b/include/swfilter.h index 8e16e22..4dbba82 100644 --- a/include/swfilter.h +++ b/include/swfilter.h @@ -1,10 +1,11 @@ /****************************************************************************** - * swfilter.h - definition of class SWFilter used to filter text between - * different formats * - * $Id: swfilter.h 1864 2005-11-20 06:06:40Z scribe $ + * swfilter.h - definition of class SWFilter used to filter text between + * different formats * - * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org) + * $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 @@ -42,13 +43,20 @@ class SWDLLEXPORT SWFilter { public: virtual ~SWFilter() {} - /** This is the main filter function + /** 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 |