<!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.15 -->
<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="functions.html">Compound Members</a> </center>
<hr><h1>listkey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font>
00002 <font class="comment"> * listkey.h - code for base class 'listkey'. listkey is the basis for all</font>
00003 <font class="comment"> * types of keys for indexing into modules</font>
00004 <font class="comment"> * (e.g. verse, word,</font>
00005 <font class="comment"> * place, etc.)</font>
00006 <font class="comment"> *</font>
00007 <font class="comment"> * $Id: listkey_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $</font>
00008 <font class="comment"> *</font>
00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font>
00010 <font class="comment"> * CrossWire Bible Society</font>
00011 <font class="comment"> * P. O. Box 2528</font>
00012 <font class="comment"> * Tempe, AZ 85280-2528</font>
00013 <font class="comment"> *</font>
00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font>
00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font>
00016 <font class="comment"> * Free Software Foundation version 2.</font>
00017 <font class="comment"> *</font>
00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font>
00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font>
00021 <font class="comment"> * General Public License for more details.</font>
00022 <font class="comment"> *</font>
00023 <font class="comment"> */</font>
00024
00025 <font class="preprocessor">#ifndef SWLSTKEY_H</font>
00026 <font class="preprocessor"></font><font class="preprocessor">#define SWLSTKEY_H</font>
00027 <font class="preprocessor"></font>
00028 <font class="preprocessor">#include <swkey.h></font>
00029
00030 <font class="preprocessor">#include <defs.h></font>
00031
<a name="l00036"></a><a class="code" href="class_list_key.html">00036</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_list_key.html">ListKey</a> : <font class="keyword">public</font> <a class="code" href="class_s_w_key.html">SWKey</a> {
00037
00038 <font class="keyword">static</font> <a class="code" href="class_s_w_class.html">SWClass</a> classdef;
00039 <font class="keywordtype">void</font> init ();
00040 <font class="keyword">protected</font>:
00041 <font class="keywordtype">int</font> arraypos;
00042 <font class="keywordtype">int</font> arraymax;
00043 <font class="keywordtype">int</font> arraycnt;
00044 <a class="code" href="class_s_w_key.html">SWKey</a> **array;
00045 <font class="keyword">public</font>:
00050 <a class="code" href="class_list_key.html">ListKey</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey = 0);
00051 <a class="code" href="class_list_key.html">ListKey</a> (<a class="code" href="class_list_key.html">ListKey</a> <font class="keyword">const</font> &k);
00054 <font class="keyword">virtual</font> ~ ListKey ();
00055
00056 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *<a class="code" href="class_s_w_key.html#a3">clone</a> () <font class="keyword">const</font>;
00059 <font class="keyword">virtual</font> <font class="keywordtype">void</font> ClearList ();
00063 <font class="keyword">virtual</font> <font class="keywordtype">int</font> Count ();
00066 <font class="keyword">virtual</font> <font class="keywordtype">void</font> Remove ();
00072 <font class="keyword">virtual</font> <font class="keywordtype">char</font> SetToElement (<font class="keywordtype">int</font> ielement, SW_POSITION = TOP);
00078 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> *GetElement (<font class="keywordtype">int</font> pos = -1);
<a name="l00082"></a><a class="code" href="class_list_key.html#a9">00082</a> <a class="code" href="class_list_key.html">ListKey</a> & operator << (<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> &ikey) { add(ikey); <font class="keywordflow">return</font> *<font class="keyword">this</font>; }
00083 <font class="keyword">virtual</font> <font class="keywordtype">void</font> add(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> &ikey);
00084
00089 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_list_key.html">ListKey</a> & ikey);
<a name="l00090"></a><a class="code" href="class_list_key.html#a12">00090</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> & ikey) { <a class="code" href="class_s_w_key.html#a8">SWKey::copyFrom</a>(ikey); }
00091
00097 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setPosition(SW_POSITION);
00100 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a14">decrement</a>(<font class="keywordtype">int</font> step);
00103 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a15">increment</a>(<font class="keywordtype">int</font> step);
00104
00105 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable () { <font class="keywordflow">return</font> 1; }
<a name="l00106"></a><a class="code" href="class_list_key.html#a17">00106</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_s_w_key.html#a17">Index</a> ()<font class="keyword"> const </font>{ <font class="keywordflow">return</font> arraypos; }
00107
<a name="l00112"></a><a class="code" href="class_list_key.html#a18">00112</a> <font class="keyword">virtual</font> <font class="keywordtype">long</font> <a class="code" href="class_s_w_key.html#a17">Index</a> (<font class="keywordtype">long</font> index) { SetToElement (index); <font class="keywordflow">return</font> <a class="code" href="class_s_w_key.html#a17">Index</a> (); }
00113
00114 SWKEY_OPERATORS
00115 <a class="code" href="class_list_key.html">ListKey</a> & operator =(<font class="keyword">const</font> <a class="code" href="class_list_key.html">ListKey</a> &key) { <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(key); <font class="keywordflow">return</font> *<font class="keyword">this</font>; }
00116 };
00117
00118
00119 <font class="preprocessor">#endif</font>
</pre></div><hr><address align="right"><small>Generated on Thu Jun 20 22:12:59 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.15 </small></address>
</body>
</html>
