qhelpsearchindexreader_p.h 2.92 KiB
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
** $QT_END_LICENSE$
****************************************************************************/
#ifndef QHELPSEARCHINDEXREADER_H
#define QHELPSEARCHINDEXREADER_H
//  W A R N I N G
//  -------------
// This file is not part of the Qt API. It exists for the convenience
// of the help generator tools. This header file may change from version
// to version without notice, or even be removed.
// We mean it.
#include "qhelpsearchengine.h"
#include <QtCore/QList>
#include <QtCore/QMutex>
#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtCore/QThread>
#include <QtCore/QWaitCondition>
QT_BEGIN_NAMESPACE
class QHelpEngineCore;
namespace fulltextsearch {
class QHelpSearchIndexReader : public QThread
    Q_OBJECT
public:
    QHelpSearchIndexReader();
    ~QHelpSearchIndexReader();
7172737475767778798081828384858687888990919293949596979899
void cancelSearching(); void search(const QString &collectionFile, const QString &indexFilesFolder, const QList<QHelpSearchQuery> &queryList); int hitCount() const; QList<QHelpSearchEngine::SearchHit> hits(int start, int end) const; signals: void searchingStarted(); void searchingFinished(int hits); protected: mutable QMutex mutex; QList<QHelpSearchEngine::SearchHit> hitList; bool m_cancel; QString m_collectionFile; QList<QHelpSearchQuery> m_query; QString m_indexFilesFolder; private: virtual void run()=0; }; } // namespace fulltextsearch QT_END_NAMESPACE #endif // QHELPSEARCHINDEXREADER_H