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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
.TH "GBFHeadings" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
GBFHeadings \- This Filter shows/hides headings in a GBF text.
.SH SYNOPSIS
.br
.PP
\fC#include <gbfheadings.h>\fR
.PP
Inherits \fBSWFilter\fR.
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBGBFHeadings\fR ()"
.br
.ti -1c
.RI "virtual \fB~GBFHeadings\fR ()"
.br
.ti -1c
.RI "virtual char \fBProcessText\fR (char *text, int maxlen, const \fBSWKey\fR *key)"
.br
.RI "\fIThis is the main filter function.\fR"
.ti -1c
.RI "virtual const char* \fBgetOptionName\fR ()"
.br
.RI "\fIgets the name of the option of this filter.\fR"
.ti -1c
.RI "virtual const char* \fBgetOptionTip\fR ()"
.br
.RI "\fIgets a short explanation of the option of this filter; it could be presented to the user in frontend programs.\fR"
.ti -1c
.RI "virtual void \fBsetOptionValue\fR (const char *ival)"
.br
.RI "\fIsets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.\fR"
.ti -1c
.RI "virtual const char* \fBgetOptionValue\fR ()"
.br
.ti -1c
.RI "virtual OptionsList \fBgetOptionValues\fR ()"
.br
.RI "\fIreturns a list of the possible option values might be.\fR"
.in -1c
.SS Private Attributes
.in +1c
.ti -1c
.RI "bool \fBoption\fR"
.br
.ti -1c
.RI "OptionsList \fBoptions\fR"
.br
.in -1c
.SS Static Private Attributes
.in +1c
.ti -1c
.RI "const char \fBon\fR []"
.br
.ti -1c
.RI "const char \fBoff\fR []"
.br
.ti -1c
.RI "const char \fBoptName\fR []"
.br
.ti -1c
.RI "const char \fBoptTip\fR []"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP
This Filter shows/hides headings in a GBF text.
.PP
Definition at line 30 of file gbfheadings.h.
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS virtual char GBFHeadings::ProcessText (char * text, int maxlen, const \fBSWKey\fR * key)\fC [virtual]\fR
.PP
This is the main filter function.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fItext\fR\fR
the text to be filtered/converted
.TP
\fB\fImaxlen\fR\fR
maximal length of text to be processed
.TP
\fB\fIkey\fR\fR
sorry I don't know
.PP
\fBReturns: \fR
.in +1c
0
.PP
Reimplemented from \fBSWFilter\fR.
.SS const char * GBFHeadings::getOptionName ()\fC [inline, virtual]\fR
.PP
gets the name of the option of this filter.
.PP
\fBReturns: \fR
.in +1c
option name
.PP
Reimplemented from \fBSWFilter\fR.
.PP
Definition at line 42 of file gbfheadings.h.
.SS const char * GBFHeadings::getOptionTip ()\fC [inline, virtual]\fR
.PP
gets a short explanation of the option of this filter; it could be presented to the user in frontend programs.
.PP
\fBReturns: \fR
.in +1c
option tip/explanation
.PP
Reimplemented from \fBSWFilter\fR.
.PP
Definition at line 46 of file gbfheadings.h.
.SS OptionsList GBFHeadings::getOptionValues ()\fC [inline, virtual]\fR
.PP
returns a list of the possible option values might be.
.PP
\fBReturns: \fR
.in +1c
list of option values
.PP
Reimplemented from \fBSWFilter\fR.
.PP
Definition at line 52 of file gbfheadings.h.
.SS virtual void GBFHeadings::setOptionValue (const char * ival)\fC [virtual]\fR
.PP
sets the value of the option of this filter, e.g maybe a strong's filter mioght be set to "on" / "off" - that would mean to show or not to show the strongs in the text, see also \fBgetOptionValues\fR.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIival\fR\fR
the new option valus
.PP
Reimplemented from \fBSWFilter\fR.
.SH AUTHOR
.PP
Generated automatically by Doxygen for The Sword Project from the source code.
|
