API-Documentation for Sword 1.5.10

00001 /******************************************************************************
00002  *
00003  * $Id: thmlvariants.h 1864 2005-11-20 06:06:40Z scribe $
00004  *
00005  * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)
00006  *      CrossWire Bible Society
00007  *      P. O. Box 2528
00008  *      Tempe, AZ  85280-2528
00009  *
00010  * This program is free software; you can redistribute it and/or modify it
00011  * under the terms of the GNU General Public License as published by the
00012  * Free Software Foundation version 2.
00013  *
00014  * This program is distributed in the hope that it will be useful, but
00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00017  * General Public License for more details.
00018  *
00019  */
00020 
00021 #ifndef THMLVARIANTS_H
00022 #define THMLVARIANTS_H
00023 
00024 #include <swoptfilter.h>
00025 
00026 SWORD_NAMESPACE_START
00027 
00030 class SWDLLEXPORT ThMLVariants : public SWOptionFilter {
00031         char option;
00032 
00033         static const char primary[];
00034         static const char secondary[];
00035         static const char all[];
00036 
00037         static const char optName[];
00038         static const char optTip[];
00039         StringList options;
00040 
00041 public:
00042         ThMLVariants();
00043         virtual ~ThMLVariants();
00044         virtual char processText(SWBuf &text, const SWKey *key = 0, const SWModule *module = 0);
00045         virtual const char *getOptionName() { return optName; }
00046         virtual const char *getOptionTip() { return optTip; }
00047         virtual void setOptionValue(const char *ival);
00048         virtual const char *getOptionValue();
00049         virtual StringList getOptionValues() { return options; }
00050 };
00051 
00052 SWORD_NAMESPACE_END
00053 #endif