Differential D21721 Diff 64978 src/core/commentsmodel.h

Changeset View

Standalone View

View Options

src/core/commentsmodel.h

  • This file was added.
1​/*
2​ * Copyright (C) 2019 Dan Leinir Turthra Jensen <admin@leinir.dk>
3​ *
4​ * This library is free software; you can redistribute it and/or
5​ * modify it under the terms of the GNU Lesser General Public
6​ * License as published by the Free Software Foundation; either
7​ * version 2.1 of the License, or (at your option) version 3, or any
8​ * later version accepted by the membership of KDE e.V. (or its
9​ * successor approved by the membership of KDE e.V.), which shall
10​ * act as a proxy defined in Section 6 of version 3 of the license.
11​ *
12​ * This library is distributed in the hope that it will be useful,
13​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
14​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​ * Lesser General Public License for more details.
16​ *
17​ * You should have received a copy of the GNU Lesser General Public
18​ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19​ *
20​ */
21​
22​#ifndef KNSCORE_COMMENTSMODEL_H
23​#define KNSCORE_COMMENTSMODEL_H
24​
25​#include <QAbstractListModel>
26​#include <QDateTime>
27​
28​#include "engine.h"
29​
30​#include "knewstuffcore_export.h"
31​
32​namespace KNSCore
33​{
34​class EntryInternal;
35​
36​struct Comment {
37​ QString id;
38​ QString subject;
39​ QString text;
40​ int childCount = 0;
41​ QString username;
42​ QDateTime date;
43​ int score = 0;
44​ std::shared_ptr<KNSCore::Comment> parent;
45​};
46​
47​/**
48​ * @brief A model which takes care of the comments for a single EntryInternal
49​ *
50​ * This model should preferably be constructed by asking the Engine to give a model
51​ * instance to you for a specific entry using the commentsForEntry function. If you
ahiemstraUnsubmitted
Done

Considering this is intended to be used from QML, I would drop this, especially since the current code in engine does nothing special. And changing this would allow for doing CommentsModel { entry: someEntry } from QML.

ahiemstra: Considering this is intended to be used from QML, I would drop this, especially since the…
leinirAuthorUnsubmitted
Done

It's not really intended to be used from QML, i really only left out a more clever wrapper because... well, it's not really that heavy. But, prompted by this, i have in fact produced that abstraction, so there is now a NewStuff.CommentsModel, which makes things a bit easier during implementation, and more delarativey ;)

leinir: It's not really intended to be used from QML, i really only left out a more clever wrapper…
52​ * insist, you can construct an instance yourself as well, but this is not recommended.
53​ *
54​ * @see Engine::commentsForEntry(KNSCore::EntryInternal)
55​ * @since 5.61
56​ */
57​class KNEWSTUFFCORE_EXPORT CommentsModel : public QAbstractListModel
58​{
59​ Q_OBJECT
60​ /**
61​ * The Entry for which this model should handle comments
62​ */
63​ Q_PROPERTY(KNSCore::EntryInternal entry READ entry WRITE setEntry NOTIFY entryChanged)
64​public:
65​ /**
66​ * Construct a new CommentsModel instance.
67​ * @note The class is intended to be constructed using the Engine::commentsForEntry function
68​ * @see Engine::commentsForEntry(KNSCore::EntryInternal)
69​ */
70​ explicit CommentsModel(Engine *parent = nullptr);
71​ virtual ~CommentsModel();
broulikUnsubmitted
Done

Why is this an explicit Engine pointer rather than generic QObject?

broulik: Why is this an explicit `Engine` pointer rather than generic `QObject`?
leinirAuthorUnsubmitted
Done

Entirely to make it awkward for people to use it in a counter-intended fashion :)

leinir: Entirely to make it awkward for people to use it in a counter-intended fashion :)
72​
broulikUnsubmitted
Done

~CommentsModel() override;?

broulik: `~CommentsModel() override;`?
73​ enum Roles {
74​ IdRole = Qt::UserRole + 1,
75​ SubjectRole,
76​ TextRole,
broulikUnsubmitted
Done

You might want to set that to Qt::DisplayRole

broulik: You might want to set that to `Qt::DisplayRole`
leinirAuthorUnsubmitted
Done

Hmm... i guess, except that it's not reeeally the obvious choice (because i don't really see one of those)... but yeah, having one is probably not terrible anyway.

leinir: Hmm... i guess, except that it's not reeeally the obvious choice (because i don't really see…
77​ ChildCountRole,
78​ UsernameRole,
79​ DateRole,
80​ ScoreRole,
81​ ParentIndexRole,
82​ DepthRole
83​ };
84​ Q_ENUM(Roles)
85​
86​ QHash< int, QByteArray > roleNames() const override;
87​ QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;
88​ Q_INVOKABLE QVariant data(int index, int role = Qt::DisplayRole) const;
89​ int rowCount(const QModelIndex& parent = QModelIndex()) const override;
broulikUnsubmitted
Done

QModelIndex is usable from QML these days, this overload isn't neccessary, you can do from QML:

model.data(model.index(row, column), role);
broulik: `QModelIndex` is usable from QML these days, this overload isn't neccessary, you can do from…
leinirAuthorUnsubmitted
Done

Aah! i did not know this, very handy indeed. Couple of places where that'll make life simpler :)

leinir: Aah! i did not know this, very handy indeed. Couple of places where that'll make life simpler :)
90​ bool canFetchMore(const QModelIndex & parent) const override;
91​ void fetchMore(const QModelIndex & parent) override;
92​
93​ const KNSCore::EntryInternal &entry() const;
94​ void setEntry(const KNSCore::EntryInternal &newEntry);
95​ Q_SIGNAL void entryChanged();
96​
97​private:
98​ class Private;
99​ Private* d;
100​};
101​}
102​
103​#endif//KNSCORE_COMMENTSMODEL_H