Setup/venv/Lib/site-packages/PyQt6/bindings/QtHelp/qhelpenginecore.sip

// qhelpenginecore.sip generated by MetaSIP
//
// This file is part of the QtHelp Python extension module.
//
// Copyright (c) 2026 Riverbank Computing Limited <info@riverbankcomputing.com>
// 
// This file is part of PyQt6.
// 
// This file may be used under the terms of the GNU General Public License
// version 3.0 as published by the Free Software Foundation and appearing in
// the file LICENSE included in the packaging of this file.  Please review the
// following information to ensure the GNU General Public License version 3.0
// requirements will be met: http://www.gnu.org/copyleft/gpl.html.
// 
// If you do not wish to use this file under the terms of the GPL version 3.0
// then you may purchase a commercial license.  For more information contact
// info@riverbankcomputing.com.
// 
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.


class QHelpEngineCore : public QObject
{
%TypeHeaderCode
#include <qhelpenginecore.h>
%End

%ConvertToSubClassCode
    static struct class_graph {
        const char *name;
        sipTypeDef **type;
        int yes, no;
    } graph[] = {
        {sipName_QHelpContentModel, &sipType_QHelpContentModel, -1, 1},
        {sipName_QHelpContentWidget, &sipType_QHelpContentWidget, -1, 2},
        {sipName_QHelpEngineCore, &sipType_QHelpEngineCore, 11, 3},
        {sipName_QHelpFilterEngine, &sipType_QHelpFilterEngine, -1, 4},
        {sipName_QHelpFilterSettingsWidget, &sipType_QHelpFilterSettingsWidget, -1, 5},
        {sipName_QHelpIndexModel, &sipType_QHelpIndexModel, -1, 6},
        {sipName_QHelpIndexWidget, &sipType_QHelpIndexWidget, -1, 7},
        {sipName_QHelpSearchEngine, &sipType_QHelpSearchEngine, -1, 8},
    #if QT_VERSION >= 0x060800
        {sipName_QHelpSearchEngineCore, &sipType_QHelpSearchEngineCore, -1, 9},
    #else
        {0, 0, -1, 9},
    #endif
        {sipName_QHelpSearchQueryWidget, &sipType_QHelpSearchQueryWidget, -1, 10},
        {sipName_QHelpSearchResultWidget, &sipType_QHelpSearchResultWidget, -1, -1},
        {sipName_QHelpEngine, &sipType_QHelpEngine, -1, -1},
    };
    
    int i = 0;
    
    sipType = NULL;
    
    do
    {
        struct class_graph *cg = &graph[i];
    
        if (cg->name != NULL && sipCpp->inherits(cg->name))
        {
            sipType = *cg->type;
            i = cg->yes;
        }
        else
            i = cg->no;
    }
    while (i >= 0);
%End

public:
    QHelpEngineCore(const QString &collectionFile, QObject *parent /TransferThis/ = 0);
    virtual ~QHelpEngineCore();
    bool setupData();
    QString collectionFile() const;
    void setCollectionFile(const QString &fileName);
    bool copyCollectionFile(const QString &fileName);
    static QString namespaceName(const QString &documentationFileName);
    bool registerDocumentation(const QString &documentationFileName);
    bool unregisterDocumentation(const QString &namespaceName);
    QString documentationFileName(const QString &namespaceName);
    QStringList registeredDocumentations() const;
    QUrl findFile(const QUrl &url) const;
    QByteArray fileData(const QUrl &url) const;
    bool removeCustomValue(const QString &key);
    QVariant customValue(const QString &key, const QVariant &defaultValue = QVariant()) const;
    bool setCustomValue(const QString &key, const QVariant &value);
    static QVariant metaData(const QString &documentationFileName, const QString &name);
    QString error() const;
    bool autoSaveFilter() const;
    void setAutoSaveFilter(bool save);

signals:
    void setupStarted();
    void setupFinished();
    void warning(const QString &msg);

public:
    QHelpFilterEngine *filterEngine() const;
    QList<QUrl> files(const QString namespaceName, const QString &filterName, const QString &extensionFilter = QString());
    void setUsesFilterEngine(bool uses);
    bool usesFilterEngine() const;
    QList<QHelpLink> documentsForIdentifier(const QString &id) const;
    QList<QHelpLink> documentsForIdentifier(const QString &id, const QString &filterName) const;
    QList<QHelpLink> documentsForKeyword(const QString &keyword) const;
    QList<QHelpLink> documentsForKeyword(const QString &keyword, const QString &filterName) const;
    bool isReadOnly() const;
    void setReadOnly(bool enable);
};