src/search/searchcriterionselector.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Adam Kidder <thekidder@gmail.com>               *
   3  *   Copyright (C) 2009 by Peter Penz <peter.penz@gmx.at>                  *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  19  ***************************************************************************/
  20
  21 #include "searchcriterionselector.h"
  22
  23 #define DISABLE_NEPOMUK_LEGACY
  24 #include <nepomuk/comparisonterm.h>
  25 #include <nepomuk/literalterm.h>
  26 #include <nepomuk/query.h>
  27
  28 #include "searchcriterionvalue.h"
  29
  30 #include <Soprano/LiteralValue>
  31 #include <Soprano/Vocabulary/NAO>
  32
  33 #include <QComboBox>
  34 #include <QHBoxLayout>
  35 #include <QList>
  36 #include <QPushButton>
  37
  38 #include <kicon.h>
  39 #include <klocale.h>
  40
  41 SearchCriterionSelector::SearchCriterionSelector(Type type, QWidget* parent) :
  42     QWidget(parent),
  43     m_layout(0),
  44     m_descriptionsBox(0),
  45     m_comparatorBox(0),
  46     m_valueWidget(0),
  47     m_removeButton(0),
  48     m_descriptions()
  49 {
  50     m_descriptionsBox = new QComboBox(this);
  51
  52     m_comparatorBox = new QComboBox(this);
  53     m_comparatorBox->setSizeAdjustPolicy(QComboBox::AdjustToContents);
  54
  55     createDescriptions();
  56     const int index = static_cast<int>(type);
  57     m_descriptionsBox->setCurrentIndex(index);
  58
  59     QWidget* filler = new QWidget(this);
  60     filler->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
  61
  62     m_removeButton = new QPushButton(this);
  63     m_removeButton->setIcon(KIcon("list-remove"));
  64     m_removeButton->setToolTip(i18nc("@info", "Remove search option"));
  65     m_removeButton->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
  66     connect(m_removeButton, SIGNAL(clicked()), this, SIGNAL(removeCriterion()));
  67
  68     m_layout = new QHBoxLayout(this);
  69     m_layout->setMargin(0);
  70     m_layout->addWidget(m_removeButton);
  71     m_layout->addWidget(m_descriptionsBox);
  72     m_layout->addWidget(m_comparatorBox);
  73     m_layout->addWidget(filler);
  74
  75     setLayout(m_layout);
  76
  77     slotDescriptionChanged(index);
  78     connect(m_descriptionsBox, SIGNAL(currentIndexChanged(int)), this, SLOT(slotDescriptionChanged(int)));
  79 }
  80
  81 SearchCriterionSelector::~SearchCriterionSelector()
  82 {
  83 }
  84
  85 Nepomuk::Query::Term SearchCriterionSelector::queryTerm() const
  86 {
  87     if (m_valueWidget == 0) {
  88         return Nepomuk::Query::Term();
  89     }
  90
  91     const int descIndex = m_descriptionsBox->currentIndex();
  92     const SearchCriterionDescription& descr = m_descriptions[descIndex];
  93
  94     const int compIndex = m_comparatorBox->currentIndex();
  95     const SearchCriterionDescription::Comparator& comp = descr.comparators()[compIndex];
  96     if (!comp.isActive) {
  97         return Nepomuk::Query::Term();
  98     }
  99
 100     const Nepomuk::Query::ComparisonTerm term(descr.identifier(),
 101                                               m_valueWidget->value(),
 102                                               comp.value);
 103     return term;
 104 }
 105
 106 SearchCriterionSelector::Type SearchCriterionSelector::type() const
 107 {
 108     return static_cast<Type>(m_descriptionsBox->currentIndex());
 109 }
 110
 111 void SearchCriterionSelector::slotDescriptionChanged(int index)
 112 {
 113     if (m_valueWidget != 0) {
 114         m_valueWidget->hide();
 115         m_layout->removeWidget(m_valueWidget);
 116         m_valueWidget = 0;
 117         // the value widget is obtained by the Search Criterion
 118         // Selector instance and may not get deleted
 119     }
 120
 121     // add comparator items
 122     disconnect(m_comparatorBox, SIGNAL(currentIndexChanged(int)), this, SLOT(slotComparatorChanged(int)));
 123     m_comparatorBox->clear();
 124
 125     const SearchCriterionDescription& description = m_descriptions[index];
 126     foreach (const SearchCriterionDescription::Comparator& comp, description.comparators()) {
 127         m_comparatorBox->addItem(comp.name);
 128     }
 129
 130     // add value widget
 131     m_valueWidget = description.valueWidget();
 132     m_layout->insertWidget(3, m_valueWidget);
 133
 134     m_comparatorBox->setCurrentIndex(0);
 135     slotComparatorChanged(0);
 136     connect(m_comparatorBox, SIGNAL(currentIndexChanged(int)), this, SLOT(slotComparatorChanged(int)));
 137 }
 138
 139 void SearchCriterionSelector::slotComparatorChanged(int index)
 140 {
 141     Q_ASSERT(index >= 0);
 142
 143     // only show the value widget if an operation is defined by the comparator
 144     const int descIndex = m_descriptionsBox->currentIndex();
 145     const SearchCriterionDescription& descr = m_descriptions[descIndex];
 146     const SearchCriterionDescription::Comparator& comp = descr.comparators()[index];
 147
 148     m_valueWidget->initializeValue(comp.autoValueType);
 149     // only show the value widget, if an operation is defined
 150     // and no automatic calculation is provided
 151     m_valueWidget->setVisible(comp.isActive && comp.autoValueType.isEmpty());
 152
 153     emit criterionChanged();
 154 }
 155
 156 void SearchCriterionSelector::createDescriptions()
 157 {
 158     Q_ASSERT(m_descriptionsBox != 0);
 159     Q_ASSERT(m_comparatorBox != 0);
 160
 161     // TODO: maybe this creation should be forwarded to a factory if
 162     // the number of items increases in future
 163     QList<SearchCriterionDescription::Comparator> defaultComps;
 164     defaultComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Greater Than"), Nepomuk::Query::ComparisonTerm::Greater));
 165     defaultComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Greater Than or Equal to"), Nepomuk::Query::ComparisonTerm::GreaterOrEqual));
 166     defaultComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Less Than"), Nepomuk::Query::ComparisonTerm::Smaller));
 167     defaultComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Less Than or Equal to"), Nepomuk::Query::ComparisonTerm::SmallerOrEqual));
 168
 169     // add "Date" description
 170     QList<SearchCriterionDescription::Comparator> dateComps;
 171     dateComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Anytime")));
 172     dateComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Today"), Nepomuk::Query::ComparisonTerm::Equal, "today"));
 173     dateComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "This Week"), Nepomuk::Query::ComparisonTerm::GreaterOrEqual, "thisWeek"));
 174     dateComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "This Month"), Nepomuk::Query::ComparisonTerm::GreaterOrEqual, "thisMonth"));
 175     dateComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "This Year"), Nepomuk::Query::ComparisonTerm::GreaterOrEqual, "thisYear"));
 176     foreach (const SearchCriterionDescription::Comparator& comp, defaultComps) {
 177         dateComps.append(comp);
 178     }
 179
 180     DateValue* dateValue = new DateValue(this);
 181     dateValue->hide();
 182     SearchCriterionDescription date(i18nc("@label", "Date:"),
 183                                     Soprano::Vocabulary::NAO::lastModified(),
 184                                     dateComps,
 185                                     dateValue);
 186     Q_ASSERT(static_cast<int>(SearchCriterionSelector::Date) == 0);
 187     m_descriptions.append(date);
 188
 189     // add "Size" description
 190     QList<SearchCriterionDescription::Comparator> sizeComps = defaultComps;
 191     sizeComps.insert(0, SearchCriterionDescription::Comparator(i18nc("@label Any (file size)", "Any")));
 192
 193     SizeValue* sizeValue = new SizeValue(this);
 194     sizeValue->hide();
 195     SearchCriterionDescription size(i18nc("@label", "Size:"),
 196                                     Soprano::Vocabulary::NAO::lastModified(), // TODO
 197                                     sizeComps,
 198                                     sizeValue);
 199     Q_ASSERT(static_cast<int>(SearchCriterionSelector::Size) == 1);
 200     m_descriptions.append(size);
 201
 202     // add "Tag" description
 203     QList<SearchCriterionDescription::Comparator> tagComps;
 204     tagComps.append(SearchCriterionDescription::Comparator(i18nc("@label All (tags)", "All")));
 205     tagComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Equal to"), Nepomuk::Query::ComparisonTerm::Equal));
 206     // It is unclear yet how to express != for tags with the new Nepomuk query API. Disable it for KDE 4.4,
 207     // but leave the translation string there to be able to enable this functionality for KDE 4.4.x:
 208     const QString dummy = i18nc("@label", "Not Equal to");
 209     Q_UNUSED(dummy);
 210     //tagComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Not Equal to"), Nepomuk::Query::ComparisonTerm::Equal)); // TODO
 211
 212     TagValue* tagValue = new TagValue(this);
 213     tagValue->hide();
 214     SearchCriterionDescription tag(i18nc("@label", "Tag:"),
 215                                    Soprano::Vocabulary::NAO::hasTag(),
 216                                    tagComps,
 217                                    tagValue);
 218     Q_ASSERT(static_cast<int>(SearchCriterionSelector::Tag) == 2);
 219     m_descriptions.append(tag);
 220
 221     // add "Rating" description
 222     QList<SearchCriterionDescription::Comparator> ratingComps = defaultComps;
 223     ratingComps.insert(0, SearchCriterionDescription::Comparator(i18nc("@label Any (rating)", "Any")));
 224
 225     RatingValue* ratingValue = new RatingValue(this);
 226     ratingValue->hide();
 227     SearchCriterionDescription rating(i18nc("@label", "Rating:"),
 228                                       Soprano::Vocabulary::NAO::numericRating(),
 229                                       ratingComps,
 230                                       ratingValue);
 231     Q_ASSERT(static_cast<int>(SearchCriterionSelector::Rating) == 3);
 232     m_descriptions.append(rating);
 233
 234     // add all descriptions to the combo box and connect the value widgets
 235     int i = 0;
 236     foreach (const SearchCriterionDescription& desc, m_descriptions) {
 237         m_descriptionsBox->addItem(desc.name(), i);
 238         connect(desc.valueWidget(), SIGNAL(valueChanged(Nepomuk::Query::LiteralTerm)), this, SIGNAL(criterionChanged()));
 239         ++i;
 240     }
 241 }
 242
 243 #include "searchcriterionselector.moc"