diff options
Diffstat (limited to 'doc/api-documentation/html/treekey_8h-source.html')
| -rw-r--r-- | doc/api-documentation/html/treekey_8h-source.html | 167 |
1 files changed, 84 insertions, 83 deletions
diff --git a/doc/api-documentation/html/treekey_8h-source.html b/doc/api-documentation/html/treekey_8h-source.html index d7d6da7..df353c4 100644 --- a/doc/api-documentation/html/treekey_8h-source.html +++ b/doc/api-documentation/html/treekey_8h-source.html @@ -3,97 +3,98 @@ <title>treekey.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>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> +<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 <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> +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 <font class="preprocessor">#include <defs.h></font> +00029 <span class="preprocessor">#include <defs.h></span> 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 +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 <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 +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 <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 +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.15 </small></address> +width=110 height=53></a>1.2.17 </small></address> </body> </html> |