KFileMetaData 5.109.0
simpleextractionresult.h
1/*
2 SPDX-FileCopyrightText: 2014 Vishesh Handa <me@vhanda.in>
3
4 SPDX-License-Identifier: LGPL-2.1-or-later
5*/
6
7#ifndef KFILEMETADATA_SimpleExtractionResult_H
8#define KFILEMETADATA_SimpleExtractionResult_H
9
10#include "extractionresult.h"
11#include <QVector>
12#include <QString>
13
14#include <memory>
15
16namespace KFileMetaData {
17enum PropertiesMapType { MultiMap };
18
19class SimpleExtractionResultPrivate;
20
31class KFILEMETADATA_EXPORT SimpleExtractionResult : public ExtractionResult
32{
33public:
34 SimpleExtractionResult(const QString& url, const QString& mimetype = QString(), const Flags& flags = Flags{ExtractPlainText | ExtractMetaData});
36 ~SimpleExtractionResult() override;
37
39 bool operator==(const SimpleExtractionResult& rhs) const;
40
41 void add(Property::Property property, const QVariant& value) override;
42 void addType(Type::Type type) override;
43 void append(const QString& text) override;
44
45#if KFILEMETADATA_ENABLE_DEPRECATED_SINCE(5, 89)
47 KFILEMETADATA_DEPRECATED_VERSION(5, 89, "Use properties(PropertiesMapType) overload instead")
48 PropertyMap properties() const;
49#endif
50
62#if KFILEMETADATA_ENABLE_DEPRECATED_SINCE(5, 89)
63 PropertyMultiMap properties(PropertiesMapType) const;
64#else
65 PropertyMultiMap properties(PropertiesMapType = PropertiesMapType::MultiMap) const;
66#endif
67
68 QString text() const;
69 QVector<Type::Type> types() const;
70
71private:
72 const std::unique_ptr<SimpleExtractionResultPrivate> d;
73};
74
75}
76
77#endif // KFILEMETADATA_SimpleExtractionResult_H
The ExtractionResult class is where all the data extracted by the indexer is saved.
Definition extractionresult.h:35
QFlags< Flag > Flags
Stores a combination of Flag values.
Definition extractionresult.h:53
A simple ExtractionResult implementation which stores all the data in memory.
Definition simpleextractionresult.h:32
PropertyMultiMap properties(PropertiesMapType=PropertiesMapType::MultiMap) const
Returns the properties of the extraction result.
void addType(Type::Type type) override
This function is called by the plugins.
void add(Property::Property property, const QVariant &value) override
This function is called by the plugins when they wish to add a key value pair which should be indexed...
void append(const QString &text) override
This function is called by plugins when they wish for some plain text to be indexed without any prope...
Property
The Property enum contains all files property types that KFileMetaData manipulates.
Definition properties.h:25