File indexing completed on 2024-05-12 04:19:48

0001 // vim: set tabstop=4 shiftwidth=4 expandtab:
0002 /*
0003 Gwenview: an image viewer
0004 Copyright 2008 Aurélien Gâteau <agateau@kde.org>
0005 
0006 This program is free software; you can redistribute it and/or
0007 modify it under the terms of the GNU General Public License
0008 as published by the Free Software Foundation; either version 2
0009 of the License, or (at your option) any later version.
0010 
0011 This program is distributed in the hope that it will be useful,
0012 but WITHOUT ANY WARRANTY; without even the implied warranty of
0013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0014 GNU General Public License for more details.
0015 
0016 You should have received a copy of the GNU General Public License
0017 along with this program; if not, write to the Free Software
0018 Foundation, Inc., 51 Franklin Street, Fifth Floor, Cambridge, MA 02110-1301, USA.
0019 
0020 */
0021 #ifndef TAGMODEL_H
0022 #define TAGMODEL_H
0023 
0024 #include <lib/gwenviewlib_export.h>
0025 
0026 // Qt
0027 #include <QStandardItemModel>
0028 
0029 // KF
0030 
0031 // Local
0032 
0033 namespace Gwenview
0034 {
0035 using SemanticInfoTag = QString;
0036 
0037 class AbstractSemanticInfoBackEnd;
0038 class TagSet;
0039 
0040 struct TagModelPrivate;
0041 class GWENVIEWLIB_EXPORT TagModel : public QStandardItemModel
0042 {
0043     Q_OBJECT
0044 public:
0045     explicit TagModel(QObject *);
0046     ~TagModel() override;
0047 
0048     enum {
0049         TagRole = Qt::UserRole,
0050         SortRole,
0051         AssignmentStatusRole,
0052     };
0053 
0054     enum AssignmentStatus {
0055         PartiallyAssigned,
0056         FullyAssigned,
0057     };
0058 
0059     void setSemanticInfoBackEnd(AbstractSemanticInfoBackEnd *);
0060     void setTagSet(const TagSet &set);
0061 
0062     /**
0063      * Convenience method to create a TagModel showing all tags available in
0064      * AbstractSemanticInfoBackEnd
0065      */
0066     static TagModel *createAllTagsModel(QObject *parent, AbstractSemanticInfoBackEnd *);
0067 
0068 public Q_SLOTS:
0069     /**
0070      * Add a new tag. If label is empty, backend will be queried for it
0071      */
0072     void addTag(const SemanticInfoTag &tag, const QString &label = QString(), AssignmentStatus status = FullyAssigned);
0073 
0074     void removeTag(const SemanticInfoTag &tag);
0075 
0076 private:
0077     TagModelPrivate *const d;
0078 };
0079 
0080 } // namespace
0081 
0082 #endif /* TAGMODEL_H */