File: qhelpenginecore.sip

package info (click to toggle)
python-qt4 4.7.3-1%2Bsqueeze1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 28,504 kB
  • ctags: 4,680
  • sloc: python: 28,738; cpp: 8,897; sh: 245; xml: 243; makefile: 150
file content (121 lines) | stat: -rw-r--r-- 4,662 bytes parent folder | download
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// qhelpenginecore.sip generated by MetaSIP on Fri Apr 16 11:32:08 2010
//
// This file is part of the QtHelp Python extension module.
//
// Copyright (c) 2010 Riverbank Computing Limited <info@riverbankcomputing.com>
// 
// This file is part of PyQt.
// 
// This file may be used under the terms of the GNU General Public
// License versions 2.0 or 3.0 as published by the Free Software
// Foundation and appearing in the files LICENSE.GPL2 and LICENSE.GPL3
// included in the packaging of this file.  Alternatively you may (at
// your option) use any later version of the GNU General Public
// License if such license has been publicly approved by Riverbank
// Computing Limited (or its successors, if any) and the KDE Free Qt
// Foundation. In addition, as a special exception, Riverbank gives you
// certain additional rights. These rights are described in the Riverbank
// GPL Exception version 1.1, which can be found in the file
// GPL_EXCEPTION.txt in this package.
// 
// Please review the following information to ensure GNU General
// Public Licensing requirements will be met:
// http://trolltech.com/products/qt/licenses/licensing/opensource/. If
// you are unsure which license is appropriate for your use, please
// review the following information:
// http://trolltech.com/products/qt/licenses/licensing/licensingoverview
// or contact the sales department at sales@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_4_4_0 -)

class QHelpEngineCore : QObject
{

%TypeHeaderCode
#include <qhelpenginecore.h>
%End

%ConvertToSubClassCode
    static struct class_graph {
            const char *name;
            sipTypeDef **type;
            int yes, no;
        } graph[] = {
            {sipName_QHelpIndexWidget,	&sipType_QHelpIndexWidget,	-1, 1},
            {sipName_QHelpContentWidget,	&sipType_QHelpContentWidget,	-1, 2},
            {sipName_QHelpContentModel,	&sipType_QHelpContentModel,	-1, 3},
            {sipName_QHelpIndexModel,	&sipType_QHelpIndexModel,	-1, 4},
            {sipName_QHelpSearchResultWidget,	&sipType_QHelpSearchResultWidget,	-1, 5},
            {sipName_QHelpEngineCore,	&sipType_QHelpEngineCore,	8, 6},
            {sipName_QHelpSearchQueryWidget,	&sipType_QHelpSearchQueryWidget,	-1, 7},
            {sipName_QHelpSearchEngine,	&sipType_QHelpSearchEngine,	-1, -1},
            {sipName_QHelpEngine,	&sipType_QHelpEngine,	-1, -1},
        };
    
        int i = 0;
    
        sipType = 0;
    
        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 &, QObject *parent /TransferThis/ = 0);
    virtual ~QHelpEngineCore();
    bool setupData();
    QString collectionFile() const;
    void setCollectionFile(const QString &);
    bool copyCollectionFile(const QString &);
    static QString namespaceName(const QString &);
    bool registerDocumentation(const QString &);
    bool unregisterDocumentation(const QString &);
    QString documentationFileName(const QString &);
    QStringList customFilters() const;
    bool removeCustomFilter(const QString &);
    bool addCustomFilter(const QString &, const QStringList &);
    QStringList filterAttributes() const;
    QStringList filterAttributes(const QString &) const;
    QString currentFilter() const;
    void setCurrentFilter(const QString &);
    QStringList registeredDocumentations() const;
    QList<QStringList> filterAttributeSets(const QString &) const;
    QList<QUrl> files(const QString, const QStringList &, const QString &extensionFilter /DocValue="Py_v3:''"/ = QString());
    QUrl findFile(const QUrl &) const;
    QByteArray fileData(const QUrl &) const;
    QMap<QString,QUrl> linksForIdentifier(const QString &) const;
    bool removeCustomValue(const QString &);
    QVariant customValue(const QString &, const QVariant &defaultValue /DocValue="Py_v3:None"/ = QVariant()) const;
    bool setCustomValue(const QString &, const QVariant &);
    static QVariant metaData(const QString &, const QString &);
    QString error() const;
%If (Qt_4_5_0 -)
    bool autoSaveFilter() const;
%End
%If (Qt_4_5_0 -)
    void setAutoSaveFilter(bool);
%End

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

%End