diff options
Diffstat (limited to 'doc/api-documentation/man/man3/swld.3')
-rw-r--r-- | doc/api-documentation/man/man3/swld.3 | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/swld.3 b/doc/api-documentation/man/man3/swld.3 new file mode 100644 index 0000000..f3322e6 --- /dev/null +++ b/doc/api-documentation/man/man3/swld.3 @@ -0,0 +1,94 @@ +.TH "SWLD" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*- +.ad l +.nh +.SH NAME +SWLD \- the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +.SH SYNOPSIS +.br +.PP +\fC#include <swld.h>\fR +.PP +Inherits \fBSWModule\fR. +.PP +Inherited by RawLD, and RawLD4. +.PP +.SS Public Methods + +.in +1c +.ti -1c +.RI "\fBSWLD\fR (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fR *idisp=0, bool unicode=false)" +.br +.RI "\fIInitializes data for instance of SWLD.\fR" +.ti -1c +.RI "virtual \fB~SWLD\fR ()" +.br +.ti -1c +.RI "virtual \fBSWKey\fR* \fBCreateKey\fR ()" +.br +.RI "\fIAllocates a key of specific type for module.\fR" +.ti -1c +.RI "virtual const char* \fBKeyText\fR (const char *ikeytext)" +.br +.RI "\fISets/gets module KeyText, getting from saved text if key is persistent.\fR" +.in -1c +.SS Protected Attributes + +.in +1c +.ti -1c +.RI "char* \fBentkeytxt\fR" +.br +.in -1c +.SH DETAILED DESCRIPTION +.PP +the basis for all types of Lexicon and Dictionary modules (hence the 'LD'). +.PP +Definition at line 34 of file swld.h. +.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION +.PP +.SS SWLD::SWLD (const char * imodname = 0, const char * imoddesc = 0, \fBSWDisplay\fR * idisp = 0, bool unicode = false) +.PP +Initializes data for instance of SWLD. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIimodname\fR\fR +Internal name for module +.TP +\fB\fIimoddesc\fR\fR +Name to display to user for module +.TP +\fB\fIidisp\fR\fR +Display object to use for displaying +.SH MEMBER FUNCTION DOCUMENTATION +.PP +.SS \fBSWKey\fR * SWLD::CreateKey ()\fC [inline, virtual]\fR +.PP +Allocates a key of specific type for module. +.PP +\fBReturns: \fR +.in +1c +pointer to allocated key +.PP +Reimplemented from \fBSWModule\fR. +.PP +Definition at line 47 of file swld.h. +.SS const char * SWLD::KeyText (const char * ikeytext)\fC [virtual]\fR +.PP +Sets/gets module KeyText, getting from saved text if key is persistent. +.PP +\fBParameters: \fR +.in +1c +.TP +\fB\fIikeytext\fR\fR +value which to set keytext; [0] - only get +.PP +\fBReturns: \fR +.in +1c +pointer to keytext +.PP +Reimplemented from \fBSWModule\fR. + +.SH AUTHOR +.PP +Generated automatically by Doxygen for The Sword Project from the source code.
\ No newline at end of file |