Move ChatDocumentHandler and related includes to LibNeoChat

src/libneochat/models/userlistmodel.h

@@ -0,0 +1,103 @@
+// SPDX-FileCopyrightText: 2018 Black Hat <bhat@encom.eu.org>
+// SPDX-License-Identifier: GPL-3.0-only
+
+#pragma once
+
+#include <Quotient/room.h>
+
+#include <QAbstractListModel>
+#include <QObject>
+#include <QPointer>
+#include <QQmlEngine>
+
+class NeoChatRoom;
+
+namespace Quotient
+{
+class User;
+}
+
+/**
+ * @class UserListModel
+ *
+ * This class defines the model for listing the users in a room.
+ *
+ * As well as gathering all the users from a room, the model ensures that they are
+ * sorted in alphabetical order.
+ *
+ * @sa NeoChatRoom
+ */
+class UserListModel : public QAbstractListModel
+{
+    Q_OBJECT
+    QML_ELEMENT
+
+    /**
+     * @brief The room that the model is getting its users from.
+     */
+    Q_PROPERTY(NeoChatRoom *room READ room WRITE setRoom NOTIFY roomChanged)
+
+public:
+    /**
+     * @brief Defines the model roles.
+     */
+    enum EventRoles {
+        DisplayNameRole = Qt::DisplayRole, /**< The user's display name in the current room. */
+        UserIdRole, /**< Matrix ID of the user. */
+        AvatarRole, /**< The source URL for the user's avatar in the current room. */
+        ObjectRole, /**< The QObject for the user. */
+        PowerLevelRole, /**< The user's power level in the current room. */
+        PowerLevelStringRole, /**< The name of the user's power level in the current room. */
+    };
+    Q_ENUM(EventRoles)
+
+    explicit UserListModel(QObject *parent = nullptr);
+
+    [[nodiscard]] NeoChatRoom *room() const;
+    void setRoom(NeoChatRoom *room);
+
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
+    [[nodiscard]] QVariant data(const QModelIndex &index, int role) const override;
+
+    /**
+     * @brief Number of rows in the model.
+     *
+     * @sa  QAbstractItemModel::rowCount
+     */
+    [[nodiscard]] int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+
+    /**
+     * @brief Returns a mapping from Role enum values to role names.
+     *
+     * @sa EventRoles, QAbstractItemModel::roleNames()
+     */
+    [[nodiscard]] QHash<int, QByteArray> roleNames() const override;
+
+    void activate();
+
+Q_SIGNALS:
+    void roomChanged();
+    void usersRefreshed();
+
+protected:
+    bool event(QEvent *event) override;
+
+private Q_SLOTS:
+    void memberJoined(const Quotient::RoomMember &member);
+    void memberLeft(const Quotient::RoomMember &member);
+    void refreshMember(const Quotient::RoomMember &member, const QList<int> &roles = {});
+    void refreshAllMembers();
+
+private:
+    QPointer<NeoChatRoom> m_currentRoom;
+    QList<QString> m_members;
+
+    bool m_active = false;
+
+    int findUserPos(const Quotient::RoomMember &member) const;
+    [[nodiscard]] int findUserPos(const QString &username) const;
+};