Branch data     Line data    Source code

       1                 :            : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2                 :            : /*
       3                 :            :  * Version: MPL 1.1 / GPLv3+ / LGPLv3+
       4                 :            :  *
       5                 :            :  * The contents of this file are subject to the Mozilla Public License Version
       6                 :            :  * 1.1 (the "License"); you may not use this file except in compliance with
       7                 :            :  * the License or as specified alternatively below. You may obtain a copy of
       8                 :            :  * the License at http://www.mozilla.org/MPL/
       9                 :            :  *
      10                 :            :  * Software distributed under the License is distributed on an "AS IS" basis,
      11                 :            :  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
      12                 :            :  * for the specific language governing rights and limitations under the
      13                 :            :  * License.
      14                 :            :  *
      15                 :            :  * Major Contributor(s):
      16                 :            :  * Copyright (C) 2012 Gert van Valkenhoef <g.h.m.van.valkenhoef@rug.nl>
      17                 :            :  *  (initial developer)
      18                 :            :  *
      19                 :            :  * All Rights Reserved.
      20                 :            :  *
      21                 :            :  * For minor contributions see the git repository.
      22                 :            :  *
      23                 :            :  * Alternatively, the contents of this file may be used under the terms of
      24                 :            :  * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
      25                 :            :  * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
      26                 :            :  * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
      27                 :            :  * instead of those above.
      28                 :            :  */
      29                 :            : 
      30                 :            : #ifndef HELPSEARCH_HXX
      31                 :            : #define HELPSEARCH_HXX
      32                 :            : 
      33                 :            : #include <l10ntools/dllapi.h>
      34                 :            : 
      35                 :            : #include <rtl/ustring.hxx>
      36                 :            : #include <vector>
      37                 :            : 
      38                 :          0 : class L10N_DLLPUBLIC HelpSearch{
      39                 :            :         private:
      40                 :            :                 rtl::OUString d_lang;
      41                 :            :                 rtl::OString d_indexDir;
      42                 :            : 
      43                 :            :         public:
      44                 :            : 
      45                 :            :         /**
      46                 :            :          * @param lang Help files language.
      47                 :            :          * @param indexDir The directory where the index files are stored.
      48                 :            :          */
      49                 :            :         HelpSearch(rtl::OUString const &lang, rtl::OUString const &indexDir);
      50                 :            : 
      51                 :            :         /**
      52                 :            :          * Query the index for a certain query string.
      53                 :            :          * @param queryStr The query.
      54                 :            :          * @param captionOnly Set to true to search in the caption, not the content.
      55                 :            :          * @param rDocuments Vector to write the paths of the found documents.
      56                 :            :          * @param rScores Vector to write the scores to.
      57                 :            :          */
      58                 :            :         bool query(rtl::OUString const &queryStr, bool captionOnly,
      59                 :            :                 std::vector<rtl::OUString> &rDocuments, std::vector<float> &rScores);
      60                 :            : };
      61                 :            : 
      62                 :            : #endif
      63                 :            : 
      64                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */