File indexing completed on 2024-05-05 04:40:51

0001 /*
0002     SPDX-FileCopyrightText: 2009 Aleix Pol <aleixpol@kde.org>
0003     SPDX-FileCopyrightText: 2010 Benjamin Port <port.benjamin@gmail.com>
0004     SPDX-FileCopyrightText: 2016 Andreas Cord-Landwehr <cordlandwehr@kde.org>
0005 
0006     SPDX-License-Identifier: LGPL-2.0-or-later
0007 */
0008 
0009 #ifndef QTHELPQTDOC_H
0010 #define QTHELPQTDOC_H
0011 
0012 #include "qthelpproviderabstract.h"
0013 
0014 class QtHelpQtDoc : public QtHelpProviderAbstract
0015 {
0016     Q_OBJECT
0017 public:
0018     explicit QtHelpQtDoc(QObject* parent, const QVariantList& args);
0019     ~QtHelpQtDoc();
0020 
0021     QIcon icon() const override;
0022     QString name() const override;
0023     void registerDocumentations();
0024     void loadDocumentation();
0025     void unloadDocumentation();
0026     /** @return local paths to all QCH files found in QT_INSTALL_DOCS directory **/
0027     QStringList qchFiles() const;
0028 
0029     /** @return true once the async initialization has finished */
0030     bool isInitialized() const { return m_isInitialized; }
0031 
0032 private:
0033     QString m_path;
0034     bool m_isInitialized = false;
0035 };
0036 
0037 #endif // QTHELPQTDOC_H