summaryrefslogtreecommitdiff
path: root/doc/api-documentation/man/man3/SWMarkupMgr.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/man/man3/SWMarkupMgr.3')
-rw-r--r--doc/api-documentation/man/man3/SWMarkupMgr.3117
1 files changed, 117 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/SWMarkupMgr.3 b/doc/api-documentation/man/man3/SWMarkupMgr.3
new file mode 100644
index 0000000..024e16d
--- /dev/null
+++ b/doc/api-documentation/man/man3/SWMarkupMgr.3
@@ -0,0 +1,117 @@
+.TH "SWMarkupMgr" 3 "30 Oct 2001" "The Sword Project" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+SWMarkupMgr \- This class is like a normal \fBSWEncodingMgr\fP, but you can additonally specify which markup you want to use.
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <swmarkupmgr.h>\fP
+.PP
+Inherits \fBSWEncodingMgr\fP.
+.PP
+.SS "Public Methods"
+
+.in +1c
+.ti -1c
+.RI "\fBSWMarkupMgr\fP (\fBSWConfig\fP *iconfig=0, \fBSWConfig\fP *isysconfig=0, bool autoload=true, char encoding=ENC_UTF8, char markup=FMT_THML)"
+.br
+.RI "\fIConstructor of SWMarkupMgr.\fP"
+.ti -1c
+.RI "\fB~SWMarkupMgr\fP ()"
+.br
+.RI "\fIThe destructor of SWMarkupMgr.\fP"
+.ti -1c
+.RI "char \fBMarkup\fP (char m=FMT_UNKNOWN)"
+.br
+.RI "\fIMarkup sets/gets the markup after initialization.\fP"
+.ti -1c
+.RI "virtual void \fBAddRenderFilters\fP (\fBSWModule\fP *module, ConfigEntMap &section)"
+.br
+.RI "\fIAdds the render filters which are defined in 'section' to the \fBSWModule\fP object 'module'.\fP"
+.in -1c
+.SS "Protected Methods"
+
+.in +1c
+.ti -1c
+.RI "void \fBCreateFilters\fP (char markup)"
+.br
+.in -1c
+.SS "Protected Attributes"
+
+.in +1c
+.ti -1c
+.RI "\fBSWFilter\fP * \fBfromthml\fP"
+.br
+.ti -1c
+.RI "\fBSWFilter\fP * \fBfromgbf\fP"
+.br
+.ti -1c
+.RI "\fBSWFilter\fP * \fBfromplain\fP"
+.br
+.ti -1c
+.RI "\fBSWFilter\fP * \fBfromosis\fP"
+.br
+.ti -1c
+.RI "char \fBmarkup\fP"
+.br
+.in -1c
+.SH "DETAILED DESCRIPTION"
+.PP
+This class is like a normal \fBSWEncodingMgr\fP, but you can additonally specify which markup you want to use.
+.PP
+Definition at line 31 of file swmarkupmgr.h.
+.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
+.PP
+.SS "SWMarkupMgr::SWMarkupMgr (\fBSWConfig\fP * iconfig = 0, \fBSWConfig\fP * isysconfig = 0, bool autoload = true, char encoding = ENC_UTF8, char markup = FMT_THML)"
+.PP
+Constructor of SWMarkupMgr.
+.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.
+.TP
+\fB\fImarkup\fP\fP
+The desired markup format.
+.SH "MEMBER FUNCTION DOCUMENTATION"
+.PP
+.SS "virtual void SWMarkupMgr::AddRenderFilters (\fBSWModule\fP * module, ConfigEntMap & section)\fC [virtual]\fP"
+.PP
+Adds the render 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 render 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
+.PP
+Reimplemented from \fBSWMgr\fP.
+.SS "char SWMarkupMgr::Markup (char m = FMT_UNKNOWN)"
+.PP
+Markup sets/gets the markup after initialization.
+.PP
+Parameters:
+.in +1c
+.TP
+\fB\fIm\fP\fP
+The new markup or FMT_UNKNOWN if you just want to get the current markup.
+.PP
+\fBReturns: \fP
+.in +1c
+The current (possibly changed) markup format.
+
+.SH "AUTHOR"
+.PP
+Generated automatically by Doxygen for The Sword Project from the source code. \ No newline at end of file