diff options
Diffstat (limited to 'doc/api-documentation/man/man3/SWCom.3')
-rw-r--r-- | doc/api-documentation/man/man3/SWCom.3 | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/SWCom.3 b/doc/api-documentation/man/man3/SWCom.3 new file mode 100644 index 0000000..8362a5e --- /dev/null +++ b/doc/api-documentation/man/man3/SWCom.3 @@ -0,0 +1,74 @@ +.TH "SWCom" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWCom \- The basis for all commentary modules. +.SH SYNOPSIS +.br +.PP +\fC#include <swcom.h>\fP +.PP +Inherits \fBSWModule\fP. +.PP +Inherited by HREFCom, RawCom, RawFiles, and zCom. +.PP +.SS "Public Methods" + +.in +1c +.ti -1c +.RI "\fBSWCom\fP (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fP *idisp=0, SWTextEncoding enc=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup mark=FMT_UNKNOWN, const char *ilang=0)" +.br +.RI "\fIInitializes data for instance of SWCom.\fP" +.ti -1c +.RI "virtual \fB~SWCom\fP ()" +.br +.ti -1c +.RI "virtual \fBSWKey\fP * \fBCreateKey\fP ()" +.br +.RI "\fIAllocates a key of specific type for module The different reimplementatiosn of \fBSWModule\fP (e.g.\fP" +.in -1c +.SH "DETAILED DESCRIPTION" +.PP +The basis for all commentary modules. +.PP +Definition at line 33 of file swcom.h. +.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION" +.PP +.SS "SWCom::SWCom (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fP * idisp = 0, SWTextEncoding enc = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup mark = FMT_UNKNOWN, const char * ilang = 0)" +.PP +Initializes data for instance of SWCom. +.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 "MEMBER FUNCTION DOCUMENTATION" +.PP +.SS "virtual \fBSWKey\fP* SWCom::CreateKey ()\fC [inline, virtual]\fP" +.PP +Allocates a key of specific type for module The different reimplementatiosn of \fBSWModule\fP (e.g. +.PP +\fBSWText\fP) support \fBSWKey\fP implementations, which support special. This functions returns a \fBSWKey\fP object which works with the current implementation of \fBSWModule\fP. For example for the \fBSWText\fP class it returns a \fBVerseKey\fP object. +.PP +\fBSee also: \fP +.in +1c +\fBVerseKey\fP, \fBListKey\fP, \fBSWText\fP, \fBSWLD\fP, SWCom +.PP +\fBReturns: \fP +.in +1c +pointer to allocated key +.PP +Reimplemented from \fBSWModule\fP. +.PP +Definition at line 44 of file swcom.h. + +.SH "AUTHOR" +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |