summaryrefslogtreecommitdiffstats
path: root/include/helpcompiler/HelpSearch.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'include/helpcompiler/HelpSearch.hxx')
-rw-r--r--include/helpcompiler/HelpSearch.hxx42
1 files changed, 42 insertions, 0 deletions
diff --git a/include/helpcompiler/HelpSearch.hxx b/include/helpcompiler/HelpSearch.hxx
new file mode 100644
index 000000000..074373c43
--- /dev/null
+++ b/include/helpcompiler/HelpSearch.hxx
@@ -0,0 +1,42 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#ifndef INCLUDED_HELPCOMPILER_HELPSEARCH_HXX
+#define INCLUDED_HELPCOMPILER_HELPSEARCH_HXX
+
+#include <helpcompiler/dllapi.h>
+
+#include <rtl/ustring.hxx>
+#include <vector>
+
+class L10N_DLLPUBLIC HelpSearch{
+ private:
+ OString d_indexDir;
+
+ public:
+
+ /**
+ * @param indexDir The directory where the index files are stored.
+ */
+ HelpSearch(OUString const &indexDir);
+
+ /**
+ * Query the index for a certain query string.
+ * @param queryStr The query.
+ * @param captionOnly Set to true to search in the caption, not the content.
+ * @param rDocuments Vector to write the paths of the found documents.
+ * @param rScores Vector to write the scores to.
+ */
+ void query(OUString const &queryStr, bool captionOnly,
+ std::vector<OUString> &rDocuments, std::vector<float> &rScores);
+};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */