File indexing completed on 2025-01-19 03:53:32

0001 /* ============================================================
0002  *
0003  * This file is a part of digiKam project
0004  * https://www.digikam.org
0005  *
0006  * Date        : 2007-03-18
0007  * Description : Core database access wrapper.
0008  *
0009  * SPDX-FileCopyrightText: 2016 by Swati Lodha <swatilodha27 at gmail dot com>
0010  *
0011  * SPDX-License-Identifier: GPL-2.0-or-later
0012  *
0013  * ============================================================ */
0014 
0015 #ifndef DIGIKAM_DB_ENGINE_ACCESS_H
0016 #define DIGIKAM_DB_ENGINE_ACCESS_H
0017 
0018 // Qt includes
0019 
0020 #include <QString>
0021 
0022 // Local includes
0023 
0024 #include "digikam_export.h"
0025 
0026 namespace Digikam
0027 {
0028 
0029 /**
0030  * The DbEngineAccess class provides access to the database:
0031  * Create an instance of this class on the stack to retrieve a pointer to the database.
0032  */
0033 class DIGIKAM_EXPORT DbEngineAccess
0034 {
0035 public:
0036 
0037     /** Checks the availability of drivers. Must be used in children class.
0038      *  Return true if low level drivers are ready to use, else false with
0039      *  an error string of the problem.
0040      */
0041     static bool checkReadyForUse(QString& error);
0042 };
0043 
0044 } // namespace Digikam
0045 
0046 #endif // DIGIKAM_DB_ENGINE_ACCESS_H