aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api-documentation/html/treekeyidx_8h-source.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/html/treekeyidx_8h-source.html')
-rw-r--r--doc/api-documentation/html/treekeyidx_8h-source.html126
1 files changed, 126 insertions, 0 deletions
diff --git a/doc/api-documentation/html/treekeyidx_8h-source.html b/doc/api-documentation/html/treekeyidx_8h-source.html
new file mode 100644
index 0000000..997f9c2
--- /dev/null
+++ b/doc/api-documentation/html/treekeyidx_8h-source.html
@@ -0,0 +1,126 @@
+<!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>treekeyidx.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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
+<hr><h1>treekeyidx.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: treekeyidx_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 TREEKEYIDX_H</font>
+00024 <font class="preprocessor"></font><font class="preprocessor">#define TREEKEYIDX_H</font>
+00025 <font class="preprocessor"></font>
+00026 <font class="preprocessor">#include &lt;treekey.h&gt;</font>
+00027 <font class="preprocessor">#include &lt;sysdata.h&gt;</font>
+00028 <font class="preprocessor">#include &lt;filemgr.h&gt;</font>
+00029
+00030
+<a name="l00035"></a><a class="code" href="class_tree_key_idx.html">00035</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_tree_key_idx.html">TreeKeyIdx</a> : <font class="keyword">public</font> <a class="code" href="class_tree_key.html">TreeKey</a> {
+00036
+00037 <font class="keyword">class </font>TreeNode {
+00038 <font class="keyword">public</font>:
+00039 TreeNode();
+00040 ~TreeNode();
+00041 <font class="keywordtype">void</font> clear();
+00042 __u32 offset;
+00043 __s32 parent;
+00044 __s32 next;
+00045 __s32 firstChild;
+00046 <font class="keywordtype">char</font> *name;
+00047 __u16 dsize;
+00048 <font class="keywordtype">char</font> *userData;
+00049 } currentNode;
+00050
+00051 <font class="keyword">static</font> <a class="code" href="class_s_w_class.html">SWClass</a> classdef;
+00052
+00053 <font class="keywordtype">char</font> *path;
+00054
+00055 FileDesc *idxfd;
+00056 FileDesc *datfd;
+00057
+00058 <font class="keywordtype">void</font> getTreeNodeFromDatOffset(<font class="keywordtype">long</font> ioffset, TreeNode *buf) <font class="keyword">const</font>;
+00059 <font class="keywordtype">char</font> getTreeNodeFromIdxOffset(<font class="keywordtype">long</font> ioffset, TreeNode *node) <font class="keyword">const</font>;
+00060 <font class="keywordtype">void</font> saveTreeNode(TreeNode *node);
+00061 <font class="keywordtype">void</font> saveTreeNodeOffsets(TreeNode *node);
+00062 <font class="keywordtype">void</font> init();
+00063
+00064 <font class="keyword">public</font>:
+00065 <a class="code" href="class_tree_key_idx.html">TreeKeyIdx</a>(<font class="keyword">const</font> <a class="code" href="class_tree_key_idx.html">TreeKeyIdx</a> &amp;ikey);
+00066 <a class="code" href="class_tree_key_idx.html">TreeKeyIdx</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *idxPath, <font class="keywordtype">int</font> fileMode = -1);
+00067 ~<a class="code" href="class_tree_key_idx.html">TreeKeyIdx</a> ();
+00068
+00069
+00070 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getLocalName();
+00071 <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> *);
+00072
+00073 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getUserData(<font class="keywordtype">int</font> *size = 0);
+00074 <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);
+00075
+00076 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *getFullName() <font class="keyword">const</font>;
+00077
+00078 <font class="keyword">virtual</font> <font class="keywordtype">void</font> root();
+00079 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> parent();
+00080
+00081 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> firstChild();
+00082 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> nextSibling();
+00083 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> previousSibling();
+00084
+00085 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> hasChildren();
+00086
+00087 <font class="keyword">virtual</font> <font class="keywordtype">void</font> append();
+00088 <font class="keyword">virtual</font> <font class="keywordtype">void</font> appendChild();
+00089 <font class="keyword">virtual</font> <font class="keywordtype">void</font> insertBefore();
+00090
+00091 <font class="keyword">virtual</font> <font class="keywordtype">void</font> remove();
+00092 <font class="keyword">virtual</font> <font class="keywordtype">void</font> save();
+00093
+00094 <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_tree_key_idx.html">TreeKeyIdx</a> &amp;ikey);
+00095 <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> &amp; ikey);
+00096
+00097 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> &amp;operator = (<font class="keyword">const</font> <a class="code" href="class_tree_key_idx.html">TreeKeyIdx</a> &amp;ikey) { <a class="code" href="class_s_w_key.html#a8">copyFrom</a>(ikey); <font class="keywordflow">return</font> *<font class="keyword">this</font>; }
+00098 <font class="keywordtype">void</font> setOffset(<font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> offset);
+00099 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> getOffset() <font class="keyword">const</font>;
+00100
+00101 SWKEY_OPERATORS
+00102
+00103 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_tree_key.html#a19">setText</a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey);
+00104 <font class="keyword">virtual</font> <font class="keywordtype">void</font> setPosition(SW_POSITION p);
+00105 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_tree_key.html#a21">getText</a>() <font class="keyword">const</font>;
+00106 <font class="keyword">virtual</font> <font class="keywordtype">int</font> _compare (<font class="keyword">const</font> <a class="code" href="class_tree_key_idx.html">TreeKeyIdx</a> &amp; ikey);
+00107 <font class="keyword">virtual</font> <font class="keywordtype">int</font> <a class="code" href="class_tree_key.html#a22">compare</a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> &amp;ikey);
+00108 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_tree_key.html#a23">decrement</a>(<font class="keywordtype">int</font> steps = 1);
+00109 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_tree_key.html#a24">increment</a>(<font class="keywordtype">int</font> steps = 1);
+00110 <font class="keyword">virtual</font> <font class="keywordtype">char</font> Traversable () { <font class="keywordflow">return</font> 1; }
+00111
+00112 <font class="keyword">static</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> create(<font class="keyword">const</font> <font class="keywordtype">char</font> *path);
+00113 };
+00114
+00115
+00116 <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>