include/helpcompiler/HelpSearch.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef INCLUDED_HELPCOMPILER_HELPSEARCH_HXX
  11 #define INCLUDED_HELPCOMPILER_HELPSEARCH_HXX
  12
  13 #include <helpcompiler/dllapi.h>
  14
  15 #include <rtl/ustring.hxx>
  16 #include <vector>
  17
  18 class L10N_DLLPUBLIC HelpSearch{
  19     private:
  20                 OString d_indexDir;
  21
  22     public:
  23
  24     /**
  25      * @param indexDir The directory where the index files are stored.
  26      */
  27         HelpSearch(OUString const &indexDir);
  28
  29     /**
  30      * Query the index for a certain query string.
  31      * @param queryStr The query.
  32      * @param captionOnly Set to true to search in the caption, not the content.
  33      * @param rDocuments Vector to write the paths of the found documents.
  34      * @param rScores Vector to write the scores to.
  35      */
  36         void query(OUString const &queryStr, bool captionOnly,
  37             std::vector<OUString> &rDocuments, std::vector<float> &rScores);
  38 };
  39
  40 #endif
  41
  42 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */