KFileMetaData

writerplugin.h
1/*
2 This file is part of the KFileMetaData project
3 SPDX-FileCopyrightText: 2016 Varun Joshi <varunj.1011@gmail.com>
4 SPDX-FileCopyrightText: 2016 Vishesh Handa <me@vhanda.in>
5
6 SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
7*/
8
9#ifndef _KFILEMETADTA_WRITERPLUGIN_H
10#define _KFILEMETADTA_WRITERPLUGIN_H
11
12#include "kfilemetadata_export.h"
13#include <QStringList>
14
15#include "writedata.h"
16
17namespace KFileMetaData
18{
19
20/**
21 * \class WriterPlugin writerplugin.h <KFileMetaData/WriterPlugin>
22 *
23 * \brief The WriterPlugin is the base class for all file metadata
24 * writers.
25 *
26 * It is responsible for writing the metadata to a file.
27 */
28class KFILEMETADATA_EXPORT WriterPlugin : public QObject
29{
30 Q_OBJECT
31public:
32 explicit WriterPlugin(QObject* parent);
33 ~WriterPlugin() override;
34
35 virtual QStringList writeMimetypes() const = 0;
36
37 virtual void write(const WriteData& data) = 0;
38};
39}
40
41Q_DECLARE_INTERFACE(KFileMetaData::WriterPlugin, "org.kde.kf5.kfilemetadata.WriterPlugin")
42#endif // _KFILEMETADTA_WRITERPLUGIN_H
The WriteData class stores all the data to be written to a file.
Definition writedata.h:30
The WriterPlugin is the base class for all file metadata writers.
The KFileMetaData namespace.
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 22 2024 12:12:41 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.