summaryrefslogtreecommitdiffstats
path: root/doc/man/man3/qsqldriverplugin.3qt
diff options
context:
space:
mode:
authorTimothy Pearson <[email protected]>2011-07-10 15:24:15 -0500
committerTimothy Pearson <[email protected]>2011-07-10 15:24:15 -0500
commitbd0f3345a938b35ce6a12f6150373b0955b8dd12 (patch)
tree7a520322212d48ebcb9fbe1087e7fca28b76185c /doc/man/man3/qsqldriverplugin.3qt
downloadqt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.tar.gz
qt3-bd0f3345a938b35ce6a12f6150373b0955b8dd12.zip
Add Qt3 development HEAD version
Diffstat (limited to 'doc/man/man3/qsqldriverplugin.3qt')
-rw-r--r--doc/man/man3/qsqldriverplugin.3qt78
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/man/man3/qsqldriverplugin.3qt b/doc/man/man3/qsqldriverplugin.3qt
new file mode 100644
index 0000000..b8211b1
--- /dev/null
+++ b/doc/man/man3/qsqldriverplugin.3qt
@@ -0,0 +1,78 @@
+'\" t
+.TH QSqlDriverPlugin 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
+.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the
+.\" license file included in the distribution for a complete license
+.\" statement.
+.\"
+.ad l
+.nh
+.SH NAME
+QSqlDriverPlugin \- Abstract base for custom QSqlDriver plugins
+.SH SYNOPSIS
+\fC#include <qsqldriverplugin.h>\fR
+.PP
+.SS "Public Members"
+.in +1c
+.ti -1c
+.BI "\fBQSqlDriverPlugin\fR ()"
+.br
+.ti -1c
+.BI "\fB~QSqlDriverPlugin\fR ()"
+.br
+.ti -1c
+.BI "virtual QStringList \fBkeys\fR () const = 0"
+.br
+.ti -1c
+.BI "virtual QSqlDriver * \fBcreate\fR ( const QString & key ) = 0"
+.br
+.in -1c
+.SH DESCRIPTION
+The QSqlDriverPlugin class provides an abstract base for custom QSqlDriver plugins.
+.PP
+The SQL driver plugin is a simple plugin interface that makes it easy to create your own SQL driver plugins that can be loaded dynamically by Qt.
+.PP
+Writing a SQL plugin is achieved by subclassing this base class, reimplementing the pure virtual functions keys() and create(), and exporting the class with the \fCQ_EXPORT_PLUGIN\fR macro. See the SQL plugins that come with Qt for example implementations (in the \fCplugins/src/sqldrivers\fR subdirectory of the source distribution). Read the plugins documentation for more information on plugins.
+.PP
+See also Plugins.
+.SH MEMBER FUNCTION DOCUMENTATION
+.SH "QSqlDriverPlugin::QSqlDriverPlugin ()"
+Constructs a SQL driver plugin. This is invoked automatically by the \fCQ_EXPORT_PLUGIN\fR macro.
+.SH "QSqlDriverPlugin::~QSqlDriverPlugin ()"
+Destroys the SQL driver plugin.
+.PP
+You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used.
+.SH "QSqlDriver * QSqlDriverPlugin::create ( const QString & key )\fC [pure virtual]\fR"
+Creates and returns a QSqlDriver object for the driver key \fIkey\fR. The driver key is usually the class name of the required driver.
+.PP
+See also keys().
+.SH "QStringList QSqlDriverPlugin::keys () const\fC [pure virtual]\fR"
+Returns the list of drivers (keys) this plugin supports.
+.PP
+These keys are usually the class names of the custom drivers that are implemented in the plugin.
+.PP
+See also create().
+
+.SH "SEE ALSO"
+.BR http://doc.trolltech.com/qsqldriverplugin.html
+.BR http://www.trolltech.com/faq/tech.html
+.SH COPYRIGHT
+Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the
+license file included in the distribution for a complete license
+statement.
+.SH AUTHOR
+Generated automatically from the source code.
+.SH BUGS
+If you find a bug in Qt, please report it as described in
+.BR http://doc.trolltech.com/bughowto.html .
+Good bug reports help us to help you. Thank you.
+.P
+The definitive Qt documentation is provided in HTML format; it is
+located at $QTDIR/doc/html and can be read using Qt Assistant or with
+a web browser. This man page is provided as a convenience for those
+users who prefer man pages, although this format is not officially
+supported by Trolltech.
+.P
+If you find errors in this manual page, please report them to
+Please include the name of the manual page (qsqldriverplugin.3qt) and the Qt
+version (3.3.8).