-/***************************************************************************
- * Copyright (C) 2010 by Peter Penz <peter.penz19@gmail.com> *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2010 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#ifndef DOLPHINSEARCHBOX_H
#define DOLPHINSEARCHBOX_H
-#include <KUrl>
-#include <QList>
+#include <QUrl>
#include <QWidget>
-class AbstractSearchFilterWidget;
-class QLabel;
-class KLineEdit;
+class DolphinFacetsWidget;
+class DolphinQuery;
+class QLineEdit;
class KSeparator;
-class QFormLayout;
-class QPushButton;
+class QToolButton;
+class QScrollArea;
+class QLabel;
class QVBoxLayout;
+class KMoreToolsMenuFactory;
/**
- * @brief Input box for searching files with or without Nepomuk.
+ * @brief Input box for searching files with or without Baloo.
*
* The widget allows to specify:
* - Where to search: Everywhere or below the current directory
* - What to search: Filenames or content
*
- * If Nepomuk is available and the current folder is indexed, further
+ * If Baloo is available and the current folder is indexed, further
* options are offered.
*/
class DolphinSearchBox : public QWidget {
Q_OBJECT
public:
- explicit DolphinSearchBox(QWidget* parent = 0);
- virtual ~DolphinSearchBox();
+ explicit DolphinSearchBox(QWidget* parent = nullptr);
+ ~DolphinSearchBox() override;
/**
* Sets the text that should be used as input for
QString text() const;
/**
- * Sets the current path that is used as root for
- * searching files, if "From Here" has been selected.
+ * Sets the current path that is used as root for searching files.
+ * If @url is the Home dir, "From Here" is selected instead.
*/
- void setSearchPath(const KUrl& url);
- KUrl searchPath() const;
+ void setSearchPath(const QUrl& url);
+ QUrl searchPath() const;
/** @return URL that will start the searching of files. */
- KUrl urlForSearching() const;
+ QUrl urlForSearching() const;
+
+ /**
+ * Extracts information from the given search \a url to
+ * initialize the search box properly.
+ */
+ void fromSearchUrl(const QUrl& url);
/**
* Selects the whole text of the search box.
void selectAll();
/**
- * @param readOnly If set to true the searchbox cannot be modified
- * by the user and acts as visual indicator for
- * an externally triggered search query.
+ * Set the search box to the active mode, if \a active
+ * is true. The active mode is default. The inactive mode only differs
+ * visually from the active mode, no change of the behavior is given.
+ *
+ * Using the search box in the inactive mode is useful when having split views,
+ * where the inactive view is indicated by an search box visually.
*/
- void setReadOnly(bool readOnly);
- bool isReadOnly() const;
+ void setActive(bool active);
+
+ /**
+ * @return True, if the search box is in the active mode.
+ * @see DolphinSearchBox::setActive()
+ */
+ bool isActive() const;
protected:
- virtual bool event(QEvent* event);
- virtual void showEvent(QShowEvent* event);
- virtual void keyReleaseEvent(QKeyEvent* event);
+ bool event(QEvent* event) override;
+ void showEvent(QShowEvent* event) override;
+ void hideEvent(QHideEvent* event) override;
+ void keyReleaseEvent(QKeyEvent* event) override;
+ bool eventFilter(QObject* obj, QEvent* event) override;
-signals:
+Q_SIGNALS:
/**
- * Is emitted when a searching should be triggered
- * and provides the text that should be used as input
- * for searching.
+ * Is emitted when a searching should be triggered.
*/
- void search(const QString& text);
+ void searchRequest();
/**
* Is emitted when the user has changed a character of
*/
void searchTextChanged(const QString& text);
- void returnPressed(const QString& text);
-
/**
* Emitted as soon as the search box should get closed.
*/
void closeRequest();
-private slots:
- void emitSearchSignal();
+ /**
+ * Is emitted, if the searchbox has been activated by
+ * an user interaction
+ * @see DolphinSearchBox::setActive()
+ */
+ void activated();
+ void focusViewRequest();
+
+private Q_SLOTS:
+ void emitSearchRequest();
+ void emitCloseRequest();
void slotConfigurationChanged();
void slotSearchTextChanged(const QString& text);
- void slotReturnPressed(const QString& text);
+ void slotReturnPressed();
+ void slotFacetChanged();
+ void slotSearchSaved();
private:
- void initButton(QPushButton* button);
+ void initButton(QToolButton* button);
void loadSettings();
void saveSettings();
void init();
/**
- * @return URL that represents the Nepomuk query for starting the search.
+ * @return URL that represents the Baloo query for starting the search.
+ */
+ QUrl balooUrlForSearching() const;
+
+ /**
+ * Sets the searchbox UI with the parameters established by the \a query
*/
- KUrl nepomukUrlForSearching() const;
+ void updateFromQuery(const DolphinQuery& query);
+
+ void updateFacetsVisible();
- void applyReadOnlyState();
+ bool isIndexingEnabled() const;
private:
+ QString queryTitle(const QString& text) const;
+
bool m_startedSearching;
- bool m_readOnly;
+ bool m_active;
QVBoxLayout* m_topLayout;
- KLineEdit* m_searchInput;
- QPushButton* m_fileNameButton;
- QPushButton* m_contentButton;
+ QLineEdit* m_searchInput;
+ QAction* m_saveSearchAction;
+ QScrollArea* m_optionsScrollArea;
+ QToolButton* m_fileNameButton;
+ QToolButton* m_contentButton;
KSeparator* m_separator;
- QPushButton* m_fromHereButton;
- QPushButton* m_everywhereButton;
-
- QLabel* m_infoLabel;
+ QToolButton* m_fromHereButton;
+ QToolButton* m_everywhereButton;
+ DolphinFacetsWidget* m_facetsWidget;
- KUrl m_searchPath;
+ QUrl m_searchPath;
+ QScopedPointer<KMoreToolsMenuFactory> m_menuFactory;
QTimer* m_startSearchTimer;
};
projects / dolphin.git / blobdiff