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 #include "searchcriterionvalue.h"
  24
  25 #include <QComboBox>
  26 #include <QHBoxLayout>
  27 #include <QList>
  28 #include <QPushButton>
  29
  30 #include <kicon.h>
  31 #include <klocale.h>
  32
  33 SearchCriterionSelector::SearchCriterionSelector(Type type, QWidget* parent) :
  34     QWidget(parent),
  35     m_layout(0),
  36     m_descriptionsBox(0),
  37     m_comparatorBox(0),
  38     m_valueWidget(0),
  39     m_removeButton(0),
  40     m_descriptions()
  41 {
  42     m_descriptionsBox = new QComboBox(this);
  43
  44     m_comparatorBox = new QComboBox(this);
  45     m_comparatorBox->setSizeAdjustPolicy(QComboBox::AdjustToContents);
  46
  47     createDescriptions();
  48     const int index = static_cast<int>(type);
  49     m_descriptionsBox->setCurrentIndex(index);
  50
  51     QWidget* filler = new QWidget(this);
  52     filler->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
  53
  54     m_removeButton = new QPushButton(this);
  55     m_removeButton->setIcon(KIcon("list-remove"));
  56     m_removeButton->setToolTip(i18nc("@info", "Remove search option"));
  57     m_removeButton->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
  58     connect(m_removeButton, SIGNAL(clicked()), this, SIGNAL(removeCriterion()));
  59
  60     m_layout = new QHBoxLayout(this);
  61     m_layout->setMargin(0);
  62     m_layout->addWidget(m_removeButton);
  63     m_layout->addWidget(m_descriptionsBox);
  64     m_layout->addWidget(m_comparatorBox);
  65     m_layout->addWidget(filler);
  66
  67     setLayout(m_layout);
  68
  69     slotDescriptionChanged(index);
  70     connect(m_descriptionsBox, SIGNAL(currentIndexChanged(int)), this, SLOT(slotDescriptionChanged(int)));
  71 }
  72
  73 SearchCriterionSelector::~SearchCriterionSelector()
  74 {
  75 }
  76
  77 QString SearchCriterionSelector::toString() const
  78 {
  79     if (m_valueWidget == 0) {
  80         return QString();
  81     }
  82
  83     const int descIndex = m_descriptionsBox->currentIndex();
  84     const SearchCriterionDescription& descr = m_descriptions[descIndex];
  85
  86     const int compIndex = m_comparatorBox->currentIndex();
  87     const SearchCriterionDescription::Comparator& comp = descr.comparators()[compIndex];
  88     if (comp.operation.isEmpty()) {
  89         return QString();
  90     }
  91
  92     QString criterion = comp.prefix + descr.identifier() + comp.operation;
  93     if (!m_valueWidget->value().isEmpty()) {
  94         const QString value = m_valueWidget->value();
  95         if (value.contains(' ')) {
  96             criterion += '"' + value + '"';
  97         } else {
  98             // Don't surround the value by " if no space is part of the value.
  99             // This increases the readability of the search-URL.
 100             criterion += value;
 101         }
 102     }
 103     return criterion;
 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.operation.isEmpty() && 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"), ">", "+"));
 165     defaultComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Greater Than or Equal to"), ">=", "+"));
 166     defaultComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Less Than"), "<", "+"));
 167     defaultComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Less Than or Equal to"), "<=", "+"));
 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"), ":", "+", "today"));
 173     dateComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "This Week"), ">=", "+", "thisWeek"));
 174     dateComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "This Month"), ">=", "+", "thisMonth"));
 175     dateComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "This Year"), ">=", "+", "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                                     "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                                     "contentSize",
 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"), ":", "+"));
 206     tagComps.append(SearchCriterionDescription::Comparator(i18nc("@label", "Not Equal to"), ":", "-"));
 207
 208     TagValue* tagValue = new TagValue(this);
 209     tagValue->hide();
 210     SearchCriterionDescription tag(i18nc("@label", "Tag:"),
 211                                    "tag",
 212                                    tagComps,
 213                                    tagValue);
 214     Q_ASSERT(static_cast<int>(SearchCriterionSelector::Tag) == 2);
 215     m_descriptions.append(tag);
 216
 217     // add "Rating" description
 218     QList<SearchCriterionDescription::Comparator> ratingComps = defaultComps;
 219     ratingComps.insert(0, SearchCriterionDescription::Comparator(i18nc("@label Any (rating)", "Any")));
 220
 221     RatingValue* ratingValue = new RatingValue(this);
 222     ratingValue->hide();
 223     SearchCriterionDescription rating(i18nc("@label", "Rating:"),
 224                                       "rating",
 225                                       ratingComps,
 226                                       ratingValue);
 227     Q_ASSERT(static_cast<int>(SearchCriterionSelector::Rating) == 3);
 228     m_descriptions.append(rating);
 229
 230     // add all descriptions to the combo box and connect the value widgets
 231     int i = 0;
 232     foreach (const SearchCriterionDescription& desc, m_descriptions) {
 233         m_descriptionsBox->addItem(desc.name(), i);
 234         connect(desc.valueWidget(), SIGNAL(valueChanged(QString)), this, SIGNAL(criterionChanged()));
 235         ++i;
 236     }
 237 }
 238
 239 #include "searchcriterionselector.moc"