]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/search/dolphinsearchbox.h
Improve drawing selected items in Compact/Details View and Places Panel
[dolphin.git] / src / search / dolphinsearchbox.h
index 8af32b377f17f4f75cb0e954f21a4cfc58e7cd0b..53b12ffabbb8ff15d6143e6f5014cd2a8906758b 100644 (file)
 #include <QList>
 #include <QWidget>
 
-class AbstractSearchFilterWidget;
+class DolphinFacetsWidget;
 class KLineEdit;
 class KSeparator;
-class QFormLayout;
 class QToolButton;
 class QScrollArea;
 class QLabel;
 class QVBoxLayout;
 
 /**
- * @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();
 
@@ -82,34 +71,44 @@ public:
     /** @return URL that will start the searching of files. */
     KUrl urlForSearching() const;
 
+    /**
+     * Extracts information from the given search \a url to
+     * initialize the search box properly.
+     */
+    void fromSearchUrl(const KUrl& 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.
-     * @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);
+    virtual bool eventFilter(QObject* obj, QEvent* event);
 
 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
@@ -120,27 +119,25 @@ signals:
     void returnPressed(const QString& text);
 
     /**
-     * Is emitted if the search location has been changed by the user.
+     * Emitted as soon as the search box should get closed.
      */
-    void searchLocationChanged(SearchLocation location);
+    void closeRequest();
 
     /**
-     * Is emitted if the search context has been changed by the user.
+     * Is emitted, if the searchbox has been activated by
+     * an user interaction
+     * @see DolphinSearchBox::setActive()
      */
-    void searchContextChanged(SearchContext context);
-
-    /**
-     * Emitted as soon as the search box should get closed.
-     */
-    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 slotFacetsButtonToggled();
+    void slotFacetChanged();
 
 private:
     void initButton(QToolButton* button);
@@ -149,15 +146,20 @@ 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.
      */
-    KUrl nepomukUrlForSearching() const;
+    KUrl balooUrlForSearching() const;
 
-    void applyReadOnlyState();
+    /**
+     * Extracts information from the given Baloo search \a url to
+     * initialize the search box properly.
+     */
+    void fromBalooSearchUrl(const KUrl& url);
 
+    void updateFacetsToggleButton();
 private:
     bool m_startedSearching;
-    bool m_readOnly;
+    bool m_active;
 
     QVBoxLayout* m_topLayout;
 
@@ -169,9 +171,10 @@ private:
     KSeparator* m_separator;
     QToolButton* m_fromHereButton;
     QToolButton* m_everywhereButton;
+    QToolButton* m_facetsToggleButton;
+    DolphinFacetsWidget* m_facetsWidget;
 
     KUrl m_searchPath;
-    KUrl m_readOnlyQuery;
 
     QTimer* m_startSearchTimer;
 };