/*************************************************************************** * * swoptfilter.h - Implenetation of SWOptionFilter * * $Id$ * * Copyright 1998 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 SWOPTFILTER_H #define SWOPTFILTER_H #include #include #include SWORD_NAMESPACE_START /** * The type definitoin for option types */ typedef std::list < SWBuf > StringList; /** Base class for all option filters. */ class SWDLLEXPORT SWOptionFilter : public virtual SWFilter { protected: SWBuf optionValue; const char *optName; const char *optTip; const StringList *optValues; bool option; bool isBooleanVal; public: SWOptionFilter(); SWOptionFilter(const char *oName, const char *oTip, const StringList *oValues); virtual ~SWOptionFilter(); /** many options are simple Off/On boolean type, and frontends may wish to show these * with checkmarks or the like to the end user. This is a convenience method * to allow a frontend to check if this filter has only Off/On values */ bool isBoolean() { return isBooleanVal; } /** gets the name of the option of this filter * @return option name */ virtual const char *getOptionName() { return optName; } /** gets a short explanation of the option of this filter; * it could be presented to the user in frontend programs * @return option tip/explanation */ virtual const char *getOptionTip() { return optTip; } /** returns a list of the possible option values * * @return list of option values */ virtual StringList getOptionValues() { return *optValues; } /** @return The value of the current option. */ virtual const char *getOptionValue(); /** sets the value of the option of this filter, * e.g maybe a strong's filter might be set to "On" / "Off" - * that would mean to show or not to show the strongs in the text, * see also getOptionValues() * @param ival the new option value */ virtual void setOptionValue(const char *ival); }; SWORD_NAMESPACE_END #endif