/usr/include/KF5/Baloo/baloo/indexerconfig.h is in baloo-kf5-dev 5.44.0-0ubuntu1.
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 101 102 103 104 105 | /*
* This file is part of the KDE Baloo Project
* Copyright (C) 2014 Vishesh Handa <vhanda@kde.org>
*
* 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) any later version.
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef BALOO_INDEXERCONFIG_H
#define BALOO_INDEXERCONFIG_H
#include <QObject>
#include "core_export.h"
namespace Baloo {
class BALOO_CORE_EXPORT IndexerConfig
{
public:
IndexerConfig();
~IndexerConfig();
bool fileIndexingEnabled() const;
void setFileIndexingEnabled(bool enabled) const;
/**
* Check if the file or folder \p path should be indexed.
*
* If itself or its nearest explicitly included or excluded ancestor is
* excluded it is not indexed.
* Otherwise it is indexed according to the
* includeFolders and excludeFilters config.
*
* \return \c true if the file or folder at \p path should
* be indexed according to the configuration.
*/
bool shouldBeIndexed(const QString& path) const;
/**
* Check if \p folder can be searched.
* \p folder can be searched if itself or one of its descendants is indexed.
*
* Example:
* if ~/foo is not indexed and ~/foo/bar is indexed
* then ~/foo can be searched.
*
* \return \c true if the \p folder can be searched.
*/
bool canBeSearched(const QString& folder) const;
/**
* Folders to search for files to index and analyze.
* \return list of paths.
*/
QStringList includeFolders() const;
/**
* Folders that are excluded from indexing.
* (Descendant folders of an excluded folder can be added
* and they will be indexed.)
* \return list of paths.
*/
QStringList excludeFolders() const;
QStringList excludeFilters() const;
QStringList excludeMimetypes() const;
void setIncludeFolders(const QStringList& includeFolders);
void setExcludeFolders(const QStringList& excludeFolders);
void setExcludeFilters(const QStringList& excludeFilters);
void setExcludeMimetypes(const QStringList& excludeMimetypes);
/**
* \return \c true if the service is run for the first time
* (or after manually setting "first run=true" in the config).
*/
bool firstRun() const;
void setFirstRun(bool firstRun) const;
bool indexHidden() const;
void setIndexHidden(bool value) const;
bool onlyBasicIndexing() const;
void setOnlyBasicIndexing(bool value);
void refresh() const;
private:
class Private;
Private* d;
};
}
#endif // BALOO_INDEXERCONFIG_H
|