initial
This commit is contained in:
rattatwinko
@@ -0,0 +1,6 @@
|
||||
# Automatically generated configuration for PyQt5.QtHelp.
|
||||
|
||||
sip-version = "6.8.6"
|
||||
sip-abi-version = "12.15"
|
||||
module-tags = ["Qt_5_15_14", "WS_X11"]
|
||||
module-disabled-features = []
|
||||
@@ -0,0 +1,61 @@
|
||||
// QtHelpmod.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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.
|
||||
|
||||
|
||||
%Module(name=PyQt5.QtHelp, keyword_arguments="Optional", use_limited_api=True)
|
||||
|
||||
%Import QtCore/QtCoremod.sip
|
||||
%Import QtGui/QtGuimod.sip
|
||||
%Import QtWidgets/QtWidgetsmod.sip
|
||||
|
||||
%Copying
|
||||
Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
|
||||
This file is part of PyQt5.
|
||||
|
||||
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.
|
||||
%End
|
||||
|
||||
%DefaultSupertype sip.simplewrapper
|
||||
|
||||
%Include qcompressedhelpinfo.sip
|
||||
%Include qhelpcontentwidget.sip
|
||||
%Include qhelpengine.sip
|
||||
%Include qhelpenginecore.sip
|
||||
%Include qhelpfilterdata.sip
|
||||
%Include qhelpfilterengine.sip
|
||||
%Include qhelpfiltersettingswidget.sip
|
||||
%Include qhelpindexwidget.sip
|
||||
%Include qhelplink.sip
|
||||
%Include qhelpsearchengine.sip
|
||||
%Include qhelpsearchquerywidget.sip
|
||||
%Include qhelpsearchresultwidget.sip
|
||||
@@ -0,0 +1,45 @@
|
||||
// qcompressedhelpinfo.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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.
|
||||
|
||||
|
||||
%If (Qt_5_13_0 -)
|
||||
|
||||
class QCompressedHelpInfo
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qcompressedhelpinfo.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
QCompressedHelpInfo();
|
||||
QCompressedHelpInfo(const QCompressedHelpInfo &other);
|
||||
~QCompressedHelpInfo();
|
||||
void swap(QCompressedHelpInfo &other);
|
||||
QString namespaceName() const;
|
||||
QString component() const;
|
||||
QVersionNumber version() const;
|
||||
static QCompressedHelpInfo fromCompressedHelpFile(const QString &documentationFileName);
|
||||
%If (Qt_5_15_0 -)
|
||||
bool isNull() const;
|
||||
%End
|
||||
};
|
||||
|
||||
%End
|
||||
@@ -0,0 +1,76 @@
|
||||
// qhelpcontentwidget.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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 QHelpContentItem /NoDefaultCtors/
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpcontentwidget.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
~QHelpContentItem();
|
||||
QHelpContentItem *child(int row) const;
|
||||
int childCount() const;
|
||||
QString title() const;
|
||||
QUrl url() const;
|
||||
int row() const;
|
||||
QHelpContentItem *parent() const;
|
||||
int childPosition(QHelpContentItem *child) const;
|
||||
};
|
||||
|
||||
class QHelpContentModel : public QAbstractItemModel /NoDefaultCtors/
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpcontentwidget.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
virtual ~QHelpContentModel();
|
||||
void createContents(const QString &customFilterName);
|
||||
QHelpContentItem *contentItemAt(const QModelIndex &index) const;
|
||||
virtual QVariant data(const QModelIndex &index, int role) const;
|
||||
virtual QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const;
|
||||
virtual QModelIndex parent(const QModelIndex &index) const;
|
||||
virtual int rowCount(const QModelIndex &parent = QModelIndex()) const;
|
||||
virtual int columnCount(const QModelIndex &parent = QModelIndex()) const;
|
||||
bool isCreatingContents() const;
|
||||
|
||||
signals:
|
||||
void contentsCreationStarted();
|
||||
void contentsCreated();
|
||||
};
|
||||
|
||||
class QHelpContentWidget : public QTreeView
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpcontentwidget.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
QModelIndex indexOf(const QUrl &link);
|
||||
|
||||
signals:
|
||||
void linkActivated(const QUrl &link);
|
||||
|
||||
private:
|
||||
QHelpContentWidget();
|
||||
};
|
||||
@@ -0,0 +1,37 @@
|
||||
// qhelpengine.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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 QHelpEngine : public QHelpEngineCore
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpengine.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
QHelpEngine(const QString &collectionFile, QObject *parent /TransferThis/ = 0);
|
||||
virtual ~QHelpEngine();
|
||||
QHelpContentModel *contentModel() const;
|
||||
QHelpIndexModel *indexModel() const;
|
||||
QHelpContentWidget *contentWidget();
|
||||
QHelpIndexWidget *indexWidget();
|
||||
QHelpSearchEngine *searchEngine();
|
||||
};
|
||||
@@ -0,0 +1,144 @@
|
||||
// qhelpenginecore.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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, 10, 3},
|
||||
#if QT_VERSION >= 0x050d00
|
||||
{sipName_QHelpFilterEngine, &sipType_QHelpFilterEngine, -1, 4},
|
||||
#else
|
||||
{0, 0, -1, 4},
|
||||
#endif
|
||||
#if QT_VERSION >= 0x050f00
|
||||
{sipName_QHelpFilterSettingsWidget, &sipType_QHelpFilterSettingsWidget, -1, 5},
|
||||
#else
|
||||
{0, 0, -1, 5},
|
||||
#endif
|
||||
{sipName_QHelpIndexModel, &sipType_QHelpIndexModel, -1, 6},
|
||||
{sipName_QHelpIndexWidget, &sipType_QHelpIndexWidget, -1, 7},
|
||||
{sipName_QHelpSearchEngine, &sipType_QHelpSearchEngine, -1, 8},
|
||||
{sipName_QHelpSearchQueryWidget, &sipType_QHelpSearchQueryWidget, -1, 9},
|
||||
{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 customFilters() const;
|
||||
bool removeCustomFilter(const QString &filterName);
|
||||
bool addCustomFilter(const QString &filterName, const QStringList &attributes);
|
||||
QStringList filterAttributes() const;
|
||||
QStringList filterAttributes(const QString &filterName) const;
|
||||
QString currentFilter() const;
|
||||
void setCurrentFilter(const QString &filterName);
|
||||
QStringList registeredDocumentations() const;
|
||||
QList<QStringList> filterAttributeSets(const QString &namespaceName) const;
|
||||
QList<QUrl> files(const QString namespaceName, const QStringList &filterAttributes, const QString &extensionFilter = QString());
|
||||
QUrl findFile(const QUrl &url) const;
|
||||
QByteArray fileData(const QUrl &url) const;
|
||||
QMap<QString, QUrl> linksForIdentifier(const QString &id) const;
|
||||
%If (Qt_5_9_0 -)
|
||||
QMap<QString, QUrl> linksForKeyword(const QString &keyword) const;
|
||||
%End
|
||||
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 currentFilterChanged(const QString &newFilter);
|
||||
void warning(const QString &msg);
|
||||
%If (Qt_5_4_0 -)
|
||||
void readersAboutToBeInvalidated();
|
||||
%End
|
||||
|
||||
public:
|
||||
%If (Qt_5_13_0 -)
|
||||
QHelpFilterEngine *filterEngine() const;
|
||||
%End
|
||||
%If (Qt_5_13_0 -)
|
||||
QList<QUrl> files(const QString namespaceName, const QString &filterName, const QString &extensionFilter = QString());
|
||||
%End
|
||||
%If (Qt_5_13_0 -)
|
||||
void setUsesFilterEngine(bool uses);
|
||||
%End
|
||||
%If (Qt_5_13_0 -)
|
||||
bool usesFilterEngine() const;
|
||||
%End
|
||||
%If (Qt_5_15_0 -)
|
||||
QList<QHelpLink> documentsForIdentifier(const QString &id) const;
|
||||
%End
|
||||
%If (Qt_5_15_0 -)
|
||||
QList<QHelpLink> documentsForIdentifier(const QString &id, const QString &filterName) const;
|
||||
%End
|
||||
%If (Qt_5_15_0 -)
|
||||
QList<QHelpLink> documentsForKeyword(const QString &keyword) const;
|
||||
%End
|
||||
%If (Qt_5_15_0 -)
|
||||
QList<QHelpLink> documentsForKeyword(const QString &keyword, const QString &filterName) const;
|
||||
%End
|
||||
};
|
||||
@@ -0,0 +1,43 @@
|
||||
// qhelpfilterdata.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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.
|
||||
|
||||
|
||||
%If (Qt_5_13_0 -)
|
||||
|
||||
class QHelpFilterData
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpfilterdata.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
QHelpFilterData();
|
||||
QHelpFilterData(const QHelpFilterData &other);
|
||||
~QHelpFilterData();
|
||||
bool operator==(const QHelpFilterData &other) const;
|
||||
void swap(QHelpFilterData &other);
|
||||
void setComponents(const QStringList &components);
|
||||
void setVersions(const QList<QVersionNumber> &versions);
|
||||
QStringList components() const;
|
||||
QList<QVersionNumber> versions() const;
|
||||
};
|
||||
|
||||
%End
|
||||
@@ -0,0 +1,61 @@
|
||||
// qhelpfilterengine.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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.
|
||||
|
||||
|
||||
%If (Qt_5_13_0 -)
|
||||
|
||||
class QHelpFilterEngine : public QObject /NoDefaultCtors/
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpfilterengine.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
QMap<QString, QString> namespaceToComponent() const;
|
||||
QMap<QString, QVersionNumber> namespaceToVersion() const;
|
||||
QStringList filters() const;
|
||||
QString activeFilter() const;
|
||||
bool setActiveFilter(const QString &filterName);
|
||||
QStringList availableComponents() const;
|
||||
QHelpFilterData filterData(const QString &filterName) const;
|
||||
bool setFilterData(const QString &filterName, const QHelpFilterData &filterData);
|
||||
bool removeFilter(const QString &filterName);
|
||||
QStringList namespacesForFilter(const QString &filterName) const;
|
||||
|
||||
signals:
|
||||
void filterActivated(const QString &newFilter);
|
||||
|
||||
protected:
|
||||
virtual ~QHelpFilterEngine();
|
||||
|
||||
public:
|
||||
%If (Qt_5_15_0 -)
|
||||
QList<QVersionNumber> availableVersions() const;
|
||||
%End
|
||||
%If (Qt_5_15_0 -)
|
||||
QStringList indices() const;
|
||||
%End
|
||||
%If (Qt_5_15_0 -)
|
||||
QStringList indices(const QString &filterName) const;
|
||||
%End
|
||||
};
|
||||
|
||||
%End
|
||||
@@ -0,0 +1,40 @@
|
||||
// qhelpfiltersettingswidget.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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.
|
||||
|
||||
|
||||
%If (Qt_5_15_0 -)
|
||||
|
||||
class QHelpFilterSettingsWidget : public QWidget
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpfiltersettingswidget.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
explicit QHelpFilterSettingsWidget(QWidget *parent /TransferThis/ = 0);
|
||||
virtual ~QHelpFilterSettingsWidget();
|
||||
void setAvailableComponents(const QStringList &components);
|
||||
void setAvailableVersions(const QList<QVersionNumber> &versions);
|
||||
void readSettings(const QHelpFilterEngine *filterEngine);
|
||||
bool applySettings(QHelpFilterEngine *filterEngine) const;
|
||||
};
|
||||
|
||||
%End
|
||||
@@ -0,0 +1,70 @@
|
||||
// qhelpindexwidget.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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 QHelpIndexModel : public QStringListModel /NoDefaultCtors/
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpindexwidget.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
%If (Qt_5_15_0 -)
|
||||
QHelpEngineCore *helpEngine() const;
|
||||
%End
|
||||
void createIndex(const QString &customFilterName);
|
||||
QModelIndex filter(const QString &filter, const QString &wildcard = QString());
|
||||
QMap<QString, QUrl> linksForKeyword(const QString &keyword) const;
|
||||
bool isCreatingIndex() const;
|
||||
|
||||
signals:
|
||||
void indexCreationStarted();
|
||||
void indexCreated();
|
||||
|
||||
private:
|
||||
virtual ~QHelpIndexModel();
|
||||
};
|
||||
|
||||
class QHelpIndexWidget : public QListView
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpindexwidget.h>
|
||||
%End
|
||||
|
||||
signals:
|
||||
void linkActivated(const QUrl &link, const QString &keyword);
|
||||
void linksActivated(const QMap<QString, QUrl> &links, const QString &keyword);
|
||||
|
||||
public slots:
|
||||
void filterIndices(const QString &filter, const QString &wildcard = QString());
|
||||
void activateCurrentItem();
|
||||
|
||||
signals:
|
||||
%If (Qt_5_15_0 -)
|
||||
void documentActivated(const QHelpLink &document, const QString &keyword);
|
||||
%End
|
||||
%If (Qt_5_15_0 -)
|
||||
void documentsActivated(const QList<QHelpLink> &documents, const QString &keyword);
|
||||
%End
|
||||
|
||||
private:
|
||||
QHelpIndexWidget();
|
||||
};
|
||||
@@ -0,0 +1,35 @@
|
||||
// qhelplink.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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.
|
||||
|
||||
|
||||
%If (Qt_5_15_0 -)
|
||||
|
||||
struct QHelpLink
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelplink.h>
|
||||
%End
|
||||
|
||||
QUrl url;
|
||||
QString title;
|
||||
};
|
||||
|
||||
%End
|
||||
@@ -0,0 +1,106 @@
|
||||
// qhelpsearchengine.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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 QHelpSearchQuery
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpsearchengine.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
enum FieldName
|
||||
{
|
||||
DEFAULT,
|
||||
FUZZY,
|
||||
WITHOUT,
|
||||
PHRASE,
|
||||
ALL,
|
||||
ATLEAST,
|
||||
};
|
||||
|
||||
QHelpSearchQuery();
|
||||
QHelpSearchQuery(QHelpSearchQuery::FieldName field, const QStringList &wordList);
|
||||
};
|
||||
|
||||
class QHelpSearchEngine : public QObject
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpsearchengine.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
QHelpSearchEngine(QHelpEngineCore *helpEngine, QObject *parent /TransferThis/ = 0);
|
||||
virtual ~QHelpSearchEngine();
|
||||
QList<QHelpSearchQuery> query() const;
|
||||
QHelpSearchQueryWidget *queryWidget();
|
||||
QHelpSearchResultWidget *resultWidget();
|
||||
int hitCount() const;
|
||||
QList<QPair<QString, QString>> hits(int start, int end) const;
|
||||
|
||||
public slots:
|
||||
void reindexDocumentation();
|
||||
void cancelIndexing();
|
||||
void search(const QList<QHelpSearchQuery> &queryList);
|
||||
void cancelSearching();
|
||||
|
||||
signals:
|
||||
void indexingStarted();
|
||||
void indexingFinished();
|
||||
void searchingStarted();
|
||||
void searchingFinished(int hits);
|
||||
|
||||
public:
|
||||
%If (Qt_5_9_0 -)
|
||||
int searchResultCount() const;
|
||||
%End
|
||||
%If (Qt_5_9_0 -)
|
||||
QVector<QHelpSearchResult> searchResults(int start, int end) const;
|
||||
%End
|
||||
%If (Qt_5_9_0 -)
|
||||
QString searchInput() const;
|
||||
%End
|
||||
|
||||
public slots:
|
||||
%If (Qt_5_9_0 -)
|
||||
void search(const QString &searchInput);
|
||||
%End
|
||||
};
|
||||
|
||||
%If (Qt_5_9_0 -)
|
||||
|
||||
class QHelpSearchResult
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpsearchengine.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
QHelpSearchResult();
|
||||
QHelpSearchResult(const QHelpSearchResult &other);
|
||||
QHelpSearchResult(const QUrl &url, const QString &title, const QString &snippet);
|
||||
~QHelpSearchResult();
|
||||
QString title() const;
|
||||
QUrl url() const;
|
||||
QString snippet() const;
|
||||
};
|
||||
|
||||
%End
|
||||
@@ -0,0 +1,62 @@
|
||||
// qhelpsearchquerywidget.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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 QHelpSearchQueryWidget : public QWidget
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpsearchquerywidget.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
%If (Qt_5_6_1 -)
|
||||
explicit QHelpSearchQueryWidget(QWidget *parent /TransferThis/ = 0);
|
||||
%End
|
||||
%If (- Qt_5_6_1)
|
||||
QHelpSearchQueryWidget(QWidget *parent /TransferThis/ = 0);
|
||||
%End
|
||||
virtual ~QHelpSearchQueryWidget();
|
||||
QList<QHelpSearchQuery> query() const;
|
||||
void setQuery(const QList<QHelpSearchQuery> &queryList);
|
||||
void expandExtendedSearch();
|
||||
void collapseExtendedSearch();
|
||||
|
||||
signals:
|
||||
void search();
|
||||
|
||||
private:
|
||||
virtual void focusInEvent(QFocusEvent *focusEvent);
|
||||
virtual void changeEvent(QEvent *event);
|
||||
|
||||
public:
|
||||
%If (Qt_5_3_0 -)
|
||||
bool isCompactMode() const;
|
||||
%End
|
||||
%If (Qt_5_3_0 -)
|
||||
void setCompactMode(bool on);
|
||||
%End
|
||||
%If (Qt_5_9_0 -)
|
||||
QString searchInput() const;
|
||||
%End
|
||||
%If (Qt_5_9_0 -)
|
||||
void setSearchInput(const QString &searchInput);
|
||||
%End
|
||||
};
|
||||
@@ -0,0 +1,35 @@
|
||||
// qhelpsearchresultwidget.sip generated by MetaSIP
|
||||
//
|
||||
// This file is part of the QtHelp Python extension module.
|
||||
//
|
||||
// Copyright (c) 2024 Riverbank Computing Limited <info@riverbankcomputing.com>
|
||||
//
|
||||
// This file is part of PyQt5.
|
||||
//
|
||||
// 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 QHelpSearchResultWidget : public QWidget /NoDefaultCtors/
|
||||
{
|
||||
%TypeHeaderCode
|
||||
#include <qhelpsearchresultwidget.h>
|
||||
%End
|
||||
|
||||
public:
|
||||
virtual ~QHelpSearchResultWidget();
|
||||
QUrl linkAt(const QPoint &point);
|
||||
|
||||
signals:
|
||||
void requestShowLink(const QUrl &url);
|
||||
};
|
||||
Reference in New Issue
Block a user