searchview.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2008-01-20
 * Description : User interface for searches
 *
 * Copyright (C) 2008-2012 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_SEARCH_VIEW_H
#define DIGIKAM_SEARCH_VIEW_H
 
// Qt includes
 
#include <QCache>
#include <QList>
#include <QRect>
#include <QWidget>
 
class QHBoxLayout;
class QDialogButtonBox;
class QPushButton;
 
namespace Digikam
{
 
class SearchGroup;
class SearchViewBottomBar;
class SearchXmlCachingReader;
class SearchXmlWriter;
 
class SearchViewThemedPartsCache
{
public:
 
    SearchViewThemedPartsCache()                   = default;
    virtual ~SearchViewThemedPartsCache()          = default;
 
    virtual QPixmap groupLabelPixmap(int w, int h) = 0;
    virtual QPixmap bottomBarPixmap(int w, int h)  = 0;
 
private:
 
    Q_DISABLE_COPY(SearchViewThemedPartsCache)
};
 
class AbstractSearchGroupContainer : public QWidget
{
    Q_OBJECT
 
public:
 
    explicit AbstractSearchGroupContainer(QWidget* const parent = nullptr);
 
public Q_SLOTS:
 
    SearchGroup* addSearchGroup();
    void removeSearchGroup(SearchGroup* group);
 
protected:
 
    void startReadingGroups(SearchXmlCachingReader& reader);
 
    void readGroup(SearchXmlCachingReader& reader);
 
    void finishReadingGroups();
 
    void writeGroups(SearchXmlWriter& writer) const;
 
    QList<QRect> startupAnimationAreaOfGroups() const;
 
    virtual SearchGroup* createSearchGroup() = 0;
 
    virtual void addGroupToLayout(SearchGroup* group) = 0;
 
protected Q_SLOTS:
 
    void removeSendingSearchGroup();
 
protected:
 
    int                 m_groupIndex;
    QList<SearchGroup*> m_groups;
};
 
// -------------------------------------------------------------------------
 
class SearchView : public AbstractSearchGroupContainer,
                   public SearchViewThemedPartsCache
{
    Q_OBJECT
 
public:
 
    SearchView();
    ~SearchView()                                  override;
 
    void setup();
    void setBottomBar(SearchViewBottomBar* const bar);
 
    void read(const QString& search);
    QString write()                          const;
 
    QPixmap groupLabelPixmap(int w, int h)         override;
    QPixmap bottomBarPixmap(int w, int h)          override;
 
Q_SIGNALS:
 
    void searchOk();
    void searchTryout();
    void searchCancel();
 
protected Q_SLOTS:
 
    void setTheme();
    void slotAddGroupButton();
    void slotResetButton();
    void startAnimation();
    void animationFrame(int);
    void timeLineFinished();
 
protected:
 
    QPixmap cachedBannerPixmap(int w, int h) const;
 
    void paintEvent(QPaintEvent* e)                 override;
    void showEvent(QShowEvent* event)               override;
 
    SearchGroup* createSearchGroup()                override;
    void addGroupToLayout(SearchGroup* group)       override;
 
private:
 
    // Disable.
    SearchView(QWidget*)                     = delete;
    SearchView(const SearchView&)            = delete;
    SearchView& operator=(const SearchView&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
// -------------------------------------------------------------------------
 
class SearchViewBottomBar : public QWidget
{
    Q_OBJECT
 
public:
 
    explicit SearchViewBottomBar(SearchViewThemedPartsCache* const cache,
                                 QWidget* const parent = nullptr);
 
Q_SIGNALS:
 
    void okPressed();
    void cancelPressed();
    void tryoutPressed();
    void addGroupPressed();
    void resetPressed();
 
protected:
 
    void paintEvent(QPaintEvent*) override;
 
protected:
 
    QHBoxLayout*                m_mainLayout;
 
    QDialogButtonBox*           m_buttonBox;
    QPushButton*                m_addGroupsButton;
    QPushButton*                m_resetButton;
 
    SearchViewThemedPartsCache* m_themeCache;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_SEARCH_VIEW_H