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
|
.TH "SWText" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SWText \- The basis for all text modules.
.SH SYNOPSIS
.br
.PP
\fC#include <swtext.h>\fP
.PP
Inherits \fBSWModule\fP.
.PP
Inherited by EchoMod, RawGBF, RawText, and zText.
.PP
.SS "Public Methods"
.in +1c
.ti -1c
.RI "\fBSWText\fP (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fP *idisp=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *ilang=0)"
.br
.RI "\fIInitializes data for instance of SWText.\fP"
.ti -1c
.RI "virtual \fB~SWText\fP ()"
.br
.ti -1c
.RI "virtual \fBSWKey\fP * \fBCreateKey\fP ()"
.br
.RI "\fICreate the correct key (\fBVerseKey\fP) for use with SWText.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP
The basis for all text modules.
.PP
Definition at line 34 of file swtext.h.
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP
.SS "SWText::SWText (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fP * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char * ilang = 0)"
.PP
Initializes data for instance of SWText.
.PP
Parameters:
.in +1c
.TP
\fB\fIimodname\fP\fP
Internal name for module
.TP
\fB\fIimoddesc\fP\fP
Name to display to user for module
.TP
\fB\fIidisp\fP\fP
Display object to use for displaying
.SH "AUTHOR"
.PP
Generated automatically by Doxygen for The Sword Project from the source code.
|