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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>SWCom class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.9.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </center>
<hr><h1>SWCom Class Reference</h1>The basis for all commentary modules.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="swcom_8h-source.html">swcom.h</a>></code>
<p>
<p>Inheritance diagram for SWCom::
<p><center><img src="class_s_w_com.gif" usemap="#SWCom_map" border="0"></center>
<map name="SWCom_map">
<area href="class_s_w_module.html" alt="SWModule" shape="rect" coords="0,0,73,24">
</map>
<a href="class_s_w_com-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_s_w_com.html#a0">SWCom</a> (const char *imodname=0, const char *imoddesc=0, <a class="el" href="class_s_w_display.html">SWDisplay</a> *idisp=0, SWTextEncoding enc=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup mark=FMT_UNKNOWN, const char *ilang=0)</td></tr>
<tr><td> </td><td><font size=-1><em>Initializes data for instance of SWCom.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="SWCom::~SWCom"></a>
virtual </td><td valign=bottom><b>~SWCom</b> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual <a class="el" href="class_s_w_key.html">SWKey</a> * </td><td valign=bottom><a class="el" href="class_s_w_com.html#a2">CreateKey</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Allocates a key of specific type for module The different reimplementatiosn of <a class="el" href="class_s_w_module.html">SWModule</a> (e.g.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The basis for all commentary modules.
<p>
<p>
Definition at line <a class="el" href="swcom_8h-source.html#l00033">33</a> of file <a class="el" href="swcom_8h-source.html">swcom.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="SWCom::SWCom"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">
SWCom::SWCom
</td>
<td class="md">( </td>
<td class="md">const char * </td>
<td class="mdname"> <em>imodname</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"> <tr>
<td></td>
<td></td>
<td class="md">const char * </td>
<td class="mdname"> <em>imoddesc</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"> <tr>
<td></td>
<td></td>
<td class="md"><a class="el" href="class_s_w_display.html">SWDisplay</a> * </td>
<td class="mdname"> <em>idisp</em> = 0, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"> <tr>
<td></td>
<td></td>
<td class="md">SWTextEncoding </td>
<td class="mdname"> <em>enc</em> = ENC_UNKNOWN, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"> <tr>
<td></td>
<td></td>
<td class="md">SWTextDirection </td>
<td class="mdname"> <em>dir</em> = DIRECTION_LTR, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"> <tr>
<td></td>
<td></td>
<td class="md">SWTextMarkup </td>
<td class="mdname"> <em>mark</em> = FMT_UNKNOWN, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"> <tr>
<td></td>
<td></td>
<td class="md">const char * </td>
<td class="mdname"> <em>ilang</em> = 0 </td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Initializes data for instance of SWCom.
<p>
<dl compact><dt>
Parameters: <dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>imodname
</em> </td><td>
Internal name for module </td></tr>
<tr><td valign=top><em>imoddesc
</em> </td><td>
Name to display to user for module </td></tr>
<tr><td valign=top><em>idisp
</em> </td><td>
Display object to use for displaying </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="SWCom::CreateKey"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">
virtual <a class="el" href="class_s_w_key.html">SWKey</a>* SWCom::CreateKey
</td>
<td class="md">( </td>
<td class="mdname"> </td>
<td class="md">) </td>
<td class="md"><code> [inline, virtual]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Allocates a key of specific type for module The different reimplementatiosn of <a class="el" href="class_s_w_module.html">SWModule</a> (e.g.
<p>
<a class="el" href="class_s_w_text.html">SWText</a>) support <a class="el" href="class_s_w_key.html">SWKey</a> implementations, which support special. This functions returns a <a class="el" href="class_s_w_key.html">SWKey</a> object which works with the current implementation of <a class="el" href="class_s_w_module.html">SWModule</a>. For example for the <a class="el" href="class_s_w_text.html">SWText</a> class it returns a <a class="el" href="class_verse_key.html">VerseKey</a> object. <dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="class_verse_key.html">VerseKey</a>, <a class="el" href="class_list_key.html">ListKey</a>, <a class="el" href="class_s_w_text.html">SWText</a>, <a class="el" href="class_s_w_l_d.html">SWLD</a>, SWCom </dl><dl compact><dt>
<b>Returns: </b><dd>
pointer to allocated key </dl>
<p>
Reimplemented from <a class="el" href="class_s_w_module.html#a23">SWModule</a>.
<p>
Definition at line <a class="el" href="swcom_8h-source.html#l00044">44</a> of file <a class="el" href="swcom_8h-source.html">swcom.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="swcom_8h-source.html">swcom.h</a></ul>
<hr><address><small>Generated at Tue Jan 22 14:52:49 2002 for The Sword Project by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
|
