summaryrefslogtreecommitdiff
path: root/doc/api-documentation/man/man3/EncodingFilterMgr.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/man/man3/EncodingFilterMgr.3')
-rw-r--r--doc/api-documentation/man/man3/EncodingFilterMgr.3120
1 files changed, 120 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/EncodingFilterMgr.3 b/doc/api-documentation/man/man3/EncodingFilterMgr.3
new file mode 100644
index 0000000..2c14a90
--- /dev/null
+++ b/doc/api-documentation/man/man3/EncodingFilterMgr.3
@@ -0,0 +1,120 @@
+.TH "EncodingFilterMgr" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+EncodingFilterMgr \- This class is like a normal \fBSWMgr\fP, but you can additonally specify which encoding you want to use.
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <encfiltmgr.h>\fP
+.PP
+Inherits SWFilterMgr.
+.PP
+Inherited by \fBMarkupFilterMgr\fP.
+.PP
+.SS "Public Methods"
+
+.in +1c
+.ti -1c
+.RI "\fBEncodingFilterMgr\fP (char encoding=ENC_UTF8)"
+.br
+.RI "\fIConstructor of SWEncodingMgr.\fP"
+.ti -1c
+.RI "\fB~EncodingFilterMgr\fP ()"
+.br
+.RI "\fIThe destructor of SWEncodingMgr.\fP"
+.ti -1c
+.RI "char \fBEncoding\fP (char enc)"
+.br
+.RI "\fIMarkup sets/gets the encoding after initialization.\fP"
+.ti -1c
+.RI "virtual void \fBAddRawFilters\fP (\fBSWModule\fP *module, ConfigEntMap &section)"
+.br
+.RI "\fIAdds the raw filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP"
+.ti -1c
+.RI "virtual void \fBAddEncodingFilters\fP (\fBSWModule\fP *module, ConfigEntMap &section)"
+.br
+.RI "\fIAdds the encoding filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP"
+.in -1c
+.SS "Protected Attributes"
+
+.in +1c
+.ti -1c
+.RI "SWFilter * \fBlatin1utf8\fP"
+.br
+.ti -1c
+.RI "SWFilter * \fBscsuutf8\fP"
+.br
+.ti -1c
+.RI "SWFilter * \fBtargetenc\fP"
+.br
+.ti -1c
+.RI "char \fBencoding\fP"
+.br
+.in -1c
+.SH "DETAILED DESCRIPTION"
+.PP
+This class is like a normal \fBSWMgr\fP, but you can additonally specify which encoding you want to use.
+.PP
+Definition at line 33 of file encfiltmgr.h.
+.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
+.PP
+.SS "EncodingFilterMgr::EncodingFilterMgr (char encoding = ENC_UTF8)"
+.PP
+Constructor of SWEncodingMgr.
+.PP
+Parameters:
+.in +1c
+.TP
+\fB\fIiconfig\fP\fP
+.TP
+\fB\fIisysconfig\fP\fP
+.TP
+\fB\fIautoload\fP\fP
+If this bool is true the constructor starts loading the installed modules. If you reimplemented \fBSWMgr\fP you can set autoload=false to load the modules with your own reimplemented function.
+.TP
+\fB\fIencoding\fP\fP
+The desired encoding.
+.SH "MEMBER FUNCTION DOCUMENTATION"
+.PP
+.SS "virtual void EncodingFilterMgr::AddEncodingFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [virtual]\fP"
+.PP
+Adds the encoding filters which are defined in 'section' to the \fBSWModule\fP object 'module'.
+.PP
+Parameters:
+.in +1c
+.TP
+\fB\fImodule\fP\fP
+To this module the encoding filter(s) are added
+.TP
+\fB\fIsection\fP\fP
+We use this section to get a list of filters we should apply to the module
+.SS "virtual void EncodingFilterMgr::AddRawFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [virtual]\fP"
+.PP
+Adds the raw filters which are defined in 'section' to the \fBSWModule\fP object 'module'.
+.PP
+Parameters:
+.in +1c
+.TP
+\fB\fImodule\fP\fP
+To this module the raw filter(s) are added
+.TP
+\fB\fIsection\fP\fP
+We use this section to get a list of filters we should apply to the module
+.SS "char EncodingFilterMgr::Encoding (char enc)"
+.PP
+Markup sets/gets the encoding after initialization.
+.PP
+Parameters:
+.in +1c
+.TP
+\fB\fIm\fP\fP
+The new encoding or ENC_UNKNOWN if you just want to get the current markup.
+.PP
+\fBReturns: \fP
+.in +1c
+The current (possibly changed) encoding format.
+
+.SH "AUTHOR"
+.PP
+Generated automatically by Doxygen for The Sword Project from the source code. \ No newline at end of file