File: qwebpage.sip

package info (click to toggle)
pyqt5 5.11.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 15,956 kB
  • sloc: python: 93,806; cpp: 21,390; xml: 285; makefile: 266; sh: 31
file content (428 lines) | stat: -rw-r--r-- 12,515 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
// qwebpage.sip generated by MetaSIP
//
// This file is part of the QtWebKitWidgets Python extension module.
//
// Copyright (c) 2018 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 QWebPage : QObject
{
%TypeHeaderCode
#include <qwebpage.h>
%End

public:
    enum NavigationType
    {
        NavigationTypeLinkClicked,
        NavigationTypeFormSubmitted,
        NavigationTypeBackOrForward,
        NavigationTypeReload,
        NavigationTypeFormResubmitted,
        NavigationTypeOther,
    };

    enum WebAction
    {
        NoWebAction,
        OpenLink,
        OpenLinkInNewWindow,
        OpenFrameInNewWindow,
        DownloadLinkToDisk,
        CopyLinkToClipboard,
        OpenImageInNewWindow,
        DownloadImageToDisk,
        CopyImageToClipboard,
        Back,
        Forward,
        Stop,
        Reload,
        Cut,
        Copy,
        Paste,
        Undo,
        Redo,
        MoveToNextChar,
        MoveToPreviousChar,
        MoveToNextWord,
        MoveToPreviousWord,
        MoveToNextLine,
        MoveToPreviousLine,
        MoveToStartOfLine,
        MoveToEndOfLine,
        MoveToStartOfBlock,
        MoveToEndOfBlock,
        MoveToStartOfDocument,
        MoveToEndOfDocument,
        SelectNextChar,
        SelectPreviousChar,
        SelectNextWord,
        SelectPreviousWord,
        SelectNextLine,
        SelectPreviousLine,
        SelectStartOfLine,
        SelectEndOfLine,
        SelectStartOfBlock,
        SelectEndOfBlock,
        SelectStartOfDocument,
        SelectEndOfDocument,
        DeleteStartOfWord,
        DeleteEndOfWord,
        SetTextDirectionDefault,
        SetTextDirectionLeftToRight,
        SetTextDirectionRightToLeft,
        ToggleBold,
        ToggleItalic,
        ToggleUnderline,
        InspectElement,
        InsertParagraphSeparator,
        InsertLineSeparator,
        SelectAll,
        ReloadAndBypassCache,
        PasteAndMatchStyle,
        RemoveFormat,
        ToggleStrikethrough,
        ToggleSubscript,
        ToggleSuperscript,
        InsertUnorderedList,
        InsertOrderedList,
        Indent,
        Outdent,
        AlignCenter,
        AlignJustified,
        AlignLeft,
        AlignRight,
        StopScheduledPageRefresh,
        CopyImageUrlToClipboard,
        OpenLinkInThisWindow,
%If (Qt_5_2_0 -)
        DownloadMediaToDisk,
%End
%If (Qt_5_2_0 -)
        CopyMediaUrlToClipboard,
%End
%If (Qt_5_2_0 -)
        ToggleMediaControls,
%End
%If (Qt_5_2_0 -)
        ToggleMediaLoop,
%End
%If (Qt_5_2_0 -)
        ToggleMediaPlayPause,
%End
%If (Qt_5_2_0 -)
        ToggleMediaMute,
%End
%If (Qt_5_2_0 -)
        ToggleVideoFullscreen,
%End
    };

    enum FindFlag
    {
        FindBackward,
        FindCaseSensitively,
        FindWrapsAroundDocument,
        HighlightAllOccurrences,
%If (Qt_5_2_0 -)
        FindAtWordBeginningsOnly,
%End
%If (Qt_5_2_0 -)
        TreatMedialCapitalAsWordBeginning,
%End
%If (Qt_5_2_0 -)
        FindBeginsInSelection,
%End
    };

    typedef QFlags<QWebPage::FindFlag> FindFlags;

    enum LinkDelegationPolicy
    {
        DontDelegateLinks,
        DelegateExternalLinks,
        DelegateAllLinks,
    };

    enum WebWindowType
    {
        WebBrowserWindow,
        WebModalDialog,
    };

    explicit QWebPage(QObject *parent /TransferThis/ = 0);
    virtual ~QWebPage();
    QWebFrame *mainFrame() const;
    QWebFrame *currentFrame() const;
    QWebHistory *history() const;
    QWebSettings *settings() const;
    void setView(QWidget *view /KeepReference/);
    QWidget *view() const;
    bool isModified() const;
    QUndoStack *undoStack() const;
    void setNetworkAccessManager(QNetworkAccessManager *manager /KeepReference/);
    QNetworkAccessManager *networkAccessManager() const;
    void setPluginFactory(QWebPluginFactory *factory /KeepReference/);
    QWebPluginFactory *pluginFactory() const;
    quint64 totalBytes() const;
    quint64 bytesReceived() const;
    QString selectedText() const;
    QAction *action(QWebPage::WebAction action) const;
    virtual void triggerAction(QWebPage::WebAction action, bool checked = false);
    QSize viewportSize() const;
    void setViewportSize(const QSize &size) const;
    virtual bool event(QEvent *);
    bool focusNextPrevChild(bool next);
    QVariant inputMethodQuery(Qt::InputMethodQuery property) const;
    bool findText(const QString &subString, QFlags<QWebPage::FindFlag> options = 0);
    void setForwardUnsupportedContent(bool forward);
    bool forwardUnsupportedContent() const;
    void setLinkDelegationPolicy(QWebPage::LinkDelegationPolicy policy);
    QWebPage::LinkDelegationPolicy linkDelegationPolicy() const;
    void setPalette(const QPalette &palette);
    QPalette palette() const;
    bool swallowContextMenuEvent(QContextMenuEvent *event);
    void updatePositionDependentActions(const QPoint &pos);

    enum Extension
    {
        ChooseMultipleFilesExtension,
        ErrorPageExtension,
    };

    class ExtensionOption
    {
%TypeHeaderCode
#include <qwebpage.h>
%End
    };

    class ExtensionReturn
    {
%TypeHeaderCode
#include <qwebpage.h>
%End
    };

    virtual bool extension(QWebPage::Extension extension, const QWebPage::ExtensionOption *option = 0, QWebPage::ExtensionReturn *output = 0);
%VirtualCatcherCode
        const sipTypeDef *option_type = sipType_QWebPage_ExtensionOption;
        const sipTypeDef *return_type = sipType_QWebPage_ExtensionReturn;
        
        if (a0 == QWebPage::ChooseMultipleFilesExtension)
        {
            option_type = sipType_QWebPage_ChooseMultipleFilesExtensionOption;
            return_type = sipType_QWebPage_ChooseMultipleFilesExtensionReturn;
        }
        else if (a0 == QWebPage::ErrorPageExtension)
        {
            option_type = sipType_QWebPage_ErrorPageExtensionOption;
            return_type = sipType_QWebPage_ErrorPageExtensionReturn;
        }
        
        PyObject *res_obj = sipCallMethod(&sipIsErr, sipMethod, "FDD",
                a0, sipType_QWebPage_Extension,
                a1, option_type, NULL,
                a2, return_type, NULL);
        
        if (res_obj)
        {
            sipParseResult(&sipIsErr, sipMethod, res_obj, "b", &sipRes);
            Py_DECREF(res_obj);
        }
        else
        {
            sipIsErr = 1;
        }
%End

    virtual bool supportsExtension(QWebPage::Extension extension) const;

signals:
    void loadFinished(bool ok);
    void loadProgress(int progress);
    void loadStarted();
    void linkHovered(const QString &link, const QString &title, const QString &textContent);
    void statusBarMessage(const QString &text);
    void selectionChanged();
    void frameCreated(QWebFrame *frame);
    void geometryChangeRequested(const QRect &geom);
    void repaintRequested(const QRect &dirtyRect);
    void scrollRequested(int dx, int dy, const QRect &scrollViewRect);
    void windowCloseRequested();
    void printRequested(QWebFrame *frame);
    void linkClicked(const QUrl &url);
    void toolBarVisibilityChangeRequested(bool visible);
    void statusBarVisibilityChangeRequested(bool visible);
    void menuBarVisibilityChangeRequested(bool visible);
    void unsupportedContent(QNetworkReply *reply);
    void downloadRequested(const QNetworkRequest &request);
    void microFocusChanged();

protected:
    virtual QWebPage *createWindow(QWebPage::WebWindowType type);
    virtual QObject *createPlugin(const QString &classid, const QUrl &url, const QStringList &paramNames, const QStringList &paramValues);
    virtual bool acceptNavigationRequest(QWebFrame *frame, const QNetworkRequest &request, QWebPage::NavigationType type);
    virtual QString chooseFile(QWebFrame *originatingFrame, const QString &oldFile);
    virtual void javaScriptAlert(QWebFrame *originatingFrame, const QString &msg);
    virtual bool javaScriptConfirm(QWebFrame *originatingFrame, const QString &msg);
    virtual bool javaScriptPrompt(QWebFrame *originatingFrame, const QString &msg, const QString &defaultValue, QString *result /Out/);
    virtual void javaScriptConsoleMessage(const QString &message, int lineNumber, const QString &sourceID);
    virtual QString userAgentForUrl(const QUrl &url) const;

public:
    void setContentEditable(bool editable);
    bool isContentEditable() const;
    QMenu *createStandardContextMenu() /Factory/;

    class ChooseMultipleFilesExtensionOption : QWebPage::ExtensionOption
    {
%TypeHeaderCode
#include <qwebpage.h>
%End

    public:
        QWebFrame *parentFrame;
        QStringList suggestedFileNames;
    };

    class ChooseMultipleFilesExtensionReturn : QWebPage::ExtensionReturn
    {
%TypeHeaderCode
#include <qwebpage.h>
%End

    public:
        QStringList fileNames;
    };

signals:
    void contentsChanged();
    void databaseQuotaExceeded(QWebFrame *frame, QString databaseName);
    void saveFrameStateRequested(QWebFrame *frame, QWebHistoryItem *item);
    void restoreFrameStateRequested(QWebFrame *frame);

public:
    QWebFrame *frameAt(const QPoint &pos) const;
    QSize preferredContentsSize() const;
    void setPreferredContentsSize(const QSize &size) const;

    enum ErrorDomain
    {
        QtNetwork,
        Http,
        WebKit,
    };

    class ErrorPageExtensionOption : QWebPage::ExtensionOption
    {
%TypeHeaderCode
#include <qwebpage.h>
%End

    public:
        QUrl url;
        QWebFrame *frame;
        QWebPage::ErrorDomain domain;
        int error;
        QString errorString;
    };

    class ErrorPageExtensionReturn : QWebPage::ExtensionReturn
    {
%TypeHeaderCode
#include <qwebpage.h>
%End

    public:
        ErrorPageExtensionReturn();
        QString contentType;
        QString encoding;
        QUrl baseUrl;
        QByteArray content;
    };

    virtual bool shouldInterruptJavaScript();

    enum PermissionPolicy
    {
        PermissionUnknown,
        PermissionGrantedByUser,
        PermissionDeniedByUser,
    };

    enum Feature
    {
        Notifications,
        Geolocation,
    };

    class ViewportAttributes
    {
%TypeHeaderCode
#include <qwebpage.h>
%End

    public:
        ViewportAttributes();
        ViewportAttributes(const QWebPage::ViewportAttributes &other);
        ~ViewportAttributes();
        qreal initialScaleFactor() const;
        qreal minimumScaleFactor() const;
        qreal maximumScaleFactor() const;
        qreal devicePixelRatio() const;
        bool isUserScalable() const;
        bool isValid() const;
        QSizeF size() const;
    };

    bool hasSelection() const;
    QString selectedHtml() const;
    QWebPage::ViewportAttributes viewportAttributesForSize(const QSize &availableSize) const;
    void setActualVisibleContentRect(const QRect &rect) const;
    void setFeaturePermission(QWebFrame *frame, QWebPage::Feature feature, QWebPage::PermissionPolicy policy);
    QStringList supportedContentTypes() const;
    bool supportsContentType(const QString &mimeType) const;

signals:
    void applicationCacheQuotaExceeded(QWebSecurityOrigin *origin, quint64 defaultOriginQuota, quint64 totalSpaceNeeded);
    void viewportChangeRequested();
    void featurePermissionRequested(QWebFrame *frame, QWebPage::Feature feature);
    void featurePermissionRequestCanceled(QWebFrame *frame, QWebPage::Feature feature);

public:
%If (Qt_5_2_0 -)

    enum VisibilityState
    {
        VisibilityStateVisible,
        VisibilityStateHidden,
        VisibilityStatePrerender,
        VisibilityStateUnloaded,
    };

%End
%If (Qt_5_2_0 -)
    QWebPage::VisibilityState visibilityState() const;
%End
%If (Qt_5_2_0 -)
    void setVisibilityState(QWebPage::VisibilityState);
%End
};

QFlags<QWebPage::FindFlag> operator|(QWebPage::FindFlag f1, QFlags<QWebPage::FindFlag> f2);