File indexing completed on 2024-05-12 16:39:40

0001 /* This file is part of the KDE project
0002    Copyright (C) 2011 Jarosław Staniek <staniek@kde.org>
0003 
0004    This library is free software; you can redistribute it and/or
0005    modify it under the terms of the GNU Library General Public
0006    License as published by the Free Software Foundation; either
0007    version 2 of the License, or (at your option) any later version.
0008 
0009    This library is distributed in the hope that it will be useful,
0010    but WITHOUT ANY WARRANTY; without even the implied warranty of
0011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012    Library General Public License for more details.
0013 
0014    You should have received a copy of the GNU Library General Public License
0015    along with this library; see the file COPYING.LIB.  If not, write to
0016    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0017  * Boston, MA 02110-1301, USA.
0018 */
0019 
0020 #ifndef KEXISEARCHABLEMODEL_H
0021 #define KEXISEARCHABLEMODEL_H
0022 
0023 #include "kexicore_export.h"
0024 #include <kexi_global.h>
0025 #include <QObject>
0026 
0027 class QModelIndex;
0028 class QVariant;
0029 class QString;
0030 class KexiSearchableModel;
0031 
0032 //! Notifier used by KexiSearchableModel to inform about deleting of the model
0033 class KEXICORE_EXPORT KexiSearchableModelDeleteNotifier : public QObject
0034 {
0035     Q_OBJECT
0036 public:
0037     ~KexiSearchableModelDeleteNotifier();
0038 
0039 Q_SIGNALS:
0040     //! Emitted by KexiSearchableModel to inform about deleting of the model
0041     void aboutToDelete(KexiSearchableModel *model);
0042 
0043 private:
0044     KexiSearchableModelDeleteNotifier();
0045 
0046     friend class KexiSearchableModel;
0047 };
0048 
0049 class KEXICORE_EXPORT KexiSearchableModel
0050 {
0051 public:
0052     KexiSearchableModel();
0053     virtual ~KexiSearchableModel();
0054     virtual int searchableObjectCount() const = 0;
0055     virtual QModelIndex sourceIndexForSearchableObject(int objectIndex) const = 0;
0056     virtual QVariant searchableData(const QModelIndex &sourceIndex, int role) const = 0;
0057     virtual QString pathFromIndex(const QModelIndex &sourceIndex) const = 0;
0058     virtual bool highlightSearchableObject(const QModelIndex &index) = 0;
0059     virtual bool activateSearchableObject(const QModelIndex &index) = 0;
0060 
0061     //! Returns notifier object that can be used to connect to its notification signal.
0062     //! This indirection is needed because the KexiSearchableModel class is not a QObject.
0063     const KexiSearchableModelDeleteNotifier* deleteNotifier() const;
0064 
0065 private:
0066     class Private;
0067     const QScopedPointer<Private> d;
0068 };
0069 
0070 #endif