summaryrefslogtreecommitdiff
path: root/doc/api-documentation/html/zcom_8h-source.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/html/zcom_8h-source.html')
-rw-r--r--doc/api-documentation/html/zcom_8h-source.html84
1 files changed, 84 insertions, 0 deletions
diff --git a/doc/api-documentation/html/zcom_8h-source.html b/doc/api-documentation/html/zcom_8h-source.html
new file mode 100644
index 0000000..a12d183
--- /dev/null
+++ b/doc/api-documentation/html/zcom_8h-source.html
@@ -0,0 +1,84 @@
+<!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>zcom.h Source File</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body bgcolor="#ffffff">
+<!-- Generated by Doxygen 1.2.9.1 -->
+<center>
+<a class="qindex" href="index.html">Main Page</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>zcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font>
+00002 <font class="comment"> * zcom.h - code for class 'zCom'- a module that reads compressed text</font>
+00003 <font class="comment"> * files: ot and nt using indexs ??.vss</font>
+00004 <font class="comment"> *</font>
+00005 <font class="comment"> * $Id: zcom_8h-source.html,v 1.4 2002/01/22 14:20:28 jansorg Exp $</font>
+00006 <font class="comment"> *</font>
+00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font>
+00008 <font class="comment"> * CrossWire Bible Society</font>
+00009 <font class="comment"> * P. O. Box 2528</font>
+00010 <font class="comment"> * Tempe, AZ 85280-2528</font>
+00011 <font class="comment"> *</font>
+00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font>
+00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font>
+00014 <font class="comment"> * Free Software Foundation version 2.</font>
+00015 <font class="comment"> *</font>
+00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font>
+00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
+00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font>
+00019 <font class="comment"> * General Public License for more details.</font>
+00020 <font class="comment"> *</font>
+00021 <font class="comment"> */</font>
+00022
+00023 <font class="preprocessor">#ifndef ZCOM_H</font>
+00024 <font class="preprocessor"></font><font class="preprocessor">#define ZCOM_H</font>
+00025 <font class="preprocessor"></font>
+00026 <font class="preprocessor">#include &lt;rawverse.h&gt;</font>
+00027 <font class="preprocessor">#include &lt;swcom.h&gt;</font>
+00028 <font class="preprocessor">#include &lt;swcomprs.h&gt;</font>
+00029
+00030 <font class="preprocessor">#include &lt;defs.h&gt;</font>
+00031
+00032 <font class="keyword">class </font>SWDLLEXPORT zCom:<font class="keyword">public</font> zVerse, <font class="keyword">public</font> <a class="code" href="class_s_w_com.html">SWCom</a> {
+00033 <font class="keywordtype">char</font> *versebuf;
+00034 <a class="code" href="class_verse_key.html">VerseKey</a> *lastWriteKey;
+00035 <font class="keywordtype">bool</font> sameBlock (<a class="code" href="class_verse_key.html">VerseKey</a> * lastWriteKey, <a class="code" href="class_verse_key.html">VerseKey</a> * key);
+00036 <font class="keywordtype">int</font> blockType;
+00037 <font class="keyword">public</font>:
+00038
+00039
+00040 zCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc =
+00041 0, <font class="keywordtype">int</font> blockType = CHAPTERBLOCKS, SWCompress * icomp =
+00042 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
+00043 <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0);
+00044 <font class="keyword">virtual</font> ~ zCom ();
+00045 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a25">getRawEntry</a> ();
+00046 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> &amp; <a class="code" href="class_s_w_module.html#a34">operator += </a>(<font class="keywordtype">int</font> increment);
+00047 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> &amp; <a class="code" href="class_s_w_module.html#a33">operator -= </a>(<font class="keywordtype">int</font> decrement)<font class="keyword"></font>
+00048 <font class="keyword"> </font>{
+00049 <font class="keywordflow">return</font> this-&gt;<a class="code" href="class_s_w_module.html#a34">operator += </a>(-decrement);
+00050 }
+00051
+00052 <font class="comment">// write interface ----------------------------</font>
+00053 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a28">isWritable</a> ()<font class="keyword"></font>
+00054 <font class="keyword"> </font>{
+00055 <font class="keywordflow">return</font> <font class="keyword">true</font>;
+00056 }
+00057 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound)<font class="keyword"></font>
+00058 <font class="keyword"> </font>{
+00059 <font class="keywordflow">return</font> zVerse::createModule (path, blockBound);
+00060 }
+00061 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> &amp; <a class="code" href="class_s_w_module.html#a29">setentry</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf, <font class="keywordtype">long</font> len); <font class="comment">// Modify current module entry</font>
+00062 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> &amp; <a class="code" href="class_s_w_module.html#a30">operator &lt;&lt; </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font>
+00063 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> &amp; <a class="code" href="class_s_w_module.html#a30">operator &lt;&lt; </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font>
+00064 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a32">deleteEntry</a> (); <font class="comment">// Delete current module entry</font>
+00065 <font class="comment">// end write interface ------------------------</font>
+00066 };
+00067
+00068
+00069 <font class="preprocessor">#endif</font>
+</font></pre></div><hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.gif" alt="doxygen" align="middle" border=0
+width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
+ &copy;&nbsp;1997-2001</small></address>
+</body>
+</html>