/usr/include/nepomuk/filequery.h is in kdelibs5-dev 4:4.13.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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | /*
This file is part of the Nepomuk KDE project.
Copyright (C) 2009-2010 Sebastian Trueg <trueg@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _NEPOMUK_QUERY_FILE_QUERY_H_
#define _NEPOMUK_QUERY_FILE_QUERY_H_
#include "query.h"
#include "nepomukquery_export.h"
namespace Nepomuk {
namespace Query {
/**
* \class FileQuery filequery.h Nepomuk/Query/FileQuery
*
* \brief A Nepomuk desktop query specialized for file searches.
*
* FileQuery is an extension to Query which adds some syntactic sugar
* for dealing with file queries. This includes a restriction of the
* results to files and the possibility to restrict the search to
* specific folders via setIncludeFolders() and setExcludeFolders().
*
* \warning %FileQuery does only return files and folders as results.
*
* \author Sebastian Trueg <trueg@kde.org>
*
* \since 4.4
*/
class NEPOMUKQUERY_EXPORT FileQuery : public Query
{
public:
/**
* Create an empty invalid file query object.
*/
FileQuery();
/**
* Create a file query with root term \a term.
*
* \since 4.6
*/
explicit FileQuery( const Term& term );
/**
* Copy constructor.
*/
FileQuery( const Query& query );
/**
* Destructor
*/
~FileQuery();
/**
* Assignment operator
*/
FileQuery& operator=( const Query& );
/**
* Add a folder to include in the search. If include folders are set the query
* will be restricted to files from that folders and their subfolders.
*
* \param folder The folder to include in the search.
*
* \sa setIncludeFolders, includeFolders, addExcludeFolder
*/
void addIncludeFolder( const KUrl& folder );
/**
* Add a folder to include in the search path. If include folders are set the query
* will be restricted to files from that folders and optionally their subfolders.
*
* \param folder The folder to include in the search.
* \param recursive If \p true subfolders of \p folder will be searched, too.
*
* \sa setIncludeFolders, includeFolders, addExcludeFolder
*
* \since 4.6
*/
void addIncludeFolder( const KUrl& folder, bool recursive );
/**
* \overload
*
* \param folders The folders to include in the search.
*
* \sa addIncludeFolder, includeFolders, setExcludeFolders
*/
void setIncludeFolders( const KUrl::List& folders );
/**
* \overload
*
* \param folders A hash of the folders to include in the search and
* their recursive flag.
*
* \since 4.6
*/
void setIncludeFolders( const QHash<KUrl, bool>& folders );
/**
* The list of include folders set via addIncludeFolder() and
* setIncludeFolders().
*
* \sa allIncludeFolders, addIncludeFolder, setIncludeFolders, excludeFolders
*/
KUrl::List includeFolders() const;
/**
* The hash of include folders set via addIncludeFolder() and
* setIncludeFolders() including their recursive flag.
*
* \sa includeFolders, addIncludeFolder, setIncludeFolders, excludeFolders
*
* \since 4.6
*/
QHash<KUrl, bool> allIncludeFolders() const;
/**
* Add a folder to exclude from the search. If exclude folders are set the query
* will be restricted to files that are not in that folder and its subfolders.
*
* \param folder The folder to exclude from the search.
*
* \sa setExcludeFolders, excludeFolders, addIncludeFolder
*/
void addExcludeFolder( const KUrl& folder );
/**
* \overload
*
* \param folders The folders to exclude from the search.
*
* \sa addExcludeFolder, excludeFolders, setIncludeFolders
*/
void setExcludeFolders( const KUrl::List& folders );
/**
* The list of exclude folders set via addExcludeFolder() and
* setExcludeFolders().
*
* \sa addExcludeFolder, setExcludeFolders, includeFolders
*/
KUrl::List excludeFolders() const;
/**
* An enumeration used in setFileMode() to state wether the query
* should return files and folders or only files or only folders.
*
* \since 4.5
*/
enum FileModeFlags {
QueryFiles = 0x1,
QueryFolders = 0x2,
QueryFilesAndFolders = QueryFiles|QueryFolders
};
Q_DECLARE_FLAGS( FileMode, FileModeFlags )
/**
* Set the file mode, i.e. wether the query should return
* files and folders or only files or only folders.
* By default both files and folders are returned.
*
* \sa fileMode()
*
* \since 4.5
*/
void setFileMode( FileMode mode );
/**
* \return The file mode set in setFileMode()
*
* \since 4.5
*/
FileMode fileMode() const;
};
}
}
Q_DECLARE_OPERATORS_FOR_FLAGS( Nepomuk::Query::FileQuery::FileMode )
#endif
|