← Back to branch summary

~ubuntu-branches/debian/squeeze/sword/squeeze

« back to all changes in this revision

Viewing changes to include/strkey.h

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Glassey
  • Date: 2004-01-15 15:50:07 UTC
  • Revision ID: james.westby@ubuntu.com-20040115155007-n9mz4x0zxrs1isd3
Tags: upstream-1.5.7
Import upstream version 1.5.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/strkey.h
 
1
/******************************************************************************
 
2
 *  strkey.h - code for class 'strkey'- a standard Biblical verse key
 
3
 *
 
4
 * $Id: strkey.h,v 1.7 2002/10/01 19:52:40 dglassey Exp $
 
5
 *
 
6
 * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
 
7
 *      CrossWire Bible Society
 
8
 *      P. O. Box 2528
 
9
 *      Tempe, AZ  85280-2528
 
10
 *
 
11
 * This program is free software; you can redistribute it and/or modify it
 
12
 * under the terms of the GNU General Public License as published by the
 
13
 * Free Software Foundation version 2.
 
14
 *
 
15
 * This program is distributed in the hope that it will be useful, but
 
16
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
18
 * General Public License for more details.
 
19
 *
 
20
 */
 
21
 
 
22
 
 
23
#ifndef STRKEY_H
 
24
#define STRKEY_H
 
25
 
 
26
#include <swkey.h>
 
27
#include <swmacs.h>
 
28
 
 
29
#include <defs.h>
 
30
 
 
31
SWORD_NAMESPACE_START
 
32
 
 
33
  /** a standard string key class (used
 
34
  * for modules that index on single strings (eg. cities,
 
35
  * names, words, etc.)
 
36
  */
 
37
class SWDLLEXPORT StrKey:public SWKey
 
38
{
 
39
  static SWClass classdef;
 
40
  void init ();
 
41
public:
 
42
  /** initializes instance of StrKey
 
43
  *
 
44
  * @param ikey text key (word, city, name, etc.)
 
45
  */
 
46
  StrKey (const char *ikey = 0);
 
47
  /** cleans up instance of StrKey
 
48
  */
 
49
  virtual ~ StrKey ();
 
50
 
 
51
  SWKEY_OPERATORS
 
52
 
 
53
};
 
54
SWORD_NAMESPACE_END
 
55
 
 
56
#endif