aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api-documentation/html/flatapi_8h-source.html
blob: ef664681230f6f187cb28836fef7ce55f8a4980c (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
90
91
92
<!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.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>flatapi.h</h1><div class="fragment"><pre>00001 <font class="preprocessor">#ifndef SWORDAPI_H</font>
00002 <font class="preprocessor"></font><font class="preprocessor">#define SWORDAPI_H</font>
00003 <font class="preprocessor"></font>
00004 <font class="preprocessor">#include &lt;swmodule.h&gt;</font>
00005 <font class="preprocessor">#include &lt;swkey.h&gt;</font>
00006 <font class="preprocessor">#include &lt;versekey.h&gt;</font>
00007 <font class="preprocessor">#include &lt;swmgr.h&gt;</font>
00008 
00009 <font class="preprocessor">#ifdef __cplusplus</font>
00010 <font class="preprocessor"></font><font class="preprocessor">#endif</font>
00011 <font class="preprocessor"></font>
00012 <font class="keyword">extern</font> <font class="stringliteral">"C"</font> {
00013 
00014 <font class="preprocessor">#define SWHANDLE int</font>
00015 <font class="preprocessor"></font>
00016 <font class="keyword">typedef</font> <font class="keyword">struct </font>{
00017         ModMap::iterator it;
00018         ModMap::iterator end;
00019 } ModItType;
00020 
00021 <font class="comment">//-----------------------------------------------------------------</font>
00022 <font class="comment">// stringlist_iterator methods</font>
00023 
00024 <font class="keywordtype">void</font> stringlist_iterator_next(SWHANDLE hsli);
00025 <font class="keyword">const</font> <font class="keywordtype">char</font> *stringlist_iterator_val(SWHANDLE hsli);
00026 
00027 
00028 <font class="comment">//-----------------------------------------------------------------</font>
00029 <font class="comment">// modmap methods</font>
00030 <font class="comment">//</font>
00031 <font class="keywordtype">void</font> ModList_iterator_next(SWHANDLE hmmi);
00032 SWHANDLE ModList_iterator_val(SWHANDLE hmmi);
00033 
00034 
00035 <font class="comment">//-----------------------------------------------------------------</font>
00036 <font class="comment">// SWMgr methods</font>
00037 <font class="comment">//</font>
00038 SWHANDLE SWMgr_new();
00039 <font class="comment">// SWConfig *, SWConfig *, bool, SWFilterMgr *</font>
00040 SWHANDLE SWMgr_newEx(SWHANDLE hiconfig, SWHANDLE hisysconfig, <font class="keywordtype">char</font> autoload, SWHANDLE hfilterMgr);
00041 <font class="keywordtype">void</font>     SWMgr_delete(SWHANDLE hmgr);
00042 SWHANDLE SWMgr_getConfig(SWHANDLE hmgr);
00043 SWHANDLE SWMgr_getModulesIterator(SWHANDLE hmgr);
00044 SWHANDLE SWMgr_getModuleByName(SWHANDLE hmgr, <font class="keyword">const</font> <font class="keywordtype">char</font> *name);
00045 <font class="keyword">const</font> <font class="keywordtype">char</font> *   SWMgr_getPrefixPath(SWHANDLE hmgr);
00046 <font class="keyword">const</font> <font class="keywordtype">char</font> *   SWMgr_getConfigPath(SWHANDLE hmgr);
00047 <font class="keywordtype">void</font>     SWMgr_setGlobalOption(SWHANDLE hmgr, <font class="keyword">const</font> <font class="keywordtype">char</font> *option, <font class="keyword">const</font> <font class="keywordtype">char</font> *value);
00048 <font class="keyword">const</font> <font class="keywordtype">char</font> *   SWMgr_getGlobalOption(SWHANDLE hmgr, <font class="keyword">const</font> <font class="keywordtype">char</font> *option);
00049 <font class="keyword">const</font> <font class="keywordtype">char</font> *   SWMgr_getGlobalOptionTip(SWHANDLE hmgr, <font class="keyword">const</font> <font class="keywordtype">char</font> *option);
00050 <font class="comment">// ret: forward_iterator</font>
00051 SWHANDLE SWMgr_getGlobalOptionsIterator(SWHANDLE hmgr);
00052 <font class="comment">// ret: forward_iterator</font>
00053 SWHANDLE SWMgr_getGlobalOptionValuesIterator(SWHANDLE hmgr, <font class="keyword">const</font> <font class="keywordtype">char</font> *option);
00054 <font class="keywordtype">void</font>     SWMgr_setCipherKey(SWHANDLE hmgr, <font class="keyword">const</font> <font class="keywordtype">char</font> *modName, <font class="keyword">const</font> <font class="keywordtype">char</font> *key);
00055 
00056 
00057 <font class="comment">//-----------------------------------------------------------------</font>
00058 <font class="comment">// SWModule methods</font>
00059 
00060 <font class="keywordtype">void</font>  SWModule_terminateSearch(SWHANDLE hmodule);
00061 <font class="keywordtype">char</font>  SWModule_error(SWHANDLE hmodule);
00062 <font class="keywordtype">int</font>   SWModule_getEntrySize(SWHANDLE hmodule);
00063 <font class="keywordtype">void</font>  SWModule_setKeyText(SWHANDLE hmodule, <font class="keyword">const</font> <font class="keywordtype">char</font> *key);
00064 <font class="keyword">const</font> <font class="keywordtype">char</font> *SWModule_getKeyText(SWHANDLE hmodule);
00065 <font class="keyword">const</font> <font class="keywordtype">char</font> *SWModule_getName(SWHANDLE hmodule);
00066 <font class="keyword">const</font> <font class="keywordtype">char</font> *SWModule_getDescription(SWHANDLE hmodule);
00067 <font class="keyword">const</font> <font class="keywordtype">char</font> *SWModule_getType(SWHANDLE hmodule);
00068 <font class="keywordtype">void</font>  SWModule_previous(SWHANDLE hmodule);
00069 <font class="keywordtype">void</font>  SWModule_next(SWHANDLE hmodule);
00070 <font class="keywordtype">void</font>  SWModule_begin(SWHANDLE hmodule);
00071 <font class="keyword">const</font> <font class="keywordtype">char</font> *SWModule_getStripText(SWHANDLE hmodule);
00072 <font class="keyword">const</font> <font class="keywordtype">char</font> *SWModule_getRenderText(SWHANDLE hmodule);
00073 
00074 }
00075 <font class="preprocessor">#ifdef __cplusplus</font>
00076 <font class="preprocessor"></font><font class="preprocessor">#endif</font>
00077 <font class="preprocessor"></font>
00078 <font class="preprocessor">#endif</font>
</pre></div><hr><address align="right"><small>Generated on Thu Jun 20 22:12:59 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>