/usr/include/kfilemetadata/extractionresult.h is in libkfilemetadata-dev 4:4.14.3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /*
* Copyright (C) 2013 Vishesh Handa <me@vhanda.in>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) version 3, or any
* later version accepted by the membership of KDE e.V. (or its
* successor approved by the membership of KDE e.V.), which shall
* act as a proxy defined in Section 6 of version 3 of the license.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef _KFILEMETADATA_EXTRACTIONRESULT_H
#define _KFILEMETADATA_EXTRACTIONRESULT_H
#include <QString>
#include <QVariant>
#include "kfilemetadata_export.h"
#include "properties.h"
#include "types.h"
namespace KFileMetaData {
/**
* \class ExtractionResult extractionresult.h
*
* \brief The ExtractionResult class is where all the data extracted by
* the indexer is saved. This class acts as a base class which should be
* dervied from and then passed to the relevant plugins.
*
* The dervied class needs to implement 3 pure virtual functions through
* which it receives the extracted data.
*
* \author Vishesh Handa <me@vhanda.in>
*/
class KFILEMETADATA_EXPORT ExtractionResult
{
public:
ExtractionResult(const QString& url, const QString& mimetype);
ExtractionResult(const ExtractionResult& rhs);
virtual ~ExtractionResult();
/**
* The input url which the plugins will use to locate the file
*/
QString inputUrl() const;
/*
* The input mimetype. This mimetype should correspond with the
* mimetypes supported with the relevant plugin when it is being
* passed to the Extractor
*/
QString inputMimetype() const;
/**
* This function is called by plugins when they wish for some plain
* text to be indexed without any property. This generally corresponds
* to the text content in a file
*/
virtual void append(const QString& text) = 0;
/**
* This function is called by the plugins when they wish to
* add a key value pair which should be indexed. This function may be
* called multiple times for the same key.
*
* \p property This specifies a property name. It should be one of the
* properties from the global list of properties.
*
* \p value The value of the property
*/
virtual void add(Property::Property property, const QVariant& value) = 0;
/**
* This function is caleld by the plugins.
* A type is a higher level classification of the file. Any file can
* have multiple types. Eg - "Audio", "Video" or "Document"
*
* Please choose one type from the list of available types
*/
virtual void addType(Type::Type type) = 0;
private:
class Private;
Private* d;
};
}
#endif // _KFILEMETADATA_EXTRACTIONRESULT_H
|