dynamicresourcefacet.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_DYNAMIC_RESOURCE_FACET_H_
#define _NEPOMUK_QUERY_DYNAMIC_RESOURCE_FACET_H_

#include "facet.h"
#include "nepomukutils_export.h"

#include <QtCore/QList>

namespace Nepomuk {
    class Resource;
    namespace Types {
        class Property;
        class Class;
    }
    namespace Query {
        class Result;
    }

    namespace Utils {
        class NEPOMUKUTILS_EXPORT DynamicResourceFacet : public Facet
        {
            Q_OBJECT

        public:
            DynamicResourceFacet( QObject* parent = 0 );

            virtual ~DynamicResourceFacet();

            Query::Term queryTerm() const;

            void setSelectionMode( SelectionMode mode );

            SelectionMode selectionMode() const;

            int count() const;

            KGuiItem guiItem( int index ) const;

            bool isSelected( int index ) const;

            void setRelation( const Types::Property& prop );

            void setResourceType( const Types::Class& type );

            void setMaxRows( int max );

            Types::Property relation() const;

            Types::Class resourceType() const;

            int maxRows() const;

            Nepomuk::Resource resourceAt( int i ) const;

            QList<Resource> selectedResources() const;

        public Q_SLOTS:
            void clearSelection();

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

            void setSelected( const Nepomuk::Resource& res, bool selected = true );

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

        protected:
            virtual Query::Query resourceQuery( const Query::Query& clientQuery ) const;

            virtual Nepomuk::Query::Term termForResource( const Resource& res ) const;

            virtual Nepomuk::Resource resourceForTerm( const Nepomuk::Query::Term& queryTerm ) const;

            virtual QList<Resource> getMoreResources() const;

            void handleClientQueryChange();

#ifdef BUILDING_NEPOMUK_TESTS
        protected:
#else
        private:
#endif
            class Private;
            Private* d;

            Q_PRIVATE_SLOT( d, void _k_newEntries( const QList<Nepomuk::Query::Result>& ) )
            Q_PRIVATE_SLOT( d, void _k_populateFinished() )
        };
    }
}

#endif