blob: 53319f9b73c7ab0bce44830a078d422f9b01ba58 (
plain) (
tree)
|
|
/******************************************************************************
* swld.h - code for base class 'SWLD'. SWLD is the basis for all
* types of Lexicon and Dictionary modules (hence the 'LD').
*
* $Id: swld.h,v 1.13 2002/10/01 19:52:40 dglassey Exp $
*
* 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 SWLD_H
#define SWLD_H
#include <swmodule.h>
#include <strkey.h>
#include <defs.h>
SWORD_NAMESPACE_START
/** the basis for all types of Lexicon and
* Dictionary modules (hence the 'LD').
*/
class SWDLLEXPORT SWLD : public SWModule {
protected:
char *entkeytxt;
public:
/** Initializes data for instance of SWLD
*
* @param imodname Internal name for module
* @param imoddesc Name to display to user for module
* @param idisp Display object to use for displaying
*/
SWLD(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 ~SWLD();
virtual SWKey *CreateKey() { return new StrKey(); }
/** Sets/gets module KeyText, getting from saved text if key is persistent
*
* @param ikeytext value which to set keytext;
* [0] - only get
* @return pointer to keytext
*/
virtual const char *KeyText(const char *ikeytext = 0);
virtual void setPosition(SW_POSITION pos);
// OPERATORS -----------------------------------------------------------------
SWMODULE_OPERATORS
};
SWORD_NAMESPACE_END
#endif
|
