summaryrefslogtreecommitdiffstats
path: root/src/webenginequick/doc/src/register_protocol_handler_request.qdoc
blob: d69f4d264e6d7cf7e9b9303b170451bfe18de956 (plain)
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
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \qmltype RegisterProtocolHandlerRequest
    \instantiates QWebEngineRegisterProtocolHandlerRequest
    \inqmlmodule QtWebEngine
    \since QtWebEngine 1.7
    \brief The RegisterProtocolHandlerRequest type enables accepting
    or rejecting requests from the \l registerProtocolHandler API.

    \sa WebEngineView::registerProtocolHandlerRequested()
*/

/*!
    \qmlproperty url RegisterProtocolHandlerRequest::origin
    \brief The URL template for the protocol handler.

    This is the second parameter from the \l registerProtocolHandler call.
*/

/*!
    \qmlproperty string RegisterProtocolHandlerRequest::scheme
    \brief The URL scheme for the protocol handler.

    This is the first parameter from the \l registerProtocolHandler call.
*/

/*!
    \qmlmethod void RegisterProtocolHandlerRequest::accept()
    \brief Accepts the request.

    Subsequent calls to accept() and reject() are ignored.
*/

/*!
    \qmlmethod void RegisterProtocolHandlerRequest::reject()
    \brief Accepts the request.

    Subsequent calls to accept() and reject() are ignored.
*/