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

Mamange the creation of NeochatRoomMembers and only create one per member rather than event.

Browse Source
This commit is contained in:
James Graham
2024-07-23 10:52:52 +01:00
parent 0867eef5ce
commit 0f72ccd00c
4 changed files with 30 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
src/neochatroommember.h
View File

@@ -12,20 +12,26 @@
class NeoChatRoom;
//! This class is for visualizing a user in a room context.
//!
//! The class is intentionally a read-only data object that is effectively a wrapper
//! around an m.room.member event for the desired user. This is designed provide the
//! data in a format ready for visualizing a user (avatar or name) in the context
//! of the room it was generated in. This means that if a user has set a unique
//! name or avatar for a particular room that is what will be returned.
//!
//! \note The RoomMember class is not intended for interacting with a User's profile.
//! For that a Quotient::User object should be obtained from a
//! Quotient::Connection as that has the support functions for modifying profile
//! information.
//!
//! \sa Quotient::User
/**
* @class NeochatRoomMember
*
* This class is a shim around RoomMember that can be safety passed to QML.
*
* Because RoomMember has an internal pointer to a RoomMemberEvent it is
* designed to be created used then quickly discarded as the stste event is changed
* every time the member updates. Passing these to QML which will hold onto them
* can lead to accessing an already deleted Quotient::RoomMemberEvent relatively easily.
*
* This class instead holds a member ID and can therefore always safely create and
* access Quotient::RoomMember objects while being used as long as needed by QML.
*
* @note This is only needed to pass to QML if only accessing in CPP RoomMmeber can
* be used safely.
*
* @note The interface is the same as Quotient::RoomMember.
*
* @sa Quotient::RoomMember
*/
class NeochatRoomMember : public QObject
{
Q_OBJECT
@@ -51,145 +57,21 @@ public:
explicit NeochatRoomMember(NeoChatRoom *room, const QString &memberId);
/**
* @brief Get unique stable user id
*
* The Matrix user ID is generated by the server and is never changed.
*/
QString id() const;
/**
* @brief The matrix.to URI for the user
*
* Typically used when you want to visit a user (see
* Quotient::UriResolverBase::visitResource()).
*
* @sa Quotient::UriResolverBase::visitResource()
*/
Quotient::Uri uri() const;
//! Whether this member is the local user
bool isLocalMember() const;
//! The membership state of the member
Quotient::Membership membershipState() const;
//! \brief The raw unmodified display name for the user in the given room
//!
//! The value will be empty if no display name has been set.
//!
//! \warning This value is not sanitized or HTML escape so use appropriately.
//! For ready to display values use displayName() or fullName() for
//! plain text and htmlSafeDisplayName() or htmlSafeFullName() fo
//! rich text.
//!
//! \sa displayName(), htmlSafeDisplayName(), fullName(), htmlSafeFullName()
QString name() const;
//! \brief Get the user display name ready for display
//!
//! This function always aims to return something that can be displayed in a
//! UI, so if no display name is set the user's Matrix ID will be returned.
//!
//! The output is sanitized and suitable for a plain text field. For a rich
//! field use htmlSafeDisplayName().
//!
//! \sa htmlSafeDisplayName()
QString displayName() const;
//! \brief Get the user display name ready for display
//!
//! This function always aims to return something that can be displayed in a
//! UI, so if no display name is set the user's Matrix ID will be returned.
//!
//! The output is sanitized and html escaped ready for a rich text field. For
//! a plain field use displayName().
//!
//! \sa displayName()
QString htmlSafeDisplayName() const;
//! \brief Get user name and id in a single string
//!
//! This function always aims to return something that can be displayed in a
//! UI, so if no display name is set the just user's Matrix ID will be returned.
//! The constructed string follows the format 'name (id)' which the spec
//! recommends for users disambiguation in a room context and in other places.
//!
//! The output is sanitized and suitable for a plain text field. For a rich
//! field use htmlSafeFullName().
//!
//! \sa htmlSafeFullName()
QString fullName() const;
//! \brief Get user name and id in a single string
//!
//! This function always aims to return something that can be displayed in a
//! UI, so if no display name is set the just user's Matrix ID will be returned.
//! The constructed string follows the format 'name (id)' which the spec
//! recommends for users disambiguation in a room context and in other places.
//!
//! The output is sanitized and html escaped ready for a rich text field. For
//! a plain field use fullName().
//!
//! \sa fullName()
QString htmlSafeFullName() const;
//! \brief Get the disambiguated user name
//!
//! This function always aims to return something that can be displayed in a
//! UI, so if no display name is set the just user's Matrix ID will be returned.
//! The output is equivalent to fullName() if there is another user in the room
//! with the same name. Otherwise it is equivalent to displayName().
//!
//! The output is sanitized and suitable for a plain text field. For a rich
//! field use htmlSafeDisambiguatedName().
//!
//! \sa htmlSafeDisambiguatedName(), fullName(), displayName()
QString disambiguatedName() const;
//! \brief Get the disambiguated user name
//!
//! This function always aims to return something that can be displayed in a
//! UI, so if no display name is set the just user's Matrix ID will be returned.
//! The output is equivalent to htmlSafeFullName() if there is another user in the room
//! with the same name. Otherwise it is equivalent to htmlSafeDisplayName().
//!
//! The output is sanitized and html escaped ready for a rich text field. For
//! a plain field use disambiguatedName().
//!
//! \sa disambiguatedName(), htmlSafeFullName(), htmlSafeDisplayName()
QString htmlSafeDisambiguatedName() const;
//! \brief Hue color component of this user based on the user's Matrix ID
//!
//! The implementation is based on XEP-0392:
//! https://xmpp.org/extensions/xep-0392.html
//! Naming and ranges are the same as QColor's hue methods:
//! https://doc.qt.io/qt-5/qcolor.html#integer-vs-floating-point-precision
int hue() const;
//! \brief HueF color component of this user based on the user's Matrix ID
//!
//! The implementation is based on XEP-0392:
//! https://xmpp.org/extensions/xep-0392.html
//! Naming and ranges are the same as QColor's hue methods:
//! https://doc.qt.io/qt-5/qcolor.html#integer-vs-floating-point-precision
qreal hueF() const;
//! \brief Color based on the user's Matrix ID
//!
//! See https://github.com/quotient-im/libQuotient/wiki/User-color-coding-standard-draft-proposal
//! for the methodology.
QColor color() const;
//! \brief The mxc URL as a string for the user avatar in the room
//!
//! This can be empty if none set.
QString avatarMediaId() const;
//! \brief The mxc URL for the user avatar in the room
//!
//! This can be empty if none set.
QUrl avatarUrl() const;
Q_SIGNALS: