File: swtext.3

package info (click to toggle)
sword 1.5.3-3woody2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 20,484 kB
  • ctags: 11,105
  • sloc: cpp: 49,665; ansic: 13,335; sh: 8,730; pascal: 3,433; tcl: 1,602; makefile: 988; perl: 565; sed: 93
file content (55 lines) | stat: -rw-r--r-- 1,272 bytes parent folder | download
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 "5 Oct 2001" "The Sword Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SWText \- The basis for all text modules. 
.SH SYNOPSIS
.br
.PP
\fC#include <swtext.h>\fR
.PP
Inherits \fBSWModule\fR.
.PP
Inherited by EchoMod, RawGBF, RawText, and zText.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "\fBSWText\fR (const char *imodname=0, const char *imoddesc=0, \fBSWDisplay\fR *idisp=0, bool unicode=false)"
.br
.RI "\fIInitializes data for instance of SWText.\fR"
.ti -1c
.RI "virtual \fB~SWText\fR ()"
.br
.ti -1c
.RI "virtual \fBSWKey\fR* \fBCreateKey\fR ()"
.br
.RI "\fICreate the correct key (\fBVerseKey\fR) for use with SWText.\fR"
.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\fR * idisp = 0, bool unicode = false)
.PP
Initializes data for instance of SWText.
.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 AUTHOR
.PP 
Generated automatically by Doxygen for The Sword Project from the source code.