]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/search/dolphinsearchbox.h
Hide search extra options when not available
[dolphin.git] / src / search / dolphinsearchbox.h
index 2b4632bb1aa7fc3f00000f0b95bb51b9fc1dbc17..e70317450707f7b01cf4a49075bbb96db4b7a0a3 100644 (file)
 #ifndef DOLPHINSEARCHBOX_H
 #define DOLPHINSEARCHBOX_H
 
-#include <KUrl>
-#include <QList>
+#include <QUrl>
 #include <QWidget>
 
 class DolphinFacetsWidget;
-class KLineEdit;
+class QLineEdit;
 class KSeparator;
 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:
-    enum SearchContext {
-        SearchFileName,
-        SearchContent
-    };
-
-    enum SearchLocation {
-        SearchFromHere,
-        SearchEverywhere
-    };
-
-    explicit DolphinSearchBox(QWidget* parent = 0);
-    virtual ~DolphinSearchBox();
+    explicit DolphinSearchBox(QWidget* parent = nullptr);
+    ~DolphinSearchBox() override;
 
     /**
      * Sets the text that should be used as input for
@@ -75,11 +65,17 @@ public:
      * Sets the current path that is used as root for
      * searching files, if "From Here" has been selected.
      */
-    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.
@@ -87,28 +83,33 @@ public:
     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.
-     * @param query    If readOnly is true this URL will be used
-     *                 to show a human readable information about the
-     *                 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, const KUrl& query = KUrl());
-    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:
     /**
-     * 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
@@ -116,31 +117,29 @@ signals:
      */
     void searchTextChanged(const QString& text);
 
-    void returnPressed(const QString& text);
+    void returnPressed();
 
     /**
-     * Is emitted if the search location has been changed by the user.
-     */
-    void searchLocationChanged(SearchLocation location);
-
-    /**
-     * Is emitted if the search context has been changed by the user.
+     * Emitted as soon as the search box should get closed.
      */
-    void searchContextChanged(SearchContext context);
+    void closeRequest();
 
     /**
-     * Emitted as soon as the search box should get closed.
+     * Is emitted, if the searchbox has been activated by
+     * an user interaction
+     * @see DolphinSearchBox::setActive()
      */
-    void closeRequest();
+    void activated();
 
 private slots:
-    void emitSearchSignal();
-    void slotSearchLocationChanged();
-    void slotSearchContextChanged();
+    void emitSearchRequest();
+    void emitCloseRequest();
     void slotConfigurationChanged();
     void slotSearchTextChanged(const QString& text);
-    void slotReturnPressed(const QString& text);
+    void slotReturnPressed();
     void slotFacetsButtonToggled();
+    void slotFacetChanged();
+    void slotSearchSaved();
 
 private:
     void initButton(QToolButton* button);
@@ -149,22 +148,29 @@ private:
     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;
+
+    /**
+     * Extracts information from the given Baloo search \a url to
+     * initialize the search box properly.
      */
-    KUrl nepomukUrlForSearching() const;
+    void fromBalooSearchUrl(const QUrl& url);
 
-    void applyReadOnlyState();
+    void setFacetsVisible(bool visible);
+    void updateFacetsToggleButton();
 
-    void updateFacetsToggleButtonIcon();
+    bool isIndexingEnabled() const;
 
 private:
     bool m_startedSearching;
-    bool m_readOnly;
+    bool m_active;
 
     QVBoxLayout* m_topLayout;
 
-    QLabel* m_searchLabel;
-    KLineEdit* m_searchInput;
+    QLineEdit* m_searchInput;
+    QAction* m_saveSearchAction;
     QScrollArea* m_optionsScrollArea;
     QToolButton* m_fileNameButton;
     QToolButton* m_contentButton;
@@ -174,8 +180,8 @@ private:
     QToolButton* m_facetsToggleButton;
     DolphinFacetsWidget* m_facetsWidget;
 
-    KUrl m_searchPath;
-    KUrl m_readOnlyQuery;
+    QUrl m_searchPath;
+    QScopedPointer<KMoreToolsMenuFactory> m_menuFactory;
 
     QTimer* m_startSearchTimer;
 };