ESCA111/neochat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document and Cleanup userlistmodel

Browse Source 
Document and cleanup userlist model.

- Remove unneeded enum UserTypes
- Cleanup includes and remove need to include QPointer
- make clear that it is a user or users that are being refreshed

Note: breaks libquotient 0.6 compatibility because of the changes to how m_currentRoom is handled
This commit is contained in:
James Graham
2023-04-29 14:53:01 +00:00
committed by Tobias Fella
parent 014185c4c9
commit ca805917de
3 changed files with 65 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/main.cpp
View File

@@ -243,7 +243,6 @@ int main(int argc, char *argv[])
qmlRegisterUncreatableType<PushNotificationState>("org.kde.neochat", 1, 0, "PushNotificationState", "ENUM");
qmlRegisterUncreatableType<PushNotificationAction>("org.kde.neochat", 1, 0, "PushNotificationAction", "ENUM");
qmlRegisterUncreatableType<NeoChatRoomType>("org.kde.neochat", 1, 0, "NeoChatRoomType", "ENUM");
qmlRegisterUncreatableType<UserType>("org.kde.neochat", 1, 0, "UserType", "ENUM");
qmlRegisterUncreatableType<NeoChatUser>("org.kde.neochat", 1, 0, "NeoChatUser", {});
qRegisterMetaType<User *>("User*");

64
src/models/userlistmodel.cpp
View File

