/usr/include/nepomuk/searchwidget.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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | /*
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 SearchWidget searchwidget.h Nepomuk/Utils/SearchWidget
*
* \brief Provides a GUI for searching files or resources of any type.
*
* The SearchWidget combines the different search GUI elements provided in
* Nepomuk in one widget: a line edit which allows to type in a query and
* the facet widget.
*
* The SearchWidget allows to specify a base query which is fixed and cannot
* be changed by the user. This allows to restrict the set of resources searched
* by the user.
*
* \author Oszkar Ambrus <aoszkar@gmail.com>, Sebastian Trueg <trueg@kde.org>
*
* \since 4.6
*/
class NEPOMUKUTILS_EXPORT SearchWidget : public QWidget
{
Q_OBJECT
public:
/**
* Constructor.
*/
SearchWidget(QWidget *parent = 0);
/**
* Destructor
*/
~SearchWidget();
/**
* The config flags can be used to configure
* the search widget to fit the needs of the application.
*/
enum ConfigFlag {
/// no flags, a plain search widget
NoConfigFlags = 0x0,
/// show the facets allowing the user to modify the query
ShowFacets = 0x1,
/// enable auto searching while the user is typing in the query (live query)
SearchWhileYouType = 0x2,
/// the default: show facets and disable live query
DefaultConfigFlags = ShowFacets
};
Q_DECLARE_FLAGS( ConfigFlags, ConfigFlag )
/**
* Set the config flags to be used. Defaults to DefaultConfigFlags.
*
* \sa configFlags()
*/
void setConfigFlags( ConfigFlags flags );
/**
* The config flags set via setConfigFlags().
*/
ConfigFlags configFlags() const;
/**
* Sets the selection mode of the view to @p mode
*/
void setSelectionMode(QAbstractItemView::SelectionMode mode);
/**
* @returns the selection mode of the view
*/
QAbstractItemView::SelectionMode selectionMode () const;
/**
* @returns the base query set via setBaseQuery().
*/
Query::Query baseQuery() const;
/**
* Construct the query currently used by this widget including
* the baseQuery(), all facets, and the user desktop query.
*/
Query::Query query() const;
/**
* @returns the current resource if any, an invalid resource if none is selected
*/
Resource currentResource() const;
/**
* @returns a list of all selected resources.
*/
QList<Resource> selectedResources() const;
/**
* The facet widget that is used internally. By default a predefined set of facets
* is used. This method can be used to access the FacetWidget in order to change its
* configuration.
*/
FacetWidget* facetWidget() const;
/**
* Creates a dialog embedding a SearchWidget that allows the user to select one resource from the
* result set.
*
* \return The Resource the user selected or an invalid one in case there was no result to choose
* or the user canceled the search.
*/
static Nepomuk::Resource searchResource( QWidget* parent = 0,
const Nepomuk::Query::Query& baseQuery = Nepomuk::Query::Query(),
SearchWidget::ConfigFlags flags = SearchWidget::DefaultConfigFlags );
/**
* Creates a dialog embedding a SearchWidget that allows the user to select resources from the
* result set.
*
* \return The resources the user selected or an empty list in case there was no result to choose
* or the user canceled the search.
*/
static QList<Nepomuk::Resource> searchResources( QWidget* parent = 0,
const Nepomuk::Query::Query& baseQuery = Nepomuk::Query::Query(),
SearchWidget::ConfigFlags flags = SearchWidget::DefaultConfigFlags );
public Q_SLOTS:
/**
* Set the query currently configured in the widget. Parts that cannot be converted into
* facets or a user desktop query string are returned.
*
* \param query The query that the widget should represent after the call.
*
* \return The rest query which could not be converted into facets and a desktop query.
*/
Nepomuk::Query::Query setQuery( const Nepomuk::Query::Query& query );
/**
* Set the base query. The base query is the fixed part of the query
* which cannot be changed by the user. It allows to restrict the
* searched set of resources.
*
* Be default the base query is empty, ie. an invalid Query.
*
* \param query The new base query.
*
* Be aware that setting the base query will reset widget's query components.
*/
void setBaseQuery( const Nepomuk::Query::Query& query );
Q_SIGNALS:
/**
* Emitted when the selection is changed, ie. the values returned by currentResource() and
* selectedResources() have changed.
*/
void selectionChanged();
/**
* \brief Emited when current resource is changed
*/
void currentResourceChanged(const Nepomuk::Resource & previous, const Nepomuk::Resource & current );
private:
class SearchWidgetPrivate;
SearchWidgetPrivate * const d_ptr;
Q_DECLARE_PRIVATE(SearchWidget)
/*! \brief Convert QModelIndex to Nepomuk::Resource and emit currentResourceChanged signal
*/
Q_PRIVATE_SLOT( d_ptr, void _k_forwardCurrentChanged( const QModelIndex &, const QModelIndex &));
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
|