coredburl.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-03-19
 * Description : Core database Url interface.
 *
 * Copyright (C) 2007-2008 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_CORE_DB_URL_H
#define DIGIKAM_CORE_DB_URL_H
 
// Qt includes
 
#include <QDateTime>
#include <QList>
#include <QUrl>
 
// Local includes
 
#include "digikam_export.h"
#include "dbengineparameters.h"
#include "coredbaccess.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT CoreDbUrl : public QUrl
{
public:
 
    static CoreDbUrl fromFileUrl(const QUrl& fileUrl,
                                 const QUrl& albumRoot,
                                 int   albumRootId,
                                 const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl fromFileUrl(const QUrl& fileUrl,
                                 const QUrl& albumRoot,
                                 const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl fromAlbumAndName(const QString& name,
                                      const QString& album,
                                      const QUrl& albumRoot,
                                      int   albumRootId,
                                      const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl fromAlbumAndName(const QString& name,
                                      const QString& album,
                                      const QUrl& albumRoot,
                                      const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl albumUrl(const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl fromTagIds(const QList<int>& tagIds,
                                const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl dateUrl(const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl fromDateForMonth(const QDate& date,
                                      const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl fromDateForYear(const QDate& date,
                                     const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl fromDateRange(const QDate& startDate, const QDate& endDate,
                                   const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl mapImagesUrl(const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl fromAreaRange(const qreal lat1, const qreal lng1,
                                   const qreal lat2, const qreal lng2,
                                   const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    static CoreDbUrl searchUrl(int searchId, const DbEngineParameters& parameters = CoreDbAccess::parameters());
 
    explicit CoreDbUrl(const QUrl& digikamUrl);
 
    CoreDbUrl();
 
    bool isAlbumUrl()     const;
    bool isTagUrl()       const;
    bool isDateUrl()      const;
    bool isSearchUrl()    const;
    bool isMapImagesUrl() const;
 
    DbEngineParameters parameters() const;
 
    void setParameters(const DbEngineParameters& parameters);
 
 
    QUrl albumRoot() const;
 
    QString albumRootPath() const;
 
    int albumRootId() const;
 
    QString album() const;
 
    QString name() const;
 
    QUrl fileUrl() const;
 
 
    int tagId() const;
 
    QList<int> tagIds() const;
 
 
    QDate startDate() const;
 
    QDate endDate() const;
 
 
    bool areaCoordinates(double* lat1, double* lat2, double* lon1, double* lon2) const;
 
 
    int searchId() const;
 
    CoreDbUrl(const CoreDbUrl& url);
 
    CoreDbUrl& operator=(const QUrl& digikamalbumsUrl);
    CoreDbUrl& operator=(const CoreDbUrl& url);
 
    bool operator==(const QUrl& digikamalbumsUrl) const;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_CORE_DB_URL_H