KDb

KDbDriverMetaData.h
1 /* This file is part of the KDE project
2  Copyright (C) 2003-2016 JarosÅ‚aw Staniek <[email protected]>
3 
4  This program is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Library General Public
6  License as published by the Free Software Foundation; either
7  version 2 of the License, or (at your option) any later version.
8 
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this program; see the file COPYING. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18 */
19 
20 #ifndef KDB_DRIVERMETADATA_H
21 #define KDB_DRIVERMETADATA_H
22 
23 #include <KPluginMetaData>
24 
25 #include "kdb_export.h"
26 
27 //! Provides information about a single driver plugin
28 class KDB_EXPORT KDbDriverMetaData : public KPluginMetaData
29 {
30 public:
32 
33  //! @return internal name of the plugin, a shortcut of pluginId()
34  QString id() const;
35 
36  //! @return true if the driver is for file-based databases like SQLite.
37  /*! Defined by a "X-KDb-FileBased" field in .json information files. */
38  bool isFileBased() const;
39 
40  //! @return true if the driver is for a backend that allows importing.
41  /*! Defined by a "X-KDb-ImportingEnabled" field in .json information files.
42  Used for database migration. */
43  bool isImportingEnabled() const;
44 
45 protected:
46  explicit KDbDriverMetaData(const QPluginLoader &loader);
47  friend class DriverManagerInternal;
48 
49 private:
50  Q_DISABLE_COPY(KDbDriverMetaData)
51  class Private;
52  Private * const d;
53 };
54 
55 #endif
Provides information about a single driver plugin.
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sat Jun 25 2022 06:21:33 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.