filequery.h

Go to the documentation of this file.

/*
   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 _NEPOMUK2_QUERY_FILE_QUERY_H_
#define _NEPOMUK2_QUERY_FILE_QUERY_H_

#include "query.h"
#include "nepomuk_export.h"

namespace Nepomuk2 {
    namespace Query {
        class NEPOMUK_EXPORT FileQuery : public Query
        {
        public:
            FileQuery();

            explicit FileQuery( const Term& term );

            FileQuery( const Query& query );

            ~FileQuery();

            FileQuery& operator=( const Query& );

            void addIncludeFolder( const KUrl& folder );

            void addIncludeFolder( const KUrl& folder, bool recursive );

            void setIncludeFolders( const KUrl::List& folders );

            void setIncludeFolders( const QHash<KUrl, bool>& folders );

            KUrl::List includeFolders() const;

            QHash<KUrl, bool> allIncludeFolders() const;

            void addExcludeFolder( const KUrl& folder );

            void setExcludeFolders( const KUrl::List& folders );

            KUrl::List excludeFolders() const;

            enum FileModeFlags {
                QueryFiles = 0x1,
                QueryFolders = 0x2,
                QueryFilesAndFolders = QueryFiles|QueryFolders
            };
            Q_DECLARE_FLAGS( FileMode, FileModeFlags )

            
            void setFileMode( FileMode mode );

            FileMode fileMode() const;
        };
    }
}

Q_DECLARE_OPERATORS_FOR_FLAGS( Nepomuk2::Query::FileQuery::FileMode )

#endif