src/search/dolphinsearchbox.h

   1 /***************************************************************************
   2  *   Copyright (C) 2010 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 DOLPHINSEARCHBOX_H
  21 #define DOLPHINSEARCHBOX_H
  22
  23 #include <QUrl>
  24 #include <QWidget>
  25
  26 class DolphinFacetsWidget;
  27 class QLineEdit;
  28 class KSeparator;
  29 class QToolButton;
  30 class QScrollArea;
  31 class QLabel;
  32 class QVBoxLayout;
  33 class KMoreToolsMenuFactory;
  34
  35 /**
  36  * @brief Input box for searching files with or without Baloo.
  37  *
  38  * The widget allows to specify:
  39  * - Where to search: Everywhere or below the current directory
  40  * - What to search: Filenames or content
  41  *
  42  * If Baloo is available and the current folder is indexed, further
  43  * options are offered.
  44  */
  45 class DolphinSearchBox : public QWidget {
  46     Q_OBJECT
  47
  48 public:
  49     explicit DolphinSearchBox(QWidget* parent = nullptr);
  50     ~DolphinSearchBox() override;
  51
  52     /**
  53      * Sets the text that should be used as input for
  54      * searching.
  55      */
  56     void setText(const QString& text);
  57
  58     /**
  59      * Returns the text that should be used as input
  60      * for searching.
  61      */
  62     QString text() const;
  63
  64     /**
  65      * Sets the current path that is used as root for
  66      * searching files, if "From Here" has been selected.
  67      */
  68     void setSearchPath(const QUrl& url);
  69     QUrl searchPath() const;
  70
  71     /** @return URL that will start the searching of files. */
  72     QUrl urlForSearching() const;
  73
  74     /**
  75      * Extracts information from the given search \a url to
  76      * initialize the search box properly.
  77      */
  78     void fromSearchUrl(const QUrl& url);
  79
  80     /**
  81      * Selects the whole text of the search box.
  82      */
  83     void selectAll();
  84
  85     /**
  86      * Set the search box to the active mode, if \a active
  87      * is true. The active mode is default. The inactive mode only differs
  88      * visually from the active mode, no change of the behavior is given.
  89      *
  90      * Using the search box in the inactive mode is useful when having split views,
  91      * where the inactive view is indicated by an search box visually.
  92      */
  93     void setActive(bool active);
  94
  95     /**
  96      * @return True, if the search box is in the active mode.
  97      * @see    DolphinSearchBox::setActive()
  98      */
  99     bool isActive() const;
 100
 101 protected:
 102     bool event(QEvent* event) override;
 103     void showEvent(QShowEvent* event) override;
 104     void hideEvent(QHideEvent* event) override;
 105     void keyReleaseEvent(QKeyEvent* event) override;
 106     bool eventFilter(QObject* obj, QEvent* event) override;
 107
 108 signals:
 109     /**
 110      * Is emitted when a searching should be triggered.
 111      */
 112     void searchRequest();
 113
 114     /**
 115      * Is emitted when the user has changed a character of
 116      * the text that should be used as input for searching.
 117      */
 118     void searchTextChanged(const QString& text);
 119
 120     void returnPressed();
 121
 122     /**
 123      * Emitted as soon as the search box should get closed.
 124      */
 125     void closeRequest();
 126
 127     /**
 128      * Is emitted, if the searchbox has been activated by
 129      * an user interaction
 130      * @see DolphinSearchBox::setActive()
 131      */
 132     void activated();
 133
 134 private slots:
 135     void emitSearchRequest();
 136     void emitCloseRequest();
 137     void slotConfigurationChanged();
 138     void slotSearchTextChanged(const QString& text);
 139     void slotReturnPressed();
 140     void slotFacetsButtonToggled();
 141     void slotFacetChanged();
 142     void slotSearchSaved();
 143
 144 private:
 145     void initButton(QToolButton* button);
 146     void loadSettings();
 147     void saveSettings();
 148     void init();
 149
 150     /**
 151      * @return URL that represents the Baloo query for starting the search.
 152      */
 153     QUrl balooUrlForSearching() const;
 154
 155     /**
 156      * Extracts information from the given Baloo search \a url to
 157      * initialize the search box properly.
 158      */
 159     void fromBalooSearchUrl(const QUrl& url);
 160
 161     void updateFacetsToggleButton();
 162
 163 private:
 164     bool m_startedSearching;
 165     bool m_active;
 166
 167     QVBoxLayout* m_topLayout;
 168
 169     QLabel* m_searchLabel;
 170     QLineEdit* m_searchInput;
 171     QAction* m_saveSearchAction;
 172     QScrollArea* m_optionsScrollArea;
 173     QToolButton* m_fileNameButton;
 174     QToolButton* m_contentButton;
 175     KSeparator* m_separator;
 176     QToolButton* m_fromHereButton;
 177     QToolButton* m_everywhereButton;
 178     QToolButton* m_facetsToggleButton;
 179     DolphinFacetsWidget* m_facetsWidget;
 180
 181     QUrl m_searchPath;
 182     QScopedPointer<KMoreToolsMenuFactory> m_menuFactory;
 183
 184     QTimer* m_startSearchTimer;
 185 };
 186
 187 #endif