source: trunk/doc/html/qsqldriverplugin.html@ 203

Last change on this file since 203 was 190, checked in by rudi, 14 years ago

reference documentation added

File size: 4.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/sql/qsqldriverplugin.cpp:45 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>QSqlDriverPlugin Class</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QSqlDriverPlugin Class Reference</h1>
33
34<p>The QSqlDriverPlugin class provides an abstract base for custom QSqlDriver plugins.
35<a href="#details">More...</a>
36<p><tt>#include &lt;<a href="qsqldriverplugin-h.html">qsqldriverplugin.h</a>&gt;</tt>
37<p><a href="qsqldriverplugin-members.html">List of all member functions.</a>
38<h2>Public Members</h2>
39<ul>
40<li class=fn><a href="#QSqlDriverPlugin"><b>QSqlDriverPlugin</b></a> ()</li>
41<li class=fn><a href="#~QSqlDriverPlugin"><b>~QSqlDriverPlugin</b></a> ()</li>
42<li class=fn>virtual QStringList <a href="#keys"><b>keys</b></a> () const = 0</li>
43<li class=fn>virtual QSqlDriver * <a href="#create"><b>create</b></a> ( const&nbsp;QString&nbsp;&amp;&nbsp;key ) = 0</li>
44</ul>
45<hr><a name="details"></a><h2>Detailed Description</h2>
46
47
48The QSqlDriverPlugin class provides an abstract base for custom <a href="qsqldriver.html">QSqlDriver</a> plugins.
49<p>
50
51<p> The SQL driver plugin is a simple plugin interface that makes it
52easy to create your own SQL driver plugins that can be loaded
53dynamically by Qt.
54<p> Writing a SQL plugin is achieved by subclassing this base class,
55reimplementing the pure virtual functions <a href="#keys">keys</a>() and <a href="#create">create</a>(), and
56exporting the class with the <tt>Q_EXPORT_PLUGIN</tt> macro. See the SQL
57plugins that come with Qt for example implementations (in the
58<tt>plugins/src/sqldrivers</tt> subdirectory of the source
59distribution). Read the <a href="plugins-howto.html">plugins
60 documentation</a> for more information on plugins.
61<p>See also <a href="plugins.html">Plugins</a>.
62
63<hr><h2>Member Function Documentation</h2>
64<h3 class=fn><a name="QSqlDriverPlugin"></a>QSqlDriverPlugin::QSqlDriverPlugin ()
65</h3>
66Constructs a SQL driver plugin. This is invoked automatically by
67the <tt>Q_EXPORT_PLUGIN</tt> macro.
68
69<h3 class=fn><a name="~QSqlDriverPlugin"></a>QSqlDriverPlugin::~QSqlDriverPlugin ()
70</h3>
71Destroys the SQL driver plugin.
72<p> You never have to call this explicitly. Qt destroys a plugin
73automatically when it is no longer used.
74
75<h3 class=fn><a href="qsqldriver.html">QSqlDriver</a>&nbsp;* <a name="create"></a>QSqlDriverPlugin::create ( const&nbsp;<a href="qstring.html">QString</a>&nbsp;&amp;&nbsp;key )<tt> [pure virtual]</tt>
76</h3>
77
78<p> Creates and returns a <a href="qsqldriver.html">QSqlDriver</a> object for the driver key <em>key</em>.
79The driver key is usually the class name of the required driver.
80<p> <p>See also <a href="#keys">keys</a>().
81
82<h3 class=fn><a href="qstringlist.html">QStringList</a> <a name="keys"></a>QSqlDriverPlugin::keys () const<tt> [pure virtual]</tt>
83</h3>
84
85<p> Returns the list of drivers (keys) this plugin supports.
86<p> These keys are usually the class names of the custom drivers that
87are implemented in the plugin.
88<p> <p>See also <a href="#create">create</a>().
89
90<!-- eof -->
91<hr><p>
92This file is part of the <a href="index.html">Qt toolkit</a>.
93Copyright &copy; 1995-2007
94<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
95<table width=100% cellspacing=0 border=0><tr>
96<td>Copyright &copy; 2007
97<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
98<td align=right><div align=right>Qt 3.3.8</div>
99</table></div></address></body>
100</html>
Note: See TracBrowser for help on using the repository browser.