summaryrefslogtreecommitdiffstats
path: root/src/webenginewidgets/api/qwebenginecontextmenudata.cpp
blob: 808c6f8b055b03078290a21d0f164a145bd13663 (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
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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWebEngine module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qwebenginecontextmenudata.h"

#include "web_contents_adapter_client.h"

QT_BEGIN_NAMESPACE

ASSERT_ENUMS_MATCH(QtWebEngineCore::WebEngineContextMenuData::MediaTypeNone,   QWebEngineContextMenuData::MediaTypeNone)
ASSERT_ENUMS_MATCH(QtWebEngineCore::WebEngineContextMenuData::MediaTypeImage,  QWebEngineContextMenuData::MediaTypeImage)
ASSERT_ENUMS_MATCH(QtWebEngineCore::WebEngineContextMenuData::MediaTypeAudio,  QWebEngineContextMenuData::MediaTypeAudio)
ASSERT_ENUMS_MATCH(QtWebEngineCore::WebEngineContextMenuData::MediaTypeVideo,  QWebEngineContextMenuData::MediaTypeVideo)
ASSERT_ENUMS_MATCH(QtWebEngineCore::WebEngineContextMenuData::MediaTypeCanvas, QWebEngineContextMenuData::MediaTypeCanvas)
ASSERT_ENUMS_MATCH(QtWebEngineCore::WebEngineContextMenuData::MediaTypeFile,   QWebEngineContextMenuData::MediaTypeFile)
ASSERT_ENUMS_MATCH(QtWebEngineCore::WebEngineContextMenuData::MediaTypePlugin, QWebEngineContextMenuData::MediaTypePlugin)

/*!
    \class QWebEngineContextMenuData
    \since 5.7
    \brief The QWebEngineContextMenuData class provides context data for populating or extending a context menu with actions.

    \inmodule QtWebEngine

    QWebEngineContextMenuData is returned by QWebEnginePage::contextMenuData() after a context menu event,
    and contains information about where the context menu event took place. This is also in the context
    in which any context specific QWebEnginePage::WebAction will be performed.
*/

/*!
    \enum QWebEngineContextMenuData::MediaType

    This enum describes the media type of the context if any.

    \value MediaTypeNone The context is not a media type.
    \value MediaTypeImage The context is an image element.
    \value MediaTypeVideo The context is a video element.
    \value MediaTypeAudio The context is an audio element.
    \value MediaTypeCanvas The context is a canvas element.
    \value MediaTypeFile The context is a file.
    \value MediaTypePlugin The context is a plugin element.
*/

/*!
    Constructs null context menu data.
*/
QWebEngineContextMenuData::QWebEngineContextMenuData() : d(nullptr)
{
}

/*!
    Constructs context menu data from \a other.
*/
QWebEngineContextMenuData::QWebEngineContextMenuData(const QWebEngineContextMenuData &other)
{
    d = new QtWebEngineCore::WebEngineContextMenuData(*other.d);
}

/*!
    Assigns the \a other context menu data to this.
*/
QWebEngineContextMenuData &QWebEngineContextMenuData::operator=(const QWebEngineContextMenuData &other)
{
    delete d;
    d = new QtWebEngineCore::WebEngineContextMenuData(*other.d);
    return *this;
}

/*!
    Destroys the context menu data.
*/
QWebEngineContextMenuData::~QWebEngineContextMenuData()
{
    delete d;
}

/*!
    Returns \c true if the context data is valid; otherwise returns \c false.
*/
bool QWebEngineContextMenuData::isValid() const
{
    return d;
}

/*!
    Resets the context data, making it invalid.
    \internal

    \sa isValid()
*/
void QWebEngineContextMenuData::reset()
{
    delete d;
    d = nullptr;
}

/*!
    Returns the position of the context, usually the mouse position where the context menu event was triggered.
*/
QPoint QWebEngineContextMenuData::position() const
{
    return d ? d->pos : QPoint();
}

/*!
    Returns the text of a link if the context is a link.
*/
QString QWebEngineContextMenuData::linkText() const
{
    return d ? d->linkText : QString();
}

/*!
    Returns the URL of a link if the context is a link.
*/
QUrl QWebEngineContextMenuData::linkUrl() const
{
    return d ? d->linkUrl : QUrl();
}

/*!
    Returns the selected text of the context.
*/
QString QWebEngineContextMenuData::selectedText() const
{
    return d ? d->selectedText : QString();
}

/*!
    If the context is a media element, returns the URL of that media.
*/
QUrl QWebEngineContextMenuData::mediaUrl() const
{
    return d ? d->mediaUrl : QUrl();
}

/*!
    Returns the type of the media element or \c MediaTypeNone if the context is not a media element.
*/
QWebEngineContextMenuData::MediaType QWebEngineContextMenuData::mediaType() const
{
    return d ? static_cast<QWebEngineContextMenuData::MediaType>(d->mediaType) : MediaTypeNone;
}

/*!
    Returns \c true if the content is editable by the user; otherwise returns \c false.
*/
bool QWebEngineContextMenuData::isContentEditable() const
{
    return d ? d->isEditable : false;
}

/*!
    If the context is a word considered misspelled by the spell-checker, returns the misspelled word.

    \since 5.8
*/
QString QWebEngineContextMenuData::misspelledWord() const
{
    if (d)
        return d->misspelledWord;
    return QString();
}

/*!
    If the context is a word considered misspelled by the spell-checker, returns a list of suggested replacements.

    \since 5.8
*/
QStringList QWebEngineContextMenuData::spellCheckerSuggestions() const
{
    if (d)
        return d->spellCheckerSuggestions;
    return QStringList();
}

/*!
    \internal
*/
QWebEngineContextMenuData &QWebEngineContextMenuData::operator=(const QWebEngineContextDataPrivate &priv)
{
    delete d;
    d = new QtWebEngineCore::WebEngineContextMenuData(priv);
    return *this;
}

QT_END_NAMESPACE