Line data    Source code

       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 HELPSEARCH_HXX
      11             : #define HELPSEARCH_HXX
      12             : 
      13             : #include <helpcompiler/dllapi.h>
      14             : 
      15             : #include <rtl/ustring.hxx>
      16             : #include <vector>
      17             : 
      18           0 : class L10N_DLLPUBLIC HelpSearch{
      19             :         private:
      20             :                 OUString d_lang;
      21             :                 OString d_indexDir;
      22             : 
      23             :         public:
      24             : 
      25             :         /**
      26             :          * @param lang Help files language.
      27             :          * @param indexDir The directory where the index files are stored.
      28             :          */
      29             :         HelpSearch(OUString const &lang, OUString const &indexDir);
      30             : 
      31             :         /**
      32             :          * Query the index for a certain query string.
      33             :          * @param queryStr The query.
      34             :          * @param captionOnly Set to true to search in the caption, not the content.
      35             :          * @param rDocuments Vector to write the paths of the found documents.
      36             :          * @param rScores Vector to write the scores to.
      37             :          */
      38             :         bool query(OUString const &queryStr, bool captionOnly,
      39             :             std::vector<OUString> &rDocuments, std::vector<float> &rScores);
      40             : };
      41             : 
      42             : #endif
      43             : 
      44             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */