searchwidget.h

Go to the documentation of this file.

/*
  Copyright (c) 2010 Oszkar Ambrus <aoszkar@gmail.com>
  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 RESOURCESEARCHWIDGET_H
#define RESOURCESEARCHWIDGET_H

#include <QWidget>
#include <QAbstractItemView>

#include "query.h"
#include "nepomukutils_export.h"

namespace Nepomuk {
    class Resource;

    namespace Utils {
        class FacetWidget;

        class NEPOMUKUTILS_EXPORT SearchWidget : public QWidget
        {
            Q_OBJECT

        public:
            SearchWidget(QWidget *parent = 0);

            ~SearchWidget();

            enum ConfigFlag {
                NoConfigFlags = 0x0,

                ShowFacets = 0x1,

                SearchWhileYouType = 0x2,

                DefaultConfigFlags = ShowFacets
            };
            Q_DECLARE_FLAGS( ConfigFlags, ConfigFlag )

            
            void setConfigFlags( ConfigFlags flags );

            ConfigFlags configFlags() const;

            void setSelectionMode(QAbstractItemView::SelectionMode mode);

            QAbstractItemView::SelectionMode selectionMode () const;

            Query::Query baseQuery() const;

            Query::Query query() const;

            Resource currentResource() const;

            QList<Resource> selectedResources() const;

            FacetWidget* facetWidget() const;

            static Nepomuk::Resource searchResource( QWidget* parent = 0,
                                                     const Nepomuk::Query::Query& baseQuery = Nepomuk::Query::Query(),
                                                     SearchWidget::ConfigFlags flags = SearchWidget::DefaultConfigFlags );

            static QList<Nepomuk::Resource> searchResources( QWidget* parent = 0,
                                                             const Nepomuk::Query::Query& baseQuery = Nepomuk::Query::Query(),
                                                             SearchWidget::ConfigFlags flags = SearchWidget::DefaultConfigFlags );

        public Q_SLOTS:
            Nepomuk::Query::Query setQuery( const Nepomuk::Query::Query& query );

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

        Q_SIGNALS:
            void selectionChanged();

        private:
            class SearchWidgetPrivate;
            SearchWidgetPrivate * const d_ptr;

            Q_DECLARE_PRIVATE(SearchWidget)

            Q_PRIVATE_SLOT( d_ptr, void _k_queryComponentChanged() )
            Q_PRIVATE_SLOT( d_ptr, void _k_listingFinished() )
        };
    }
}

Q_DECLARE_OPERATORS_FOR_FLAGS( Nepomuk::Utils::SearchWidget::ConfigFlags )

#endif // RESOURCESEARCHWIDGET_H