/******************************************************************************
 *  strkey.h - code for class 'strkey'- a standard Biblical verse key
 *
 * $Id: strkey.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 STRKEY_H
#define STRKEY_H

#include <swkey.h>

#include <defs.h>

SWORD_NAMESPACE_START

  /** a standard string key class (used
  * for modules that index on single strings (eg. cities,
  * names, words, etc.)
  */
class SWDLLEXPORT StrKey:public SWKey
{
  static SWClass classdef;
  void init ();
public:
  /** initializes instance of StrKey
  *
  * @param ikey text key (word, city, name, etc.)
  */
  StrKey (const char *ikey = 0);
  /** cleans up instance of StrKey
  */
  virtual ~ StrKey ();

  SWKEY_OPERATORS

};
SWORD_NAMESPACE_END

#endif
