workspace/libs/plasma/searchmatch.cpp

   1 /*
   2  *   Copyright 2006-2007 Aaron Seigo <aseigo@kde.org>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU Library General Public License as
   6  *   published by the Free Software Foundation; either version 2, 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 Library General Public
  15  *   License 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 #include "searchmatch.h"
  21
  22 #include <QVariant>
  23 #include <QStringList>
  24 #include <QIcon>
  25
  26 #include <KDebug>
  27
  28 #include "abstractrunner.h"
  29
  30 namespace Plasma
  31 {
  32
  33 class SearchMatch::Private
  34 {
  35     public:
  36         Private(AbstractRunner *r)
  37             : runner(r),
  38               type(SearchMatch::ExactMatch),
  39               enabled(true),
  40               relevance(.7)
  41         {
  42         }
  43
  44         AbstractRunner *runner;
  45         SearchMatch::Type type;
  46         QString text;
  47         QString subtext;
  48         QIcon icon;
  49         QVariant data;
  50         bool enabled;
  51         qreal relevance;
  52 };
  53
  54
  55 SearchMatch::SearchMatch(AbstractRunner *runner)
  56     : d(new Private(runner))
  57 {
  58 }
  59
  60 SearchMatch::~SearchMatch()
  61 {
  62     delete d;
  63 }
  64
  65 void SearchMatch::setType(Type type)
  66 {
  67     d->type = type;
  68 }
  69
  70 SearchMatch::Type SearchMatch::type() const
  71 {
  72     return d->type;
  73 }
  74
  75 void SearchMatch::setRelevance(qreal relevance)
  76 {
  77     d->relevance = qMax(qreal(0.0), qMin(qreal(1.0), relevance));
  78 }
  79
  80 qreal SearchMatch::relevance() const
  81 {
  82     return d->relevance;
  83 }
  84
  85 AbstractRunner* SearchMatch::runner() const
  86 {
  87     return d->runner;
  88 }
  89
  90 void SearchMatch::setText(const QString& text)
  91 {
  92     d->text = text;
  93 }
  94
  95 void SearchMatch::setSubtext(const QString& subtext)
  96 {
  97     d->subtext = subtext;
  98 }
  99
 100 void SearchMatch::setData(const QVariant& data)
 101 {
 102     d->data = data;
 103 }
 104
 105 void SearchMatch::setIcon(const QIcon& icon)
 106 {
 107     d->icon = icon;
 108 }
 109
 110 QVariant SearchMatch::data() const
 111 {
 112     return d->data;
 113 }
 114
 115 QString SearchMatch::text() const
 116 {
 117     return d->text;
 118 }
 119
 120 QString SearchMatch::subtext() const
 121 {
 122     return d->subtext;
 123 }
 124
 125 QIcon SearchMatch::icon() const
 126 {
 127     return d->icon;
 128 }
 129
 130 void SearchMatch::setEnabled( bool enabled )
 131 {
 132     d->enabled = enabled;
 133 }
 134
 135 bool SearchMatch::isEnabled() const
 136 {
 137   return d->enabled;
 138 }
 139
 140 bool SearchMatch::operator<(const SearchMatch& other) const
 141 {
 142     return d->relevance < other.d->relevance;
 143 }
 144
 145 void SearchMatch::exec(const SearchContext *context) const
 146 {
 147     Q_ASSERT(context);
 148
 149     //kDebug() << "we have" << context->searchTerm() << context->mimetype();
 150     if (d->runner) {
 151         //TODO: this could be dangerous if the runner is deleted behind our backs.
 152         d->runner->exec(context, this);
 153     }
 154 }
 155
 156 } // Plasma namespace
 157