aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api-documentation/html/flatapi_8h-source.html
blob: f48030604507a117f66de98431fec852e5cb1f3b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<!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>flatapi.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> &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="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
<hr><h1>flatapi.h</h1><div class="fragment"><pre>00001 <span class="preprocessor">#ifndef SWORDAPI_H</span>
00002 <span class="preprocessor"></span><span class="preprocessor">#define SWORDAPI_H</span>
00003 <span class="preprocessor"></span>
00004 <span class="comment">//#include &lt;swmodule.h&gt;</span>
00005 <span class="comment">//#include &lt;swkey.h&gt;</span>
00006 <span class="comment">//#include &lt;versekey.h&gt;</span>
00007 <span class="comment">//#include &lt;swmgr.h&gt;</span>
00008 <span class="preprocessor">#include &lt;defs.h&gt;</span>
00009 <span class="preprocessor">#ifdef __cplusplus</span>
00010 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
00011 <span class="preprocessor"></span>
00012 <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
00013 
00014 <span class="preprocessor">#define SWHANDLE int</span>
00015 <span class="preprocessor"></span>
00016 <span class="comment">//using namespace sword;</span>
00017 
00018 <span class="comment">//-----------------------------------------------------------------</span>
00019 <span class="comment">// stringlist_iterator methods</span>
00020 
00021 <span class="keywordtype">void</span> SWDLLEXPORT stringlist_iterator_next(SWHANDLE hsli);
00022 <span class="keyword">const</span> <span class="keywordtype">char</span> * SWDLLEXPORT stringlist_iterator_val(SWHANDLE hsli);
00023 
00024 
00025 <span class="comment">//-----------------------------------------------------------------</span>
00026 <span class="comment">// modmap methods</span>
00027 <span class="comment">//</span>
00028 <span class="keywordtype">void</span> SWDLLEXPORT ModList_iterator_next(SWHANDLE hmmi);
00029 SWHANDLE SWDLLEXPORT ModList_iterator_val(SWHANDLE hmmi);
00030 
00031 
00032 <span class="comment">//-----------------------------------------------------------------</span>
00033 <span class="comment">// SWMgr methods</span>
00034 <span class="comment">//</span>
00035 SWHANDLE SWDLLEXPORT SWMgr_new();
00036 <span class="comment">// SWConfig *, SWConfig *, bool, SWFilterMgr *</span>
00037 SWHANDLE SWDLLEXPORT SWMgr_newEx(SWHANDLE hiconfig, SWHANDLE hisysconfig, <span class="keywordtype">char</span> autoload, SWHANDLE hfilterMgr);
00038 <span class="keywordtype">void</span>     SWDLLEXPORT SWMgr_delete(SWHANDLE hmgr);
00039 SWHANDLE SWDLLEXPORT SWMgr_getConfig(SWHANDLE hmgr);
00040 SWHANDLE SWDLLEXPORT SWMgr_getModulesIterator(SWHANDLE hmgr);
00041 SWHANDLE SWDLLEXPORT SWMgr_getModuleByName(SWHANDLE hmgr, <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
00042 <span class="keyword">const</span> <span class="keywordtype">char</span> *   SWDLLEXPORT SWMgr_getPrefixPath(SWHANDLE hmgr);
00043 <span class="keyword">const</span> <span class="keywordtype">char</span> *   SWDLLEXPORT SWMgr_getConfigPath(SWHANDLE hmgr);
00044 <span class="keywordtype">void</span>     SWDLLEXPORT SWMgr_setGlobalOption(SWHANDLE hmgr, <span class="keyword">const</span> <span class="keywordtype">char</span> *option, <span class="keyword">const</span> <span class="keywordtype">char</span> *value);
00045 <span class="keyword">const</span> <span class="keywordtype">char</span> *   SWDLLEXPORT SWMgr_getGlobalOption(SWHANDLE hmgr, <span class="keyword">const</span> <span class="keywordtype">char</span> *option);
00046 <span class="keyword">const</span> <span class="keywordtype">char</span> *   SWDLLEXPORT SWMgr_getGlobalOptionTip(SWHANDLE hmgr, <span class="keyword">const</span> <span class="keywordtype">char</span> *option);
00047 <span class="comment">// ret: forward_iterator</span>
00048 SWHANDLE SWDLLEXPORT SWMgr_getGlobalOptionsIterator(SWHANDLE hmgr);
00049 <span class="comment">// ret: forward_iterator</span>
00050 SWHANDLE SWDLLEXPORT SWMgr_getGlobalOptionValuesIterator(SWHANDLE hmgr, <span class="keyword">const</span> <span class="keywordtype">char</span> *option);
00051 <span class="keywordtype">void</span>     SWDLLEXPORT SWMgr_setCipherKey(SWHANDLE hmgr, <span class="keyword">const</span> <span class="keywordtype">char</span> *modName, <span class="keyword">const</span> <span class="keywordtype">char</span> *key);
00052 
00053 
00054 <span class="comment">//-----------------------------------------------------------------</span>
00055 <span class="comment">// SWModule methods</span>
00056 
00057 <span class="keywordtype">void</span>  SWDLLEXPORT SWModule_terminateSearch(SWHANDLE hmodule);
00058 <span class="keywordtype">char</span>  SWDLLEXPORT SWModule_error(SWHANDLE hmodule);
00059 <span class="keywordtype">int</span>   SWDLLEXPORT SWModule_getEntrySize(SWHANDLE hmodule);
00060 <span class="keywordtype">void</span>  SWDLLEXPORT SWModule_setKeyText(SWHANDLE hmodule, <span class="keyword">const</span> <span class="keywordtype">char</span> *key);
00061 <span class="keyword">const</span> <span class="keywordtype">char</span> * SWDLLEXPORT SWModule_getKeyText(SWHANDLE hmodule);
00062 <span class="keyword">const</span> <span class="keywordtype">char</span> * SWDLLEXPORT SWModule_getName(SWHANDLE hmodule);
00063 <span class="keyword">const</span> <span class="keywordtype">char</span> * SWDLLEXPORT SWModule_getDescription(SWHANDLE hmodule);
00064 <span class="keyword">const</span> <span class="keywordtype">char</span> * SWDLLEXPORT SWModule_getType(SWHANDLE hmodule);
00065 <span class="keywordtype">void</span>  SWDLLEXPORT SWModule_previous(SWHANDLE hmodule);
00066 <span class="keywordtype">void</span>  SWDLLEXPORT SWModule_next(SWHANDLE hmodule);
00067 <span class="keywordtype">void</span>  SWDLLEXPORT SWModule_begin(SWHANDLE hmodule);
00068 <span class="keyword">const</span> <span class="keywordtype">char</span> * SWDLLEXPORT SWModule_getStripText(SWHANDLE hmodule);
00069 <span class="keyword">const</span> <span class="keywordtype">char</span> * SWDLLEXPORT SWModule_getRenderText(SWHANDLE hmodule);
00070 
00071 }
00072 <span class="preprocessor">#ifdef __cplusplus</span>
00073 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
00074 <span class="preprocessor"></span>
00075 <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>