diff options
Diffstat (limited to 'doc/api-documentation/man/man3/swmgr.3')
| -rw-r--r-- | doc/api-documentation/man/man3/swmgr.3 | 378 |
1 files changed, 0 insertions, 378 deletions
diff --git a/doc/api-documentation/man/man3/swmgr.3 b/doc/api-documentation/man/man3/swmgr.3 deleted file mode 100644 index e18a57f..0000000 --- a/doc/api-documentation/man/man3/swmgr.3 +++ /dev/null @@ -1,378 +0,0 @@ -.TH "SWMgr" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- -.ad l -.nh -.SH NAME -SWMgr \- The main class of Sword to handle all other things. -.SH SYNOPSIS -.br -.PP -\fC#include <swmgr.h>\fR -.PP -.SS Public Methods - -.in +1c -.ti -1c -.RI "\fBSWMgr\fR (\fBSWConfig\fR *iconfig=0, \fBSWConfig\fR *isysconfig=0, bool autoload=true)" -.br -.RI "\fIConstructor of SWMgr.\fR" -.ti -1c -.RI "\fBSWMgr\fR (const char *iConfigPath, bool autoload=true)" -.br -.ti -1c -.RI "virtual \fB~SWMgr\fR ()" -.br -.RI "\fIThe destructor of SWMgr.\fR" -.ti -1c -.RI "virtual void \fBInstallScan\fR (const char *dir)" -.br -.RI "\fIInstalls a scan for modules in the directory givan as parameter.\fR" -.ti -1c -.RI "virtual void \fBLoad\fR ()" -.br -.RI "\fILoad the modules.\fR" -.ti -1c -.RI "virtual void \fBsetGlobalOption\fR (const char *option, const char *value)" -.br -.RI "\fISet a global option Set a global option using the parameters.\fR" -.ti -1c -.RI "virtual const char* \fBgetGlobalOption\fR (const char *option)" -.br -.RI "\fIGives the value of the given option.\fR" -.ti -1c -.RI "virtual const char* \fBgetGlobalOptionTip\fR (const char *option)" -.br -.RI "\fIGives a description for the given option.\fR" -.ti -1c -.RI "virtual OptionsList \fBgetGlobalOptions\fR ()" -.br -.RI "\fIA list of all availble options with the currently set values.\fR" -.ti -1c -.RI "virtual OptionsList \fBgetGlobalOptionValues\fR (const char *option)" -.br -.ti -1c -.RI "virtual char \fBsetCipherKey\fR (const char *modName, const char *key)" -.br -.RI "\fISets the cipher key for the given module.\fR" -.ti -1c -.RI "const float \fBVersion\fR () const" -.br -.RI "\fIGet the Sword version.\fR" -.in -1c -.SS Public Attributes - -.in +1c -.ti -1c -.RI "\fBSWConfig\fR* \fBconfig\fR" -.br -.RI "\fIThe global config object.\fR" -.ti -1c -.RI "\fBSWConfig\fR* \fBsysconfig\fR" -.br -.ti -1c -.RI "ModMap \fBModules\fR" -.br -.RI "\fIA map of all modules This map contains the list of installed modules we use.\fR" -.ti -1c -.RI "char* \fBprefixPath\fR" -.br -.RI "\fIThe path to your Sword directory.\fR" -.ti -1c -.RI "char* \fBconfigPath\fR" -.br -.in -1c -.SS Static Public Methods - -.in +1c -.ti -1c -.RI "void \fBfindConfig\fR (char *configType, char **\fBprefixPath\fR, char **configPath)" -.br -.in -1c -.SS Static Public Attributes - -.in +1c -.ti -1c -.RI "bool \fBdebug\fR" -.br -.RI "\fIEnable / Disable debug output Set this static bool to true to get more verbose debug messages from SWMgr.\fR" -.in -1c -.SS Protected Methods - -.in +1c -.ti -1c -.RI "void \fBCreateMods\fR ()" -.br -.ti -1c -.RI "\fBSWModule\fR* \fBCreateMod\fR (string name, string driver, ConfigEntMap §ion)" -.br -.ti -1c -.RI "void \fBDeleteMods\fR ()" -.br -.ti -1c -.RI "virtual void \fBinit\fR ()" -.br -.ti -1c -.RI "virtual char \fBAddModToConfig\fR (int conffd, const char *fname)" -.br -.ti -1c -.RI "virtual void \fBloadConfigDir\fR (const char *ipath)" -.br -.ti -1c -.RI "virtual void \fBAddGlobalOptions\fR (\fBSWModule\fR *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end)" -.br -.ti -1c -.RI "virtual void \fBAddLocalOptions\fR (\fBSWModule\fR *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end)" -.br -.ti -1c -.RI "virtual void \fBAddRenderFilters\fR (\fBSWModule\fR *module, ConfigEntMap §ion)" -.br -.RI "\fIAdds the render filters which are defined in "section" to the \fBSWModule\fR object "module".\fR" -.ti -1c -.RI "virtual void \fBAddStripFilters\fR (\fBSWModule\fR *module, ConfigEntMap §ion)" -.br -.RI "\fIAdds the strip filters which are defined in "section" to the \fBSWModule\fR object "module".\fR" -.ti -1c -.RI "virtual void \fBAddRawFilters\fR (\fBSWModule\fR *module, ConfigEntMap §ion)" -.br -.RI "\fIAdds the raw filters which are defined in "section" to the \fBSWModule\fR object "module".\fR" -.in -1c -.SS Protected Attributes - -.in +1c -.ti -1c -.RI "\fBSWConfig\fR* \fBmyconfig\fR" -.br -.ti -1c -.RI "\fBSWConfig\fR* \fBmysysconfig\fR" -.br -.ti -1c -.RI "char \fBconfigType\fR" -.br -.ti -1c -.RI "FilterMap \fBoptionFilters\fR" -.br -.ti -1c -.RI "FilterMap \fBcipherFilters\fR" -.br -.ti -1c -.RI "\fBSWFilter\fR* \fBgbfplain\fR" -.br -.ti -1c -.RI "\fBSWFilter\fR* \fBthmlplain\fR" -.br -.ti -1c -.RI "FilterList \fBcleanupFilters\fR" -.br -.ti -1c -.RI "OptionsList \fBoptions\fR" -.br -.in -1c -.SH DETAILED DESCRIPTION -.PP -The main class of Sword to handle all other things. -.PP -SWmgr manages the installed modules, the filters and global options like footnotes or strong numbers. The class SWMgr is the most important class of Sword. It is used to manage the installed modules. It also manages the filters (Render-, Strip- and Rawfilters). -.PP -\fBSee also: \fR -.in +1c -\fBAddRawFilters\fR(), \fBAddRenderFilters\fR(), \fBAddStripFilters\fR() -.PP -\fBVersion: \fR -.in +1c -\fBId: \fR -.in +1c - swmgr.h,v 1.27 2001/10/05 20:37:00 mgruner Exp -.PP -Definition at line 63 of file swmgr.h. -.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION -.PP -.SS SWMgr::SWMgr (\fBSWConfig\fR * iconfig = 0, \fBSWConfig\fR * isysconfig = 0, bool autoload = true) -.PP -Constructor of SWMgr. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIiconfig\fR\fR -.TP -\fB\fIisysconfig\fR\fR -.TP -\fB\fIautoload\fR\fR -If this bool is true the constructor starts loading the installed modules. If you reimplemented SWMgr you can set autoload=false to load the modules with your own reimplemented function. -.SS SWMgr::~SWMgr ()\fC [virtual]\fR -.PP -The destructor of SWMgr. -.PP -This destrutcot cleans up the modules and deletes the created object. Destroy the SWMgr at last in your application. -.SH MEMBER FUNCTION DOCUMENTATION -.PP -.SS void SWMgr::AddRawFilters (\fBSWModule\fR * module, ConfigEntMap & section)\fC [protected, virtual]\fR -.PP -Adds the raw filters which are defined in "section" to the \fBSWModule\fR object "module". -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fImodule\fR\fR -To this module the raw filter(s) are added -.TP -\fB\fIsection\fR\fR -We use this section to get a list of filters we should apply to the module -.SS void SWMgr::AddRenderFilters (\fBSWModule\fR * module, ConfigEntMap & section)\fC [protected, virtual]\fR -.PP -Adds the render filters which are defined in "section" to the \fBSWModule\fR object "module". -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fImodule\fR\fR -To this module the render filter(s) are added -.TP -\fB\fIsection\fR\fR -We use this section to get a list of filters we should apply to the module -.SS void SWMgr::AddStripFilters (\fBSWModule\fR * module, ConfigEntMap & section)\fC [protected, virtual]\fR -.PP -Adds the strip filters which are defined in "section" to the \fBSWModule\fR object "module". -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fImodule\fR\fR -To this module the strip filter(s) are added -.TP -\fB\fIsection\fR\fR -We use this section to get a list of filters we should apply to the module -.SS void SWMgr::InstallScan (const char * dir)\fC [virtual]\fR -.PP -Installs a scan for modules in the directory givan as parameter. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIdir\fR\fR -The directory where new modules should be searched. -.SS void SWMgr::Load ()\fC [virtual]\fR -.PP -Load the modules. -.PP -Reimplement this function to use your own Load function, for example to use your own filters. -.SS const float SWMgr::Version () const\fC [inline]\fR -.PP -Get the Sword version. -.PP -Function to get the used version of Sword. This is required, because the modules have now a MinimumVersion tag, so it should be possible to get the currently used version. -.PP -\fBReturns: \fR -.in +1c -The version of the Sword library as a float (e.g. 1.52). -.PP -Definition at line 239 of file swmgr.h. -.SS const char * SWMgr::getGlobalOption (const char * option)\fC [virtual]\fR -.PP -Gives the value of the given option. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIThe\fR\fR -option, which should be used to return the value of it -.PP -\fBReturns: \fR -.in +1c -The value of the given option -.SS const char * SWMgr::getGlobalOptionTip (const char * option)\fC [virtual]\fR -.PP -Gives a description for the given option. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIoption\fR\fR -The option, which should be used -.PP -\fBReturns: \fR -.in +1c -A description of the given option -.PP -\fBSee also: \fR -.in +1c -\fBsetGlobalOption\fR, \fBgetGlobalOption\fR, \fBgetGlobalOptions\fR -.SS OptionsList SWMgr::getGlobalOptions ()\fC [virtual]\fR -.PP -A list of all availble options with the currently set values. -.PP -\fBReturns: \fR -.in +1c -This function returns a list of global options. -.SS char SWMgr::setCipherKey (const char * modName, const char * key)\fC [virtual]\fR -.PP -Sets the cipher key for the given module. -.PP -This function updates the key at runtime, but it does not write to the config file. To write the new unlock key to the config file use code like this: -.PP -.nf - SectionMap::iterator section; - ConfigEntMap::iterator entry; - DIR *dir = opendir(configPath); - struct dirent *ent; - char* modFile; - if (dir) { // find and update .conf file - rewinddir(dir); - while ((ent = readdir(dir))) - { - if ((strcmp(ent->d_name, ".")) && (strcmp(ent->d_name, ".."))) - { - modFile = m_backend->configPath; - modFile += "/"; - modFile += ent->d_name; - SWConfig *myConfig = new SWConfig( modFile ); - section = myConfig->Sections.find( m_module->Name() ); - if ( section != myConfig->Sections.end() ) - { - entry = section->second.find("CipherKey"); - if (entry != section->second.end()) - { - entry->second = unlockKey;//set cipher key - myConfig->Save();//save config file - } - } - delete myConfig; - } - } - } - closedir(dir); -.fi -\fBParameters: \fR -.in +1c -.TP -\fB\fImodName\fR\fR -For this module we change the unlockKey -.PP -\fBan key This is the new unlck key we use for te module.\fR -.in +1c -.SS void SWMgr::setGlobalOption (const char * option, const char * value)\fC [virtual]\fR -.PP -Set a global option Set a global option using the parameters. -.PP -A global option could be for example footnotes. -.PP -\fBParameters: \fR -.in +1c -.TP -\fB\fIoption\fR\fR -The name of the option, for which you want to change the value. Well known and often used values are "Footnotes" or "Strongs" -.TP -\fB\fIvalue\fR\fR -The value. Common values are "On" and "Off" -.SH MEMBER DATA DOCUMENTATION -.PP -.SS \fBSWConfig\fR * SWMgr::config -.PP -The global config object. -.PP -This is the global config object. It contains all items of all modules, so lookups should use this config object. If you want to save a cipher key or other things to the module config file, do NOT use this object, because it would corrupt your configs after config->Save(). -.PP -Definition at line 122 of file swmgr.h. - -.SH AUTHOR -.PP -Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |