summaryrefslogtreecommitdiff
path: root/doc/api-documentation/man/man3/EncodingFilterMgr.3
blob: 2c14a9066664c60d98a0b7ab80a3352353bc4fde (plain)
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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.