File: strkey.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 (60 lines) | stat: -rw-r--r-- 1,133 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
56
57
58
59
60
.TH "StrKey" 3 "5 Oct 2001" "The Sword Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
StrKey \- a standard string key class (used for modules that index on single strings (eg. 
.SH SYNOPSIS
.br
.PP
\fC#include <strkey.h>\fR
.PP
Inherits \fBSWKey\fR.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "\fBStrKey\fR (const char *ikey=0)"
.br
.RI "\fIinitializes instance of StrKey.\fR"
.ti -1c
.RI "virtual \fB~StrKey\fR ()"
.br
.RI "\fIcleans up instance of StrKey.\fR"
.in -1c
.SS Private Methods

.in +1c
.ti -1c
.RI "void \fBinit\fR ()"
.br
.in -1c
.SS Static Private Attributes

.in +1c
.ti -1c
.RI "\fBSWClass\fR \fBclassdef\fR"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP 
a standard string key class (used for modules that index on single strings (eg.
.PP
cities, names, words, etc.) 
.PP
Definition at line 35 of file strkey.h.
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS StrKey::StrKey (const char * ikey = 0)
.PP
initializes instance of StrKey.
.PP
\fBParameters: \fR
.in +1c
.TP
\fB\fIikey\fR\fR
text key (word, city, name, etc.) 

.SH AUTHOR
.PP 
Generated automatically by Doxygen for The Sword Project from the source code.