src/search/dolphinfacetswidget.h

   1 /***************************************************************************
   2  *   Copyright (C) 2012 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef DOLPHINFACETSWIDGET_H
  21 #define DOLPHINFACETSWIDGET_H
  22
  23 #include <QWidget>
  24 #include <KCoreDirLister>
  25
  26 class QComboBox;
  27 class QDate;
  28 class QEvent;
  29 class QToolButton;
  30
  31 /**
  32  * @brief Allows to filter search-queries by facets.
  33  *
  34  * TODO: The current implementation is a temporary
  35  * workaround for the 4.9 release and represents no
  36  * real facets-implementation yet: There have been
  37  * some Dolphin specific user-interface and interaction
  38  * issues since 4.6 by embedding the Nepomuk facet-widget
  39  * into a QDockWidget (this is unrelated to the
  40  * Nepomuk facet-widget itself). Now in combination
  41  * with the search-shortcuts in the Places Panel some
  42  * existing issues turned into real showstoppers.
  43  *
  44  * So the longterm plan is to use the Nepomuk facets
  45  * again as soon as possible.
  46  */
  47 class DolphinFacetsWidget : public QWidget
  48 {
  49     Q_OBJECT
  50
  51 public:
  52     explicit DolphinFacetsWidget(QWidget* parent = nullptr);
  53     ~DolphinFacetsWidget() override;
  54
  55     QStringList searchTerms() const;
  56     QString facetType() const;
  57
  58     bool isSearchTerm(const QString& term) const;
  59     void setSearchTerm(const QString& term);
  60     void resetSearchTerms();
  61
  62     void setFacetType(const QString& type);
  63
  64 signals:
  65     void facetChanged();
  66
  67 protected:
  68     void changeEvent(QEvent* event) override;
  69
  70 private slots:
  71     void updateTagsMenu();
  72     void updateTagsMenuItems(const QUrl&, const KFileItemList& items);
  73
  74 private:
  75     void setRating(const int stars);
  76     void setTimespan(const QDate& date);
  77     void addSearchTag(const QString& tag);
  78     void removeSearchTag(const QString& tag);
  79
  80     void initComboBox(QComboBox* combo);
  81     void updateTagsSelector();
  82
  83 private:
  84     QComboBox* m_typeSelector;
  85     QComboBox* m_dateSelector;
  86     QComboBox* m_ratingSelector;
  87     QToolButton* m_tagsSelector;
  88
  89     QStringList m_searchTags;
  90     KCoreDirLister m_tagsLister;
  91 };
  92
  93 #endif