┌   ┐
54
└   ┘

summaryrefslogtreecommitdiff
path: root/src/search/dolphinquery.h
diff options
context:
space:
mode:
authorIsmael Asensio <[email protected]>2019-11-13 22:16:35 +0100
committerIsmael Asensio <[email protected]>2019-11-13 22:21:07 +0100
commit8d92c8be7f117dee18710ee1ba6b7cfa45d3f5f0 (patch)
tree57488f5813f057727a5f64bdd473b72c8d5942a7 /src/search/dolphinquery.h
parent3984e607bb4437a38af16e007f1c23fbcff7dfb2 (diff)
refactor(search): De-couple baloo URL parsing logic from UI
Summary: Extracts the logic that parses `baloosearch:` urls into a new model class. The parser logic itself is kept as is. The search box UI is later updated using the model fields. This refactor has been proposed by @bruns in the review of D24422, as it largely simplifies the unit tests and further expansion/improvements. Test Plan: No behavior changes. Test case is added in the follow-up revision: D25258 Reviewers: #dolphin, elvisangelaccio, bruns Reviewed By: #dolphin, elvisangelaccio, bruns Subscribers: ngraham, bruns, kfm-devel Tags: #dolphin Differential Revision: https://phabricator.kde.org/D25257
Diffstat (limited to 'src/search/dolphinquery.h')
-rw-r--r--src/search/dolphinquery.h60
1 files changed, 60 insertions, 0 deletions
diff --git a/src/search/dolphinquery.h b/src/search/dolphinquery.h
new file mode 100644
index 000000000..736abf66f
--- /dev/null
+++ b/src/search/dolphinquery.h
@@ -0,0 +1,60 @@
+/***************************************************************************
+ * Copyright (C) 2019 by Ismael Asensio <[email protected]> *
+ * *
+ * 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 *
+ ***************************************************************************/
+
+#ifndef DOLPHINQUERY_H
+#define DOLPHINQUERY_H
+
+#include "dolphin_export.h"
+
+#include <QString>
+#include <QUrl>
+
+/**
+ * @brief Simple query model that parses a Baloo search Url and extracts its
+ * separate components to be displayed on dolphin search box.
+ */
+class DOLPHIN_EXPORT DolphinQuery
+{
+public:
+ /** Calls Baloo::Query::fromSearchUrl() with the given @p searchUrl
+ * and parses the result to extract its separate components */
+ static DolphinQuery fromBalooSearchUrl(const QUrl& searchUrl);
+
+ /** @return the \a searchUrl passed to Baloo::Query::fromSearchUrl() */
+ QUrl searchUrl() const;
+ /** @return the user text part of the query, to be shown in the searchbar */
+ QString text() const;
+ /** @return the first of Baloo::Query::types(), or an empty string */
+ QString type() const;
+ /** @return a list of the search terms of the Baloo::Query that act as a filter,
+ * such as \"rating>= <i>value<i>\" or \"modified>= <i>date<i>\"*/
+ QStringList searchTerms() const;
+ /** @return Baloo::Query::includeFolder(), that is, the initial directory
+ * for the query or an empty string if its a global search" */
+ QString includeFolder() const;
+
+private:
+ QUrl m_searchUrl;
+ QString m_searchText;
+ QString m_fileType;
+ QStringList m_searchTerms;
+ QString m_includeFolder;
+};
+
+#endif //DOLPHINQUERY_H