summaryrefslogtreecommitdiffstats
path: root/src/core/api/qwebenginefindtextresult.cpp
blob: ce953ddff1f92a40d71772c1bbcb8634061e0e9a (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
// Copyright (C) 2021 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 "qwebenginefindtextresult.h"

QT_BEGIN_NAMESPACE

class QWebEngineFindTextResultPrivate : public QSharedData {
public:
    int numberOfMatches = 0;
    int activeMatch = 0;
};

/*!
    \class QWebEngineFindTextResult
    \brief The QWebEngineFindTextResult class encapsulates the result of a string search on a page.
    \since 5.14

    \inmodule QtWebEngineCore

    The string search can be initiated by the \l QWebEnginePage::findText() or
    \l{WebEngineView::findText()}{WebEngineView.findText()} method. The results of the search
    are highlighted in the view. The details of this result are passed as a
    QWebEngineFindTextResult object that can be used to show a status message,
    such as "2 of 2 matches". For example:

    \code
    QObject::connect(view.page(), &QWebEnginePage::findTextFinished, [](const QWebEngineFindTextResult &result) {
        qInfo() << result.activeMatch() << "of" << result.numberOfMatches() << "matches";
    });
    \endcode

    Results are passed to the user in the
    \l QWebEnginePage::findTextFinished() and
    \l{WebEngineView::findTextFinished()}{WebEngineView.findTextFinished()} signals.
*/

/*! \internal
*/
QWebEngineFindTextResult::QWebEngineFindTextResult()
    : d(new QWebEngineFindTextResultPrivate)
{}

/*! \internal
*/
QWebEngineFindTextResult::QWebEngineFindTextResult(int numberOfMatches, int activeMatch)
    : d(new QWebEngineFindTextResultPrivate)
{
    d->numberOfMatches = numberOfMatches;
    d->activeMatch = activeMatch;
}

/*! \internal
*/
QWebEngineFindTextResult::QWebEngineFindTextResult(const QWebEngineFindTextResult &other)
    : d(other.d)
{}

/*! \internal
*/
QWebEngineFindTextResult &QWebEngineFindTextResult::operator=(const QWebEngineFindTextResult &other)
{
    d = other.d;
    return *this;
}

/*! \internal
*/
QWebEngineFindTextResult::~QWebEngineFindTextResult()
{}

/*!
    \property QWebEngineFindTextResult::numberOfMatches
    \brief The number of matches found.
*/
int QWebEngineFindTextResult::numberOfMatches() const
{
    return d->numberOfMatches;
}

/*!
    \property QWebEngineFindTextResult::activeMatch
    \brief The index of the currently highlighted match.
*/
int QWebEngineFindTextResult::activeMatch() const
{
    return d->activeMatch;
}

QT_END_NAMESPACE

#include "moc_qwebenginefindtextresult.cpp"