summaryrefslogtreecommitdiffstats
path: root/src/ifmedia/qifmediaindexercontrolbackendinterface.cpp
blob: c69c04bc8c4c12c06663ca53dd6c1d6b92213001 (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
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#include "qifmediaindexercontrolbackendinterface.h"

QT_BEGIN_NAMESPACE

/*!
    \class QIfMediaIndexerControlBackendInterface
    \inmodule QtIfMedia
    \ingroup backends
    \inherits QObject
    \keyword org.qt-project.interfaceframework.MediaIndexer/1.0
    \brief The QIfMediaIndexerControlBackendInterface defines the interface for backends to the
    QIfMediaIndexerControl feature class.

    The QIfMediaIndexerControlBackendInterface is the interface used by \l QIfMediaIndexerControl

    The interface is discovered by a \l QIfMediaIndexerControl object, which connects to it and sets it up.

    <example of a fully featured backend>
*/

/*!
    Constructs a backend interface.

    The \a parent is sent to the QObject constructor.
*/
QIfMediaIndexerControlBackendInterface::QIfMediaIndexerControlBackendInterface(QObject *parent)
    : QIfFeatureInterface(parent)
{

}

/*!
    \fn QIfMediaIndexerControlBackendInterface::pause()

    Pauses the currently ongoing indexing. If currently no indexing is ongoing this call should not perform any actions.

    \sa resume()
*/

/*!
    \fn QIfMediaIndexerControlBackendInterface::resume()

    Resumes the previously paused indexing. If there is nothing to resume this call should not perform any actions.

    \sa pause()
*/

/*!
    \fn void QIfMediaIndexerControlBackendInterface::progressChanged(qreal progress)

    This signal is emitted when indexing is currently ongoing and the progress of the operation changed.
    The \a progress argument passes the current progress between \e 0 and \e 1.
*/

/*!
    \fn void QIfMediaIndexerControlBackendInterface::stateChanged(QIfMediaIndexerControl::State state)

    This signal is emitted whenever the indexing state changed. The \a state argument holds the new state
    of the indexer.
*/

QT_END_NAMESPACE

#include "moc_qifmediaindexercontrolbackendinterface.cpp"