@@ -7,7 +7,6 @@
#include <events/roompowerlevelsevent.h>
#include "neochatroom.h"
#include "neochatuser.h"
using namespace Quotient;
@@ -23,40 +22,20 @@ void UserListModel::setRoom(NeoChatRoom *room)
return;
}
beginResetModel();
if (m_currentRoom) {
m_currentRoom->disconnect(this);
// m_currentRoom->connection()->disconnect(this);
for (User *user : std::as_const(m_users)) {
user->disconnect(this);
}
m_users.clear();
}
m_currentRoom = room;
if (m_currentRoom) {
connect(m_currentRoom, &Room::userAdded, this, &UserListModel::userAdded);
connect(m_currentRoom, &Room::userRemoved, this, &UserListModel::userRemoved);
connect(m_currentRoom, &Room::memberAboutToRename, this, &UserListModel::userRemoved);
connect(m_currentRoom, &Room::memberRenamed, this, &UserListModel::userAdded);
connect(m_currentRoom, &Room::changed, this, &UserListModel::refreshAll);
{
m_users = m_currentRoom->users();
std::sort(m_users.begin(), m_users.end(), room->memberSorter());
}
for (User *user : std::as_const(m_users)) {
#ifdef QUOTIENT_07
connect(user, &User::defaultAvatarChanged, this, [this, user]() {
avatarChanged(user, m_currentRoom);
});
#else
connect(user, &User::avatarChanged, this, &UserListModel::avatarChanged);
#endif
}
connect(m_currentRoom->connection(), &Connection::loggedOut, this, [this]() {
setRoom(nullptr);
});
connect(m_currentRoom, &Room::changed, this, &UserListModel::refreshAllUsers);
}
endResetModel();
refreshAllUsers();
Q_EMIT roomChanged();
}
@@ -80,7 +59,9 @@ QVariant UserListModel::data(const QModelIndex &index, int role) const
}
if (index.row() >= m_users.count()) {
return QStringLiteral("DEADBEEF");
qDebug() << "UserListModel, something's wrong: index.row() >= "
"users.count()";
return {};
}
auto user = m_users.at(index.row());
if (role == NameRole) {
@@ -133,7 +114,6 @@ int UserListModel::rowCount(const QModelIndex &parent) const
if (parent.isValid()) {
return 0;
}
return m_users.count();
}
@@ -145,10 +125,12 @@ void UserListModel::userAdded(Quotient::User *user)
endInsertRows();
#ifdef QUOTIENT_07
connect(user, &User::defaultAvatarChanged, this, [this, user]() {
avatarChanged(user, m_currentRoom);
refreshUser(user, {AvatarRole});
});
#else
connect(user, &Quotient::User::avatarChanged, this, &UserListModel::avatarChanged);
connect(user, &Quotient::User::avatarChanged, this, [this, user]() {
refreshUser(user, {AvatarRole});
});
#endif
}
@@ -165,7 +147,7 @@ void UserListModel::userRemoved(Quotient::User *user)
}
}
void UserListModel::refresh(Quotient::User *user, const QVector<int> &roles)
void UserListModel::refreshUser(Quotient::User *user, const QVector<int> &roles)
{
auto pos = findUserPos(user);
if (pos != m_users.size()) {
@@ -175,7 +157,7 @@ void UserListModel::refresh(Quotient::User *user, const QVector<int> &roles)
}
}
void UserListModel::refreshAll()
void UserListModel::refreshAllUsers()
{
beginResetModel();
for (User *user : std::as_const(m_users)) {
@@ -183,17 +165,18 @@ void UserListModel::refreshAll()
}
m_users.clear();
{
m_users = m_currentRoom->users();
std::sort(m_users.begin(), m_users.end(), m_currentRoom->memberSorter());
}
m_users = m_currentRoom->users();
std::sort(m_users.begin(), m_users.end(), m_currentRoom->memberSorter());
for (User *user : std::as_const(m_users)) {
#ifdef QUOTIENT_07
connect(user, &User::defaultAvatarChanged, this, [this, user]() {
avatarChanged(user, m_currentRoom);
refreshUser(user, {AvatarRole});
});
#else
connect(user, &User::avatarChanged, this, &UserListModel::avatarChanged);
connect(user, &User::avatarChanged, this, [this, user]() {
refreshUser(user, {AvatarRole});
});
#endif
}
connect(m_currentRoom->connection(), &Connection::loggedOut, this, [this]() {
@@ -203,13 +186,6 @@ void UserListModel::refreshAll()
Q_EMIT usersRefreshed();
}
void UserListModel::avatarChanged(Quotient::User *user, const Quotient::Room *context)
{
if (context == m_currentRoom) {
refresh(user, {AvatarRole});
}
}
int UserListModel::findUserPos(Quotient::User *user) const
{
return findUserPos(m_currentRoom->safeMemberName(user->id()));

73
src/models/userlistmodel.h
View File

@@ -3,8 +3,6 @@
#pragma once
#include <room.h>
#include <QAbstractListModel>
#include <QObject>
#include <QPointer>
@@ -14,37 +12,38 @@ class NeoChatRoom;
namespace Quotient
{
class User;
class Room;
}
class UserType : public QObject
{
Q_OBJECT
public:
enum Types {
Owner = 1,
Admin,
Moderator,
Member,
Muted,
Custom,
};
Q_ENUM(Types)
};
/**
* @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
/**
* @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 {
NameRole = Qt::UserRole + 1,
UserIdRole,
AvatarRole,
ObjectRole,
PowerLevelRole,
PowerLevelStringRole,
NameRole = Qt::UserRole + 1, /**< 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. */
};
UserListModel(QObject *parent = nullptr);
@@ -52,11 +51,30 @@ public:
[[nodiscard]] NeoChatRoom *room() const;
void setRoom(NeoChatRoom *room);
/**
* @brief The user at the given index of the model.
*/
[[nodiscard]] Quotient::User *userAt(QModelIndex index) const;
/**
* @brief Get the given role value at the given index.
*
* @sa QAbstractItemModel::data
*/
[[nodiscard]] QVariant data(const QModelIndex &index, int role = NameRole) 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;
Q_SIGNALS:
@@ -66,9 +84,8 @@ Q_SIGNALS:
private Q_SLOTS:
void userAdded(Quotient::User *user);
void userRemoved(Quotient::User *user);
void refresh(Quotient::User *user, const QVector<int> &roles = {});
void refreshAll();
void avatarChanged(Quotient::User *user, const Quotient::Room *context);
void refreshUser(Quotient::User *user, const QVector<int> &roles = {});
void refreshAllUsers();
private:
QPointer<NeoChatRoom> m_currentRoom;