swoptfilter.h

Go to the documentation of this file.

/***************************************************************************
 *
 * swoptfilter.h -  class SWOptionFilter: the base for all OptionFilters
 *          in SWORD.  An OptionFilter allows the user to turn
 *          on and off certain features they may wish to see or
 *          not see.  Essentially, an OptionFilter is usually
 *          included in a choice for the end user and the result
 *          of being turned "Off" is that the filter will strip
 *          the markup for that feature from the text stream
 *          when it is processed.
 *
 * $Id: swoptfilter.h 3786 2020-08-30 11:35:14Z scribe $
 *
 * 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 <swfilter.h>
#include <swbuf.h>
#include <list>

SWORD_NAMESPACE_START

typedef std::list<SWBuf> StringList;


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();


    bool isBoolean() { return isBooleanVal; }

    virtual const char *getOptionName() { return optName; }

    virtual const char *getOptionTip() { return optTip; }

    virtual StringList getOptionValues() { return *optValues; }

    virtual const char *getOptionValue();

    virtual void setOptionValue(const char *ival);

};

SWORD_NAMESPACE_END
#endif