diff options
Diffstat (limited to 'doc/api-documentation/html/treekeyidx_8h-source.html')
| -rw-r--r-- | doc/api-documentation/html/treekeyidx_8h-source.html | 226 |
1 files changed, 117 insertions, 109 deletions
diff --git a/doc/api-documentation/html/treekeyidx_8h-source.html b/doc/api-documentation/html/treekeyidx_8h-source.html index 997f9c2..75584ec 100644 --- a/doc/api-documentation/html/treekeyidx_8h-source.html +++ b/doc/api-documentation/html/treekeyidx_8h-source.html @@ -3,124 +3,132 @@ <title>treekeyidx.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.2.15 --> +<!-- 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="functions.html">Compound Members</a> </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> +<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>treekeyidx.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: treekeyidx_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 <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 <treekey.h></font> -00027 <font class="preprocessor">#include <sysdata.h></font> -00028 <font class="preprocessor">#include <filemgr.h></font> +00023 <span class="preprocessor">#ifndef TREEKEYIDX_H</span> +00024 <span class="preprocessor"></span><span class="preprocessor">#define TREEKEYIDX_H</span> +00025 <span class="preprocessor"></span> +00026 <span class="preprocessor">#include <treekey.h></span> +00027 <span class="preprocessor">#include <sysdata.h></span> +00028 <span class="preprocessor">#include <filemgr.h></span> 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> &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 +00030 SWORD_NAMESPACE_START +00031 +<a name="l00036"></a><a class="code" href="classsword_1_1_tree_key_idx.html">00036</a> <span class="keyword">class </span>SWDLLEXPORT <a class="code" href="classsword_1_1_tree_key_idx.html">TreeKeyIdx</a> : <span class="keyword">public</span> <a class="code" href="classsword_1_1_tree_key.html">TreeKey</a> { +00037 +00038 <span class="keyword">class </span>TreeNode { +00039 <span class="keyword">public</span>: +00040 TreeNode(); +00041 ~TreeNode(); +00042 <span class="keywordtype">void</span> clear(); +00043 __u32 offset; +00044 __s32 parent; +00045 __s32 next; +00046 __s32 firstChild; +00047 <span class="keywordtype">char</span> *name; +00048 __u16 dsize; +00049 <span class="keywordtype">char</span> *userData; +00050 } currentNode; +00051 +00052 <span class="keyword">static</span> <a class="code" href="classsword_1_1_s_w_class.html">SWClass</a> classdef; +00053 +00054 <span class="keywordtype">char</span> *path; +00055 +00056 FileDesc *idxfd; +00057 FileDesc *datfd; +00058 +00059 <span class="keywordtype">void</span> getTreeNodeFromDatOffset(<span class="keywordtype">long</span> ioffset, TreeNode *buf) <span class="keyword">const</span>; +00060 <span class="keywordtype">char</span> getTreeNodeFromIdxOffset(<span class="keywordtype">long</span> ioffset, TreeNode *node) <span class="keyword">const</span>; +00061 <span class="keywordtype">void</span> saveTreeNode(TreeNode *node); +00062 <span class="keywordtype">void</span> saveTreeNodeOffsets(TreeNode *node); +00063 <span class="keywordtype">void</span> init(); +00064 +00065 <span class="keyword">public</span>: +00066 <a class="code" href="classsword_1_1_tree_key_idx.html">TreeKeyIdx</a>(<span class="keyword">const</span> <a class="code" href="classsword_1_1_tree_key_idx.html">TreeKeyIdx</a> &ikey); +00067 <a class="code" href="classsword_1_1_tree_key_idx.html">TreeKeyIdx</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *idxPath, <span class="keywordtype">int</span> fileMode = -1); +00068 ~<a class="code" href="classsword_1_1_tree_key_idx.html">TreeKeyIdx</a> (); 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>; +00070 <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>; +00071 +00072 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getLocalName(); +00073 <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> *); +00074 +00075 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getUserData(<span class="keywordtype">int</span> *size = 0); +00076 <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); 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(); +00078 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getFullName() <span class="keyword">const</span>; +00079 +00080 <span class="keyword">virtual</span> <span class="keywordtype">void</span> root(); +00081 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> parent(); +00082 +00083 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> firstChild(); +00084 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> nextSibling(); +00085 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> previousSibling(); 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> &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> & ikey); -00096 -00097 <font class="keyword">virtual</font> <a class="code" href="class_s_w_key.html">SWKey</a> &operator = (<font class="keyword">const</font> <a class="code" href="class_tree_key_idx.html">TreeKeyIdx</a> &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 +00087 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> hasChildren(); +00088 +00089 <span class="keyword">virtual</span> <span class="keywordtype">void</span> append(); +00090 <span class="keyword">virtual</span> <span class="keywordtype">void</span> appendChild(); +00091 <span class="keyword">virtual</span> <span class="keywordtype">void</span> insertBefore(); +00092 +00093 <span class="keyword">virtual</span> <span class="keywordtype">void</span> remove(); +00094 <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(); +00095 +00096 <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_tree_key_idx.html">TreeKeyIdx</a> &ikey); +00097 <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); +00098 +00099 <span class="keywordtype">void</span> setOffset(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> offset); +00100 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> getOffset() <span class="keyword">const</span>; +00101 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> & 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> &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 +00103 +00104 <span class="comment">// OPERATORS ------------------------------------------------------------</span> +00105 +00106 +00107 <span class="keyword">virtual</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> &operator = (<span class="keyword">const</span> <a class="code" href="classsword_1_1_tree_key_idx.html">TreeKeyIdx</a> &ikey) { <a class="code" href="classsword_1_1_s_w_key.html#a8">copyFrom</a>(ikey); <span class="keywordflow">return</span> *<span class="keyword">this</span>; } +00108 SWKEY_OPERATORS +00109 +00110 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_tree_key.html#a19">setText</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *ikey); +00111 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setPosition(SW_POSITION p); +00112 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classsword_1_1_tree_key.html#a21">getText</a>() <span class="keyword">const</span>; +00113 <span class="keyword">virtual</span> <span class="keywordtype">int</span> _compare (<span class="keyword">const</span> <a class="code" href="classsword_1_1_tree_key_idx.html">TreeKeyIdx</a> & ikey); +00114 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classsword_1_1_tree_key.html#a22">compare</a>(<span class="keyword">const</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> &ikey); +00115 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_tree_key.html#a23">decrement</a>(<span class="keywordtype">int</span> steps = 1); +00116 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_tree_key.html#a24">increment</a>(<span class="keywordtype">int</span> steps = 1); +00117 <span class="keyword">virtual</span> <span class="keywordtype">char</span> Traversable () { <span class="keywordflow">return</span> 1; } +00118 +00119 <span class="keyword">static</span> <span class="keywordtype">signed</span> <span class="keywordtype">char</span> create(<span class="keyword">const</span> <span class="keywordtype">char</span> *path); +00120 }; +00121 +00122 SWORD_NAMESPACE_END +00123 +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.15 </small></address> +width=110 height=53></a>1.2.17 </small></address> </body> </html> |