facet.h

Go to the documentation of this file.

/*
   This file is part of the Nepomuk KDE project.
   Copyright (C) 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 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 _NEPOMUK_QUERY_FACET_H_
#define _NEPOMUK_QUERY_FACET_H_

#include <QtCore/QObject>

#include "nepomukutils_export.h"

class KGuiItem;

namespace Nepomuk {
    namespace Query {
        class Term;
        class Query;
    }

    namespace Utils {
        class NEPOMUKUTILS_EXPORT Facet : public QObject
        {
            Q_OBJECT

        public:
            Facet( QObject* parent = 0 );

            virtual ~Facet();

            enum SelectionMode {
                MatchAll,

                MatchAny,

                MatchOne
            };

            virtual SelectionMode selectionMode() const = 0;

            virtual Query::Term queryTerm() const = 0;

            virtual int count() const = 0;

            virtual QString text( int index ) const;

            virtual KGuiItem guiItem( int index ) const;

            virtual bool isSelected( int index ) const = 0;

            Query::Query clientQuery() const;

            static Facet* createFileTypeFacet( QObject* parent = 0 );

            static Facet* createTypeFacet( QObject* parent = 0 );

            static Facet* createDateFacet( QObject* parent = 0 );

            static Facet* createTagFacet( QObject* parent = 0 );

            static Facet* createPriorityFacet( QObject* parent = 0 );

            static Facet* createRatingFacet( QObject* parent = 0 );

        public Q_SLOTS:
            virtual void clearSelection() = 0;

            virtual void setSelected( int index, bool selected = true ) = 0;

            virtual bool selectFromTerm( const Nepomuk::Query::Term& queryTerm ) = 0;

            void setClientQuery( const Nepomuk::Query::Query& query );

        Q_SIGNALS:
            void queryTermChanged( Nepomuk::Utils::Facet* facet, const Nepomuk::Query::Term& queryTerm );

            void layoutChanged( Nepomuk::Utils::Facet* facet );

            void selectionChanged( Nepomuk::Utils::Facet* facet );

        protected Q_SLOTS:
            void setQueryTermChanged();

            void setLayoutChanged();

            void setSelectionChanged();

        protected:
            virtual void handleClientQueryChange();

        private:
            class FacetPrivate;
            FacetPrivate* const d;
        };
    }
}

#endif