summaryrefslogtreecommitdiff
path: root/src/nepomuk/utils/resourcemodel.h
diff options
context:
space:
mode:
authorAndrea Diamantini <adjam7@gmail.com>2013-02-10 10:10:45 +0100
committerAndrea Diamantini <adjam7@gmail.com>2013-02-10 10:10:45 +0100
commit09983747f71fd7bd8f8dc0cece1fe3b4a996ef72 (patch)
tree91e843d5e6242af8c4d7cee3722d4eddca97524a /src/nepomuk/utils/resourcemodel.h
parentSVN_SILENT made messages (.desktop file) (diff)
downloadrekonq-09983747f71fd7bd8f8dc0cece1fe3b4a996ef72.tar.xz
Restore rekonq migration to nepomuk2
Being kde 4.10 been released, we are ready to. I yet could not understand if this compiles (without nepomuk) in 4.9. CCMAIL:david.narvaez@computer.org CCMAIL:me@vhanda.in REVIEW: 108152
Diffstat (limited to 'src/nepomuk/utils/resourcemodel.h')
-rw-r--r--src/nepomuk/utils/resourcemodel.h177
1 files changed, 177 insertions, 0 deletions
diff --git a/src/nepomuk/utils/resourcemodel.h b/src/nepomuk/utils/resourcemodel.h
new file mode 100644
index 00000000..526c7ac0
--- /dev/null
+++ b/src/nepomuk/utils/resourcemodel.h
@@ -0,0 +1,177 @@
+/*
+ This file is part of the Nepomuk KDE project.
+ Copyright (C) 2007-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_RESOUCE_MODEL_H_
+#define _NEPOMUK_RESOUCE_MODEL_H_
+
+#include <QtCore/QAbstractItemModel>
+
+#include "nepomukutils_export.h"
+
+namespace Nepomuk2 {
+
+ class Resource;
+
+ namespace Utils {
+ /**
+ * \class ResourceModel resourcemodel.h Nepomuk/Utils/ResourceModel
+ *
+ * \brief Base class for all models providing a plain list of resources.
+ *
+ * The %ResourceModel is a base class for models that handle a set of
+ * %Nepomuk Resource instances. This can be a simple list as in SimpleResourceModel
+ * or a set of query results as in ResultModel. It could also be a dynamic list
+ * which is updated while the user scrolls it.
+ *
+ * %ResourceModel cannot be instanciated by itself. Use one of the subclasses
+ * or derive your own subclass from it.
+ *
+ * At least the following methods need to be implemented in a subclass:
+ * \li resourceForIndex()
+ * \li indexForResource(),
+ * \li QAbstractItemModel::rowCount()
+ * \li QAbstractItemModel::index()
+ *
+ * \author Sebastian Trueg <trueg@kde.org>
+ *
+ * \since 4.6
+ */
+ class NEPOMUKUTILS_EXPORT ResourceModel : public QAbstractItemModel
+ {
+ Q_OBJECT
+
+ public:
+ /**
+ * Constructor.
+ */
+ ResourceModel( QObject* parent = 0 );
+
+ /**
+ * Destructor
+ */
+ virtual ~ResourceModel();
+
+ /**
+ * The columns supported by ResourceModel are identified
+ * by this enumeration.
+ */
+ enum ResourceModelColumns {
+ /// The first column displays the label of the resource and its icon
+ ResourceColumn = 0,
+
+ /// The second column displays the resource's type
+ ResourceTypeColumn = 1,
+
+ /// The number of columns
+ ResourceModelColumnCount = 2
+ };
+
+ /**
+ * Custom roles that can be accessed for example in delegates.
+ */
+ enum ResourceRoles {
+ /**
+ * The resource itself, provided as a Nepomuk::Resource instance.
+ */
+ ResourceRole = 7766897,
+
+ /**
+ * The type of the resource, provided as a Nepomuk::Types::Class
+ * instance.
+ */
+ ResourceTypeRole = 687585,
+
+ /**
+ * The creation date of the resource.
+ */
+ ResourceCreationDateRole = 7766898
+ };
+
+ /**
+ * Get the Resource which corresponds to \p index.
+ *
+ * \return The Resource which corresponds to \p index or an invalid Resource
+ * if \p index is invalid.
+ */
+ virtual Resource resourceForIndex( const QModelIndex& index ) const = 0;
+
+ /**
+ * Get the index for a resource.
+ *
+ * \return The index which corresponds to \p res of an invalid QModelIndex
+ * if \p res is not part of this model.
+ */
+ virtual QModelIndex indexForResource( const Resource& res ) const = 0;
+
+ /**
+ * The default implementation returns an invalid QModelIndex, thus providing
+ * a plain list.
+ */
+ virtual QModelIndex parent( const QModelIndex& child ) const;
+
+ /**
+ * The default implementation returns 2 with the first column representing the resource
+ * itself and the second one showing the type.
+ */
+ virtual int columnCount( const QModelIndex& parent ) const;
+
+ /**
+ * Handles most roles typically used in applications like Qt::DisplayRole, Qt::ToolTipRole,
+ * and Qt::DecorationRole. Additionally KCategorizedSortFilterProxyModel roles are supported
+ * categorizing by resource types.
+ */
+ virtual QVariant data( const QModelIndex& index, int role = Qt::DisplayRole ) const;
+
+ /**
+ * Provides header data for the supported columns.
+ */
+ virtual QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const;
+
+ /**
+ * Reimplemented to support dragging of resources out of the model.
+ */
+ virtual Qt::ItemFlags flags( const QModelIndex& index ) const;
+
+ /**
+ * Stores the resource URIs via KUrl::List::populateMimeData() and as a specific
+ * "application/x-nepomuk-resource-uri" mime type to indicate that these are URIs
+ * corresponding to actual %Nepomuk resources.
+ */
+ virtual QMimeData* mimeData( const QModelIndexList& indexes ) const;
+
+ /**
+ * \return The KUrl mime types and "application/x-nepomuk-resource-uri".
+ */
+ virtual QStringList mimeTypes() const;
+
+ /**
+ * Provided for future extensions.
+ */
+ virtual bool setData( const QModelIndex& index, const QVariant& value, int role );
+
+ private:
+ class Private;
+ Private* const d;
+ };
+ }
+}
+
+#endif