itemlister.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2007-03-20
 * Description : Listing information from database.
 *
 * Copyright (C) 2005      by Renchi Raju    <renchi dot raju at gmail dot com>
 * Copyright (C) 2007-2012 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2007-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2015      by Mohamed_Anwer  <m_dot_anwer at gmx dot com>
 *
 * 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_ITEM_LISTER_H
#define DIGIKAM_ITEM_LISTER_H
 
// Qt includes
 
#include <QString>
 
// Local includes
 
#include "digikam_export.h"
#include "iteminfo.h"
#include "iteminfolist.h"
#include "coredbaccess.h"
#include "coredburl.h"
#include "itemlisterrecord.h"
#include "itemlisterreceiver.h"
#include "dbjobinfo.h"
 
namespace Digikam
{
 
class DIGIKAM_DATABASE_EXPORT ItemLister
{
 
public:
 
    explicit ItemLister();
    ~ItemLister();
 
    void setRecursive(bool recursive);
 
    void setListOnlyAvailable(bool listOnlyAvailable);
 
    void list(ItemListerReceiver* const receiver,
              const CoreDbUrl& url);
 
    void listDateRange(ItemListerReceiver* const receiver,
                       const QDate& startDate,
                       const QDate& endDate);
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void listPAlbum(ItemListerReceiver* const receiver,
                    int albumRootId,
                    const QString& album);
 
private:
 
    QSet<int> albumRootsToList() const;
 
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void listTag(ItemListerReceiver* const receiver,
                 const QList<int>& tagIds);
 
    void listImageTagPropertySearch(ItemListerReceiver* const receiver,
                                    const QString& xml);
 
    QString tagSearchXml(int tagId,
                         const QString& type,
                         bool includeChildTags) const;
 
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void listSearch(ItemListerReceiver* const receiver,
                    const QString& xml,
                    int limit = 0,
                    qlonglong referenceImageId = -1);
 
    void listHaarSearch(ItemListerReceiver* const receiver,
                        const QString& xml);
 
    void listAreaRange(ItemListerReceiver* const receiver,
                       double lat1,
                       double lat2,
                       double lon1,
                       double lon2);
 
private:
 
    void listFromHaarSearch(ItemListerReceiver* const receiver,
                            const QMap<qlonglong,
                            double>& imageSimilarityMap);
 
    // -----------------------------------------------------------------------------
 
 
public:
 
    void listFaces(ItemListerReceiver* const receiver,
                   int personId);
 
private:
 
    void listFromIdList(ItemListerReceiver* const receiver,
                        const QList<qlonglong>& imageIds);
 
 
private:
 
    // Disable
    ItemLister(const ItemLister&)            = delete;
    ItemLister& operator=(const ItemLister&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_ITEM_LISTER_H