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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>SWMgr class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.6 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center>
<hr><h1>SWMgr Class Reference</h1>The main class of Sword to handle all other things.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="swmgr_h-source.html">swmgr.h</a>></code>
<p>
<a href="class_swmgr-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_swmgr.html#a0">SWMgr</a> (<a class="el" href="class_swconfig.html">SWConfig</a> *iconfig=0, <a class="el" href="class_swconfig.html">SWConfig</a> *isysconfig=0, bool autoload=true)</td></tr>
<tr><td> </td><td><font size=-1><em>Constructor of SWMgr.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWMgr::SWMgr"></a>
</td><td valign=bottom><b>SWMgr</b> (const char *iConfigPath, bool autoload=true)</td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_swmgr.html#a2">~SWMgr</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>The destructor of SWMgr.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#a3">InstallScan</a> (const char *dir)</td></tr>
<tr><td> </td><td><font size=-1><em>Installs a scan for modules in the directory givan as parameter.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#a4">Load</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Load the modules.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#a5">setGlobalOption</a> (const char *option, const char *value)</td></tr>
<tr><td> </td><td><font size=-1><em>Set a global option Set a global option using the parameters.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swmgr.html#a6">getGlobalOption</a> (const char *option)</td></tr>
<tr><td> </td><td><font size=-1><em>Gives the value of the given option.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual const char* </td><td valign=bottom><a class="el" href="class_swmgr.html#a7">getGlobalOptionTip</a> (const char *option)</td></tr>
<tr><td> </td><td><font size=-1><em>Gives a description for the given option.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual OptionsList </td><td valign=bottom><a class="el" href="class_swmgr.html#a8">getGlobalOptions</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>A list of all availble options with the currently set values.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="SWMgr::getGlobalOptionValues"></a>
virtual OptionsList </td><td valign=bottom><b>getGlobalOptionValues</b> (const char *option)</td></tr>
<tr><td nowrap align=right valign=top>virtual char </td><td valign=bottom><a class="el" href="class_swmgr.html#a10">setCipherKey</a> (const char *modName, const char *key)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the cipher key for the given module.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>const float </td><td valign=bottom><a class="el" href="class_swmgr.html#a11">Version</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Get the Sword version.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_swconfig.html">SWConfig</a>* </td><td valign=bottom><a class="el" href="class_swmgr.html#m0">config</a></td></tr>
<tr><td> </td><td><font size=-1><em>The global config object.</em> <a href="#m0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m1" doxytag="SWMgr::sysconfig"></a>
<a class="el" href="class_swconfig.html">SWConfig</a>* </td><td valign=bottom><b>sysconfig</b></td></tr>
<tr><td nowrap align=right valign=top><a name="m2" doxytag="SWMgr::Modules"></a>
ModMap </td><td valign=bottom><a class="el" href="class_swmgr.html#m2">Modules</a></td></tr>
<tr><td> </td><td><font size=-1><em>A map of all modules This map contains the list of installed modules we use.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m3" doxytag="SWMgr::prefixPath"></a>
char* </td><td valign=bottom><a class="el" href="class_swmgr.html#m3">prefixPath</a></td></tr>
<tr><td> </td><td><font size=-1><em>The path to your Sword directory.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="m4" doxytag="SWMgr::configPath"></a>
char* </td><td valign=bottom><b>configPath</b></td></tr>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="d0" doxytag="SWMgr::findConfig"></a>
void </td><td valign=bottom><b>findConfig</b> (char *configType, char **<a class="el" href="class_swmgr.html#m3">prefixPath</a>, char **configPath)</td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="p0" doxytag="SWMgr::debug"></a>
bool </td><td valign=bottom><a class="el" href="class_swmgr.html#p0">debug</a></td></tr>
<tr><td> </td><td><font size=-1><em>Enable / Disable debug output Set this static bool to true to get more verbose debug messages from SWMgr.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="b0" doxytag="SWMgr::CreateMods"></a>
void </td><td valign=bottom><b>CreateMods</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="b1" doxytag="SWMgr::CreateMod"></a>
<a class="el" href="class_swmodule.html">SWModule</a>* </td><td valign=bottom><b>CreateMod</b> (string name, string driver, ConfigEntMap &section)</td></tr>
<tr><td nowrap align=right valign=top><a name="b2" doxytag="SWMgr::DeleteMods"></a>
void </td><td valign=bottom><b>DeleteMods</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="b3" doxytag="SWMgr::init"></a>
virtual void </td><td valign=bottom><b>init</b> ()</td></tr>
<tr><td nowrap align=right valign=top><a name="b4" doxytag="SWMgr::AddModToConfig"></a>
virtual char </td><td valign=bottom><b>AddModToConfig</b> (int conffd, const char *fname)</td></tr>
<tr><td nowrap align=right valign=top><a name="b5" doxytag="SWMgr::loadConfigDir"></a>
virtual void </td><td valign=bottom><b>loadConfigDir</b> (const char *ipath)</td></tr>
<tr><td nowrap align=right valign=top><a name="b6" doxytag="SWMgr::AddGlobalOptions"></a>
virtual void </td><td valign=bottom><b>AddGlobalOptions</b> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)</td></tr>
<tr><td nowrap align=right valign=top><a name="b7" doxytag="SWMgr::AddLocalOptions"></a>
virtual void </td><td valign=bottom><b>AddLocalOptions</b> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section, ConfigEntMap::iterator start, ConfigEntMap::iterator end)</td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#b8">AddRenderFilters</a> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section)</td></tr>
<tr><td> </td><td><font size=-1><em>Adds the render filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module".</em> <a href="#b8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#b9">AddStripFilters</a> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section)</td></tr>
<tr><td> </td><td><font size=-1><em>Adds the strip filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module".</em> <a href="#b9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="class_swmgr.html#b10">AddRawFilters</a> (<a class="el" href="class_swmodule.html">SWModule</a> *module, ConfigEntMap &section)</td></tr>
<tr><td> </td><td><font size=-1><em>Adds the raw filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module".</em> <a href="#b10">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="n0" doxytag="SWMgr::myconfig"></a>
<a class="el" href="class_swconfig.html">SWConfig</a>* </td><td valign=bottom><b>myconfig</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="SWMgr::mysysconfig"></a>
<a class="el" href="class_swconfig.html">SWConfig</a>* </td><td valign=bottom><b>mysysconfig</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n2" doxytag="SWMgr::configType"></a>
char </td><td valign=bottom><b>configType</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n3" doxytag="SWMgr::optionFilters"></a>
FilterMap </td><td valign=bottom><b>optionFilters</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n4" doxytag="SWMgr::cipherFilters"></a>
FilterMap </td><td valign=bottom><b>cipherFilters</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n5" doxytag="SWMgr::gbfplain"></a>
<a class="el" href="class_swfilter.html">SWFilter</a>* </td><td valign=bottom><b>gbfplain</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n6" doxytag="SWMgr::thmlplain"></a>
<a class="el" href="class_swfilter.html">SWFilter</a>* </td><td valign=bottom><b>thmlplain</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n7" doxytag="SWMgr::cleanupFilters"></a>
FilterList </td><td valign=bottom><b>cleanupFilters</b></td></tr>
<tr><td nowrap align=right valign=top><a name="n8" doxytag="SWMgr::options"></a>
OptionsList </td><td valign=bottom><b>options</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The main class of Sword to handle all other things.
<p>
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).
<p>
<dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="class_swmgr.html#b10">AddRawFilters</a>(), <a class="el" href="class_swmgr.html#b8">AddRenderFilters</a>(), <a class="el" href="class_swmgr.html#b9">AddStripFilters</a>() </dl><dl compact><dt>
<b>Version: </b><dd>
</dl><dl compact><dt>
<b>Id: </b><dd>
swmgr.h,v 1.27 2001/10/05 20:37:00 mgruner Exp </dl>
<p>
<p>
Definition at line <a class="el" href="swmgr_h-source.html#l00063">63</a> of file <a class="el" href="swmgr_h-source.html">swmgr.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="SWMgr::SWMgr"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
SWMgr::SWMgr (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_swconfig.html">SWConfig</a> * <em>iconfig</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="class_swconfig.html">SWConfig</a> * <em>isysconfig</em> = 0,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>autoload</em> = true )
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor of SWMgr.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>iconfig</em>
</td><td>
</td></tr>
<tr><td valign=top><em>isysconfig</em>
</td><td>
</td></tr>
<tr><td valign=top><em>autoload</em>
</td><td>
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. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="SWMgr::~SWMgr"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
SWMgr::~SWMgr (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The destructor of SWMgr.
<p>
This destrutcot cleans up the modules and deletes the created object. Destroy the SWMgr at last in your application. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b10" doxytag="SWMgr::AddRawFilters"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void SWMgr::AddRawFilters (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_swmodule.html">SWModule</a> * <em>module</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
ConfigEntMap & <em>section</em> )<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Adds the raw filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module".
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>module</em>
</td><td>
To this module the raw filter(s) are added </td></tr>
<tr><td valign=top><em>section</em>
</td><td>
We use this section to get a list of filters we should apply to the module </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b8" doxytag="SWMgr::AddRenderFilters"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void SWMgr::AddRenderFilters (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_swmodule.html">SWModule</a> * <em>module</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
ConfigEntMap & <em>section</em> )<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Adds the render filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module".
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>module</em>
</td><td>
To this module the render filter(s) are added </td></tr>
<tr><td valign=top><em>section</em>
</td><td>
We use this section to get a list of filters we should apply to the module </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b9" doxytag="SWMgr::AddStripFilters"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void SWMgr::AddStripFilters (
</b></td>
<td valign="bottom"><b>
<a class="el" href="class_swmodule.html">SWModule</a> * <em>module</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
ConfigEntMap & <em>section</em> )<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Adds the strip filters which are defined in "section" to the <a class="el" href="class_swmodule.html">SWModule</a> object "module".
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>module</em>
</td><td>
To this module the strip filter(s) are added </td></tr>
<tr><td valign=top><em>section</em>
</td><td>
We use this section to get a list of filters we should apply to the module </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a3" doxytag="SWMgr::InstallScan"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void SWMgr::InstallScan (
</b></td>
<td valign="bottom"><b>
const char * <em>dir</em> )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Installs a scan for modules in the directory givan as parameter.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>dir</em>
</td><td>
The directory where new modules should be searched. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="SWMgr::Load"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void SWMgr::Load (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Load the modules.
<p>
Reimplement this function to use your own Load function, for example to use your own filters. </td>
</tr>
</table>
<a name="a11" doxytag="SWMgr::Version"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const float SWMgr::Version (
</b></td>
<td valign="bottom"><b>
) const<code> [inline]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the Sword version.
<p>
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. <dl compact><dt>
<b>Returns: </b><dd>
The version of the Sword library as a float (e.g. 1.52). </dl>
<p>
Definition at line <a class="el" href="swmgr_h-source.html#l00239">239</a> of file <a class="el" href="swmgr_h-source.html">swmgr.h</a>. </td>
</tr>
</table>
<a name="a6" doxytag="SWMgr::getGlobalOption"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const char * SWMgr::getGlobalOption (
</b></td>
<td valign="bottom"><b>
const char * <em>option</em> )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gives the value of the given option.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>The</em>
</td><td>
option, which should be used to return the value of it </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
The value of the given option </dl> </td>
</tr>
</table>
<a name="a7" doxytag="SWMgr::getGlobalOptionTip"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const char * SWMgr::getGlobalOptionTip (
</b></td>
<td valign="bottom"><b>
const char * <em>option</em> )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Gives a description for the given option.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>option</em>
</td><td>
The option, which should be used </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
A description of the given option </dl><dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="class_swmgr.html#a5">setGlobalOption</a>, <a class="el" href="class_swmgr.html#a6">getGlobalOption</a>, <a class="el" href="class_swmgr.html#a8">getGlobalOptions</a> </dl> </td>
</tr>
</table>
<a name="a8" doxytag="SWMgr::getGlobalOptions"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
OptionsList SWMgr::getGlobalOptions (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
A list of all availble options with the currently set values.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
This function returns a list of global options. </dl> </td>
</tr>
</table>
<a name="a10" doxytag="SWMgr::setCipherKey"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
char SWMgr::setCipherKey (
</b></td>
<td valign="bottom"><b>
const char * <em>modName</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>key</em> )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Sets the cipher key for the given module.
<p>
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:
<p>
<div class="fragment"><pre> SectionMap::iterator section;
ConfigEntMap::iterator entry;
DIR *dir = opendir(configPath);
<font class="keyword">struct </font>dirent *ent;
<font class="keywordtype">char</font>* modFile;
<font class="keywordflow">if</font> (dir) { <font class="comment">// find and update .conf file</font>
rewinddir(dir);
<font class="keywordflow">while</font> ((ent = readdir(dir)))
{
<font class="keywordflow">if</font> ((strcmp(ent->d_name, <font class="stringliteral">"."</font>)) && (strcmp(ent->d_name, <font class="stringliteral">".."</font>)))
{
modFile = m_backend->configPath;
modFile += <font class="stringliteral">"/"</font>;
modFile += ent->d_name;
<a class="code" href="class_swconfig.html">SWConfig</a> *myConfig = <font class="keyword">new</font> SWConfig( modFile );
section = myConfig->Sections.find( m_module->Name() );
<font class="keywordflow">if</font> ( section != myConfig->Sections.end() )
{
entry = section->second.find(<font class="stringliteral">"CipherKey"</font>);
<font class="keywordflow">if</font> (entry != section->second.end())
{
entry->second = unlockKey;<font class="comment">//set cipher key</font>
myConfig-><a class="code" href="class_swconfig.html#a3">Save</a>();<font class="comment">//save config file</font>
}
}
<font class="keyword">delete</font> myConfig;
}
}
}
closedir(dir);</pre></div><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>modName</em>
</td><td>
For this module we change the unlockKey </td></tr>
</table>
</dl><dl compact><dt>
<b>an key This is the new unlck key we use for te module.</b><dd>
</dl> </td>
</tr>
</table>
<a name="a5" doxytag="SWMgr::setGlobalOption"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void SWMgr::setGlobalOption (
</b></td>
<td valign="bottom"><b>
const char * <em>option</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>value</em> )<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set a global option Set a global option using the parameters.
<p>
A global option could be for example footnotes. <dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>option</em>
</td><td>
The name of the option, for which you want to change the value. Well known and often used values are "Footnotes" or "Strongs" </td></tr>
<tr><td valign=top><em>value</em>
</td><td>
The value. Common values are "On" and "Off" </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="m0" doxytag="SWMgr::config"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="class_swconfig.html">SWConfig</a> * SWMgr::config
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The global config object.
<p>
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().
<p>
Definition at line <a class="el" href="swmgr_h-source.html#l00122">122</a> of file <a class="el" href="swmgr_h-source.html">swmgr.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="swmgr_h-source.html">swmgr.h</a></ul>
<hr><address><small>Generated at Fri Oct 5 22:45:37 2001 for The Sword Project by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
|
