The Sword Project: swtext.h Source File

swtext.h

/******************************************************************************
 *  swtext.h   - code for base class 'SWText'.  SWText is the basis for all
 *               types of text modules
 *
 * $Id: swtext.h 1864 2005-11-20 06:06:40Z 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 SWTEXT_H
#define SWTEXT_H

#include <swmodule.h>

#include <defs.h>

SWORD_NAMESPACE_START

class VerseKey;

class SWDLLEXPORT SWText : public SWModule {

        // for conversion if we have been set with a different internal key type
        mutable VerseKey *tmpVK;

protected:
        VerseKey &getVerseKey() const;
        
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);

        virtual ~SWText();
        virtual SWKey *CreateKey();

        virtual long Index() const;
        virtual long Index(long iindex);

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

};

SWORD_NAMESPACE_END

#endif

The SWORD Project; P. O. Box 2528; Tempe, AZ 85280-2528 USA