<!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>treekey.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>treekey.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font>
00002 <font class="comment"> * versekey.h - code for class 'versekey'- a standard Biblical verse key</font>
00003 <font class="comment"> *</font>
00004 <font class="comment"> * $Id: treekey_8h-source.html,v 1.3 2002/06/20 20:23:10 mgruner Exp $</font>
00005 <font class="comment"> *</font>
00006 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font>
00007 <font class="comment"> * CrossWire Bible Society</font>
00008 <font class="comment"> * P. O. Box 2528</font>
00009 <font class="comment"> * Tempe, AZ 85280-2528</font>
00010 <font class="comment"> *</font>
00011 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font>
00012 <font class="comment"> * under the terms of the GNU General Public License as published by the</font>
00013 <font class="comment"> * Free Software Foundation version 2.</font>
00014 <font class="comment"> *</font>
00015 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font>
00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font>
00018 <font class="comment"> * General Public License for more details.</font>
00019 <font class="comment"> *</font>
00020 <font class="comment"> */</font>
00021
00022
00023 <font class="preprocessor">#ifndef TREEKEY_H</font>
00024 <font class="preprocessor"></font><font class="preprocessor">#define TREEKEY_H</font>
00025 <font class="preprocessor"></font>
00026 <font class="preprocessor">#include <swkey.h></font>
00027 <font class="preprocessor">#include <swmacs.h></font>
00028
00029 <font class="preprocessor">#include <defs.h></font>
00030
00031
<a name="l00036"></a><a class="code" href="class_tree_key.html">00036</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_tree_key.html">TreeKey</a> : <font class="keyword">public</font> <a class="code" href="class_s_w_key.html">SWKey</a> {
00037 <font class="keyword">static</font> <a class="code" href="class_s_w_class.html">SWClass</a> classdef;
00038 <font class="keywordtype">void</font> init();
00039
00040 <font class="keyword">public</font>:
00041 <font class="comment">// TreeKey (const char *ikey = 0);</font>
00042 <font class="comment">// TreeKey (const SWKey * ikey);</font>
00043 <font class="comment">// TreeKey (TreeKey const &k);</font>
00044 <a class="code" href="class_tree_key.html">TreeKey</a> () { init(); };
00045 ~<a class="code" href="class_tree_key.html">TreeKey</a> () {};
00046
00047
00048 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getLocalName() = 0;
00049 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *setLocalName(<font class="keyword">const</font> <font class="keywordtype">char</font> *) = 0;
00050
00051 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getUserData(<font class="keywordtype">int</font> *size = 0) = 0;
00052 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setUserData(<font class="keyword">const</font> <font class="keywordtype">char</font> *userData, <font class="keywordtype">int</font> size = 0) = 0;
00053
00054 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getFullName() <font class="keyword">const</font> = 0;
00055
00056 <font class="keyword">virtual</font> <font class="keywordtype">void</font> root() = 0;
00057 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> parent() = 0;
00058
00059 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> firstChild() = 0;
00060 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> nextSibling() = 0;
00061 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> previousSibling() = 0;
00062
00063 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> hasChildren() = 0;
00064
00065 <font class="keyword">virtual</font> <font class="keywordtype">void</font> append() = 0;
00066 <font class="keyword">virtual</font> <font class="keywordtype">void</font> appendChild() = 0;
00067 <font class="keyword">virtual</font> <font class="keywordtype">void</font> insertBefore() = 0;
00068
00069 <font class="keyword">virtual</font> <font class="keywordtype">void</font> remove() = 0;
00070
00071 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setOffset(<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> offset) = 0;
00072 <font class="keyword">virtual</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> getOffset() <font class="keyword">const</font> = 0;
00073
00074 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_key.html#a7">setText</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey) = 0;
00075 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setPosition(SW_POSITION p) = 0;
00076 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_key.html#a9">getText</a>() <font class="keyword">const</font> = 0;
00077 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_s_w_key.html#a11">compare</a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> &ikey) = 0;
00078 <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> steps = 1) = 0;
00079 <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> steps = 1) = 0;
00080 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable () { <font class="keywordflow">return</font> 1; }
<a name="l00081"></a><a class="code" href="class_tree_key.html#a26">00081</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> getOffset(); }
00082 <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> iindex) { setOffset(iindex); <font class="keywordflow">return</font> getOffset(); }
00083
00084 SWKEY_OPERATORS
00085
00086 };
00087
00088
00089 <font class="preprocessor">#endif</font>
</pre></div><hr><address align="right"><small>Generated on Thu Jun 20 22:13:01 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>
