blob: 622e1110b0000d4f89bee67d6bba9c76eba3692c (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>listkey.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.17 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </center>
<hr><h1>listkey.h</h1><div class="fragment"><pre>00001 <span class="comment">/******************************************************************************</span>
00002 <span class="comment"> * listkey.h - code for base class 'listkey'. listkey is the basis for all</span>
00003 <span class="comment"> * types of keys for indexing into modules</span>
00004 <span class="comment"> * (e.g. verse, word,</span>
00005 <span class="comment"> * place, etc.)</span>
00006 <span class="comment"> *</span>
00007 <span class="comment"> * $Id: listkey_8h-source.html,v 1.9 2002/10/31 11:30:15 joachim Exp $</span>
00008 <span class="comment"> *</span>
00009 <span class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</span>
00010 <span class="comment"> * CrossWire Bible Society</span>
00011 <span class="comment"> * P. O. Box 2528</span>
00012 <span class="comment"> * Tempe, AZ 85280-2528</span>
00013 <span class="comment"> *</span>
00014 <span class="comment"> * This program is free software; you can redistribute it and/or modify it</span>
00015 <span class="comment"> * under the terms of the GNU General Public License as published by the</span>
00016 <span class="comment"> * Free Software Foundation version 2.</span>
00017 <span class="comment"> *</span>
00018 <span class="comment"> * This program is distributed in the hope that it will be useful, but</span>
00019 <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span>
00020 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
00021 <span class="comment"> * General Public License for more details.</span>
00022 <span class="comment"> *</span>
00023 <span class="comment"> */</span>
00024
00025 <span class="preprocessor">#ifndef SWLSTKEY_H</span>
00026 <span class="preprocessor"></span><span class="preprocessor">#define SWLSTKEY_H</span>
00027 <span class="preprocessor"></span>
00028 <span class="preprocessor">#include <swkey.h></span>
00029
00030 <span class="preprocessor">#include <defs.h></span>
00031
00032 SWORD_NAMESPACE_START
00033
<a name="l00038"></a><a class="code" href="classsword_1_1_list_key.html">00038</a> <span class="keyword">class </span>SWDLLEXPORT <a class="code" href="classsword_1_1_list_key.html">ListKey</a> : <span class="keyword">public</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> {
00039
00040 <span class="keyword">static</span> <a class="code" href="classsword_1_1_s_w_class.html">SWClass</a> classdef;
00041 <span class="keywordtype">void</span> init ();
00042 <span class="keyword">protected</span>:
00043 <span class="keywordtype">int</span> arraypos;
00044 <span class="keywordtype">int</span> arraymax;
00045 <span class="keywordtype">int</span> arraycnt;
00046 <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> **array;
00047 <span class="keyword">public</span>:
00052 <a class="code" href="classsword_1_1_list_key.html">ListKey</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *ikey = 0);
00053 <a class="code" href="classsword_1_1_list_key.html">ListKey</a> (<a class="code" href="classsword_1_1_list_key.html">ListKey</a> <span class="keyword">const</span> &k);
00056 <span class="keyword">virtual</span> ~ ListKey ();
00057
00058 <span class="keyword">virtual</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> *<a class="code" href="classsword_1_1_s_w_key.html#a3">clone</a> () <span class="keyword">const</span>;
00061 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ClearList ();
00065 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Count ();
00068 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Remove ();
00074 <span class="keyword">virtual</span> <span class="keywordtype">char</span> SetToElement (<span class="keywordtype">int</span> ielement, SW_POSITION = TOP);
00080 <span class="keyword">virtual</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> *GetElement (<span class="keywordtype">int</span> pos = -1);
<a name="l00084"></a><a class="code" href="classsword_1_1_list_key.html#a9">00084</a> <a class="code" href="classsword_1_1_list_key.html">ListKey</a> & operator << (<span class="keyword">const</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> &ikey) { add(ikey); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00085 <span class="keyword">virtual</span> <span class="keywordtype">void</span> add(<span class="keyword">const</span> SWKey &ikey);
00086
00091 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a8">copyFrom</a>(<span class="keyword">const</span> ListKey & ikey);
<a name="l00092"></a><a class="code" href="classsword_1_1_list_key.html#a12">00092</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a8">copyFrom</a>(<span class="keyword">const</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> & ikey) { SWKey::copyFrom(ikey); }
00093
00099 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setPosition(SW_POSITION);
00102 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a16">decrement</a>(<span class="keywordtype">int</span> step);
00105 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a17">increment</a>(<span class="keywordtype">int</span> step);
00106
00107 <span class="keyword">virtual</span> <span class="keywordtype">char</span> Traversable () { <span class="keywordflow">return</span> 1; }
<a name="l00108"></a><a class="code" href="classsword_1_1_list_key.html#a17">00108</a> <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="classsword_1_1_s_w_key.html#a19">Index</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> arraypos; }
00109 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getRangeText() <span class="keyword">const</span>;
00110
<a name="l00115"></a><a class="code" href="classsword_1_1_list_key.html#a19">00115</a> <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="classsword_1_1_s_w_key.html#a19">Index</a> (<span class="keywordtype">long</span> index) { SetToElement (index); <span class="keywordflow">return</span> <a class="code" href="classsword_1_1_s_w_key.html#a19">Index</a> (); }
00116 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classsword_1_1_s_w_key.html#a9">getText</a>() <span class="keyword">const</span>;
00117 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a7">setText</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *ikey);
00118
00119 SWKEY_OPERATORS
00120 ListKey & operator =(<span class="keyword">const</span> ListKey &key) { <a class="code" href="classsword_1_1_s_w_key.html#a8">copyFrom</a>(key); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00121 };
00122
00123 SWORD_NAMESPACE_END
00124 <span class="preprocessor">#endif</span>
</pre></div><hr><address style="align: right;"><small>Generated on Thu Oct 31 12:11:28 2002 for The Sword Project by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.17 </small></address>
</body>
</html>
|
