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