summaryrefslogtreecommitdiffstats
path: root/src/core/api/qwebenginefilesystemaccessrequest.cpp
blob: 3f901b671cf7bc22a38b8b21c0921333b81ce1ee (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
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
// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#include "qwebenginefilesystemaccessrequest.h"

#include "file_system_access/file_system_access_permission_request_controller.h"

QT_BEGIN_NAMESPACE

/*!
    \class QWebEngineFileSystemAccessRequest
    \brief The QWebEngineFileSystemAccessRequest class enables accepting or rejecting
     requests for local file system access from JavaScript applications.

    \since 6.4

    \inmodule QtWebEngineCore

    To allow web applications to access local files of the computer,
    applications must connect to QWebEnginePage::fileSystemAccessRequested, which takes a
    QWebEngineFileSystemAccessRequest instance as an argument.

    If a web applications requests access to local files or directories,
    QWebEnginePage::fileSystemAccessRequested will be emitted with an
    QWebEngineFileSystemAccessRequest instance as an argument where accessFlags() indicates
    the type of the requested access: read, write or both. The signal handler needs to then
    either call accept() or reject().
*/

/*!
   \enum QWebEngineFileSystemAccessRequest::AccessFlag

   This enum describes the type of the requested access: read, write or both. The options
   can be OR-ed together from the following list:

   \value Read
   \value Write
*/

/*!
   \enum QWebEngineFileSystemAccessRequest::HandleType

   This enum describes the type of the requested file system entry.

   \value File
   \value Directory
*/

QWebEngineFileSystemAccessRequest::QWebEngineFileSystemAccessRequest(
        const QWebEngineFileSystemAccessRequest &other) = default;
QWebEngineFileSystemAccessRequest &QWebEngineFileSystemAccessRequest::operator=(
        const QWebEngineFileSystemAccessRequest &other) = default;
QWebEngineFileSystemAccessRequest::~QWebEngineFileSystemAccessRequest() = default;

/*! \fn bool QWebEngineFileSystemAccessRequest::operator==(const QWebEngineFileSystemAccessRequest &lhs, const QWebEngineFileSystemAccessRequest &rhs)
    Returns \c true if \a lhs and \a rhs both point to the same request.
*/

/*! \fn bool QWebEngineFileSystemAccessRequest::operator!=(const QWebEngineFileSystemAccessRequest &lhs, const QWebEngineFileSystemAccessRequest &rhs)
    Returns \c true if \a lhs and \a rhs point to different requests.
*/

/*! \internal */
QWebEngineFileSystemAccessRequest::QWebEngineFileSystemAccessRequest(
        std::shared_ptr<QtWebEngineCore::FileSystemAccessPermissionRequestController> controller)
    : d_ptr(std::move(controller))
{
}

/*!
    Rejects a request to access local files.
*/
void QWebEngineFileSystemAccessRequest::reject()
{
    d_ptr->reject();
}

/*!
    Accepts the request to access local files.
*/
void QWebEngineFileSystemAccessRequest::accept()
{
    d_ptr->accept();
}

/*!
    \property QWebEngineFileSystemAccessRequest::origin
    \brief The URL of the web page that issued the file system access request.
*/

QUrl QWebEngineFileSystemAccessRequest::origin() const
{
    return d_ptr->origin();
}

/*!
    \property QWebEngineFileSystemAccessRequest::filePath
    \brief Returns the file path this file system access request is referring to.
*/

QUrl QWebEngineFileSystemAccessRequest::filePath() const
{
    return d_ptr->filePath();
}

/*!
    \property QWebEngineFileSystemAccessRequest::handleType
    \brief Returns the type of the requested file system entry. (File or directory)
 */
HandleType QWebEngineFileSystemAccessRequest::handleType() const
{
    return d_ptr->handleType();
}

/*!
    \property QWebEngineFileSystemAccessRequest::accessFlags
    \brief Contains the requested file access rights.
 */
AccessFlags QWebEngineFileSystemAccessRequest::accessFlags() const
{
    return d_ptr->accessFlags();
}

QT_END_NAMESPACE

#include "moc_qwebenginefilesystemaccessrequest.cpp"