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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<HTML>
<HEAD>
<TITLE>class toConnectionProvider</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class toConnectionProvider</h1>
</TD>
<TD valign="top" align="right" colspan="1"> This class is used to implement new database providers. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH colspan="2">Contains pure virtuals</TH></TR><TR><TH>Definition</TH><TD><code>#include <<A HREF="toconnection_h.html">toconnection.h</A>></code></TD></TR>
<TR><TH><A HREF="full-list-toConnectionProvider.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI> <b><A HREF="#ref8">toConnectionProvider</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,bool add=true)
</LI>
<LI>virtual <b><A HREF="#ref9">~toConnectionProvider</A></b> ()
</LI>
<LI>virtual <A HREF="toConnection__connectionImpl.html">toConnection::connectionImpl</A> * <b><i><A HREF="#ref10">provideConnection</A></i></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,
<A HREF="toConnection.html">toConnection</A> *conn)
</LI>
<LI>virtual std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <b><A HREF="#ref11">providedHosts</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
</LI>
<LI>virtual std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <b><i><A HREF="#ref12">providedDatabases</A></i></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,
const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &host,
const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &user,
const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &pwd)
</LI>
<LI>virtual void <b><A HREF="#ref13">initialize</A></b> (void)
</LI>
<LI>virtual std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <b><A HREF="#ref14">providedOptions</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
</LI>
<LI>virtual <A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> * <b><A HREF="#ref15">providerConfigurationTab</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent)
</LI>
<LI>const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> & <b><A HREF="#ref22">config</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &def)
</LI>
<LI>void <b><A HREF="#ref23">setConfig</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &value)
</LI>
</ul><h4>Public Static Methods</h4><ul><LI>static <A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> * <b><A HREF="#ref16">configurationTab</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent)
</LI>
<LI>static std::list<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>> <b><A HREF="#ref17">providers</A></b> ()
</LI>
<LI>static std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <b><A HREF="#ref18">options</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
</LI>
<LI>static <A HREF="toConnection__connectionImpl.html">toConnection::connectionImpl</A> * <b><A HREF="#ref19">connection</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,<A HREF="toConnection.html">toConnection</A> *conn)
</LI>
<LI>static std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <b><A HREF="#ref20">hosts</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
</LI>
<LI>static std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <b><A HREF="#ref21">databases</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &host,
const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &user,const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &pwd)
</LI>
<LI>static void <b><A HREF="#ref24">initializeAll</A></b> (void)
</LI>
</ul><h4>Protected Methods</h4><ul><LI>void <b><A HREF="#ref6">addProvider</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
</LI>
<LI>void <b><A HREF="#ref7">removeProvider</A></b> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p> This class is used to implement new database providers.
</p>
<A NAME="addProvider"></A><A NAME="ref6"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>addProvider</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
<br></td><td align="right"><h3><strong>addProvider</strong></h3></td></tr></table><p> <small>[protected]</small></p><p> Add a provider to the list that this provider can handle.
</p>
<A NAME="removeProvider"></A><A NAME="ref7"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>removeProvider</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
<br></td><td align="right"><h3><strong>removeProvider</strong></h3></td></tr></table><p> <small>[protected]</small></p><p> Remove a provider from the list that this provider can handle.
</p>
<A NAME="toConnectionProvider"></A><A NAME="ref8"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>toConnectionProvider</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,bool add=true)
<br></td><td align="right"><h3><strong>toConnectionProvider</strong></h3></td></tr></table><p></p><p> Create a new provider with the specified name.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>provider</i></TD><TD align="left" valign="top">Name of the provider.
</TD></TR>
</TABLE></P>
<A NAME="~toConnectionProvider"></A><A NAME="ref9"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <strong>~toConnectionProvider</strong> ()
<br></td><td align="right"><h3><strong>~toConnectionProvider</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p> Destructor.
</p>
<A NAME="provideConnection"></A><A NAME="ref10"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="toConnection__connectionImpl.html">toConnection::connectionImpl</A> * <i><strong>provideConnection</strong></i> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,
<A HREF="toConnection.html">toConnection</A> *conn)
<br></td><td align="right"><h3><i><strong>provideConnection</strong></i></h3></td></tr></table><p> <small>[pure virtual]</small></p><p> Create an implementation of a connection to this database.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>provider</i></TD><TD align="left" valign="top">Provider to use for connection.
</TD></TR>
<TR><TD align="left" valign="top"><i>conn</i></TD><TD align="left" valign="top">The connection object to use the created connection.
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: A connection implementation created with new.
</p>
<A NAME="providedHosts"></A><A NAME="ref11"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <strong>providedHosts</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
<br></td><td align="right"><h3><strong>providedHosts</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p> List the available hosts this database provider knows about.
</p>
<p><b>Returns</b>: A list of hosts.
</p>
<A NAME="providedDatabases"></A><A NAME="ref12"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <i><strong>providedDatabases</strong></i> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,
const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &host,
const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &user,
const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &pwd)
<br></td><td align="right"><h3><i><strong>providedDatabases</strong></i></h3></td></tr></table><p> <small>[pure virtual]</small></p><p> List the available databases this provider knows about for a given host.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>host</i></TD><TD align="left" valign="top">Host to return connections for.
</TD></TR>
<TR><TD align="left" valign="top"><i>user</i></TD><TD align="left" valign="top">That might be needed.
</TD></TR>
<TR><TD align="left" valign="top"><i>password</i></TD><TD align="left" valign="top">That might be needed.
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: A list of databases available for a given host.
</p>
<A NAME="initialize"></A><A NAME="ref13"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>initialize</strong> (void)
<br></td><td align="right"><h3><strong>initialize</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p> Will be called after program has been started and before connections have been opened.
Use for initialization.
</p>
<A NAME="providedOptions"></A><A NAME="ref14"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <strong>providedOptions</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
<br></td><td align="right"><h3><strong>providedOptions</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p> Get a list of options available for the connection. An option with the name
"-" indicates a break should be made to separate the rest of the options from the previous
options. An option preceeded by "*" means selected by default. The * shoul be stripped before
before passing it to the connection call.
</p>
<A NAME="providerConfigurationTab"></A><A NAME="ref15"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> * <strong>providerConfigurationTab</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent)
<br></td><td align="right"><h3><strong>providerConfigurationTab</strong></h3></td></tr></table><p> <small>[virtual]</small></p><p>
Create and return configuration tab for this connectiontype. The returned widget should also
be a childclass of <A HREF="toSettingTab.html">toSettingTab</A>.
</p>
<p></p>
<p><b>Returns</b>: A pointer to the widget containing the setup tab for this tool or NULL of
no settings are available.
</p>
<A NAME="configurationTab"></A><A NAME="ref16"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> * <strong>configurationTab</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,<A HREF="/usr/lib/qt3/doc/html/qwidget.html">QWidget</A> *parent)
<br></td><td align="right"><h3><strong>configurationTab</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get a list of names for providers.
</p>
<A NAME="providers"></A><A NAME="ref17"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<<A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A>> <strong>providers</strong> ()
<br></td><td align="right"><h3><strong>providers</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get a list of names for providers.
</p>
<A NAME="options"></A><A NAME="ref18"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <strong>options</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
<br></td><td align="right"><h3><strong>options</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get a list of options for a given provider.
</p>
<A NAME="connection"></A><A NAME="ref19"></A><table width="100%"><tr bgcolor="#eeeeee"><td> <A HREF="toConnection__connectionImpl.html">toConnection::connectionImpl</A> * <strong>connection</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,<A HREF="toConnection.html">toConnection</A> *conn)
<br></td><td align="right"><h3><strong>connection</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Implement a connection for a given provider.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>provider</i></TD><TD align="left" valign="top">Provider to implement.
</TD></TR>
<TR><TD align="left" valign="top"><i>conn</i></TD><TD align="left" valign="top">Connection to create implementation for.
</TD></TR>
</TABLE></P>
<A NAME="hosts"></A><A NAME="ref20"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <strong>hosts</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider)
<br></td><td align="right"><h3><strong>hosts</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get a list of hosts this provider knows about.
</p>
<A NAME="databases"></A><A NAME="ref21"></A><table width="100%"><tr bgcolor="#eeeeee"><td> std::list<<A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A>> <strong>databases</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &provider,const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &host,
const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &user,const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> &pwd)
<br></td><td align="right"><h3><strong>databases</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Get a list of databases for a given provider and host.
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>provider</i></TD><TD align="left" valign="top">Provider to fetch databases for.
</TD></TR>
<TR><TD align="left" valign="top"><i>host</i></TD><TD align="left" valign="top">Host to fetch databases for.
</TD></TR>
<TR><TD align="left" valign="top"><i>user</i></TD><TD align="left" valign="top">That might be needed.
</TD></TR>
<TR><TD align="left" valign="top"><i>password</i></TD><TD align="left" valign="top">That might be needed.
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: List of known databases.
</p>
<A NAME="config"></A><A NAME="ref22"></A><table width="100%"><tr bgcolor="#eeeeee"><td>const <A HREF="/usr/lib/qt3/doc/html/qstring.html">QString</A> & <strong>config</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &def)
<br></td><td align="right"><h3><strong>config</strong></h3></td></tr></table><p></p><p>
Get connection specific settings.
</p>
<p> Setting names are hierachical separated by ':' instead of '/' usually used
in filenames. As an example all settings for the tool 'Example' would be
under the 'Example:{settingname}' name. Observe that the settings are stored
under the main provider name as passed to the toConnectionProvider constructor.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>tag</i></TD><TD align="left" valign="top">The name of the configuration setting.
</TD></TR>
<TR><TD align="left" valign="top"><i>def</i></TD><TD align="left" valign="top">Contents of this setting.
</TD></TR>
</TABLE></P>
<A NAME="setConfig"></A><A NAME="ref23"></A><table width="100%"><tr bgcolor="#eeeeee"><td>void <strong>setConfig</strong> (const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &tag,const <A HREF="/usr/lib/qt3/doc/html/qcstring.html">QCString</A> &value)
<br></td><td align="right"><h3><strong>setConfig</strong></h3></td></tr></table><p></p><p>
Change connectionspecific setting. Depending on the implementation this can change the
contents on disk or not.
</p>
<p> Setting names are hierachical separated by ':' instead of '/' usually used
in filenames. As an example all settings for the tool 'Example' would be
under the 'Example:{settingname}' name. Observe that the settings are stored
under the main provider name as passed to the toConnectionProvider constructor.
</p>
<p></p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>tag</i></TD><TD align="left" valign="top">The name of the configuration setting.
</TD></TR>
<TR><TD align="left" valign="top"><i>def</i></TD><TD align="left" valign="top">Default value of the setting, if it is not available.
</TD></TR>
</TABLE></P>
<A NAME="initializeAll"></A><A NAME="ref24"></A><table width="100%"><tr bgcolor="#eeeeee"><td> void <strong>initializeAll</strong> (void)
<br></td><td align="right"><h3><strong>initializeAll</strong></h3></td></tr></table><p> <small>[static]</small></p><p> Call all initializers
</p>
<HR>
<table>
<tr><td><small>Generated by: nneul on skyhawk on Wed Feb 23 19:49:58 2005, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
