diff options
Diffstat (limited to 'doc/api-documentation/man/man3/SWText.3')
-rw-r--r-- | doc/api-documentation/man/man3/SWText.3 | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/SWText.3 b/doc/api-documentation/man/man3/SWText.3 new file mode 100644 index 0000000..60fc4af --- /dev/null +++ b/doc/api-documentation/man/man3/SWText.3 @@ -0,0 +1,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.
\ No newline at end of file |