swtext.h

Go to the documentation of this file.

/******************************************************************************
 *
 * swtext.h -   class SWText: the basis for all Bible modules
 *
 * $Id: swtext.h 3821 2020-11-02 18:33:02Z scribe $
 *
 * 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 SWTEXT_H
#define SWTEXT_H

#include <swmodule.h>

#include <defs.h>

SWORD_NAMESPACE_START

class VerseKey;

class SWDLLEXPORT SWText : public SWModule {

private:
    // for conversion if we have been set with a different internal key type
    mutable VerseKey *tmpVK1;
    mutable VerseKey *tmpVK2;
    mutable bool tmpSecond;
    char *versification;

protected:
    const VerseKey &getVerseKey(const SWKey *key=0) const { return getVerseKeyConst(key); }
    const VerseKey &getVerseKeyConst(const SWKey *key=0) const;
    VerseKey &getVerseKey(SWKey *key=0);
    
public:
    SWText(const char *imodname = 0, const char *imoddesc = 0,
            SWDisplay *idisp = 0,
            SWTextEncoding encoding = ENC_UNKNOWN,
            SWTextDirection dir = DIRECTION_LTR,
            SWTextMarkup markup = FMT_UNKNOWN, const char *ilang = 0,
            const char *versification = "KJV");

    virtual ~SWText();
    virtual SWKey *createKey() const;

    virtual long getIndex() const;
    virtual void setIndex(long iindex);

    // OPERATORS -----------------------------------------------------------------
    
    SWMODULE_OPERATORS

};

SWORD_NAMESPACE_END

#endif