Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

flatapi.h

00001 #ifndef SWORDAPI_H
00002 #define SWORDAPI_H
00003 
00004 #include <swmodule.h>
00005 #include <swkey.h>
00006 #include <versekey.h>
00007 #include <swmgr.h>
00008 
00009 #ifdef __cplusplus
00010 #endif
00011 
00012 extern "C" {
00013 
00014 #define SWHANDLE int
00015 
00016 typedef struct {
00017         ModMap::iterator it;
00018         ModMap::iterator end;
00019 } ModItType;
00020 
00021 //-----------------------------------------------------------------
00022 // stringlist_iterator methods
00023 
00024 void stringlist_iterator_next(SWHANDLE hsli);
00025 const char *stringlist_iterator_val(SWHANDLE hsli);
00026 
00027 
00028 //-----------------------------------------------------------------
00029 // modmap methods
00030 //
00031 void ModList_iterator_next(SWHANDLE hmmi);
00032 SWHANDLE ModList_iterator_val(SWHANDLE hmmi);
00033 
00034 
00035 //-----------------------------------------------------------------
00036 // SWMgr methods
00037 //
00038 SWHANDLE SWMgr_new();
00039 // SWConfig *, SWConfig *, bool, SWFilterMgr *
00040 SWHANDLE SWMgr_newEx(SWHANDLE hiconfig, SWHANDLE hisysconfig, char autoload, SWHANDLE hfilterMgr);
00041 void     SWMgr_delete(SWHANDLE hmgr);
00042 SWHANDLE SWMgr_getConfig(SWHANDLE hmgr);
00043 SWHANDLE SWMgr_getModulesIterator(SWHANDLE hmgr);
00044 SWHANDLE SWMgr_getModuleByName(SWHANDLE hmgr, const char *name);
00045 const char *   SWMgr_getPrefixPath(SWHANDLE hmgr);
00046 const char *   SWMgr_getConfigPath(SWHANDLE hmgr);
00047 void     SWMgr_setGlobalOption(SWHANDLE hmgr, const char *option, const char *value);
00048 const char *   SWMgr_getGlobalOption(SWHANDLE hmgr, const char *option);
00049 const char *   SWMgr_getGlobalOptionTip(SWHANDLE hmgr, const char *option);
00050 // ret: forward_iterator
00051 SWHANDLE SWMgr_getGlobalOptionsIterator(SWHANDLE hmgr);
00052 // ret: forward_iterator
00053 SWHANDLE SWMgr_getGlobalOptionValuesIterator(SWHANDLE hmgr, const char *option);
00054 void     SWMgr_setCipherKey(SWHANDLE hmgr, const char *modName, const char *key);
00055 
00056 
00057 //-----------------------------------------------------------------
00058 // SWModule methods
00059 
00060 void  SWModule_terminateSearch(SWHANDLE hmodule);
00061 char  SWModule_error(SWHANDLE hmodule);
00062 int   SWModule_getEntrySize(SWHANDLE hmodule);
00063 void  SWModule_setKeyText(SWHANDLE hmodule, const char *key);
00064 const char *SWModule_getKeyText(SWHANDLE hmodule);
00065 const char *SWModule_getName(SWHANDLE hmodule);
00066 const char *SWModule_getDescription(SWHANDLE hmodule);
00067 const char *SWModule_getType(SWHANDLE hmodule);
00068 void  SWModule_previous(SWHANDLE hmodule);
00069 void  SWModule_next(SWHANDLE hmodule);
00070 void  SWModule_begin(SWHANDLE hmodule);
00071 const char *SWModule_getStripText(SWHANDLE hmodule);
00072 const char *SWModule_getRenderText(SWHANDLE hmodule);
00073 
00074 }
00075 #ifdef __cplusplus
00076 #endif
00077 
00078 #endif

Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by doxygen1.2.15