searchmodificationhelper.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2000-12-05
 * Description : helper class used to modify search albums in views
 *
 * Copyright (C) 2009-2010 by Johannes Wienke <languitar at semipol dot de>
 * Copyright (C) 2014-2022 by Gilles Caulier <caulier dot gilles at gmail 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_SEARCH_MODIFICATION_HELPER_H
#define DIGIKAM_SEARCH_MODIFICATION_HELPER_H
 
// Qt includes
 
#include <QObject>
 
// Local includes
 
#include "album.h"
 
namespace Digikam
{
 
class SketchWidget;
class ItemInfo;
 
typedef QPair<QDateTime, QDateTime> DateRange;
 
typedef QList<DateRange> DateRangeList;
 
class SearchModificationHelper: public QObject
{
    Q_OBJECT
 
public:
 
    SearchModificationHelper(QObject* const parent, QWidget* const dialogParent);
 
    ~SearchModificationHelper() override;
 
    SAlbum* createFuzzySearchFromSketch(const QString& name,
                                        SketchWidget* sketchWidget,
                                        unsigned int numberOfResults,
                                        const QList<int>& targetAlbums,
                                        bool overwriteIfExisting = false);
 
    SAlbum* createFuzzySearchFromDropped(const QString& name,
                                        const QString& filePath,
                                        float threshold,
                                        float maxThreshold,
                                        const QList<int>& targetAlbums,
                                        bool overwriteIfExisting = false);
 
    SAlbum* createFuzzySearchFromImage(const QString& name,
                                       const ItemInfo& image,
                                       float threshold,
                                       float maxThreshold,
                                       const QList<int>& targetAlbums,
                                       bool overwriteIfExisting = false);
 
public Q_SLOTS:
 
    void slotSearchDelete(SAlbum* searchAlbum);
 
    void slotSearchRename(SAlbum* searchAlbum);
 
    SAlbum* slotCreateTimeLineSearch(const QString& desiredName,
                                     const DateRangeList& dateRanges,
                                     bool overwriteIfExisting = false);
 
    void slotCreateFuzzySearchFromSketch(const QString& name,
                                         SketchWidget* sketchWidget,
                                         unsigned int numberOfResults,
                                         const QList<int>& targetAlbums,
                                         bool overwriteIfExisting = false);
 
    void slotCreateFuzzySearchFromImage(const QString& name,
                                        const ItemInfo& image,
                                        float threshold,
                                        float maxThreshold,
                                        const QList<int>& targetAlbums,
                                        bool overwriteIfExisting = false);
 
    void slotCreateFuzzySearchFromDropped(const QString& name,
                                          const QString& filePath,
                                          float threshold,
                                          float maxThreshold,
                                          const QList<int>& targetAlbums,
                                          bool overwriteIfExisting);
 
private:
 
    bool checkAlbum(const QString& name) const;
    bool checkName(QString& name);
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_SEARCH_MODIFICATION_HELPER_H