/***************************************************************************
- * Copyright (C) 2009 by Peter Penz <peter.penz@gmx.at> *
- * Copyright (C) 2009 by Matthias Fuchs <mat69@gmx.net> *
+ * 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 *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
+
#ifndef DOLPHINSEARCHBOX_H
#define DOLPHINSEARCHBOX_H
+#include <QUrl>
#include <QWidget>
-#include <KIcon>
-
-class KLineEdit;
-class KUrl;
-class QCompleter;
-class QModelIndex;
-class QStandardItemModel;
+class DolphinFacetsWidget;
+class DolphinQuery;
+class QLineEdit;
+class KSeparator;
+class QToolButton;
+class QScrollArea;
+class QLabel;
+class QVBoxLayout;
+class KMoreToolsMenuFactory;
/**
- * @brief Helper class used for completition for the DolphinSearchBox.
+ * @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 Baloo is available and the current folder is indexed, further
+ * options are offered.
*/
-class DolphinSearchCompleter : public QObject
-{
+class DolphinSearchBox : public QWidget {
Q_OBJECT
public:
- DolphinSearchCompleter(KLineEdit *linedit);
+ explicit DolphinSearchBox(QWidget* parent = nullptr);
+ ~DolphinSearchBox() override;
-public slots:
- void highlighted(const QModelIndex& index);
- void slotTextEdited(const QString &text);
+ /**
+ * Sets the text that should be used as input for
+ * searching.
+ */
+ void setText(const QString& text);
-private:
- void addCompletionItem(const QString& displayed, const QString& usedForCompletition, const QString& description = QString(), const QString& toolTip = QString(), const KIcon& icon = KIcon());
+ /**
+ * Returns the text that should be used as input
+ * for searching.
+ */
+ QString text() const;
- void findText(int* wordStart, int* wordEnd, QString* newWord, int cursorPos, const QString &input);
+ /**
+ * 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 QUrl& url);
+ QUrl searchPath() const;
-private:
- KLineEdit* q;
- QCompleter* m_completer;
- QStandardItemModel* m_completionModel;
- QString m_userText;
- int m_wordStart;
- int m_wordEnd;
-};
+ /** @return URL that will start the searching of files. */
+ QUrl urlForSearching() const;
-/**
- * @brief Input box for searching files with Nepomuk.
- */
-class DolphinSearchBox : public QWidget
-{
- Q_OBJECT
+ /**
+ * Extracts information from the given search \a url to
+ * initialize the search box properly.
+ */
+ void fromSearchUrl(const QUrl& url);
-public:
- DolphinSearchBox(QWidget* parent = 0);
- virtual ~DolphinSearchBox();
+ /**
+ * Selects the whole text of the search box.
+ */
+ void selectAll();
/**
- * Returns the text that should be used as input
- * for searching.
+ * 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.
*/
- QString text() 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 bool eventFilter(QObject* watched, QEvent* 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:
/**
- * Is emitted when the user pressed Return or Enter
- * and provides the text that should be used as input
- * for searching.
+ * Is emitted when a searching should be triggered.
+ */
+ void searchRequest();
+
+ /**
+ * Is emitted when the user has changed a character of
+ * the text that should be used as input for searching.
*/
- void search(const QString& text);
+ void searchTextChanged(const QString& text);
/**
- * Is emitted if the search box gets the focus and
- * requests the need for a UI that allows to adjust
- * search options. It is up to the application to ignore
- * this request.
+ * Emitted as soon as the search box should get closed.
*/
- void requestSearchOptions();
+ void closeRequest();
+
+ /**
+ * Is emitted, if the searchbox has been activated by
+ * an user interaction
+ * @see DolphinSearchBox::setActive()
+ */
+ void activated();
+ void focusViewRequest();
private slots:
- void emitSearchSignal();
+ void emitSearchRequest();
+ void emitCloseRequest();
+ void slotConfigurationChanged();
+ void slotSearchTextChanged(const QString& text);
+ void slotReturnPressed();
+ void slotFacetChanged();
+ void slotSearchSaved();
private:
- KLineEdit* m_searchInput;
- DolphinSearchCompleter* m_completer;
+ void initButton(QToolButton* button);
+ void loadSettings();
+ void saveSettings();
+ void init();
+
+ /**
+ * @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
+ */
+ void updateFromQuery(const DolphinQuery& query);
+
+ void updateFacetsVisible();
+
+ bool isIndexingEnabled() const;
+
+private:
+ QString queryTitle(const QString& text) const;
+
+ bool m_startedSearching;
+ bool m_active;
+
+ QVBoxLayout* m_topLayout;
+
+ QLineEdit* m_searchInput;
+ QAction* m_saveSearchAction;
+ QScrollArea* m_optionsScrollArea;
+ QToolButton* m_fileNameButton;
+ QToolButton* m_contentButton;
+ KSeparator* m_separator;
+ QToolButton* m_fromHereButton;
+ QToolButton* m_everywhereButton;
+ DolphinFacetsWidget* m_facetsWidget;
+
+ QUrl m_searchPath;
+ QScopedPointer<KMoreToolsMenuFactory> m_menuFactory;
+
+ QTimer* m_startSearchTimer;
};
#endif
projects / dolphin.git / blobdiff