File: qhelpfilterengine.sip

package info (click to toggle)
pyqt6 6.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,708 kB
  • sloc: cpp: 17,985; python: 10,547; javascript: 721; makefile: 25; sh: 10
file content (51 lines) | stat: -rw-r--r-- 1,896 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
// qhelpfilterengine.sip generated by MetaSIP
//
// This file is part of the QtHelp Python extension module.
//
// Copyright (c) 2025 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 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:
    QList<QVersionNumber> availableVersions() const;
    QStringList indices() const;
    QStringList indices(const QString &filterName) const;
};