Disable tooltip in BasicListItem

See https://invent.kde.org/frameworks/kirigami/-/merge_requests/1035

.flatpak-manifest.json

@@ -28,17 +28,6 @@
             "buildsystem": "cmake-ninja",
             "sources": [ { "type": "git", "url": "https://invent.kde.org/libraries/kirigami-addons.git" } ]
         },
-        {
-            "name": "kquickcharts",
-            "buildsystem": "cmake-ninja",
-            "sources": [
-                {
-                    "type": "git",
-                    "url": "https://invent.kde.org/frameworks/kquickcharts.git",
-                    "branch": "kf5"
-                }
-            ]
-        },
         {
             "name": "kquickimageeditor",
             "buildsystem": "cmake-ninja",

.gitignore

@@ -10,3 +10,4 @@ kate.project.ctags.*
 *.user
 .flatpak-builder/
 .idea/
+cmake-build-*

.gitlab-ci.yml

@@ -4,7 +4,7 @@
 include:
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/reuse-lint.yml
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/android.yml
-#  - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/android-qt6.yml
+  - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/android-qt6.yml
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/linux.yml
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/linux-qt6.yml
   - https://invent.kde.org/sysadmin/ci-utilities/raw/master/gitlab-templates/windows.yml

.kde-ci.yml

@@ -59,4 +59,4 @@ Dependencies:
     'frameworks/kdbusaddons': '@latest-kf6'
 
 Options:
-  require-passing-tests-on: [ 'Linux/Qt5', 'FreeBSD', 'Windows' ]
+  require-passing-tests-on: [ 'Linux/Qt5', 'FreeBSD', 'Windows/Qt5' ]

autotests/texthandlertest.cpp

@@ -6,7 +6,7 @@
 
 #include "texthandler.h"
 
-#include <connection.h>
+#include <qnamespace.h>
 #include <quotient_common.h>
 #include <syncdata.h>
 
@@ -49,7 +49,8 @@ private Q_SLOTS:
     void receiveStripReply();
     void receivePlainTextIn();
 
-    void recieveRichInPlainOut();
+    void receiveRichInPlainOut_data();
+    void receiveRichInPlainOut();
     void receivePlainStripHtml();
     void receivePlainStripMarkup();
     void receiveStripNewlines();
@@ -59,6 +60,9 @@ private Q_SLOTS:
     void receiveRichtextIn();
     void receiveRichMxcUrl();
     void receiveRichPlainUrl();
+    void receiveRichEmote();
+    void receiveRichEdited_data();
+    void receiveRichEdited();
 };
 
 #ifdef QUOTIENT_07
@@ -146,7 +150,44 @@ void TextHandlerTest::initTestCase()
         "sender": "@example:example.org",
         "type": "m.room.message",
         "unsigned": {
-          "age": 1235
+          "age": 1232
+        }
+      },
+      {
+        "content": {
+          "body": "/me This is an emote.",
+          "format": "org.matrix.custom.html",
+          "formatted_body": "This is an emote.",
+          "msgtype": "m.emote"
+        },
+        "event_id": "$153273582443PhrSn:example.org",
+        "origin_server_ts": 1532735824654,
+        "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
+        "sender": "@example:example.org",
+        "type": "m.room.message",
+        "unsigned": {
+          "age": 1231
+        }
+      },
+      {
+        "content": {
+            "body": "tested",
+            "msgtype": "m.text"
+        },
+        "event_id": "$zrCiBxBnqqTn0Z5FY78qSZAszno_w8nJJXzfBULG-3E",
+        "origin_server_ts": 1680948575928,
+        "room_id": "!jEsUZKDJdhlrceRyVU:example.org",
+        "sender": "@example:example.org",
+        "type": "m.room.message",
+        "unsigned": {
+            "age": 1747776,
+            "m.relations": {
+                "m.replace": {
+                    "event_id": "$UX0PlpyI7vYO32iHMuuYEP7ECMh4sX3XLGiB2SwM4mQ",
+                    "origin_server_ts": 1680948580992,
+                    "sender": "@example:example.org"
+                }
+            }
         }
       }
     ],
@@ -309,15 +350,24 @@ void TextHandlerTest::receiveStripReply()
     QCOMPARE(testTextHandler.handleRecievePlainText(), testOutputString);
 }
 
-void TextHandlerTest::recieveRichInPlainOut()
+void TextHandlerTest::receiveRichInPlainOut_data()
 {
-    const QString testInputString = QStringLiteral("a &amp; b");
-    const QString testOutputString = QStringLiteral("a & b");
+    QTest::addColumn<QString>("testInputString");
+    QTest::addColumn<QString>("testOutputString");
+
+    QTest::newRow("ampersand") << QStringLiteral("a &amp; b") << QStringLiteral("a & b");
+    QTest::newRow("quote") << QStringLiteral("&quot;a and b&quot;") << QStringLiteral("\"a and b\"");
+}
+
+void TextHandlerTest::receiveRichInPlainOut()
+{
+    QFETCH(QString, testInputString);
+    QFETCH(QString, testOutputString);
 
     TextHandler testTextHandler;
     testTextHandler.setData(testInputString);
 
-    QCOMPARE(testTextHandler.handleRecievePlainText(), testOutputString);
+    QCOMPARE(testTextHandler.handleRecievePlainText(Qt::RichText), testOutputString);
 }
 
 void TextHandlerTest::receivePlainTextIn()
@@ -347,6 +397,9 @@ void TextHandlerTest::receiveStripNewlines()
     const QString testInputStringRich = QStringLiteral("Test<br>many<br />new<br>lines.");
     const QString testOutputString = QStringLiteral("Test many new lines.");
 
+    const QString testInputStringPlain2 = QStringLiteral("* List\n* Items");
+    const QString testOutputString2 = QStringLiteral("List Items");
+
     TextHandler testTextHandler;
     testTextHandler.setData(testInputStringPlain);
 
@@ -354,9 +407,11 @@ void TextHandlerTest::receiveStripNewlines()
     QCOMPARE(testTextHandler.handleRecieveRichText(Qt::PlainText, nullptr, nullptr, true), testOutputString);
 
     testTextHandler.setData(testInputStringRich);
-
     QCOMPARE(testTextHandler.handleRecievePlainText(Qt::RichText, true), testOutputString);
     QCOMPARE(testTextHandler.handleRecieveRichText(Qt::RichText, nullptr, nullptr, true), testOutputString);
+
+    testTextHandler.setData(testInputStringPlain2);
+    QCOMPARE(testTextHandler.handleRecievePlainText(Qt::RichText, true), testOutputString2);
 }
 
 /**
@@ -434,7 +489,7 @@ void TextHandlerTest::receiveRichMxcUrl()
     TextHandler testTextHandler;
     testTextHandler.setData(testInputString);
 
-    QCOMPARE(testTextHandler.handleRecieveRichText(Qt::RichText, room, room->messageEvents().back().get()), testOutputString);
+    QCOMPARE(testTextHandler.handleRecieveRichText(Qt::RichText, room, room->messageEvents().at(0).get()), testOutputString);
 }
 #endif
 
@@ -493,5 +548,44 @@ void TextHandlerTest::receiveRichPlainUrl()
     QCOMPARE(testTextHandler.handleRecieveRichText(Qt::RichText), testOutputStringMxId);
 }
 
+// Test that user pill is add to an emote message.
+// N.B. The second message in the test timeline is marked as an emote.
+void TextHandlerTest::receiveRichEmote()
+{
+    auto event = room->messageEvents().at(1).get();
+    auto author = static_cast<NeoChatUser *>(room->user(event->senderId()));
+    const QString testInputString = QStringLiteral("This is an emote.");
+    const QString testOutputString = QStringLiteral("* <a href=\"https://matrix.to/#/@example:example.org\" style=\"color:") + author->color().name()
+        + QStringLiteral("\">@example:example.org</a> This is an emote.");
+
+    TextHandler testTextHandler;
+    testTextHandler.setData(testInputString);
+
+    QCOMPARE(testTextHandler.handleRecieveRichText(Qt::RichText, room, event), testOutputString);
+}
+
+void TextHandlerTest::receiveRichEdited_data()
+{
+    QTest::addColumn<QString>("testInputString");
+    QTest::addColumn<QString>("testOutputString");
+
+    QTest::newRow("basic") << QStringLiteral("Edited") << QStringLiteral("Edited <span style=\"color:#000000\">(edited)</span>");
+    QTest::newRow("multiple paragraphs") << QStringLiteral("<p>Edited</p>\n<p>Edited</p>")
+                                         << QStringLiteral("<p>Edited</p>\n<p>Edited <span style=\"color:#000000\">(edited)</span></p>");
+    QTest::newRow("blockquote") << QStringLiteral("<blockquote>Edited</blockquote>")
+                                << QStringLiteral("<blockquote>Edited</blockquote><p> <span style=\"color:#000000\">(edited)</span></p>");
+}
+
+void TextHandlerTest::receiveRichEdited()
+{
+    QFETCH(QString, testInputString);
+    QFETCH(QString, testOutputString);
+
+    TextHandler testTextHandler;
+    testTextHandler.setData(testInputString);
+
+    QCOMPARE(testTextHandler.handleRecieveRichText(Qt::RichText, room, room->messageEvents().at(2).get()), testOutputString);
+}
+
 QTEST_MAIN(TextHandlerTest)
 #include "texthandlertest.moc"

org.kde.neochat.appdata.xml

@@ -231,6 +231,7 @@
     <content_attribute id="social-chat">intense</content_attribute>
   </content_rating>
   <releases>
+    <release version="23.04.0" date="2023-04-20"/>
     <release version="23.01" date="2023-01-30">
       <url>https://plasma-mobile.org/2023/01/30/january-blog-post/</url>
       <description>

src/CMakeLists.txt

@@ -47,7 +47,6 @@ add_library(neochat STATIC
     filetransferpseudojob.cpp
     models/searchmodel.cpp
     texthandler.cpp
-    models/locationsmodel.cpp
 )
 
 add_executable(neochat-app
@@ -179,6 +178,7 @@ if(ANDROID)
         "home"
         "preferences-desktop-notification"
         "computer-symbolic"
+        "gps"
     )
 else()
     target_link_libraries(neochat PUBLIC Qt::Widgets KF${QT_MAJOR_VERSION}::KIOWidgets)

src/chatdocumenthandler.cpp

@@ -138,12 +138,13 @@ int ChatDocumentHandler::completionStartIndex() const
         return 0;
     }
 
-#if QT_VERSION > QT_VERSION_CHECK(6, 0, 0)
+#if !defined(Q_OS_ANDROID) && QT_VERSION > QT_VERSION_CHECK(6, 0, 0)
     const long long cursor = cursorPosition();
 #else
     const auto cursor = cursorPosition();
 #endif
     const auto &text = getText();
+
     auto start = std::min(cursor, text.size()) - 1;
     while (start > -1) {
         if (text.at(start) == QLatin1Char(' ')) {
@@ -324,3 +325,35 @@ void ChatDocumentHandler::pushMention(const Mention mention) const
         m_room->mentions()->push_back(mention);
     }
 }
+
+QColor ChatDocumentHandler::mentionColor() const
+{
+    return m_mentionColor;
+}
+
+void ChatDocumentHandler::setMentionColor(const QColor &color)
+{
+    if (m_mentionColor == color) {
+        return;
+    }
+    m_mentionColor = color;
+    m_highlighter->mentionFormat.setForeground(m_mentionColor);
+    m_highlighter->rehighlight();
+    Q_EMIT mentionColorChanged();
+}
+
+QColor ChatDocumentHandler::errorColor() const
+{
+    return m_errorColor;
+}
+
+void ChatDocumentHandler::setErrorColor(const QColor &color)
+{
+    if (m_errorColor == color) {
+        return;
+    }
+    m_errorColor = color;
+    m_highlighter->errorFormat.setForeground(m_errorColor);
+    m_highlighter->rehighlight();
+    Q_EMIT errorColorChanged();
+}

src/chatdocumenthandler.h

@@ -35,6 +35,9 @@ class ChatDocumentHandler : public QObject
 
     Q_PROPERTY(NeoChatRoom *room READ room WRITE setRoom NOTIFY roomChanged)
 
+    Q_PROPERTY(QColor mentionColor READ mentionColor WRITE setMentionColor NOTIFY mentionColorChanged);
+    Q_PROPERTY(QColor errorColor READ errorColor WRITE setErrorColor NOTIFY errorColorChanged);
+
 public:
     explicit ChatDocumentHandler(QObject *parent = nullptr);
 
@@ -60,6 +63,13 @@ public:
 
     void updateCompletions();
     CompletionModel *completionModel() const;
+
+    [[nodiscard]] QColor mentionColor() const;
+    void setMentionColor(const QColor &color);
+
+    [[nodiscard]] QColor errorColor() const;
+    void setErrorColor(const QColor &color);
+
 Q_SIGNALS:
     void isEditChanged();
     void documentChanged();
@@ -68,6 +78,8 @@ Q_SIGNALS:
     void completionModelChanged();
     void selectionStartChanged();
     void selectionEndChanged();
+    void errorColorChanged();
+    void mentionColorChanged();
 
 private:
     int completionStartIndex() const;
@@ -79,6 +91,9 @@ private:
     NeoChatRoom *m_room = nullptr;
     bool completionVisible = false;
 
+    QColor m_mentionColor;
+    QColor m_errorColor;
+
     int m_cursorPosition;
     int m_selectionStart;
     int m_selectionEnd;

src/controller.cpp

@@ -593,6 +593,7 @@ void Controller::setActiveConnection(Connection *connection)
     }
     if (m_connection != nullptr) {
         disconnect(m_connection, &Connection::syncError, this, nullptr);
+        disconnect(m_connection, &Connection::accountDataChanged, this, nullptr);
     }
     m_connection = connection;
     if (connection != nullptr) {
@@ -616,12 +617,18 @@ void Controller::setActiveConnection(Connection *connection)
                 RoomManager::instance().warning(i18n("File too large to download."), i18n("Contact your matrix server administrator for support."));
             }
         });
+        connect(connection, &Connection::accountDataChanged, this, [this](const QString &type) {
+            if (type == QLatin1String("org.kde.neochat.account_label")) {
+                Q_EMIT activeAccountLabelChanged();
+            }
+        });
     } else {
         NeoChatConfig::self()->setActiveConnection(QString());
     }
     NeoChatConfig::self()->save();
     Q_EMIT activeConnectionChanged();
     Q_EMIT activeConnectionIndexChanged();
+    Q_EMIT activeAccountLabelChanged();
 }
 
 void Controller::saveWindowGeometry()
@@ -809,3 +816,22 @@ bool Controller::isFlatpak() const
     return false;
 #endif
 }
+
+void Controller::setActiveAccountLabel(const QString &label)
+{
+    if (!m_connection) {
+        return;
+    }
+    QJsonObject json{
+        {"account_label", label},
+    };
+    m_connection->setAccountData("org.kde.neochat.account_label", json);
+}
+
+QString Controller::activeAccountLabel() const
+{
+    if (!m_connection) {
+        return {};
+    }
+    return m_connection->accountDataJson("org.kde.neochat.account_label")["account_label"].toString();
+}

src/controller.h

@@ -42,6 +42,7 @@ class Controller : public QObject
     Q_PROPERTY(int activeConnectionIndex READ activeConnectionIndex NOTIFY activeConnectionIndexChanged)
     Q_PROPERTY(int quotientMinorVersion READ quotientMinorVersion CONSTANT)
     Q_PROPERTY(bool isFlatpak READ isFlatpak CONSTANT)
+    Q_PROPERTY(QString activeAccountLabel READ activeAccountLabel WRITE setActiveAccountLabel NOTIFY activeAccountLabelChanged)
 
 public:
     static Controller &instance();
@@ -103,6 +104,23 @@ public:
     int quotientMinorVersion() const;
     bool isFlatpak() const;
 
+    /**
+     * @brief The label for this account.
+     *
+     * Account labels are a concept Specific to NeoChat, allowing accounts to be labelled, e.g. for "Work", "Private", etc.
+     * @return The label, if it exists, otherwise an empty string
+     */
+    [[nodiscard]] QString activeAccountLabel() const;
+
+    /**
+     * @brief Set the label for this account.
+     *
+     * Set to an empty string to remove the label
+     * @sa Controller::activeAccountLabel
+     * @param label The label to use, or an empty string
+     */
+    void setActiveAccountLabel(const QString &label);
+
 private:
     explicit Controller(QObject *parent = nullptr);
 
@@ -152,6 +170,7 @@ Q_SIGNALS:
     void keyVerificationKey(const QString &sas);
     void activeConnectionIndexChanged();
     void roomAdded(NeoChatRoom *room);
+    void activeAccountLabelChanged();
 
 public Q_SLOTS:
     void logout(Quotient::Connection *conn, bool serverSideLogout);

src/filetransferpseudojob.cpp

@@ -25,6 +25,7 @@ void FileTransferPseudoJob::fileTransferProgress(QString id, qint64 progress, qi
 
 void FileTransferPseudoJob::fileTransferCompleted(QString id, QUrl localFile)
 {
+    Q_UNUSED(localFile);
     if (id != m_eventId) {
         return;
     }

src/main.cpp

@@ -52,7 +52,6 @@
 #include "models/devicesmodel.h"
 #include "models/emojimodel.h"
 #include "models/keywordnotificationrulemodel.h"
-#include "models/locationsmodel.h"
 #include "models/messageeventmodel.h"
 #include "models/messagefiltermodel.h"
 #include "models/publicroomlistmodel.h"
@@ -236,7 +235,6 @@ int main(int argc, char *argv[])
     qmlRegisterType<CompletionModel>("org.kde.neochat", 1, 0, "CompletionModel");
     qmlRegisterType<StateModel>("org.kde.neochat", 1, 0, "StateModel");
     qmlRegisterType<SearchModel>("org.kde.neochat", 1, 0, "SearchModel");
-    qmlRegisterType<LocationsModel>("org.kde.neochat", 1, 0, "LocationsModel");
 #ifdef QUOTIENT_07
     qmlRegisterType<PollHandler>("org.kde.neochat", 1, 0, "PollHandler");
 #endif

src/models/actionsmodel.cpp

@@ -5,7 +5,6 @@
 
 #include "controller.h"
 #include "neochatroom.h"
-#include "neochatuser.h"
 #include "roommanager.h"
 #include <events/roommemberevent.h>
 #include <events/roompowerlevelsevent.h>
@@ -19,6 +18,41 @@ QStringList rainbowColors{"#ff2b00", "#ff5500", "#ff8000", "#ffaa00", "#ffd500",
                           "#00ff2b", "#00ff55", "#00ff80", "#00ffaa", "#00ffd5", "#00ffff", "#00d4ff", "#00aaff", "#007fff", "#0055ff", "#002bff", "#0000ff",
                           "#2a00ff", "#5500ff", "#7f00ff", "#aa00ff", "#d400ff", "#ff00ff", "#ff00d4", "#ff00aa", "#ff0080", "#ff0055", "#ff002b", "#ff0000"};
 
+auto leaveRoomLambda = [](const QString &text, NeoChatRoom *room) {
+    if (text.isEmpty()) {
+        Q_EMIT room->showMessage(NeoChatRoom::Info, i18n("Leaving this room."));
+        room->connection()->leaveRoom(room);
+    } else {
+        QRegularExpression roomRegex(QStringLiteral(R"(^[#!][^:]+:\w(?:\w|\.|-)*\.\w+(?::\d{1,5})?)"));
+        auto regexMatch = roomRegex.match(text);
+        if (!regexMatch.hasMatch()) {
+            Q_EMIT room->showMessage(NeoChatRoom::Error,
+                                     i18nc("'<text>' does not look like a room id or alias.", "'%1' does not look like a room id or alias.", text));
+            return QString();
+        }
+        auto leaving = room->connection()->room(text);
+        if (!leaving) {
+            leaving = room->connection()->roomByAlias(text);
+        }
+        if (leaving) {
+            Q_EMIT room->showMessage(NeoChatRoom::Info, i18nc("Leaving room <roomname>.", "Leaving room %1.", text));
+            room->connection()->leaveRoom(leaving);
+        } else {
+            Q_EMIT room->showMessage(NeoChatRoom::Info, i18nc("Room <roomname> not found", "Room %1 not found.", text));
+        }
+    }
+    return QString();
+};
+
+auto roomNickLambda = [](const QString &text, NeoChatRoom *room) {
+    if (text.isEmpty()) {
+        Q_EMIT room->showMessage(NeoChatRoom::Error, i18n("No new nickname provided, no changes will happen."));
+    } else {
+        room->connection()->user()->rename(text, room);
+    }
+    return QString();
+};
+
 QVector<ActionsModel::Action> actions{
     Action{
         QStringLiteral("shrug"),
@@ -268,31 +302,7 @@ QVector<ActionsModel::Action> actions{
     },
     Action{
         QStringLiteral("part"),
-        [](const QString &text, NeoChatRoom *room) {
-            if (text.isEmpty()) {
-                Q_EMIT room->showMessage(NeoChatRoom::Info, i18n("Leaving this room."));
-                room->connection()->leaveRoom(room);
-            } else {
-                QRegularExpression roomRegex(QStringLiteral(R"(^[#!][^:]+:\w(?:\w|\.|-)*\.\w+(?::\d{1,5})?)"));
-                auto regexMatch = roomRegex.match(text);
-                if (!regexMatch.hasMatch()) {
-                    Q_EMIT room->showMessage(NeoChatRoom::Error,
-                                             i18nc("'<text>' does not look like a room id or alias.", "'%1' does not look like a room id or alias.", text));
-                    return QString();
-                }
-                auto leaving = room->connection()->room(text);
-                if (!leaving) {
-                    leaving = room->connection()->roomByAlias(text);
-                }
-                if (leaving) {
-                    Q_EMIT room->showMessage(NeoChatRoom::Info, i18nc("Leaving room <roomname>.", "Leaving room %1.", text));
-                    room->connection()->leaveRoom(leaving);
-                } else {
-                    Q_EMIT room->showMessage(NeoChatRoom::Info, i18nc("Room <roomname> not found", "Room %1 not found.", text));
-                }
-            }
-            return QString();
-        },
+        leaveRoomLambda,
         false,
         std::nullopt,
         kli18n("[<room alias or id>]"),
@@ -300,31 +310,7 @@ QVector<ActionsModel::Action> actions{
     },
     Action{
         QStringLiteral("leave"),
-        [](const QString &text, NeoChatRoom *room) {
-            if (text.isEmpty()) {
-                Q_EMIT room->showMessage(NeoChatRoom::Info, i18n("Leaving this room."));
-                room->connection()->leaveRoom(room);
-            } else {
-                QRegularExpression roomRegex(QStringLiteral(R"(^[#!][^:]+:\w(?:\w|\.|-)*\.\w+(?::\d{1,5})?)"));
-                auto regexMatch = roomRegex.match(text);
-                if (!regexMatch.hasMatch()) {
-                    Q_EMIT room->showMessage(NeoChatRoom::Error,
-                                             i18nc("'<text>' does not look like a room id or alias.", "'%1' does not look like a room id or alias.", text));
-                    return QString();
-                }
-                auto leaving = room->connection()->room(text);
-                if (!leaving) {
-                    leaving = room->connection()->roomByAlias(text);
-                }
-                if (leaving) {
-                    Q_EMIT room->showMessage(NeoChatRoom::Info, i18nc("Leaving room <roomname>.", "Leaving room %1.", text));
-                    room->connection()->leaveRoom(leaving);
-                } else {
-                    Q_EMIT room->showMessage(NeoChatRoom::Info, i18nc("Room <roomname> not found", "Room %1 not found.", text));
-                }
-            }
-            return QString();
-        },
+        leaveRoomLambda,
         false,
         std::nullopt,
         kli18n("[<room alias or id>]"),
@@ -347,14 +333,15 @@ QVector<ActionsModel::Action> actions{
     },
     Action{
         QStringLiteral("roomnick"),
-        [](const QString &text, NeoChatRoom *room) {
-            if (text.isEmpty()) {
-                Q_EMIT room->showMessage(NeoChatRoom::Error, i18n("No new nickname provided, no changes will happen."));
-            } else {
-                room->connection()->user()->rename(text, room);
-            }
-            return QString();
-        },
+        roomNickLambda,
+        false,
+        std::nullopt,
+        kli18n("<display name>"),
+        kli18n("Changes your display name in this room"),
+    },
+    Action{
+        QStringLiteral("myroomnick"),
+        roomNickLambda,
         false,
         std::nullopt,
         kli18n("<display name>"),

src/models/actionsmodel.h

@@ -9,20 +9,42 @@
 
 class NeoChatRoom;
 
+/**
+ * @class ActionsModel
+ *
+ * This class defines a model for chat actions.
+ *
+ * @note A chat action is a message starting with /, resulting in something other
+ *       than a normal message being sent (e.g. /me, /join).
+ */
 class ActionsModel : public QAbstractListModel
 {
 public:
+    /**
+     * @brief Definition of an action.
+     */
     struct Action {
-        // The prefix, without '/' and space after the word
-        QString prefix;
+        QString prefix; /**< The prefix, without '/' and space after the word. */
+        /**
+         * @brief The function to execute when the action is triggered.
+         */
         std::function<QString(const QString &, NeoChatRoom *)> handle;
-        // If this is true, this action transforms a message to a different message and it will be sent.
-        // If this is false, this message does some action on the client and should not be sent as a message.
+        /**
+         * @brief Whether the action is a message type action.
+         *
+         * If this is true, a message action will be sent. If this is false, this
+         * message does some action on the client and should not be sent as a message.
+         */
         bool messageAction;
-        // If this action changes the message type, this is the new message type. Otherwise it's nullopt
+        /**
+         * @brief The new message type of a message being sent.
+         *
+         * For a non-message action or a message action that outputs the same type
+         * as its input, it's nullopt.
+         */
         std::optional<Quotient::RoomMessageEvent::MsgType> messageType = std::nullopt;
-        KLazyLocalizedString parameters;
-        KLazyLocalizedString description;
+        KLazyLocalizedString parameters; /**< The input parameters expected by the action. */
+        KLazyLocalizedString description; /**< The description of the action. */
     };
     static ActionsModel &instance()
     {
@@ -30,18 +52,41 @@ public:
         return _instance;
     }
 
+    /**
+     * @brief Defines the model roles.
+     */
     enum Roles {
-        Prefix = Qt::DisplayRole,
-        Description,
-        CompletionType,
-        Parameters,
+        Prefix = Qt::DisplayRole, /**< The prefix, without '/' and space after the word. */
+        Description, /**< The description of the action. */
+        CompletionType, /**< The completion type (always "action" for this model). */
+        Parameters, /**< The input parameters expected by the action. */
     };
     Q_ENUM(Roles);
 
-    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
+
+    /**
+     * @brief Number of rows in the model.
+     *
+     * @sa QAbstractItemModel::rowCount
+     */
+    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+
+    /**
+     * @brief Returns a mapping from Role enum values to role names.
+     *
+     * @sa EventRoles, QAbstractItemModel::roleNames()
+     */
     QHash<int, QByteArray> roleNames() const override;
 
+    /**
+     * @brief Return a vector with all supported actions.
+     */
     QVector<Action> &allActions() const;
 
 private:

src/models/collapsestateproxymodel.cpp

@@ -9,9 +9,9 @@
 bool CollapseStateProxyModel::filterAcceptsRow(int source_row, const QModelIndex &source_parent) const
 {
     Q_UNUSED(source_parent);
-    return sourceModel()->data(sourceModel()->index(source_row, 0), MessageEventModel::EventTypeRole)
+    return sourceModel()->data(sourceModel()->index(source_row, 0), MessageEventModel::DelegateTypeRole)
         != MessageEventModel::DelegateType::State // If this is not a state, show it
-        || sourceModel()->data(sourceModel()->index(source_row + 1, 0), MessageEventModel::EventTypeRole)
+        || sourceModel()->data(sourceModel()->index(source_row + 1, 0), MessageEventModel::DelegateTypeRole)
         != MessageEventModel::DelegateType::State // If this is the first state in a block, show it. TODO hidden events?
         || sourceModel()->data(sourceModel()->index(source_row, 0), MessageEventModel::ShowSectionRole).toBool(); // If it's a new day, show it
 }
@@ -47,7 +47,7 @@ QString CollapseStateProxyModel::aggregateEventToString(int sourceRow) const
         if (!uniqueAuthors.contains(nextAuthor)) {
             uniqueAuthors.append(nextAuthor);
         }
-        if (sourceModel()->data(sourceModel()->index(i - 1, 0), MessageEventModel::EventTypeRole)
+        if (sourceModel()->data(sourceModel()->index(i - 1, 0), MessageEventModel::DelegateTypeRole)
                 != MessageEventModel::DelegateType::State // If it's not a state event
             || sourceModel()->data(sourceModel()->index(i - 1, 0), MessageEventModel::ShowSectionRole).toBool() // or the section needs to be visible
         ) {
@@ -105,7 +105,7 @@ QVariantList CollapseStateProxyModel::stateEventsList(int sourceRow) const
             {"text", sourceModel()->data(sourceModel()->index(i, 0), Qt::DisplayRole).toString()},
         };
         stateEvents.append(nextState);
-        if (sourceModel()->data(sourceModel()->index(i - 1, 0), MessageEventModel::EventTypeRole)
+        if (sourceModel()->data(sourceModel()->index(i - 1, 0), MessageEventModel::DelegateTypeRole)
                 != MessageEventModel::DelegateType::State // If it's not a state event
             || sourceModel()->data(sourceModel()->index(i - 1, 0), MessageEventModel::ShowSectionRole).toBool() // or the section needs to be visible
         ) {
@@ -123,7 +123,7 @@ QVariantList CollapseStateProxyModel::authorList(int sourceRow) const
         if (!uniqueAuthors.contains(nextAvatar)) {
             uniqueAuthors.append(nextAvatar);
         }
-        if (sourceModel()->data(sourceModel()->index(i - 1, 0), MessageEventModel::EventTypeRole)
+        if (sourceModel()->data(sourceModel()->index(i - 1, 0), MessageEventModel::DelegateTypeRole)
                 != MessageEventModel::DelegateType::State // If it's not a state event
             || sourceModel()->data(sourceModel()->index(i - 1, 0), MessageEventModel::ShowSectionRole).toBool() // or the section needs to be visible
         ) {

src/models/collapsestateproxymodel.h

@@ -6,26 +6,58 @@
 #include "messageeventmodel.h"
 #include <QSortFilterProxyModel>
 
+/**
+ * @class CollapseStateProxyModel
+ *
+ * This model aggregates multiple sequential state events into a single entry.
+ *
+ * Events are only aggregated if they happened on the same day.
+ *
+ * @sa MessageEventModel
+ */
 class CollapseStateProxyModel : public QSortFilterProxyModel
 {
     Q_OBJECT
 public:
+    /**
+     * @brief Defines the model roles.
+     */
     enum Roles {
-        AggregateDisplayRole = MessageEventModel::LastRole + 1,
-        StateEventsRole,
-        AuthorListRole,
+        AggregateDisplayRole = MessageEventModel::LastRole + 1, /**< Single line aggregation of all the state events. */
+        StateEventsRole, /**< List of state events in the aggregated state. */
+        AuthorListRole, /**< List of unique authors of the aggregated state event. */
     };
+
+    /**
+     * @brief Whether a row should be shown out or not.
+     *
+     * @sa QSortFilterProxyModel::filterAcceptsRow
+     */
     [[nodiscard]] bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const override;
-    [[nodiscard]] QHash<int, QByteArray> roleNames() const override;
+
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QSortFilterProxyModel::data
+     */
     [[nodiscard]] QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) const override;
 
     /**
-     * @brief QString aggregating the text of consecutive state events starting at row.
+     * @brief Returns a mapping from Role enum values to role names.
+     *
+     * @sa Roles, QAbstractProxyModel::roleNames()
+     */
+    [[nodiscard]] QHash<int, QByteArray> roleNames() const override;
+
+private:
+    /**
+     * @brief Aggregation of the text of consecutive state events starting at row.
      *
      * If state events happen on different days they will be split into two aggregate
      * events.
      */
     [[nodiscard]] QString aggregateEventToString(int row) const;
+
     /**
      * @brief Return a list of consecutive state events starting at row.
      *
@@ -33,6 +65,7 @@ public:
      * events.
      */
     [[nodiscard]] QVariantList stateEventsList(int row) const;
+
     /**
      * @brief List of unique authors for the aggregate state events starting at row.
      */

src/models/completionmodel.cpp

@@ -5,7 +5,6 @@
 #include <QDebug>
 
 #include "actionsmodel.h"
-#include "chatdocumenthandler.h"
 #include "completionproxymodel.h"
 #include "customemojimodel.h"
 #include "emojimodel.h"

src/models/completionmodel.h

@@ -13,41 +13,89 @@ class UserListModel;
 class NeoChatRoom;
 class RoomListModel;
 
+/**
+ * @class CompletionModel
+ *
+ * This class defines the model for suggesting completions in chat text.
+ *
+ * This model is able to select the appropriate completion type for the input text
+ * and present a list of options that can be presented to the user.
+ */
 class CompletionModel : public QAbstractListModel
 {
     Q_OBJECT
+
+    /**
+     * @brief The current text to search for completions.
+     */
     Q_PROPERTY(QString text READ text NOTIFY textChanged)
+
+    /**
+     * @brief The current room that the model is getting completions for.
+     */
     Q_PROPERTY(NeoChatRoom *room READ room WRITE setRoom NOTIFY roomChanged)
+
+    /**
+     * @brief The current type of completion being done on the entered text.
+     *
+     * @sa AutoCompletionType
+     */
     Q_PROPERTY(AutoCompletionType autoCompletionType READ autoCompletionType NOTIFY autoCompletionTypeChanged);
+
+    /**
+     * @brief The RoomListModel to be used for room completions.
+     */
     Q_PROPERTY(RoomListModel *roomListModel READ roomListModel WRITE setRoomListModel NOTIFY roomListModelChanged);
 
 public:
+    /**
+     * @brief Defines the different types of completion available.
+     */
     enum AutoCompletionType {
-        User,
-        Room,
-        Emoji,
-        Command,
-        None,
+        User, /**< A user in the current room. */
+        Room, /**< A matrix room. */
+        Emoji, /**< An emoji. */
+        Command, /**< A / command. */
+        None, /**< No available completion for the current text. */
     };
     Q_ENUM(AutoCompletionType)
 
+    /**
+     * @brief Defines the model roles.
+     */
     enum Roles {
-        Text = Qt::DisplayRole,
-        Subtitle,
-        Icon,
-        ReplacedText,
+        Text = Qt::DisplayRole, /**< The main text to show. */
+        Subtitle, /**< The subtitle text to show. */
+        Icon, /**< The icon to show. */
+        ReplacedText, /**< The text to replace the input text with for the completion. */
     };
     Q_ENUM(Roles);
 
     CompletionModel(QObject *parent = nullptr);
 
-    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
+
+    /**
+     * @brief Number of rows in the model.
+     *
+     * @sa  QAbstractItemModel::rowCount
+     */
+    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+
+    /**
+     * @brief Returns a mapping from Role enum values to role names.
+     *
+     * @sa EventRoles, QAbstractItemModel::roleNames()
+     */
     QHash<int, QByteArray> roleNames() const override;
 
     QString text() const;
     void setText(const QString &text, const QString &fullText);
-    void updateCompletion();
 
     NeoChatRoom *room() const;
     void setRoom(NeoChatRoom *room);
@@ -56,6 +104,7 @@ public:
     void setRoomListModel(RoomListModel *roomListModel);
 
     AutoCompletionType autoCompletionType() const;
+    void setAutoCompletionType(AutoCompletionType autoCompletionType);
 
 Q_SIGNALS:
     void textChanged();
@@ -70,7 +119,7 @@ private:
     NeoChatRoom *m_room = nullptr;
     AutoCompletionType m_autoCompletionType = None;
 
-    void setAutoCompletionType(AutoCompletionType autoCompletionType);
+    void updateCompletion();
 
     UserListModel *m_userListModel;
     RoomListModel *m_roomListModel;

src/models/completionproxymodel.cpp

@@ -2,9 +2,8 @@
 // SPDX-License-Identifier: LGPL-2.0-or-later
 
 #include "completionproxymodel.h"
-#include <QDebug>
 
-#include "neochatroom.h"
+#include <QDebug>
 
 bool CompletionProxyModel::filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const
 {
@@ -44,7 +43,6 @@ int CompletionProxyModel::secondaryFilterRole() const
 void CompletionProxyModel::setSecondaryFilterRole(int role)
 {
     m_secondaryFilterRole = role;
-    Q_EMIT secondaryFilterRoleChanged();
 }
 
 QString CompletionProxyModel::filterText() const
@@ -55,7 +53,6 @@ QString CompletionProxyModel::filterText() const
 void CompletionProxyModel::setFilterText(const QString &filterText)
 {
     m_filterText = filterText;
-    Q_EMIT filterTextChanged();
 }
 
 void CompletionProxyModel::setFullText(const QString &fullText)

src/models/completionproxymodel.h

@@ -5,28 +5,71 @@
 
 #include <QSortFilterProxyModel>
 
+/**
+ * @class CompletionProxyModel
+ *
+ * A filter model to sort and filter completion results.
+ *
+ * This model is designed to work with multiple source models depending upon the
+ * completion type.
+ *
+ * A model value will be shown if its primary or secondary role values start with
+ * the filter text. The exception is if the full text perfectly matches
+ * the primary filter role value in which case the completion ends (i.e. the filter
+ * will return no results).
+ *
+ * @note The filter is primarily design to work with strings, therefore make sure
+ *       that the source model roles that are to be filtered are strings.
+ */
 class CompletionProxyModel : public QSortFilterProxyModel
 {
     Q_OBJECT
-    Q_PROPERTY(int secondaryFilterRole READ secondaryFilterRole WRITE setSecondaryFilterRole NOTIFY secondaryFilterRoleChanged)
-    Q_PROPERTY(QString filterText READ filterText WRITE setFilterText NOTIFY filterTextChanged)
 
 public:
+    /**
+     * @brief Wether a row should be shown or not.
+     *
+     * @sa QSortFilterProxyModel::filterAcceptsRow
+     */
     bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override;
+
+    /**
+     * @brief Returns true if the value of source_left is less than source_right.
+     *
+     * @sa QSortFilterProxyModel::lessThan
+     */
     bool lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const override;
 
+    /**
+     * @brief Get the current secondary filter role.
+     */
     int secondaryFilterRole() const;
+
+    /**
+     * @brief Set the secondary filter role.
+     *
+     * Refer to the source model for what value corresponds to what role.
+     */
     void setSecondaryFilterRole(int role);
 
+    /**
+     * @brief Get the current text being used to filter the source model.
+     */
     QString filterText() const;
+
+    /**
+     * @brief Set the text to be used to filter the source model.
+     */
     void setFilterText(const QString &filterText);
 
+    /**
+     * @brief Set the full text in the chatbar after the completion start.
+     *
+     * This is used to automatically end the completion if the user replicated the
+     * primary filter role value perfectly.
+     */
     void setFullText(const QString &fullText);
 
-Q_SIGNALS:
-    void secondaryFilterRoleChanged();
-    void filterTextChanged();
-
 private:
     int m_secondaryFilterRole = -1;
     QString m_filterText;

src/models/customemojimodel.cpp

@@ -58,7 +58,7 @@ void CustomEmojiModel::addEmoji(const QString &name, const QUrl &location)
     auto job = Controller::instance().activeConnection()->uploadFile(location.toLocalFile());
 
     if (running(job)) {
-        connect(job, &BaseJob::success, this, [this, name, job] {
+        connect(job, &BaseJob::success, this, [name, job] {
             const auto &data = Controller::instance().activeConnection()->accountData("im.ponies.user_emotes");
             auto json = data != nullptr ? data->contentJson() : QJsonObject();
             auto emojiData = json["images"].toObject();
@@ -141,6 +141,8 @@ QVariant CustomEmojiModel::data(const QModelIndex &idx, int role) const
         return QUrl(QStringLiteral("image://mxc/") + data.url.mid(6));
     case Roles::MxcUrl:
         return data.url.mid(6);
+    default:
+        return {};
     }
 
     return QVariant();

src/models/customemojimodel.h

@@ -17,19 +17,29 @@ struct CustomEmoji {
     Q_PROPERTY(QString name MEMBER name)
 };
 
+/**
+ * @class CustomEmojiModel
+ *
+ * This class defines the model for custom user emojis.
+ *
+ * This is based upon the im.ponies.user_emotes spec (MSC2545).
+ */
 class CustomEmojiModel : public QAbstractListModel
 {
     Q_OBJECT
 
 public:
+    /**
+     * @brief Defines the model roles.
+     */
     enum Roles {
-        Name = Qt::DisplayRole,
-        ImageURL,
-        ModelData, // for emulating the regular emoji model's usage, otherwise the UI code would get too complicated
-        MxcUrl = 50,
-        DisplayRole = 51,
-        ReplacedTextRole = 52,
-        DescriptionRole = 53, // also invalid, reserved
+        Name = Qt::DisplayRole, /**< The name of the emoji. */
+        ImageURL, /**< The URL for the custom emoji. */
+        ModelData, /**< for emulating the regular emoji model's usage, otherwise the UI code would get too complicated. */
+        MxcUrl = 50, /**< The mxc source URL for the custom emoji. */
+        DisplayRole = 51, /**< The name of the emoji. For compatibility with EmojiModel. */
+        ReplacedTextRole = 52, /**< The name of the emoji. For compatibility with EmojiModel. */
+        DescriptionRole = 53, /**< Invalid, reserved. For compatibility with EmojiModel. */
     };
     Q_ENUM(Roles);
 
@@ -39,14 +49,45 @@ public:
         return _instance;
     }
 
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) const override;
+
+    /**
+     * @brief Number of rows in the model.
+     *
+     * @sa  QAbstractItemModel::rowCount
+     */
     int rowCount(const QModelIndex &parent = QModelIndex()) const override;
 
+    /**
+     * @brief Returns a mapping from Role enum values to role names.
+     *
+     * @sa Roles, QAbstractItemModel::roleNames()
+     */
     QHash<int, QByteArray> roleNames() const override;
 
+    /**
+     * @brief Substitute any custom emojis for an image in the input text.
+     */
     Q_INVOKABLE QString preprocessText(const QString &it);
+
+    /**
+     * @brief Return a list of custom emojis where the name contains the filter text.
+     */
     Q_INVOKABLE QVariantList filterModel(const QString &filter);
+
+    /**
+     * @brief Add a new emoji to the model.
+     */
     Q_INVOKABLE void addEmoji(const QString &name, const QUrl &location);
+
+    /**
+     * @brief Remove an emoji from the model.
+     */
     Q_INVOKABLE void removeEmoji(const QString &name);
 
 private:

src/models/devicesmodel.h

@@ -12,28 +12,67 @@ namespace Quotient
 class Connection;
 }
 
+/**
+ * @class DevicesModel
+ *
+ * This class defines the model for managing the devices of the local user.
+ *
+ * A device is any session where the local user is logged into a client. This means
+ * the same physical device can have multiple sessions for example if the user uses
+ * multiple clients on the same machine.
+ */
 class DevicesModel : public QAbstractListModel
 {
     Q_OBJECT
 
+    /**
+     * @brief The current connection that the model is getting its devices from.
+     */
     Q_PROPERTY(Quotient::Connection *connection READ connection NOTIFY connectionChanged)
 
 public:
+    /**
+     * @brief Defines the model roles.
+     */
     enum Roles {
-        Id,
-        DisplayName,
-        LastIp,
-        LastTimestamp,
+        Id, /**< The device ID. */
+        DisplayName, /**< Display name set by the user for this device. */
+        LastIp, /**< The IP address where this device was last seen. */
+        LastTimestamp, /**< The timestamp when this devices was last seen. */
     };
     Q_ENUM(Roles);
 
     DevicesModel(QObject *parent = nullptr);
 
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     QVariant data(const QModelIndex &index, int role) const override;
-    QHash<int, QByteArray> roleNames() const override;
+
+    /**
+     * @brief Number of rows in the model.
+     *
+     * @sa  QAbstractItemModel::rowCount
+     */
     int rowCount(const QModelIndex &parent) const override;
 
+    /**
+     * @brief Returns a mapping from Role enum values to role names.
+     *
+     * @sa Roles, QAbstractItemModel::roleNames()
+     */
+    QHash<int, QByteArray> roleNames() const override;
+
+    /**
+     * @brief Logout the device at the given index.
+     */
     Q_INVOKABLE void logout(int index, const QString &password);
+
+    /**
+     * @brief Set the display name of the device at the given index.
+     */
     Q_INVOKABLE void setName(int index, const QString &name);
 
     Quotient::Connection *connection() const;

src/models/emojimodel.h

@@ -51,12 +51,30 @@ struct Emoji {
 
 Q_DECLARE_METATYPE(Emoji)
 
+/**
+ * @class EmojiModel
+ *
+ * This class defines the model for visualising a list of emojis.
+ */
 class EmojiModel : public QAbstractListModel
 {
     Q_OBJECT
 
+    /**
+     * @brief Return a list of recently used emojis.
+     */
     Q_PROPERTY(QVariantList history READ history NOTIFY historyChanged)
+
+    /**
+     * @brief Return a list of emoji categories.
+     *
+     * @note No custom emoji categories will be included.
+     */
     Q_PROPERTY(QVariantList categories READ categories CONSTANT)
+
+    /**
+     * @brief Return a list of emoji categories with custom emojis.
+     */
     Q_PROPERTY(QVariantList categoriesWithCustom READ categoriesWithCustom CONSTANT)
 
 public:
@@ -66,47 +84,92 @@ public:
         return _instance;
     }
 
+    /**
+     * @brief Defines the model roles.
+     */
     enum RoleNames {
-        ShortNameRole = Qt::DisplayRole,
-        UnicodeRole,
-        InvalidRole = 50,
-        DisplayRole = 51,
-        ReplacedTextRole = 52,
-        DescriptionRole = 53,
+        ShortNameRole = Qt::DisplayRole, /**< The name of the emoji. */
+        UnicodeRole, /**< The unicode character of the emoji. */
+        InvalidRole = 50, /**< Invalid, reserved. */
+        DisplayRole = 51, /**< The display text for an emoji. */
+        ReplacedTextRole = 52, /**< The text to replace the short name with (i.e. the unicode character). */
+        DescriptionRole = 53, /**< The long description of an emoji. */
     };
     Q_ENUM(RoleNames);
 
+    /**
+     * @brief Defines the potential categories an emoji can be placed in.
+     */
     enum Category {
-        Custom,
-        Search,
-        SearchNoCustom,
-        History,
-        HistoryNoCustom,
-        Smileys,
-        People,
-        Nature,
-        Food,
-        Activities,
-        Travel,
-        Objects,
-        Symbols,
-        Flags,
-        Component,
+        Custom, /**< A custom user emoji. */
+        Search, /**< The results of a filter. */
+        SearchNoCustom, /**< The results of a filter with no custom emojis. */
+        History, /**< Recently used emojis. */
+        HistoryNoCustom, /**< Recently used emojis with no custom emojis. */
+        Smileys, /**< Smileys & emotion emojis. */
+        People, /**< People & Body emojis. */
+        Nature, /**< Animals & Nature emojis. */
+        Food, /**< Food & Drink emojis. */
+        Activities, /**< Activities emojis. */
+        Travel, /**< Travel & Places emojis. */
+        Objects, /**< Objects emojis. */
+        Symbols, /**< Symbols emojis. */
+        Flags, /**< Flags emojis. */
+        Component, /**< ??? */
     };
     Q_ENUM(Category)
 
-    [[nodiscard]] int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     [[nodiscard]] QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) 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 RoleNames, QAbstractItemModel::roleNames()
+     */
     [[nodiscard]] QHash<int, QByteArray> roleNames() const override;
 
-    Q_INVOKABLE QVariantList history() const;
+    /**
+     * @brief Return a filtered list of emojis.
+     *
+     * @note This includes custom emojis, use filterModelNoCustom to return a result
+     *       without custom emojis.
+     *
+     * @sa filterModelNoCustom
+     */
     Q_INVOKABLE static QVariantList filterModel(const QString &filter, bool limit = true);
+
+    /**
+     * @brief Return a filtered list of emojis without custom emojis.
+     *
+     * @note Use filterModel to return a result with custom emojis.
+     *
+     * @sa filterModel
+     */
     Q_INVOKABLE static QVariantList filterModelNoCustom(const QString &filter, bool limit = true);
 
+    /**
+     * @brief Return a list of emojis for the given category.
+     */
     Q_INVOKABLE QVariantList emojis(Category category) const;
 
+    /**
+     * @brief Return a list of emoji tones for the given base emoji.
+     */
     Q_INVOKABLE QVariantList tones(const QString &baseEmoji) const;
 
+    Q_INVOKABLE QVariantList history() const;
     QVariantList categories() const;
     QVariantList categoriesWithCustom() const;
 

src/models/keywordnotificationrulemodel.h

@@ -7,23 +7,54 @@
 
 #include <QAbstractListModel>
 
+/**
+ * @class KeywordNotificationRuleModel
+ *
+ * This class defines the model for managing notification push rule keywords.
+ */
 class KeywordNotificationRuleModel : public QAbstractListModel
 {
     Q_OBJECT
 
 public:
+    /**
+     * @brief Defines the model roles.
+     */
     enum EventRoles {
-        NameRole = Qt::DisplayRole,
+        NameRole = Qt::DisplayRole, /**< The push rule keyword. */
     };
 
     KeywordNotificationRuleModel(QObject *parent = nullptr);
 
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     [[nodiscard]] QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) 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;
 
+    /**
+     * @brief Add a new keyword to the model.
+     */
     Q_INVOKABLE void addKeyword(const QString &keyword);
+
+    /**
+     * @brief Remove a keyword from the model.
+     */
     Q_INVOKABLE void removeKeywordAtIndex(int index);
 
 private Q_SLOTS:

src/models/locationsmodel.cpp

@@ -1,102 +0,0 @@
-// SPDX-FileCopyrightText: 2023 Tobias Fella <tobias.fella@kde.org>
-// SPDX-License-Identifier: GPL-2.0-or-later
-
-#include "locationsmodel.h"
-
-using namespace Quotient;
-
-LocationsModel::LocationsModel(QObject *parent)
-    : QAbstractListModel(parent)
-{
-    connect(this, &LocationsModel::roomChanged, this, [=]() {
-        for (const auto &event : m_room->messageEvents()) {
-            if (!is<RoomMessageEvent>(*event)) {
-                continue;
-            }
-            if (event->contentJson()["msgtype"] == "m.location") {
-                const auto &e = *event;
-                addLocation(eventCast<const RoomMessageEvent>(&e));
-            }
-        }
-        connect(m_room, &NeoChatRoom::aboutToAddHistoricalMessages, this, [=](const auto &events) {
-            for (const auto &event : events) {
-                if (!is<RoomMessageEvent>(*event)) {
-                    continue;
-                }
-                if (event->contentJson()["msgtype"] == "m.location") {
-                    const auto &e = *event;
-                    addLocation(eventCast<const RoomMessageEvent>(&e));
-                }
-            }
-        });
-        connect(m_room, &NeoChatRoom::aboutToAddNewMessages, this, [=](const auto &events) {
-            for (const auto &event : events) {
-                if (!is<RoomMessageEvent>(*event)) {
-                    continue;
-                }
-                if (event->contentJson()["msgtype"] == "m.location") {
-                    const auto &e = *event;
-                    addLocation(eventCast<const RoomMessageEvent>(&e));
-                }
-            }
-        });
-    });
-}
-
-void LocationsModel::addLocation(const RoomMessageEvent *event)
-{
-    const auto uri = event->contentJson()["org.matrix.msc3488.location"]["uri"].toString();
-    const auto parts = uri.mid(4).split(QLatin1Char(','));
-    const auto latitude = parts[0].toFloat();
-    const auto longitude = parts[1].toFloat();
-    beginInsertRows(QModelIndex(), m_locations.size(), m_locations.size() + 1);
-    m_locations += LocationData{
-        .eventId = event->id(),
-        .latitude = latitude,
-        .longitude = longitude,
-        .text = event->contentJson()["body"].toString(),
-        .author = dynamic_cast<NeoChatUser *>(m_room->user(event->senderId())),
-    };
-    endInsertRows();
-}
-
-NeoChatRoom *LocationsModel::room() const
-{
-    return m_room;
-}
-
-void LocationsModel::setRoom(NeoChatRoom *room)
-{
-    if (m_room) {
-        disconnect(this, nullptr, m_room, nullptr);
-    }
-    m_room = room;
-    Q_EMIT roomChanged();
-}
-
-QHash<int, QByteArray> LocationsModel::roleNames() const
-{
-    return {
-        {LongitudeRole, "longitude"},
-        {LatitudeRole, "latitude"},
-        {TextRole, "text"},
-    };
-}
-
-QVariant LocationsModel::data(const QModelIndex &index, int roleName) const
-{
-    auto row = index.row();
-    if (roleName == LongitudeRole) {
-        return m_locations[row].longitude;
-    } else if (roleName == LatitudeRole) {
-        return m_locations[row].latitude;
-    } else if (roleName == TextRole) {
-        return m_locations[row].text;
-    }
-    return {};
-}
-
-int LocationsModel::rowCount(const QModelIndex &parent) const
-{
-    return m_locations.size();
-}

src/models/locationsmodel.h

@@ -1,49 +0,0 @@
-// SPDX-FileCopyrightText: 2023 Tobias Fella <tobias.fella@kde.org>
-// SPDX-License-Identifier: GPL-2.0-or-later
-
-#pragma once
-
-#include <QAbstractListModel>
-
-#include "neochatroom.h"
-
-#include <events/roommessageevent.h>
-
-class LocationsModel : public QAbstractListModel
-{
-    Q_OBJECT
-
-public:
-    enum Roles {
-        TextRole = Qt::DisplayRole,
-        LongitudeRole,
-        LatitudeRole,
-    };
-    Q_ENUM(Roles)
-    Q_PROPERTY(NeoChatRoom *room READ room WRITE setRoom NOTIFY roomChanged)
-
-    explicit LocationsModel(QObject *parent = nullptr);
-
-    [[nodiscard]] NeoChatRoom *room() const;
-    void setRoom(NeoChatRoom *room);
-
-    [[nodiscard]] QHash<int, QByteArray> roleNames() const override;
-    [[nodiscard]] QVariant data(const QModelIndex &index, int roleName) const override;
-    [[nodiscard]] int rowCount(const QModelIndex &parent) const override;
-
-Q_SIGNALS:
-    void roomChanged();
-
-private:
-    QPointer<NeoChatRoom> m_room;
-
-    struct LocationData {
-        QString eventId;
-        float latitude;
-        float longitude;
-        QString text;
-        NeoChatUser *author;
-    };
-    QList<LocationData> m_locations;
-    void addLocation(const Quotient::RoomMessageEvent *event);
-};

src/models/messageeventmodel.cpp

@@ -33,7 +33,7 @@ using namespace Quotient;
 QHash<int, QByteArray> MessageEventModel::roleNames() const
 {
     QHash<int, QByteArray> roles = QAbstractItemModel::roleNames();
-    roles[EventTypeRole] = "eventType";
+    roles[DelegateTypeRole] = "delegateType";
     roles[MessageRole] = "message";
     roles[EventIdRole] = "eventId";
     roles[TimeRole] = "time";
@@ -45,19 +45,16 @@ QHash<int, QByteArray> MessageEventModel::roleNames() const
     roles[SpecialMarksRole] = "marks";
     roles[LongOperationRole] = "progressInfo";
     roles[FileMimetypeIcon] = "fileMimetypeIcon";
-    roles[AnnotationRole] = "annotation";
     roles[EventResolvedTypeRole] = "eventResolvedType";
     roles[IsReplyRole] = "isReply";
     roles[ReplyRole] = "reply";
     roles[ReplyIdRole] = "replyId";
-    roles[UserMarkerRole] = "userMarker";
     roles[ShowAuthorRole] = "showAuthor";
     roles[ShowSectionRole] = "showSection";
     roles[ReadMarkersRole] = "readMarkers";
     roles[ReadMarkersStringRole] = "readMarkersString";
     roles[ShowReadMarkersRole] = "showReadMarkers";
     roles[ReactionRole] = "reaction";
-    roles[IsEditedRole] = "isEdited";
     roles[SourceRole] = "source";
     roles[MimeTypeRole] = "mimeType";
     roles[FormattedBodyRole] = "formattedBody";
@@ -69,12 +66,14 @@ QHash<int, QByteArray> MessageEventModel::roleNames() const
     roles[IsRedactedRole] = "isRedacted";
     roles[GenericDisplayRole] = "genericDisplay";
     roles[IsPendingRole] = "isPending";
+    roles[LatitudeRole] = "latitude";
+    roles[LongitudeRole] = "longitude";
+    roles[AssetRole] = "asset";
     return roles;
 }
 
 MessageEventModel::MessageEventModel(QObject *parent)
     : QAbstractListModel(parent)
-    , m_currentRoom(nullptr)
 {
     using namespace Quotient;
     qmlRegisterAnonymousType<FileTransferInfo>("org.kde.neochat", 1);
@@ -87,6 +86,11 @@ MessageEventModel::MessageEventModel(QObject *parent)
 
 MessageEventModel::~MessageEventModel() = default;
 
+NeoChatRoom *MessageEventModel::room() const
+{
+    return m_currentRoom;
+}
+
 void MessageEventModel::setRoom(NeoChatRoom *room)
 {
     if (room == m_currentRoom) {
@@ -314,7 +318,7 @@ int MessageEventModel::refreshEventRoles(const QString &id, const QVector<int> &
             return -1;
         }
         row = int(timelineIt - m_currentRoom->messageEvents().rbegin()) + timelineBaseIndex();
-        if (data(index(row, 0), EventTypeRole).toInt() == ReadMarker || data(index(row, 0), EventTypeRole).toInt() == Other) {
+        if (data(index(row, 0), DelegateTypeRole).toInt() == ReadMarker || data(index(row, 0), DelegateTypeRole).toInt() == Other) {
             row++;
         }
     }
@@ -445,7 +449,7 @@ QVariant MessageEventModel::data(const QModelIndex &idx, int role) const
 
     if (m_lastReadEventIndex.row() == row) {
         switch (role) {
-        case EventTypeRole:
+        case DelegateTypeRole:
             return DelegateType::ReadMarker;
         case TimeRole: {
             const QDateTime eventDate = data(index(m_lastReadEventIndex.row() + 1, 0), TimeRole).toDateTime().toLocalTime();
@@ -494,10 +498,10 @@ QVariant MessageEventModel::data(const QModelIndex &idx, int role) const
     }
 
     if (role == SourceRole) {
-        return evt.originalJson();
+        return QJsonDocument(evt.fullJson()).toJson();
     }
 
-    if (role == EventTypeRole) {
+    if (role == DelegateTypeRole) {
         if (auto e = eventCast<const RoomMessageEvent>(&evt)) {
             switch (e->msgtype()) {
             case MessageEventType::Emote:
@@ -566,7 +570,7 @@ QVariant MessageEventModel::data(const QModelIndex &idx, int role) const
         }
 
         if (auto e = eventCast<const RoomMessageEvent>(&evt)) {
-            if(e->msgtype() == Quotient::MessageEventType::Location) {
+            if (e->msgtype() == Quotient::MessageEventType::Location) {
                 return e->contentJson();
             }
             // Cannot use e.contentJson() here because some
@@ -659,14 +663,6 @@ QVariant MessageEventModel::data(const QModelIndex &idx, int role) const
         return EventStatus::Normal;
     }
 
-    if (role == IsEditedRole) {
-        if (auto e = eventCast<const RoomMessageEvent>(&evt)) {
-            return !e->unsignedJson().isEmpty() && e->unsignedJson().contains("m.relations")
-                && e->unsignedJson()["m.relations"].toObject().contains("m.replace");
-        }
-        return false;
-    }
-
     if (role == EventIdRole) {
         return !evt.id().isEmpty() ? evt.id() : evt.transactionId();
     }
@@ -682,29 +678,11 @@ QVariant MessageEventModel::data(const QModelIndex &idx, int role) const
         }
     }
 
-    if (role == AnnotationRole) {
-        if (isPending) {
-            return pendingIt->annotation();
-        }
-    }
-
     if (role == TimeRole || role == SectionRole) {
         auto ts = isPending ? pendingIt->lastUpdated() : makeMessageTimestamp(timelineIt);
         return role == TimeRole ? QVariant(ts) : renderDate(ts);
     }
 
-    if (role == UserMarkerRole) {
-        QVariantList variantList;
-        const auto users = m_currentRoom->usersAtEventId(evt.id());
-        for (User *user : users) {
-            if (user == m_currentRoom->localUser()) {
-                continue;
-            }
-            variantList.append(QVariant::fromValue(user));
-        }
-        return variantList;
-    }
-
     if (role == IsReplyRole) {
         return !evt.contentJson()["m.relates_to"].toObject()["m.in_reply_to"].toObject()["event_id"].toString().isEmpty();
     }
@@ -790,7 +768,7 @@ QVariant MessageEventModel::data(const QModelIndex &idx, int role) const
             // While the row is removed the subsequent row indexes are not changed so we need to skip over the removed index.
             // See - https://doc.qt.io/qt-5/qabstractitemmodel.html#beginRemoveRows
             if (data(i, SpecialMarksRole) != EventStatus::Hidden && !itemData(i).empty()) {
-                return data(i, AuthorRole) != data(idx, AuthorRole) || data(i, EventTypeRole) == MessageEventModel::State
+                return data(i, AuthorRole) != data(idx, AuthorRole) || data(i, DelegateTypeRole) == MessageEventModel::State
                     || data(i, TimeRole).toDateTime().msecsTo(data(idx, TimeRole).toDateTime()) > 600000
                     || data(i, TimeRole).toDateTime().toLocalTime().date().day() != data(idx, TimeRole).toDateTime().toLocalTime().date().day();
             }
@@ -815,6 +793,32 @@ QVariant MessageEventModel::data(const QModelIndex &idx, int role) const
         return false;
     }
 
+    if (role == LatitudeRole) {
+        const auto geoUri = evt.contentJson()["geo_uri"_ls].toString();
+        if (geoUri.isEmpty()) {
+            return {};
+        }
+        const auto latitude = geoUri.split(u';')[0].split(u':')[1].split(u',')[0];
+        return latitude.toFloat();
+    }
+
+    if (role == LongitudeRole) {
+        const auto geoUri = evt.contentJson()["geo_uri"_ls].toString();
+        if (geoUri.isEmpty()) {
+            return {};
+        }
+        const auto latitude = geoUri.split(u';')[0].split(u':')[1].split(u',')[1];
+        return latitude.toFloat();
+    }
+
+    if (role == AssetRole) {
+        const auto assetType = evt.contentJson()["org.matrix.msc3488.asset"].toObject()["type"].toString();
+        if (assetType.isEmpty()) {
+            return {};
+        }
+        return assetType;
+    }
+
     if (role == ReadMarkersRole) {
 #ifdef QUOTIENT_07
         auto userIds = room()->userIdsAtEvent(evt.id());
@@ -979,13 +983,13 @@ QVariant MessageEventModel::data(const QModelIndex &idx, int role) const
     }
 
     if (role == IsPendingRole) {
-        return row < m_currentRoom->pendingEvents().size();
+        return row < static_cast<int>(m_currentRoom->pendingEvents().size());
     }
 
     return {};
 }
 
-int MessageEventModel::eventIDToIndex(const QString &eventID) const
+int MessageEventModel::eventIdToRow(const QString &eventID) const
 {
     const auto it = m_currentRoom->findInTimeline(eventID);
     if (it == m_currentRoom->historyEdge()) {
@@ -1027,7 +1031,7 @@ QVariant MessageEventModel::getLastLocalUserMessageEventId()
                 targetMessage.insert("event_id", eventId);
                 targetMessage.insert("formattedBody", content["formatted_body"].toString());
                 // Need to get the message from the original eventId or body will have * on the front
-                QModelIndex idx = index(eventIDToIndex(eventId), 0);
+                QModelIndex idx = index(eventIdToRow(eventId), 0);
                 targetMessage.insert("message", idx.data(Qt::UserRole + 2));
 
                 return targetMessage;
@@ -1037,14 +1041,14 @@ QVariant MessageEventModel::getLastLocalUserMessageEventId()
     return targetMessage;
 }
 
-QVariant MessageEventModel::getLatestMessageFromIndex(const int baseline)
+QVariant MessageEventModel::getLatestMessageFromRow(const int startRow)
 {
     QVariantMap replyResponse;
-    const auto &timelineBottom = m_currentRoom->messageEvents().rbegin() + baseline;
+    const auto &timelineBottom = m_currentRoom->messageEvents().rbegin() + startRow;
 
-    // set a cap limit of baseline + 35 messages, to prevent loading a lot of messages
+    // set a cap limit of startRow + 35 messages, to prevent loading a lot of messages
     // in rooms where the user has not sent many messages
-    const auto limit = timelineBottom + std::min(baseline + 35, m_currentRoom->timelineSize());
+    const auto limit = timelineBottom + std::min(startRow + 35, m_currentRoom->timelineSize());
 
     for (auto it = timelineBottom; it != limit; ++it) {
         auto evt = it->event();
@@ -1066,7 +1070,7 @@ QVariant MessageEventModel::getLatestMessageFromIndex(const int baseline)
             }
             replyResponse.insert("event_id", eventId);
             // Need to get the message from the original eventId or body will have * on the front
-            QModelIndex idx = index(eventIDToIndex(eventId), 0);
+            QModelIndex idx = index(eventIdToRow(eventId), 0);
             replyResponse.insert("message", idx.data(Qt::UserRole + 2));
             replyResponse.insert("sender_id", QVariant::fromValue(m_currentRoom->getUser((*it)->senderId())));
             replyResponse.insert("at", -it->index());

src/models/messageeventmodel.h

@@ -7,75 +7,99 @@
 
 #include "neochatroom.h"
 
+/**
+ * @class MessageEventModel
+ *
+ * This class defines the model for visualising the room timeline.
+ *
+ * This model covers all event types in the timeline with many of the roles being
+ * specific to a subset of events. This means the user needs to understand which
+ * roles will return useful information for a given event type.
+ *
+ * @sa NeoChatRoom
+ */
 class MessageEventModel : public QAbstractListModel
 {
     Q_OBJECT
+
+    /**
+     * @brief The current room that the model is getting its messages from.
+     */
     Q_PROPERTY(NeoChatRoom *room READ room WRITE setRoom NOTIFY roomChanged)
 
 public:
+    /**
+     * @brief The type of delegate that is needed for the event.
+     *
+     * @note While similar this is not the matrix event or message type. This is
+     *       to tell a QML ListView what delegate to show for each event. So while
+     *       similar to the spec it is not the same.
+     */
     enum DelegateType {
-        Emote,
-        Notice,
-        Image,
-        Audio,
-        Video,
-        File,
-        Message,
-        Sticker,
-        State,
-        Encrypted,
-        ReadMarker,
-        Poll,
-        Location,
-        Other,
+        Emote, /**< A message that begins with /me. */
+        Notice, /**< A notice event. */
+        Image, /**< A message that is an image. */
+        Audio, /**< A message that is an audio recording. */
+        Video, /**< A message that is a video. */
+        File, /**< A message that is a file. */
+        Message, /**< A text message. */
+        Sticker, /**< A message that is a sticker. */
+        State, /**< A state event in the room. */
+        Encrypted, /**< An encrypted message that cannot be decrypted. */
+        ReadMarker, /**< The local user read marker. */
+        Poll, /**< The initial event for a poll. */
+        Location, /**< A location event. */
+        Other, /**< Anything that cannot be classified as another type. */
     };
     Q_ENUM(DelegateType);
 
+    /**
+     * @brief Defines the model roles.
+     */
     enum EventRoles {
-        EventTypeRole = Qt::UserRole + 1,
-        MessageRole,
-        EventIdRole,
-        TimeRole,
-        SectionRole,
-        AuthorRole,
-        ContentRole,
-        ContentTypeRole,
-        HighlightRole,
-        SpecialMarksRole,
-        LongOperationRole,
-        AnnotationRole,
-        UserMarkerRole,
-        FormattedBodyRole,
-        GenericDisplayRole,
+        DelegateTypeRole = Qt::UserRole + 1, /**< The delegate type of the message. */
+        MessageRole, /**< Plain text representation of the message. */
+        EventIdRole, /**< The matrix event ID of the event. */
+        TimeRole, /**< The timestamp for when the event was sent. */
+        SectionRole, /**< The date of the event as a string. */
+        AuthorRole, /**< The author of the event. */
+        ContentRole, /**< The full message content. */
+        ContentTypeRole, /**< The content mime type. */
+        HighlightRole, /**< Whether the event should be highlighted. */
+        SpecialMarksRole, /**< Whether the event is hidden or not. */
+        LongOperationRole, /**< Progress info when downloading files. */
+        FormattedBodyRole, /**< The formatted body of a rich message. */
+        GenericDisplayRole, /**< A generic string based upon the message type. */
 
-        MimeTypeRole,
-        FileMimetypeIcon,
+        MimeTypeRole, /**< The mime type of the message's file or media. */
+        FileMimetypeIcon, /**< The icon name for the mime type of a file. */
 
-        IsReplyRole,
-        ReplyRole,
-        ReplyIdRole,
+        IsReplyRole, /**< Is the message a reply to another event. */
+        ReplyRole, /**< The content data of the message that was replied to. */
+        ReplyIdRole, /**< The matrix ID of the message that was replied to. */
 
-        ShowAuthorRole,
-        ShowSectionRole,
+        ShowAuthorRole, /**< Whether the author's name should be shown. */
+        ShowSectionRole, /**< Whether the section header should be shown. */
 
-        ReadMarkersRole, /**< QVariantList of users at the event for read marker tracking. */
-        ReadMarkersStringRole, /**< QString with the display name and mxID of the users at the event. */
-        ShowReadMarkersRole, /**< bool with whether there are any other user read markers to be shown. */
-        ReactionRole,
+        ReadMarkersRole, /**< Other users at the event for read marker tracking. */
+        ReadMarkersStringRole, /**< String with the display name and mxID of the users at the event. */
+        ShowReadMarkersRole, /**< Whether there are any other user read markers to be shown. */
+        ReactionRole, /**< List of reactions to this event. */
+        SourceRole, /**< The full message source JSON. */
+        MediaUrlRole, /**< The source URL for any media in the message. */
 
-        IsEditedRole,
-        SourceRole,
-        MediaUrlRole,
         // For debugging
-        EventResolvedTypeRole,
-        AuthorIdRole,
-        VerifiedRole,
-        // Sender's displayname, always without the matrix id
-        DisplayNameForInitialsRole,
-        // The displayname for the event's sender; for name change events, the old displayname
-        AuthorDisplayNameRole,
-        IsRedactedRole,
-        IsPendingRole,
+        EventResolvedTypeRole, /**< The event type the message. */
+        AuthorIdRole, /**< Matrix ID of the message author. */
+
+        VerifiedRole, /**< Whether an encrypted message is sent in a verified session. */
+        DisplayNameForInitialsRole, /**< Sender's displayname, always without the matrix id. */
+        AuthorDisplayNameRole, /**< The displayname for the event's sender; for name change events, the old displayname. */
+        IsRedactedRole, /**< Whether an event has been deleted. */
+        IsPendingRole, /**< Whether an event is waiting to be accepted by the server. */
+        LatitudeRole, /**< Latitude for a location event. */
+        LongitudeRole, /**< Longitude for a location event. */
+        AssetRole, /**< Type of location event, e.g. self pin of the user location. */
         LastRole, // Keep this last
     };
     Q_ENUM(EventRoles)
@@ -83,20 +107,67 @@ public:
     explicit MessageEventModel(QObject *parent = nullptr);
     ~MessageEventModel() override;
 
-    [[nodiscard]] NeoChatRoom *room() const
-    {
-        return m_currentRoom;
-    }
+    [[nodiscard]] NeoChatRoom *room() const;
     void setRoom(NeoChatRoom *room);
 
-    [[nodiscard]] int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     [[nodiscard]] QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) 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_INVOKABLE [[nodiscard]] int eventIDToIndex(const QString &eventID) const;
+    /**
+     * @brief Get the row number of the given event ID in the model.
+     */
+    Q_INVOKABLE [[nodiscard]] int eventIdToRow(const QString &eventID) const;
+
+    /**
+     * @brief Get the last message sent by the local user.
+     *
+     * @note This checks a maximum of the previous 35 message for performance reasons.
+     *
+     * @return a QVariantMap for the event with the following parameters:
+     *  - eventId - The event ID.
+     *  - formattedBody - The message text formatted as Qt::RichText.
+     *  - message - The message text formatted as Qt::PlainText.
+     */
     Q_INVOKABLE [[nodiscard]] QVariant getLastLocalUserMessageEventId();
-    Q_INVOKABLE [[nodiscard]] QVariant getLatestMessageFromIndex(const int baseline);
-    Q_INVOKABLE void loadReply(const QModelIndex &row);
+
+    /**
+     * @brief Get the last message sent earlier than the given row.
+     *
+     * @note This checks a maximum of the previous 35 message for performance reasons.
+     *
+     * @return a QVariantMap for the event with the following parameters:
+     *  - eventId - The event ID.
+     *  - message - The message text formatted as Qt::PlainText.
+     *  - sender_id - The matrix ID of the sender.
+     *  - at - The QModelIndex of the message.
+     */
+    Q_INVOKABLE [[nodiscard]] QVariant getLatestMessageFromRow(const int startRow);
+
+    /**
+     * @brief Load the event that the item at the given index replied to.
+     *
+     * This is used to ensure that the reply data is available when the message that
+     * was replied to is outside the currently loaded timeline.
+     */
+    Q_INVOKABLE void loadReply(const QModelIndex &index);
 
 private Q_SLOTS:
     int refreshEvent(const QString &eventId);

src/models/messagefiltermodel.cpp

@@ -41,7 +41,7 @@ bool MessageFilterModel::filterAcceptsRow(int sourceRow, const QModelIndex &sour
         return false;
     }
 
-    const auto eventType = index.data(MessageEventModel::EventTypeRole).toInt();
+    const auto eventType = index.data(MessageEventModel::DelegateTypeRole).toInt();
 
     if (eventType == MessageEventModel::Other) {
         return false;

src/models/messagefiltermodel.h

@@ -5,10 +5,21 @@
 
 #include <QSortFilterProxyModel>
 
+/**
+ * @class MessageFilterModel
+ *
+ * This model filters out any messages that should be hidden.
+ *
+ * Deleted messages are only hidden if the user hasn't set them to be shown.
+ */
 class MessageFilterModel : public QSortFilterProxyModel
 {
     Q_OBJECT
 public:
     MessageFilterModel(QObject *parent = nullptr);
+
+    /**
+     * @brief Custom filter function to remove hidden messages.
+     */
     bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override;
 };

src/models/publicroomlistmodel.cpp

@@ -12,6 +12,11 @@ PublicRoomListModel::PublicRoomListModel(QObject *parent)
 {
 }
 
+Quotient::Connection *PublicRoomListModel::connection() const
+{
+    return m_connection;
+}
+
 void PublicRoomListModel::setConnection(Connection *conn)
 {
     if (m_connection == conn) {
@@ -47,6 +52,11 @@ void PublicRoomListModel::setConnection(Connection *conn)
     Q_EMIT hasMoreChanged();
 }
 
+QString PublicRoomListModel::server() const
+{
+    return m_server;
+}
+
 void PublicRoomListModel::setServer(const QString &value)
 {
     if (m_server == value) {
@@ -76,6 +86,11 @@ void PublicRoomListModel::setServer(const QString &value)
     Q_EMIT hasMoreChanged();
 }
 
+QString PublicRoomListModel::keyword() const
+{
+    return m_keyword;
+}
+
 void PublicRoomListModel::setKeyword(const QString &value)
 {
     if (m_keyword == value) {

src/models/publicroomlistmodel.h

@@ -13,54 +13,96 @@ namespace Quotient
 class Connection;
 }
 
+/**
+ * @class PublicRoomListModel
+ *
+ * This class defines the model for visualising a list of public rooms.
+ *
+ * The model finds the public rooms visible to the given server (which doesn't have
+ * to be the user's home server) and can also apply a filter if desired.
+ *
+ * Due to the fact that the public room list could be huge the model is lazily loaded
+ * and requires that the next batch of rooms be manually called.
+ */
 class PublicRoomListModel : public QAbstractListModel
 {
     Q_OBJECT
+
+    /**
+     * @brief The current connection that the model is getting its rooms from.
+     */
     Q_PROPERTY(Quotient::Connection *connection READ connection WRITE setConnection NOTIFY connectionChanged)
+
+    /**
+     * @brief The server to get the public room list from.
+     */
     Q_PROPERTY(QString server READ server WRITE setServer NOTIFY serverChanged)
+
+    /**
+     * @brief The filter keyword for the list of public rooms.
+     */
     Q_PROPERTY(QString keyword READ keyword WRITE setKeyword NOTIFY keywordChanged)
+
+    /**
+     * @brief Whether the model has more items to load.
+     */
     Q_PROPERTY(bool hasMore READ hasMore NOTIFY hasMoreChanged)
 
 public:
+    /**
+     * @brief Defines the model roles.
+     */
     enum EventRoles {
-        NameRole = Qt::DisplayRole + 1,
-        AvatarRole,
-        TopicRole,
-        RoomIDRole,
-        AliasRole,
-        MemberCountRole,
-        AllowGuestsRole,
-        WorldReadableRole,
-        IsJoinedRole,
+        NameRole = Qt::DisplayRole + 1, /**< The name of the room. */
+        AvatarRole, /**< The source URL for the room's avatar. */
+        TopicRole, /**< The room topic. */
+        RoomIDRole, /**< The room matrix ID. */
+        AliasRole, /**< The room canonical alias. */
+        MemberCountRole, /**< The number of members in the room. */
+        AllowGuestsRole, /**< Whether the room allows guest users. */
+        WorldReadableRole, /**< Whether the room events can be seen by non-members. */
+        IsJoinedRole, /**< Whether the local user has joined the room. */
     };
 
     PublicRoomListModel(QObject *parent = nullptr);
 
+    /**
+     * @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;
 
-    [[nodiscard]] Quotient::Connection *connection() const
-    {
-        return m_connection;
-    }
+    [[nodiscard]] Quotient::Connection *connection() const;
     void setConnection(Quotient::Connection *conn);
 
-    [[nodiscard]] QString server() const
-    {
-        return m_server;
-    }
+    [[nodiscard]] QString server() const;
     void setServer(const QString &value);
 
-    [[nodiscard]] QString keyword() const
-    {
-        return m_keyword;
-    }
+    [[nodiscard]] QString keyword() const;
     void setKeyword(const QString &value);
 
     [[nodiscard]] bool hasMore() const;
 
+    /**
+     * @brief Load the next set of rooms.
+     *
+     * @param count the maximum number of rooms to load.
+     */
     Q_INVOKABLE void next(int count = 50);
 
 private:

src/models/roomlistmodel.cpp

@@ -10,11 +10,13 @@
 #include "user.h"
 
 #include <QDebug>
+#if QT_VERSION < QT_VERSION_CHECK(6, 6, 0)
 #ifndef Q_OS_ANDROID
 #include <QDBusConnection>
 #include <QDBusInterface>
 #include <QDBusMessage>
 #endif
+#endif
 
 #include <KLocalizedString>
 #include <QGuiApplication>
@@ -29,15 +31,6 @@ using namespace Quotient;
 
 Q_DECLARE_METATYPE(Quotient::JoinState)
 
-#ifndef Q_OS_ANDROID
-bool useUnityCounter()
-{
-    static const auto Result = QDBusInterface("com.canonical.Unity", "/").isValid();
-
-    return Result;
-}
-#endif
-
 RoomListModel::RoomListModel(QObject *parent)
     : QAbstractListModel(parent)
 {
@@ -46,34 +39,41 @@ RoomListModel::RoomListModel(QObject *parent)
         m_categoryVisibility[collapsedSection] = false;
     }
 
-#ifndef Q_OS_ANDROID
     connect(this, &RoomListModel::notificationCountChanged, this, [this]() {
-        if (useUnityCounter()) {
-            // copied from Telegram desktop
-            const auto launcherUrl = "application://org.kde.neochat.desktop";
-            // Gnome requires that count is a 64bit integer
-            const qint64 counterSlice = std::min(m_notificationCount, 9999);
-            QVariantMap dbusUnityProperties;
+#if QT_VERSION < QT_VERSION_CHECK(6, 6, 0)
+#ifndef Q_OS_ANDROID
+        // copied from Telegram desktop
+        const auto launcherUrl = "application://org.kde.neochat.desktop";
+        // Gnome requires that count is a 64bit integer
+        const qint64 counterSlice = std::min(m_notificationCount, 9999);
+        QVariantMap dbusUnityProperties;
 
-            if (counterSlice > 0) {
-                dbusUnityProperties["count"] = counterSlice;
-                dbusUnityProperties["count-visible"] = true;
-            } else {
-                dbusUnityProperties["count-visible"] = false;
-            }
-
-            auto signal = QDBusMessage::createSignal("/com/canonical/unity/launcherentry/neochat", "com.canonical.Unity.LauncherEntry", "Update");
-
-            signal.setArguments({launcherUrl, dbusUnityProperties});
-
-            QDBusConnection::sessionBus().send(signal);
+        if (counterSlice > 0) {
+            dbusUnityProperties["count"] = counterSlice;
+            dbusUnityProperties["count-visible"] = true;
+        } else {
+            dbusUnityProperties["count-visible"] = false;
         }
+
+        auto signal = QDBusMessage::createSignal("/com/canonical/unity/launcherentry/neochat", "com.canonical.Unity.LauncherEntry", "Update");
+
+        signal.setArguments({launcherUrl, dbusUnityProperties});
+
+        QDBusConnection::sessionBus().send(signal);
+#endif // Q_OS_ANDROID
+#else
+        qGuiApp->setBadgeNumber(m_notificationCount);
+#endif // QT_VERSION_CHECK(6, 6, 0)
     });
-#endif
 }
 
 RoomListModel::~RoomListModel() = default;
 
+Quotient::Connection *RoomListModel::connection() const
+{
+    return m_connection;
+}
+
 void RoomListModel::setConnection(Connection *connection)
 {
     if (connection == m_connection) {
@@ -154,10 +154,10 @@ void RoomListModel::doAddRoom(Room *r)
 void RoomListModel::connectRoomSignals(NeoChatRoom *room)
 {
     connect(room, &Room::displaynameChanged, this, [this, room] {
-        refresh(room);
+        refresh(room, {DisplayNameRole, NameRole});
     });
     connect(room, &Room::unreadMessagesChanged, this, [this, room] {
-        refresh(room);
+        refresh(room, {UnreadCountRole, NotificationCountRole, HighlightCountRole});
     });
     connect(room, &Room::notificationCountChanged, this, [this, room] {
         refresh(room);
@@ -172,7 +172,7 @@ void RoomListModel::connectRoomSignals(NeoChatRoom *room)
         refresh(room);
     });
     connect(room, &Room::addedMessages, this, [this, room] {
-        refresh(room, {LastEventRole, SubtitleTextRole});
+        refresh(room, {LastEventRole, SubtitleTextRole, LastActiveTimeRole});
     });
     connect(room, &Room::pendingEventMerged, this, [this, room] {
         refresh(room, {LastEventRole, SubtitleTextRole});
@@ -242,6 +242,11 @@ void RoomListModel::handleNotifications()
 }
 #endif
 
+int RoomListModel::notificationCount() const
+{
+    return m_notificationCount;
+}
+
 void RoomListModel::refreshNotificationCount()
 {
     int count = 0;
@@ -445,40 +450,40 @@ QHash<int, QByteArray> RoomListModel::roleNames() const
     return roles;
 }
 
-QString RoomListModel::categoryName(int section)
+QString RoomListModel::categoryName(int category)
 {
-    switch (section) {
-    case 1:
+    switch (category) {
+    case NeoChatRoomType::Invited:
         return i18n("Invited");
-    case 2:
+    case NeoChatRoomType::Favorite:
         return i18n("Favorite");
-    case 3:
+    case NeoChatRoomType::Direct:
         return i18n("Direct Messages");
-    case 4:
+    case NeoChatRoomType::Normal:
         return i18n("Normal");
-    case 5:
+    case NeoChatRoomType::Deprioritized:
         return i18n("Low priority");
-    case 6:
+    case NeoChatRoomType::Space:
         return i18n("Spaces");
     default:
         return "Deadbeef";
     }
 }
 
-QString RoomListModel::categoryIconName(int section)
+QString RoomListModel::categoryIconName(int category)
 {
-    switch (section) {
-    case 1:
+    switch (category) {
+    case NeoChatRoomType::Invited:
         return QStringLiteral("user-invisible");
-    case 2:
+    case NeoChatRoomType::Favorite:
         return QStringLiteral("favorite");
-    case 3:
+    case NeoChatRoomType::Direct:
         return QStringLiteral("dialog-messages");
-    case 4:
+    case NeoChatRoomType::Normal:
         return QStringLiteral("group");
-    case 5:
+    case NeoChatRoomType::Deprioritized:
         return QStringLiteral("object-order-lower");
-    case 6:
+    case NeoChatRoomType::Space:
         return QStringLiteral("group");
     default:
         return QStringLiteral("tools-report-bug");
@@ -516,7 +521,7 @@ NeoChatRoom *RoomListModel::roomByAliasOrId(const QString &aliasOrId)
     return nullptr;
 }
 
-int RoomListModel::indexForRoom(NeoChatRoom *room) const
+int RoomListModel::rowForRoom(NeoChatRoom *room) const
 {
     return m_rooms.indexOf(room);
 }

src/models/roomlistmodel.h

@@ -20,77 +20,137 @@ class NeoChatRoomType : public QObject
     Q_OBJECT
 
 public:
+    /**
+     * @brief Defines the room list categories a room can be assigned.
+     */
     enum Types {
-        Invited = 1,
-        Favorite,
-        Direct,
-        Normal,
-        Deprioritized,
-        Space,
+        Invited = 1, /**< The user has been invited to the room. */
+        Favorite, /**< The room is set as a favourite. */
+        Direct, /**< The room is a direct chat. */
+        Normal, /**< The default category for a joined room. */
+        Deprioritized, /**< The room is set as low priority. */
+        Space, /**< The room is a space. */
     };
     Q_ENUM(Types)
 };
 
+/**
+ * @class RoomListModel
+ *
+ * This class defines the model for visualising the user's list of joined rooms.
+ */
 class RoomListModel : public QAbstractListModel
 {
     Q_OBJECT
+
+    /**
+     * @brief The current connection that the model is getting its rooms from.
+     */
     Q_PROPERTY(Quotient::Connection *connection READ connection WRITE setConnection NOTIFY connectionChanged)
+
+    /**
+     * @brief The total number of notifications for all the rooms.
+     */
     Q_PROPERTY(int notificationCount READ notificationCount NOTIFY notificationCountChanged)
 
 public:
+    /**
+     * @brief Defines the model roles.
+     */
     enum EventRoles {
-        NameRole = Qt::UserRole + 1,
-        DisplayNameRole,
-        AvatarRole,
-        CanonicalAliasRole,
-        TopicRole,
-        CategoryRole,
-        UnreadCountRole,
-        NotificationCountRole,
-        HighlightCountRole,
-        LastEventRole,
-        LastActiveTimeRole,
-        JoinStateRole,
-        CurrentRoomRole,
-        CategoryVisibleRole,
-        SubtitleTextRole,
-        AvatarImageRole,
-        IdRole,
-        IsSpaceRole,
+        NameRole = Qt::UserRole + 1, /**< The name of the room. */
+        DisplayNameRole, /**< The display name of the room. */
+        AvatarRole, /**< The source URL for the room's avatar. */
+        CanonicalAliasRole, /**< The room canonical alias. */
+        TopicRole, /**< The room topic. */
+        CategoryRole, /**< The room category, e.g favourite. */
+        UnreadCountRole, /**< The number of unread messages in the room. */
+        NotificationCountRole, /**< The number of notifications in the room. */
+        HighlightCountRole, /**< The number of highlighted messages in the room. */
+        LastEventRole, /**< Text for the last event in the room. */
+        LastActiveTimeRole, /**< The timestamp of the last event sent in the room. */
+        JoinStateRole, /**< The local user's join state in the room. */
+        CurrentRoomRole, /**< The room object for the room. */
+        CategoryVisibleRole, /**< If the room's category is visible. */
+        SubtitleTextRole, /**< The text to show as the room subtitle. */
+        AvatarImageRole, /**< The room avatar as an image. */
+        IdRole, /**< The room matrix ID. */
+        IsSpaceRole, /**< Whether the room is a space. */
     };
     Q_ENUM(EventRoles)
 
     RoomListModel(QObject *parent = nullptr);
     ~RoomListModel() override;
 
-    [[nodiscard]] Quotient::Connection *connection() const
-    {
-        return m_connection;
-    }
+    [[nodiscard]] Quotient::Connection *connection() const;
     void setConnection(Quotient::Connection *connection);
-    void doResetModel();
 
-    Q_INVOKABLE [[nodiscard]] NeoChatRoom *roomAt(int row) const;
+    [[nodiscard]] int notificationCount() const;
 
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     [[nodiscard]] QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
+
+    /**
+     * @brief Number of rows in the model.
+     *
+     * @sa QAbstractItemModel::rowCount
+     */
     Q_INVOKABLE [[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_INVOKABLE [[nodiscard]] static QString categoryName(int section);
-    Q_INVOKABLE [[nodiscard]] static QString categoryIconName(int section);
+    /**
+     * @brief Return the room at the given row.
+     */
+    Q_INVOKABLE [[nodiscard]] NeoChatRoom *roomAt(int row) const;
+
+    /**
+     * @brief Return a string to represent the given room category.
+     */
+    Q_INVOKABLE [[nodiscard]] static QString categoryName(int category);
+
+    /**
+     * @brief Return a string with the name of the given room category icon.
+     */
+    Q_INVOKABLE [[nodiscard]] static QString categoryIconName(int category);
+
+    /**
+     * @brief Set whether a given category should be visible or not.
+     *
+     * @param category the NeoChatRoomType::Types value for the category (it's an
+     *                 int due to the pain of Q_INVOKABLES and cpp enums).
+     * @param visible true if the category should be visible, false if not.
+     */
     Q_INVOKABLE void setCategoryVisible(int category, bool visible);
+
+    /**
+     * @brief Return whether a room category is set to be visible.
+     */
     Q_INVOKABLE [[nodiscard]] bool categoryVisible(int category) const;
-    Q_INVOKABLE [[nodiscard]] int indexForRoom(NeoChatRoom *room) const;
 
-    [[nodiscard]] int notificationCount() const
-    {
-        return m_notificationCount;
-    }
+    /**
+     * @brief Return the model row for the given room.
+     */
+    Q_INVOKABLE [[nodiscard]] int rowForRoom(NeoChatRoom *room) const;
 
+    /**
+     * @brief Return a room for the given room alias or room matrix ID.
+     *
+     * The room must be in the model.
+     */
     Q_INVOKABLE NeoChatRoom *roomByAliasOrId(const QString &aliasOrId);
 
 private Q_SLOTS:
+    void doResetModel();
     void doAddRoom(Quotient::Room *room);
     void updateRoom(Quotient::Room *room, Quotient::Room *prev);
     void deleteRoom(Quotient::Room *room);

src/models/searchmodel.cpp

@@ -43,20 +43,27 @@ void SearchModel::search()
     }
 
     SearchJob::RoomEventsCriteria criteria{
-        m_searchText,
-        {},
-        RoomEventFilter{
-            .rooms = {m_room->id()},
-        },
-        "recent",
-        SearchJob::IncludeEventContext{3, 3, true},
-        false,
-        none,
+        .searchTerm = m_searchText,
+        .keys = {},
+        .filter =
+            RoomEventFilter{
+                .unreadThreadNotifications = none,
+                .lazyLoadMembers = true,
+                .includeRedundantMembers = false,
+                .notRooms = {},
+                .rooms = {m_room->id()},
+                .containsUrl = false,
+            },
+        .orderBy = "recent",
+        .eventContext = SearchJob::IncludeEventContext{3, 3, true},
+        .includeState = false,
+        .groupings = none,
+
     };
 
     auto job = m_connection->callApi<SearchJob>(SearchJob::Categories{criteria});
     m_job = job;
-    connect(job, &BaseJob::finished, this, [=] {
+    connect(job, &BaseJob::finished, this, [this, job] {
         beginResetModel();
         m_result = job->searchCategories().roomEvents;
         endResetModel();
@@ -116,6 +123,7 @@ QVariant SearchModel::data(const QModelIndex &index, int role) const
 
 int SearchModel::rowCount(const QModelIndex &parent) const
 {
+    Q_UNUSED(parent);
 #ifdef QUOTIENT_07
     if (m_result.has_value()) {
         return m_result->results.size();
@@ -127,7 +135,7 @@ int SearchModel::rowCount(const QModelIndex &parent) const
 QHash<int, QByteArray> SearchModel::roleNames() const
 {
     return {
-        {EventTypeRole, "eventType"},
+        {DelegateTypeRole, "delegateType"},
         {DisplayRole, "display"},
         {AuthorRole, "author"},
         {ShowSectionRole, "showSection"},

src/models/searchmodel.h

@@ -17,24 +17,50 @@ class Connection;
 
 class NeoChatRoom;
 
+/**
+ * @class SearchModel
+ *
+ * This class defines the model for visualising the results of a room message search.
+ */
 class SearchModel : public QAbstractListModel
 {
     Q_OBJECT
 
+    /**
+     * @brief The text to search messages for.
+     */
     Q_PROPERTY(QString searchText READ searchText WRITE setSearchText NOTIFY searchTextChanged)
+
+    /**
+     * @brief The current connection that the model is using to search for messages.
+     */
     Q_PROPERTY(Quotient::Connection *connection READ connection WRITE setConnection NOTIFY connectionChanged)
+
+    /**
+     * @brief The current room that the search is being done from.
+     */
     Q_PROPERTY(NeoChatRoom *room READ room WRITE setRoom NOTIFY roomChanged)
+
+    /**
+     * @brief Whether the model is currently searching for messages.
+     */
     Q_PROPERTY(bool searching READ searching NOTIFY searchingChanged)
 
 public:
+    /**
+     * @brief Defines the model roles.
+     *
+     * Some of the roles exist only for compatibility with the MessageEventModel,
+     * since the same delegates are used.
+     */
     enum Roles {
-        DisplayRole = Qt::DisplayRole,
-        EventTypeRole,
-        ShowAuthorRole,
-        AuthorRole,
-        ShowSectionRole,
-        SectionRole,
-        TimeRole,
+        DisplayRole = Qt::DisplayRole, /**< The message string. */
+        DelegateTypeRole, /**< The type of the event. */
+        ShowAuthorRole, /**< Whether the author should be shown (always true). */
+        AuthorRole, /**< The author of the event. */
+        ShowSectionRole, /**< Whether the section header should be shown. */
+        SectionRole, /**< The date of the event as a string. */
+        TimeRole, /**< The timestamp for when the event was sent. */
     };
     Q_ENUM(Roles);
     SearchModel(QObject *parent = nullptr);
@@ -48,13 +74,33 @@ public:
     NeoChatRoom *room() const;
     void setRoom(NeoChatRoom *room);
 
-    Q_INVOKABLE void search();
+    bool searching() const;
 
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
+
+    /**
+     * @brief Number of rows in the model.
+     *
+     * @sa QAbstractItemModel::rowCount
+     */
     int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+
+    /**
+     * @brief Returns a mapping from Role enum values to role names.
+     *
+     * @sa Roles, QAbstractItemModel::roleNames()
+     */
     QHash<int, QByteArray> roleNames() const override;
 
-    bool searching() const;
+    /**
+     * @brief Start searching for messages.
+     */
+    Q_INVOKABLE void search();
 
 Q_SIGNALS:
     void searchTextChanged();

src/models/serverlistmodel.h

@@ -9,33 +9,89 @@
 #include <QPointer>
 #include <QUrl>
 
+/**
+ * @class ServerListModel
+ *
+ * This class defines the model for visualising a list of matrix servers.
+ *
+ * The list of servers is retrieved from the local cache. Any additions are also
+ * stored locally so that they are retrieved on subsequent instantiations.
+ *
+ * The model also automatically adds the local user's home server and matrix.org to
+ * the model. Finally the model also adds an entry to create a space in the model
+ * for an "add new server" delegate.
+ */
 class ServerListModel : public QAbstractListModel
 {
     Q_OBJECT
 
 public:
+    /**
+     * @brief Define the data required to represent a server.
+     */
     struct Server {
-        QString url;
-        bool isHomeServer;
-        bool isAddServerDelegate;
-        bool isDeletable;
+        QString url; /**< Server URL. */
+        bool isHomeServer; /**< Whether the server is the local user's home server. */
+        bool isAddServerDelegate; /**< Wether the item is the "add new server" delegate. */
+        bool isDeletable; /**< Whether the item can be deleted from the model. */
     };
+
+    /**
+     * @brief Defines the model roles.
+     */
     enum EventRoles {
-        UrlRole = Qt::UserRole + 1,
-        IsHomeServerRole,
-        IsAddServerDelegateRole,
-        IsDeletableRole,
+        UrlRole = Qt::UserRole + 1, /**< Server URL. */
+        IsHomeServerRole, /**< Whether the server is the local user's home server. */
+        IsAddServerDelegateRole, /**< Whether the item is the add new server delegate. */
+        IsDeletableRole, /**< Whether the item can be deleted from the model. */
     };
 
     ServerListModel(QObject *parent = nullptr);
 
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
     [[nodiscard]] QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) 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;
 
+    /**
+     * @brief Start a check to see if the given URL is a valid matrix server.
+     *
+     * This function starts the check but due to the requests being asynchronous
+     * the caller will need to watch the serverCheckComplete signal for confirmation.
+     * The server URL should be treated as invalid until the signal is emitted true.
+     *
+     * @sa serverCheckComplete()
+     */
     Q_INVOKABLE void checkServer(const QString &url);
+
+    /**
+     * @brief Add a new server to the model.
+     *
+     * The server will also be stored in local cache.
+     */
     Q_INVOKABLE void addServer(const QString &url);
+
+    /**
+     * @brief Remove the server at the given index.
+     *
+     * The server will also be removed from local cache.
+     */
     Q_INVOKABLE void removeServerAtIndex(int index);
 
 Q_SIGNALS:

src/models/statemodel.cpp

@@ -49,7 +49,7 @@ void StateModel::setRoom(NeoChatRoom *room)
     Q_EMIT roomChanged();
     beginResetModel();
     endResetModel();
-    connect(room, &NeoChatRoom::changed, this, [=] {
+    connect(room, &NeoChatRoom::changed, this, [this] {
         beginResetModel();
         endResetModel();
     });

src/models/userlistmodel.cpp

@@ -217,6 +217,9 @@ int UserListModel::findUserPos(Quotient::User *user) const
 
 int UserListModel::findUserPos(const QString &username) const
 {
+    if (!m_currentRoom) {
+        return 0;
+    }
     return m_currentRoom->memberSorter().lowerBoundIndex(m_users, username);
 }
 

src/neochatroom.cpp

@@ -8,7 +8,6 @@
 #include <QMimeDatabase>
 #include <QTemporaryFile>
 #include <QTextDocument>
-#include <functional>
 
 #include <QMediaMetaData>
 #include <QMediaPlayer>
@@ -110,6 +109,34 @@ NeoChatRoom::NeoChatRoom(Connection *connection, QString roomId, JoinState joinS
     });
 }
 
+bool NeoChatRoom::hasFileUploading() const
+{
+    return m_hasFileUploading;
+}
+
+void NeoChatRoom::setHasFileUploading(bool value)
+{
+    if (value == m_hasFileUploading) {
+        return;
+    }
+    m_hasFileUploading = value;
+    Q_EMIT hasFileUploadingChanged();
+}
+
+int NeoChatRoom::fileUploadingProgress() const
+{
+    return m_fileUploadingProgress;
+}
+
+void NeoChatRoom::setFileUploadingProgress(int value)
+{
+    if (m_fileUploadingProgress == value) {
+        return;
+    }
+    m_fileUploadingProgress = value;
+    Q_EMIT fileUploadingProgressChanged();
+}
+
 void NeoChatRoom::uploadFile(const QUrl &url, const QString &body)
 {
     doUploadFile(url, body);
@@ -227,17 +254,16 @@ const RoomEvent *NeoChatRoom::lastEvent() const
             continue;
         }
 
-        if (event->isStateEvent() && !NeoChatConfig::self()->showStateEvent()) {
+        if (event->isStateEvent() && !NeoChatConfig::showStateEvent()) {
             continue;
         }
 
         if (auto roomMemberEvent = eventCast<const RoomMemberEvent>(event)) {
-            if ((roomMemberEvent->isJoin() || roomMemberEvent->isLeave()) && !NeoChatConfig::self()->showLeaveJoinEvent()) {
+            if ((roomMemberEvent->isJoin() || roomMemberEvent->isLeave()) && !NeoChatConfig::showLeaveJoinEvent()) {
                 continue;
-            } else if (roomMemberEvent->isRename() && !roomMemberEvent->isJoin() && !roomMemberEvent->isLeave() && !NeoChatConfig::self()->showRename()) {
+            } else if (roomMemberEvent->isRename() && !roomMemberEvent->isJoin() && !roomMemberEvent->isLeave() && !NeoChatConfig::showRename()) {
                 continue;
-            } else if (roomMemberEvent->isAvatarUpdate() && !roomMemberEvent->isJoin() && !roomMemberEvent->isLeave()
-                       && !NeoChatConfig::self()->showAvatarUpdate()) {
+            } else if (roomMemberEvent->isAvatarUpdate() && !roomMemberEvent->isJoin() && !roomMemberEvent->isLeave() && !NeoChatConfig::showAvatarUpdate()) {
                 continue;
             }
         }
@@ -294,7 +320,7 @@ QString NeoChatRoom::lastEventToString(Qt::TextFormat format, bool stripNewlines
         return roomMembername(event->senderId()) + (event->isStateEvent() ? QLatin1String(" ") : QLatin1String(": "))
             + eventToString(*event, format, stripNewlines);
     }
-    return QLatin1String("");
+    return {};
 }
 
 bool NeoChatRoom::isEventHighlighted(const RoomEvent *e) const
@@ -361,30 +387,6 @@ QDateTime NeoChatRoom::lastActiveTime()
     return messageEvents().rbegin()->get()->originTimestamp();
 }
 
-int NeoChatRoom::savedTopVisibleIndex() const
-{
-    return firstDisplayedMarker() == historyEdge() ? 0 : int(firstDisplayedMarker() - messageEvents().rbegin());
-}
-
-int NeoChatRoom::savedBottomVisibleIndex() const
-{
-    return lastDisplayedMarker() == historyEdge() ? 0 : int(lastDisplayedMarker() - messageEvents().rbegin());
-}
-
-void NeoChatRoom::saveViewport(int topIndex, int bottomIndex)
-{
-    if (topIndex == -1 || bottomIndex == -1 || (bottomIndex == savedBottomVisibleIndex() && (bottomIndex == 0 || topIndex == savedTopVisibleIndex()))) {
-        return;
-    }
-    if (bottomIndex == 0) {
-        setFirstDisplayedEventId({});
-        setLastDisplayedEventId({});
-        return;
-    }
-    setFirstDisplayedEvent(maxTimelineIndex() - topIndex);
-    setLastDisplayedEvent(maxTimelineIndex() - bottomIndex);
-}
-
 QVariantList NeoChatRoom::getUsers(const QString &keyword, int limit) const
 {
     const auto userList = users();
@@ -418,15 +420,6 @@ QVariantMap NeoChatRoom::getUser(const QString &userID) const
                        {QStringLiteral("color"), user.color()}};
 }
 
-QUrl NeoChatRoom::urlToMxcUrl(const QUrl &mxcUrl)
-{
-#ifdef QUOTIENT_07
-    return connection()->makeMediaUrl(mxcUrl);
-#else
-    return DownloadFileJob::makeRequestUrl(connection()->homeserver(), mxcUrl);
-#endif
-}
-
 QString NeoChatRoom::avatarMediaId() const
 {
     if (const auto avatar = Room::avatarMediaId(); !avatar.isEmpty()) {
@@ -468,7 +461,7 @@ QString NeoChatRoom::eventToString(const RoomEvent &evt, Qt::TextFormat format,
                     fileCaption = e.plainBody() + " | " + fileCaption;
                 }
                 textHandler.setData(fileCaption);
-                return !fileCaption.isEmpty() ? textHandler.handleRecievePlainText() : i18n("a file");
+                return !fileCaption.isEmpty() ? textHandler.handleRecievePlainText(Qt::PlainText, stripNewlines) : i18n("a file");
             }
 
             QString body;
@@ -604,8 +597,12 @@ QString NeoChatRoom::eventToString(const RoomEvent &evt, Qt::TextFormat format,
         [](const RoomNameEvent &e) {
             return (e.name().isEmpty()) ? i18n("cleared the room name") : i18n("set the room name to: %1", e.name().toHtmlEscaped());
         },
-        [prettyPrint](const RoomTopicEvent &e) {
-            return (e.topic().isEmpty()) ? i18n("cleared the topic") : i18n("set the topic to: %1", prettyPrint ? Quotient::prettyPrint(e.topic()) : e.topic());
+        [prettyPrint, stripNewlines](const RoomTopicEvent &e) {
+            return (e.topic().isEmpty()) ? i18n("cleared the topic")
+                                         : i18n("set the topic to: %1",
+                                                prettyPrint         ? Quotient::prettyPrint(e.topic())
+                                                    : stripNewlines ? e.topic().replace(u'\n', u' ')
+                                                                    : e.topic());
         },
         [](const RoomAvatarEvent &) {
             return i18n("changed the room avatar");
@@ -767,6 +764,7 @@ QString NeoChatRoom::eventToGenericString(const RoomEvent &evt) const
         },
 #ifdef QUOTIENT_07
         [](const PollStartEvent &e) {
+            Q_UNUSED(e);
             return i18n("started a poll");
         },
 #endif
@@ -791,30 +789,6 @@ void NeoChatRoom::changeAvatar(const QUrl &localFile)
     }
 }
 
-void NeoChatRoom::addLocalAlias(const QString &alias)
-{
-    auto a = aliases();
-    if (a.contains(alias)) {
-        return;
-    }
-
-    a += alias;
-
-    setLocalAliases(a);
-}
-
-void NeoChatRoom::removeLocalAlias(const QString &alias)
-{
-    auto a = aliases();
-    if (!a.contains(alias)) {
-        return;
-    }
-
-    a.removeAll(alias);
-
-    setLocalAliases(a);
-}
-
 QString msgTypeToString(MessageEventType msgType)
 {
     switch (msgType) {
@@ -1001,11 +975,6 @@ bool NeoChatRoom::isUserBanned(const QString &user) const
     return getCurrentState<RoomMemberEvent>(user)->membership() == MembershipType::Ban;
 }
 
-QString NeoChatRoom::htmlSafeName() const
-{
-    return name().toHtmlEscaped();
-}
-
 QString NeoChatRoom::htmlSafeDisplayName() const
 {
     return displayName().toHtmlEscaped();
@@ -1488,6 +1457,11 @@ bool NeoChatRoom::isSpace()
 #endif
 }
 
+PushNotificationState::State NeoChatRoom::pushNotificationState() const
+{
+    return m_currentPushNotificationState;
+}
+
 void NeoChatRoom::setPushNotificationState(PushNotificationState::State state)
 {
     // The caller should never try to set the state to unknown.
@@ -1910,3 +1884,27 @@ NeoChatUser *NeoChatRoom::directChatRemoteUser() const
 {
     return dynamic_cast<NeoChatUser *>(connection()->directChatUsers(this)[0]);
 }
+
+void NeoChatRoom::sendLocation(float lat, float lon, const QString &description)
+{
+    QJsonObject locationContent{
+        {"uri", "geo:%1,%2"_ls.arg(QString::number(lat), QString::number(lon))},
+    };
+
+    if (!description.isEmpty()) {
+        locationContent["description"] = description;
+    }
+
+    QJsonObject content{
+        {"body", i18nc("'Lat' and 'Lon' as in Latitude and Longitude", "Lat: %1, Lon: %2", lat, lon)},
+        {"msgtype", "m.location"},
+        {"geo_uri", "geo:%1,%2"_ls.arg(QString::number(lat), QString::number(lon))},
+        {"org.matrix.msc3488.location", locationContent},
+        {"org.matrix.msc3488.asset",
+         QJsonObject{
+             {"type", "m.pin"},
+         }},
+        {"org.matrix.msc1767.text", i18nc("'Lat' and 'Lon' as in Latitude and Longitude", "Lat: %1, Lon: %2", lat, lon)},
+    };
+    postJson("m.room.message", content);
+}

src/neochatroom.h

@@ -3,14 +3,13 @@
 
 #pragma once
 
-#include <qobjectdefs.h>
 #include <room.h>
 
 #include <QCache>
 #include <QObject>
 #include <QTextCursor>
 
-#include <qcoro/task.h>
+#include <QCoroTask>
 
 #include "neochatuser.h"
 #include "pollhandler.h"
@@ -20,36 +19,150 @@ class PushNotificationState : public QObject
     Q_OBJECT
 
 public:
+    /**
+     * @brief Describes the push notification state for the room.
+     */
     enum State {
-        Unknown,
-        Default,
-        Mute,
-        MentionKeyword,
-        All,
+        Unknown, /**< The state has not yet been obtained from the server. */
+        Default, /**< The room follows the globally configured rules for the local user. */
+        Mute, /**< No notifications for messages in the room. */
+        MentionKeyword, /**< Notifications only for local user mentions and keywords. */
+        All, /**< Notifications for all messages. */
     };
     Q_ENUM(State);
 };
 
+/**
+ * @brief Defines a user mention in the current chat or edit text.
+ */
 struct Mention {
-    QTextCursor cursor;
-    QString text;
-    int start = 0;
-    int position = 0;
-    QString id;
+    QTextCursor cursor; /**< Contains the mention's text and position in the text.  */
+    QString text; /**< The inserted text of the mention. */
+    int start = 0; /**< Start position of the mention. */
+    int position = 0; /**< End position of the mention. */
+    QString id; /**< The id the mention (used to create link when sending the message). */
 };
 
+/**
+ * @class NeoChatRoom
+ *
+ * This class is designed to act as a wrapper over Quotient::Room to provide API and
+ * functionality not available in Quotient::Room.
+ *
+ * The functions fall into two main categories:
+ *  - Helper functions to make functionality easily accessible in QML.
+ *  - Implement functions not yet available in Quotient::Room.
+ *
+ * @sa Quotient::Room
+ */
 class NeoChatRoom : public Quotient::Room
 {
     Q_OBJECT
+
+    /**
+     * @brief A list of users currently typing in the room.
+     *
+     * The list does not include the local user.
+     *
+     * This is different to getting a list of NeoChatUser objects or Quotient::User objects
+     * as neither of those can provide details like the displayName or avatarMediaId
+     * without the room context as these can vary from room to room. This function
+     * provides the room context and puts the result as a list of QVariantMap objects.
+     *
+     * @return a QVariantMap for the user with the following
+     * parameters:
+     *  - id - User ID.
+     *  - avatarMediaId - Avatar id in the context of this room.
+     *  - displayName - Display name in the context of this room.
+     *  - display - Name in the context of this room.
+     *
+     * @sa Quotient::User, NeoChatUser
+     */
     Q_PROPERTY(QVariantList usersTyping READ getUsersTyping NOTIFY typingChanged)
-    Q_PROPERTY(bool hasFileUploading READ hasFileUploading WRITE setHasFileUploading NOTIFY hasFileUploadingChanged)
-    Q_PROPERTY(int fileUploadingProgress READ fileUploadingProgress NOTIFY fileUploadingProgressChanged)
-    Q_PROPERTY(QString avatarMediaId READ avatarMediaId NOTIFY avatarChanged STORED false)
-    Q_PROPERTY(bool readMarkerLoaded READ readMarkerLoaded NOTIFY readMarkerLoadedChanged)
+
+    /**
+     * @brief Convenience function to get the QDateTime of the last event.
+     *
+     * @sa lastEvent()
+     */
     Q_PROPERTY(QDateTime lastActiveTime READ lastActiveTime NOTIFY lastActiveTimeChanged)
+
+    /**
+     * @brief Whether a file is being uploaded to the server.
+     */
+    Q_PROPERTY(bool hasFileUploading READ hasFileUploading WRITE setHasFileUploading NOTIFY hasFileUploadingChanged)
+
+    /**
+     * @brief Progress of a file upload as a percentage 0 - 100%.
+     *
+     * The value will be 0 if no file is uploading.
+     *
+     * @sa hasFileUploading
+     */
+    Q_PROPERTY(int fileUploadingProgress READ fileUploadingProgress NOTIFY fileUploadingProgressChanged)
+
+    /**
+     * @brief Whether the read marker should be shown.
+     */
+    Q_PROPERTY(bool readMarkerLoaded READ readMarkerLoaded NOTIFY readMarkerLoadedChanged)
+
+    /**
+     * @brief Display name with any html special characters escaped.
+     */
+    Q_PROPERTY(QString htmlSafeDisplayName READ htmlSafeDisplayName NOTIFY displayNameChanged)
+
+    /**
+     * @brief The avatar image to be used for the room.
+     */
+    Q_PROPERTY(QString avatarMediaId READ avatarMediaId NOTIFY avatarChanged STORED false)
+
+    /**
+     * @brief Get a user object for the other person in a direct chat.
+     */
+    Q_PROPERTY(NeoChatUser *directChatRemoteUser READ directChatRemoteUser CONSTANT)
+
+    /**
+     * @brief If the room is a space.
+     */
     Q_PROPERTY(bool isSpace READ isSpace CONSTANT)
+
+    /**
+     * @brief Whether the local user has an invite to the room.
+     *
+     * False for any other state including if the local user is a member.
+     */
     Q_PROPERTY(bool isInvite READ isInvite NOTIFY isInviteChanged)
+
+    /**
+     * @brief The current join rule for the room as a QString.
+     *
+     * Possible values are [public, knock, invite, private, restricted].
+     *
+     * @sa https://spec.matrix.org/v1.5/client-server-api/#mroomjoin_rules
+     */
     Q_PROPERTY(QString joinRule READ joinRule WRITE setJoinRule NOTIFY joinRuleChanged)
+
+    /**
+     * @brief Get the maximum room version that the server supports.
+     *
+     * Only returns main integer room versions (i.e. no msc room versions).
+     */
+    Q_PROPERTY(int maxRoomVersion READ maxRoomVersion NOTIFY maxRoomVersionChanged)
+
+    /**
+     * @brief The rule for which messages should generate notifications for the room.
+     *
+     * @sa PushNotificationState::State
+     */
+    Q_PROPERTY(PushNotificationState::State pushNotificationState READ pushNotificationState WRITE setPushNotificationState NOTIFY pushNotificationStateChanged)
+
+    /**
+     * @brief The current history visibilty setting for the room.
+     *
+     * Possible values are [invited, joined, shared, world_readable].
+     *
+     * @sa https://spec.matrix.org/v1.5/client-server-api/#room-history-visibility
+     */
     Q_PROPERTY(QString historyVisibility READ historyVisibility WRITE setHistoryVisibility NOTIFY historyVisibilityChanged)
 
     /**
@@ -65,98 +178,441 @@ class NeoChatRoom : public Quotient::Room
      */
     Q_PROPERTY(bool urlPreviewEnabled READ urlPreviewEnabled WRITE setUrlPreviewEnabled NOTIFY urlPreviewEnabledChanged)
 
-    // Properties for the various permission levels for the room
+    /**
+     * @brief Whether the local user can encrypt the room.
+     *
+     * Requires libQuotient 0.7 compiled with the Quotient_E2EE_ENABLED parameter to
+     * be able to return true.
+     *
+     * A local user can encrypt a room if they have permission to send the m.room.encryption
+     * state event.
+     *
+     * @sa https://spec.matrix.org/v1.5/client-server-api/#mroomencryption
+     */
+    Q_PROPERTY(bool canEncryptRoom READ canEncryptRoom NOTIFY canEncryptRoomChanged)
+
+    /**
+     * @brief The default power level in the room for new users.
+     */
     Q_PROPERTY(int defaultUserPowerLevel READ defaultUserPowerLevel WRITE setDefaultUserPowerLevel NOTIFY defaultUserPowerLevelChanged)
+
+    /**
+     * @brief The power level required to invite users to the room.
+     */
     Q_PROPERTY(int invitePowerLevel READ invitePowerLevel WRITE setInvitePowerLevel NOTIFY invitePowerLevelChanged)
+
+    /**
+     * @brief The power level required to kick users from the room.
+     */
     Q_PROPERTY(int kickPowerLevel READ kickPowerLevel WRITE setKickPowerLevel NOTIFY kickPowerLevelChanged)
+
+    /**
+     * @brief The power level required to ban users from the room.
+     */
     Q_PROPERTY(int banPowerLevel READ banPowerLevel WRITE setBanPowerLevel NOTIFY banPowerLevelChanged)
+
+    /**
+     * @brief The power level required to delete other user messages.
+     */
     Q_PROPERTY(int redactPowerLevel READ redactPowerLevel WRITE setRedactPowerLevel NOTIFY redactPowerLevelChanged)
+
+    /**
+     * @brief The default power level for state events that are not explicitly specified.
+     */
     Q_PROPERTY(int statePowerLevel READ statePowerLevel WRITE setStatePowerLevel NOTIFY statePowerLevelChanged)
+
+    /**
+     * @brief The default power level for event that are not explicitly specified.
+     */
     Q_PROPERTY(int defaultEventPowerLevel READ defaultEventPowerLevel WRITE setDefaultEventPowerLevel NOTIFY defaultEventPowerLevelChanged)
+
+    /**
+     * @brief The power level required to change power levels for the room.
+     */
     Q_PROPERTY(int powerLevelPowerLevel READ powerLevelPowerLevel WRITE setPowerLevelPowerLevel NOTIFY powerLevelPowerLevelChanged)
+
+    /**
+     * @brief The power level required to change the room name.
+     */
     Q_PROPERTY(int namePowerLevel READ namePowerLevel WRITE setNamePowerLevel NOTIFY namePowerLevelChanged)
+
+    /**
+     * @brief The power level required to change the room avatar.
+     */
     Q_PROPERTY(int avatarPowerLevel READ avatarPowerLevel WRITE setAvatarPowerLevel NOTIFY avatarPowerLevelChanged)
+
+    /**
+     * @brief The power level required to change the room aliases.
+     */
     Q_PROPERTY(int canonicalAliasPowerLevel READ canonicalAliasPowerLevel WRITE setCanonicalAliasPowerLevel NOTIFY canonicalAliasPowerLevelChanged)
+
+    /**
+     * @brief The power level required to change the room topic.
+     */
     Q_PROPERTY(int topicPowerLevel READ topicPowerLevel WRITE setTopicPowerLevel NOTIFY topicPowerLevelChanged)
+
+    /**
+     * @brief The power level required to encrypt the room.
+     */
     Q_PROPERTY(int encryptionPowerLevel READ encryptionPowerLevel WRITE setEncryptionPowerLevel NOTIFY encryptionPowerLevelChanged)
+
+    /**
+     * @brief The power level required to change the room history visibility.
+     */
     Q_PROPERTY(int historyVisibilityPowerLevel READ historyVisibilityPowerLevel WRITE setHistoryVisibilityPowerLevel NOTIFY historyVisibilityPowerLevelChanged)
+
+    /**
+     * @brief The power level required to pin events in the room.
+     */
     Q_PROPERTY(int pinnedEventsPowerLevel READ pinnedEventsPowerLevel WRITE setPinnedEventsPowerLevel NOTIFY pinnedEventsPowerLevelChanged)
+
+    /**
+     * @brief The power level required to upgrade the room.
+     */
     Q_PROPERTY(int tombstonePowerLevel READ tombstonePowerLevel WRITE setTombstonePowerLevel NOTIFY tombstonePowerLevelChanged)
+
+    /**
+     * @brief The power level required to set the room server access control list (ACL).
+     */
     Q_PROPERTY(int serverAclPowerLevel READ serverAclPowerLevel WRITE setServerAclPowerLevel NOTIFY serverAclPowerLevelChanged)
+
+    /**
+     * @brief The power level required to add children to a space.
+     */
     Q_PROPERTY(int spaceChildPowerLevel READ spaceChildPowerLevel WRITE setSpaceChildPowerLevel NOTIFY spaceChildPowerLevelChanged)
+
+    /**
+     * @brief The power level required to set the room parent space.
+     */
     Q_PROPERTY(int spaceParentPowerLevel READ spaceParentPowerLevel WRITE setSpaceParentPowerLevel NOTIFY spaceParentPowerLevelChanged)
 
-    Q_PROPERTY(QString htmlSafeDisplayName READ htmlSafeDisplayName NOTIFY displayNameChanged)
-    Q_PROPERTY(PushNotificationState::State pushNotificationState MEMBER m_currentPushNotificationState WRITE setPushNotificationState NOTIFY
-                   pushNotificationStateChanged)
-
-    // Due to problems with QTextDocument, unlike the other properties here, chatBoxText is *not* used to store the text when switching rooms
+    /**
+     * @brief The current text in the chatbox for the room.
+     *
+     * Due to problems with QTextDocument, unlike the other properties here,
+     * chatBoxText is *not* used to store the text when switching rooms.
+     */
     Q_PROPERTY(QString chatBoxText READ chatBoxText WRITE setChatBoxText NOTIFY chatBoxTextChanged)
 
     /**
      * @brief The text for any message currently being edited in the room.
      */
     Q_PROPERTY(QString editText READ editText WRITE setEditText NOTIFY editTextChanged)
-    Q_PROPERTY(QString chatBoxReplyId READ chatBoxReplyId WRITE setChatBoxReplyId NOTIFY chatBoxReplyIdChanged)
-    Q_PROPERTY(QString chatBoxEditId READ chatBoxEditId WRITE setChatBoxEditId NOTIFY chatBoxEditIdChanged)
-    Q_PROPERTY(NeoChatUser *chatBoxReplyUser READ chatBoxReplyUser NOTIFY chatBoxReplyIdChanged)
-    Q_PROPERTY(QString chatBoxReplyMessage READ chatBoxReplyMessage NOTIFY chatBoxReplyIdChanged)
-    Q_PROPERTY(NeoChatUser *chatBoxEditUser READ chatBoxEditUser NOTIFY chatBoxEditIdChanged)
-    Q_PROPERTY(QString chatBoxEditMessage READ chatBoxEditMessage NOTIFY chatBoxEditIdChanged)
-    Q_PROPERTY(QString chatBoxAttachmentPath READ chatBoxAttachmentPath WRITE setChatBoxAttachmentPath NOTIFY chatBoxAttachmentPathChanged)
-    Q_PROPERTY(bool canEncryptRoom READ canEncryptRoom NOTIFY canEncryptRoomChanged)
 
     /**
-     * @brief Get the maximum room version that the server supports.
+     * @brief The event id of a message being replied to.
      *
-     * Only returns main integer room versions (i.e. no msc room versions).
+     * Will be QString() if not replying to a message.
      */
-    Q_PROPERTY(int maxRoomVersion READ maxRoomVersion NOTIFY maxRoomVersionChanged)
-    Q_PROPERTY(NeoChatUser *directChatRemoteUser READ directChatRemoteUser CONSTANT)
+    Q_PROPERTY(QString chatBoxReplyId READ chatBoxReplyId WRITE setChatBoxReplyId NOTIFY chatBoxReplyIdChanged)
+
+    /**
+     * @brief The event id of a message being edited.
+     *
+     * Will be QString() if not editing to a message.
+     */
+    Q_PROPERTY(QString chatBoxEditId READ chatBoxEditId WRITE setChatBoxEditId NOTIFY chatBoxEditIdChanged)
+
+    /**
+     * @brief Get the user object for the message being replied to.
+     *
+     * Returns a nullptr if not replying to a message.
+     */
+    Q_PROPERTY(NeoChatUser *chatBoxReplyUser READ chatBoxReplyUser NOTIFY chatBoxReplyIdChanged)
+
+    /**
+     * @brief The content of the message being replied to.
+     *
+     * Will be QString() if not replying to a message.
+     */
+    Q_PROPERTY(QString chatBoxReplyMessage READ chatBoxReplyMessage NOTIFY chatBoxReplyIdChanged)
+
+    /**
+     * @brief Get the user object for the message being edited.
+     *
+     * Returns a nullptr if not editing a message.
+     */
+    Q_PROPERTY(NeoChatUser *chatBoxEditUser READ chatBoxEditUser NOTIFY chatBoxEditIdChanged)
+
+    /**
+     * @brief The content of the message being edited.
+     *
+     * Will be QString() if not editing a message.
+     */
+    Q_PROPERTY(QString chatBoxEditMessage READ chatBoxEditMessage NOTIFY chatBoxEditIdChanged)
+
+    /**
+     * @brief The file path of the attachment to be sent.
+     */
+    Q_PROPERTY(QString chatBoxAttachmentPath READ chatBoxAttachmentPath WRITE setChatBoxAttachmentPath NOTIFY chatBoxAttachmentPathChanged)
 
 public:
+    /**
+     * @brief Define the types on inline messages that can be shown.
+     */
     enum MessageType {
-        Positive,
-        Info,
-        Error,
+        Positive, /**< Positive message, typically green. */
+        Info, /**< Info message, typically highlight color. */
+        Error, /**< Error message, typically red. */
     };
     Q_ENUM(MessageType);
 
     explicit NeoChatRoom(Quotient::Connection *connection, QString roomId, Quotient::JoinState joinState = {});
 
+    /**
+     * @brief Get a list of users in the context of this room.
+     *
+     * This is different to getting a list of NeoChatUser objects or Quotient::User objects
+     * as neither of those can provide details like the displayName or avatarMediaId
+     * without the room context as these can vary from room to room. This function
+     * provides the room context and returns the result as a list of QVariantMap objects.
+     *
+     * @param keyword filters the users based on the displayname containing keyword.
+     * @param limit max number of user returned, -1 is infinite.
+     *
+     * @return a QVariantList containing a QVariantMap for each user with the following
+     * properties:
+     *  - id - User ID.
+     *  - displayName - Display name in the context of this room.
+     *  - avatarMediaId - Avatar id in the context of this room.
+     *  - color - Color for the user.
+     *
+     * @sa Quotient::User, NeoChatUser
+     */
+    Q_INVOKABLE [[nodiscard]] QVariantList getUsers(const QString &keyword, int limit = -1) const;
+
+    /**
+     * @brief Get a user in the context of this room.
+     *
+     * This is different to getting a NeoChatUser object or Quotient::User object
+     * as neither of those can provide details like the displayName or avatarMediaId
+     * without the room context as these can vary from room to room. This function
+     * provides the room context and outputs the result as QVariantMap.
+     *
+     * @param userID the ID of the user to output.
+     *
+     * @return a QVariantMap for the user with the following properties:
+     *  - id - User ID.
+     *  - displayName - Display name in the context of this room.
+     *  - avatarMediaId - Avatar id in the context of this room.
+     *  - color - Color for the user.
+     *
+     * @sa Quotient::User, NeoChatUser
+     */
+    Q_INVOKABLE [[nodiscard]] QVariantMap getUser(const QString &userID) const;
+
     [[nodiscard]] QVariantList getUsersTyping() const;
 
-    /// Get the interesting last event.
-    ///
-    /// This function respect the showLeaveJoinEvent setting and discard
-    /// other not interesting events. This function can return an empty pointer
-    /// when the room is empty of RoomMessageEvent.
+    [[nodiscard]] QDateTime lastActiveTime();
+
+    /**
+     * @brief Get the last interesting event.
+     *
+     * This function respects the user's state event setting and discards
+     * other not interesting events.
+     *
+     * @warning This function can return an empty pointer if the room does not have
+     *          any RoomMessageEvents loaded.
+     */
     [[nodiscard]] const Quotient::RoomEvent *lastEvent() const;
 
-    /// Convenient way to get the last event but in a string format.
-    ///
-    /// \see lastEvent
-    /// \see lastEventIsSpoiler
+    /**
+     * @brief Output a string for the message content ready for display.
+     *
+     * The output string is dependant upon the event type and the desired output format.
+     *
+     * For most messages this is the body content of the message. For media messages
+     * This will be the caption and for state events it will be a string specific
+     * to that event with some dynamic details about the event added.
+     *
+     * E.g. For a room topic state event the text will be:
+     *      "set the topic to: <new topic text>"
+     *
+     * @param evt the event for which a string is desired.
+     * @param format the output format, usually Qt::PlainText or Qt::RichText.
+     * @param stripNewlines whether the output should have new lines in it.
+     */
+    [[nodiscard]] QString eventToString(const Quotient::RoomEvent &evt, Qt::TextFormat format = Qt::PlainText, bool stripNewlines = false) const;
+
+    /**
+     * @brief Output a generic string for the message content ready for display.
+     *
+     * The output string is dependant upon the event type.
+     *
+     * Unlike NeoChatRoom::eventToString the string is the same for all events of
+     * the same type
+     *
+     * E.g. For a message the text will be:
+     *      "sent a message"
+     *
+     * @sa eventToString()
+     */
+    [[nodiscard]] QString eventToGenericString(const Quotient::RoomEvent &evt) const;
+
+    /**
+     * @brief Convenient way to call eventToString on the last event.
+     *
+     * @sa lastEvent()
+     * @sa eventToString()
+     */
     [[nodiscard]] QString lastEventToString(Qt::TextFormat format = Qt::PlainText, bool stripNewlines = false) const;
 
-    /// Convenient way to check if the last event looks like it has spoilers.
-    ///
-    /// \see lastEvent
-    /// \see lastEventToString
+    /**
+     * @brief Convenient way to check if the last event looks like it has spoilers.
+     *
+     * This does a basic check to see if the message contains a data-mx-spoiler
+     * attribute within the text which makes it likely that the message has a spoiler
+     * section. However this is not 100% reliable as during parsing it may be
+     * removed if used within an illegal tag or on a tag for which data-mx-spoiler
+     * is not a valid attribute.
+     *
+     * @sa lastEvent()
+     */
     [[nodiscard]] bool lastEventIsSpoiler() const;
 
-    /// Convenient way to get the QDateTime of the last event.
-    ///
-    /// \see lastEvent
-    [[nodiscard]] QDateTime lastActiveTime();
+    [[nodiscard]] bool hasFileUploading() const;
+    void setHasFileUploading(bool value);
+
+    [[nodiscard]] int fileUploadingProgress() const;
+    void setFileUploadingProgress(int value);
+
+    /**
+     * @brief Download a file for the given event to a local file location.
+     */
+    Q_INVOKABLE void download(const QString &eventId, const QUrl &localFilename = {});
+
+    /**
+     * @brief Download a file for the given event as a temporary file.
+     */
+    Q_INVOKABLE bool downloadTempFile(const QString &eventId);
+
+    /**
+     * @brief Check if the given event is highlighted.
+     *
+     * An event is highlighted if it contains the local user's id but was not sent by the
+     * local user.
+     */
+    bool isEventHighlighted(const Quotient::RoomEvent *e) const;
+
+    /**
+     * @brief Convenience function to find out if the room contains the given user.
+     *
+     * A room contains the user if the user can be found and their JoinState is
+     * not JoinState::Leave.
+     */
+    Q_INVOKABLE [[nodiscard]] bool containsUser(const QString &userID) const;
+
+    /**
+     * @brief True if the given user ID is banned from the room.
+     */
+    Q_INVOKABLE [[nodiscard]] bool isUserBanned(const QString &user) const;
+
+    /**
+     * @brief True if the local user can send the given event type.
+     */
+    Q_INVOKABLE [[nodiscard]] bool canSendEvent(const QString &eventType) const;
+
+    /**
+     * @brief True if the local user can send the given state event type.
+     */
+    Q_INVOKABLE [[nodiscard]] bool canSendState(const QString &eventType) const;
+
+    /**
+     * @brief Send a report to the server for an event.
+     *
+     * @param eventId the ID of the event being reported.
+     * @param reason the reason given for reporting the event.
+     */
+    Q_INVOKABLE void reportEvent(const QString &eventId, const QString &reason);
+
+    [[nodiscard]] bool readMarkerLoaded() const;
+
+    QString htmlSafeDisplayName() const;
+
+#ifndef QUOTIENT_07
+    /**
+     * @brief Get a display name for the user with html escaped.
+     */
+    Q_INVOKABLE QString htmlSafeMemberName(const QString &userId) const
+    {
+        return safeMemberName(userId).toHtmlEscaped();
+    }
+#endif
+
+    /**
+     * @brief Get subtitle text for room
+     *
+     * Fetches last event and removes markdown formatting
+     *
+     * @see lastEventToString()
+     */
+    [[nodiscard]] QString subtitleText();
+
+    [[nodiscard]] QString avatarMediaId() const;
+
+    NeoChatUser *directChatRemoteUser() const;
 
     [[nodiscard]] bool isSpace();
 
-    bool isEventHighlighted(const Quotient::RoomEvent *e) const;
+    bool isInvite() const;
+
+    Q_INVOKABLE void clearInvitationNotification();
 
     [[nodiscard]] QString joinRule() const;
     void setJoinRule(const QString &joinRule);
 
+    int maxRoomVersion() const;
+
+    /**
+     * @brief Map an alias to the room and publish.
+     *
+     * The alias is first mapped to the room and then published as an
+     * alternate alias. Publishing the alias will fail if the user does not have
+     * permission to send m.room.canonical_alias event messages.
+     *
+     * @note This is different to Quotient::Room::setLocalAliases() as that can only
+     * get the room to publish an alias that is already mapped.
+     *
+     * @property alias QString in the form #new_alias:server.org
+     *
+     * @sa Quotient::Room::setLocalAliases()
+     */
+    Q_INVOKABLE void mapAlias(const QString &alias);
+
+    /**
+     * @brief Unmap an alias from the room.
+     *
+     * An unmapped alias is also removed as either the canonical alias or an alternate
+     * alias.
+     *
+     * @note This is different to Quotient::Room::setLocalAliases() as that can only
+     * get the room to un-publish an alias, while the mapping still exists.
+     *
+     * @property alias QString in the form #mapped_alias:server.org
+     *
+     * @sa Quotient::Room::setLocalAliases()
+     */
+    Q_INVOKABLE void unmapAlias(const QString &alias);
+
+    /**
+     * @brief Set the canonical alias of the room to an available mapped alias.
+     *
+     * If the new alias was already published as an alternate alias it will be removed
+     * from that list.
+     *
+     * @note This is an overload of the function Quotient::Room::setCanonicalAlias().
+     * This is to provide the functionality to remove the new canonical alias as a
+     * published alt alias when set.
+     *
+     * @property newAlias QString in the form #new_alias:server.org
+     *
+     * @sa Quotient::Room::setCanonicalAlias()
+     * */
+    Q_INVOKABLE void setCanonicalAlias(const QString &newAlias);
+
+    PushNotificationState::State pushNotificationState() const;
+    void setPushNotificationState(PushNotificationState::State state);
+
     [[nodiscard]] QString historyVisibility() const;
     void setHistoryVisibility(const QString &historyVisibilityRule);
 
@@ -166,6 +622,8 @@ public:
     [[nodiscard]] bool urlPreviewEnabled() const;
     void setUrlPreviewEnabled(const bool &urlPreviewEnabled);
 
+    bool canEncryptRoom() const;
+
     /**
      * @brief Get the power level for the given user ID in the room.
      *
@@ -236,65 +694,6 @@ public:
     [[nodiscard]] int spaceParentPowerLevel() const;
     void setSpaceParentPowerLevel(const int &newPowerLevel);
 
-    [[nodiscard]] bool hasFileUploading() const
-    {
-        return m_hasFileUploading;
-    }
-    void setHasFileUploading(bool value)
-    {
-        if (value == m_hasFileUploading) {
-            return;
-        }
-        m_hasFileUploading = value;
-        Q_EMIT hasFileUploadingChanged();
-    }
-
-    [[nodiscard]] int fileUploadingProgress() const
-    {
-        return m_fileUploadingProgress;
-    }
-    void setFileUploadingProgress(int value)
-    {
-        if (m_fileUploadingProgress == value) {
-            return;
-        }
-        m_fileUploadingProgress = value;
-        Q_EMIT fileUploadingProgressChanged();
-    }
-
-    [[nodiscard]] bool readMarkerLoaded() const;
-
-    Q_INVOKABLE [[nodiscard]] int savedTopVisibleIndex() const;
-    Q_INVOKABLE [[nodiscard]] int savedBottomVisibleIndex() const;
-    Q_INVOKABLE void saveViewport(int topIndex, int bottomIndex);
-
-    Q_INVOKABLE [[nodiscard]] QVariantList getUsers(const QString &keyword, int limit = -1) const;
-    Q_INVOKABLE [[nodiscard]] QVariantMap getUser(const QString &userID) const;
-
-    Q_INVOKABLE QUrl urlToMxcUrl(const QUrl &mxcUrl);
-
-    [[nodiscard]] QString avatarMediaId() const;
-
-    [[nodiscard]] QString eventToString(const Quotient::RoomEvent &evt, Qt::TextFormat format = Qt::PlainText, bool stripNewlines = false) const;
-    [[nodiscard]] QString eventToGenericString(const Quotient::RoomEvent &evt) const;
-
-    Q_INVOKABLE [[nodiscard]] bool containsUser(const QString &userID) const;
-    Q_INVOKABLE [[nodiscard]] bool isUserBanned(const QString &user) const;
-
-    Q_INVOKABLE [[nodiscard]] bool canSendEvent(const QString &eventType) const;
-    Q_INVOKABLE [[nodiscard]] bool canSendState(const QString &eventType) const;
-
-    bool isInvite() const;
-
-    Q_INVOKABLE QString htmlSafeName() const;
-    Q_INVOKABLE QString htmlSafeDisplayName() const;
-    Q_INVOKABLE void clearInvitationNotification();
-    Q_INVOKABLE void reportEvent(const QString &eventId, const QString &reason);
-
-    Q_INVOKABLE void setPushNotificationState(PushNotificationState::State state);
-
-    Q_INVOKABLE void download(const QString &eventId, const QUrl &localFilename = {});
-
     QString chatBoxText() const;
     void setChatBoxText(const QString &text);
 
@@ -316,44 +715,40 @@ public:
     QString chatBoxAttachmentPath() const;
     void setChatBoxAttachmentPath(const QString &attachmentPath);
 
+    /**
+     * @brief Retrieve the mentions for the current chatbox text.
+     */
     QVector<Mention> *mentions();
 
     /**
-     * @brief Vector of mentions in the current edit text.
+     * @brief Retrieve the mentions for the current edit text.
      */
     QVector<Mention> *editMentions();
 
+    /**
+     * @brief Get the saved chatbox text for the room.
+     */
     QString savedText() const;
+
+    /**
+     * @brief Save the chatbox text for the room.
+     */
     void setSavedText(const QString &savedText);
 
-    bool canEncryptRoom() const;
-
-    Q_INVOKABLE bool downloadTempFile(const QString &eventId);
-
-    /*
-     * Map an alias to the room
-     *
-     * Note: this is different to setLocalAliases as that can only
-     * get the room to publish and alias that is already mapped.
-     */
-    Q_INVOKABLE void mapAlias(const QString &alias);
-    Q_INVOKABLE void unmapAlias(const QString &alias);
-    Q_INVOKABLE void setCanonicalAlias(const QString &newAlias);
-
 #ifdef QUOTIENT_07
+    /**
+     * @brief Get a PollHandler object for the given event Id.
+     *
+     * Will return an existing PollHandler if one already exists for the event ID.
+     * A new PollHandler will be created if one doesn't exist.
+     *
+     * @note Requires libQuotient 0.7.
+     *
+     * @sa PollHandler
+     */
     Q_INVOKABLE PollHandler *poll(const QString &eventId);
 #endif
 
-#ifndef QUOTIENT_07
-    Q_INVOKABLE QString htmlSafeMemberName(const QString &userId) const
-    {
-        return safeMemberName(userId).toHtmlEscaped();
-    }
-#endif
-
-    int maxRoomVersion() const;
-    NeoChatUser *directChatRemoteUser() const;
-
 private:
     QSet<const Quotient::RoomEvent *> highlights;
 
@@ -432,26 +827,87 @@ Q_SIGNALS:
     void spaceParentPowerLevelChanged();
 
 public Q_SLOTS:
+    /**
+     * @brief Upload a file to the matrix server and post the file to the room.
+     *
+     * @param url the location of the file to be uploaded.
+     * @param body the caption that is to be given to the file.
+     */
     void uploadFile(const QUrl &url, const QString &body = QString());
+
+    /**
+     * @brief Accept an invitation for the local user to join the room.
+     */
     void acceptInvitation();
+
+    /**
+     * @brief Leave and forget the room for the local user.
+     *
+     * @note This means that not only will the user no longer receive events in
+     *       the room but the will forget any history up to this point.
+     *
+     * @sa https://spec.matrix.org/latest/client-server-api/#leaving-rooms
+     */
     void forget();
+
+    /**
+     * @brief Set the typing notification state on the room for the local user.
+     */
     void sendTypingNotification(bool isTyping);
 
-    /// @param rawText The text as it was typed.
-    /// @param cleanedText The text with link to the users.
+    /**
+     * @brief Send a message to the room.
+     *
+     * @param rawText the text as it was typed.
+     * @param cleanedText the text marked up as html.
+     * @param type the type of message being sent.
+     * @param replyEventId the id of the message being replied to if a reply.
+     * @param relateToEventId the id of the message being edited if an edit.
+     */
     void postMessage(const QString &rawText,
                      const QString &cleanedText,
                      Quotient::MessageEventType type = Quotient::MessageEventType::Text,
                      const QString &replyEventId = QString(),
                      const QString &relateToEventId = QString());
+
+    /**
+     * @brief Send an html message to the room.
+     *
+     * @param text the text as it was typed.
+     * @param html the text marked up as html.
+     * @param type the type of message being sent.
+     * @param replyEventId the id of the message being replied to if a reply.
+     * @param relateToEventId the id of the message being edited if an edit.
+     */
     void postHtmlMessage(const QString &text,
                          const QString &html,
                          Quotient::MessageEventType type = Quotient::MessageEventType::Text,
                          const QString &replyEventId = QString(),
                          const QString &relateToEventId = QString());
+
+    /**
+     * @brief Set the room avatar.
+     */
     void changeAvatar(const QUrl &localFile);
-    void addLocalAlias(const QString &alias);
-    void removeLocalAlias(const QString &alias);
+
+    /**
+     * @brief Toggle the reaction state of the given reaction for the local user.
+     */
     void toggleReaction(const QString &eventId, const QString &reaction);
+
+    /**
+     * @brief Delete recent messages by the given user.
+     *
+     * This will delete all messages by that user in this room that are currently loaded.
+     */
     void deleteMessagesByUser(const QString &user, const QString &reason);
+
+    /**
+     *  @brief Sends a location to a room
+     *  The event is sent in the migration format as specified in MSC3488
+     * @param lat latitude
+     * @param lon longitude
+     * @param description description for the location
+     */
+    void sendLocation(float lat, float lon, const QString &description);
 };

src/neochatuser.cpp

@@ -16,13 +16,6 @@ NeoChatUser::NeoChatUser(QString userId, Connection *connection)
 {
     connect(static_cast<QGuiApplication *>(QGuiApplication::instance()), &QGuiApplication::paletteChanged, this, &NeoChatUser::polishColor);
     polishColor();
-    if (connection->userId() == id()) {
-        connect(connection, &Connection::accountDataChanged, this, [this](QString type) {
-            if (type == QLatin1String("org.kde.neochat.account_label")) {
-                Q_EMIT accountLabelChanged();
-            }
-        });
-    }
 }
 
 QColor NeoChatUser::color()
@@ -46,17 +39,3 @@ void NeoChatUser::polishColor()
     // https://github.com/quotient-im/libQuotient/wiki/User-color-coding-standard-draft-proposal
     setColor(QColor::fromHslF(hueF(), 1, -0.7 * lightness + 0.9, 1));
 }
-
-void NeoChatUser::setAccountLabel(const QString &accountLabel)
-{
-    Q_ASSERT(connection()->user()->id() == id());
-    QJsonObject json;
-    json["account_label"] = accountLabel;
-    connection()->setAccountData("org.kde.neochat.account_label", json);
-}
-
-QString NeoChatUser::accountLabel() const
-{
-    Q_ASSERT(connection()->user()->id() == id());
-    return connection()->accountDataJson("org.kde.neochat.account_label")["account_label"].toString();
-}

src/neochatuser.h

@@ -11,8 +11,6 @@ class NeoChatUser : public Quotient::User
 {
     Q_OBJECT
     Q_PROPERTY(QColor color READ color WRITE setColor NOTIFY colorChanged)
-    // Only valid for the local user
-    Q_PROPERTY(QString accountLabel READ accountLabel WRITE setAccountLabel NOTIFY accountLabelChanged)
 public:
     NeoChatUser(QString userId, Quotient::Connection *connection);
 
@@ -20,13 +18,8 @@ public Q_SLOTS:
     QColor color();
     void setColor(const QColor &color);
 
-    // Only valid for the local user
-    QString accountLabel() const;
-    void setAccountLabel(const QString &accountLabel);
-
 Q_SIGNALS:
     void colorChanged(QColor _t1);
-    void accountLabelChanged();
 
 private:
     QColor m_color;

src/notificationsmanager.cpp

@@ -71,6 +71,9 @@ void NotificationsManager::postNotification(NeoChatRoom *room,
     notification->setDefaultAction(i18n("Open NeoChat in this room"));
     connect(notification, &KNotification::defaultActivated, this, [=]() {
         WindowController::instance().showAndRaiseWindow(notification->xdgActivationToken());
+        if (!room) {
+            return;
+        }
         if (room->localUser()->id() != Controller::instance().activeConnection()->userId()) {
 #ifdef QUOTIENT_07
             Controller::instance().setActiveConnection(Accounts.get(room->localUser()->id()));
@@ -116,14 +119,23 @@ void NotificationsManager::postInviteNotification(NeoChatRoom *room, const QStri
     });
     notification->setActions({i18n("Accept Invitation"), i18n("Reject Invitation")});
     connect(notification, &KNotification::action1Activated, this, [room, notification]() {
+        if (!room) {
+            return;
+        }
         room->acceptInvitation();
         notification->close();
     });
     connect(notification, &KNotification::action2Activated, this, [room, notification]() {
+        if (!room) {
+            return;
+        }
         RoomManager::instance().leaveRoom(room);
         notification->close();
     });
     connect(notification, &KNotification::closed, this, [this, room]() {
+        if (!room) {
+            return;
+        }
         m_invitations.remove(room->id());
     });
 

src/qml/Component/ChatBox/ChatBar.qml

@@ -65,8 +65,17 @@ QQC2.Control {
                     emojiDialog.open()
                 }
             }
+        },
+        Kirigami.Action {
+            id: mapButton
+            icon.name: "globe"
+            property bool isBusy: false
+            text: i18n("Send a Location")
+            displayHint: QQC2.AbstractButton.IconOnly
 
-            tooltip: text
+            onTriggered: {
+                locationChooserComponent.createObject(QQC2.ApplicationWindow.overlay, {room: currentRoom}).open()
+            }
         },
         Kirigami.Action {
             id: sendAction
@@ -197,7 +206,7 @@ QQC2.Control {
                 if (event.key === Qt.Key_V && event.modifiers & Qt.ControlModifier) {
                     chatBar.pasteImage();
                 } else if (event.key === Qt.Key_Up && event.modifiers & Qt.ControlModifier) {
-                    let replyEvent = messageEventModel.getLatestMessageFromIndex(0)
+                    let replyEvent = messageEventModel.getLatestMessageFromRow(0)
                     if (replyEvent && replyEvent["event_id"]) {
                         currentRoom.chatBoxReplyId = replyEvent["event_id"]
                     }
@@ -394,6 +403,8 @@ QQC2.Control {
         cursorPosition: textField.cursorPosition
         selectionStart: textField.selectionStart
         selectionEnd: textField.selectionEnd
+        mentionColor: Kirigami.Theme.linkColor
+        errorColor: Kirigami.Theme.negativeTextColor
         Component.onCompleted: {
             RoomManager.chatDocumentHandler = documentHandler;
         }
@@ -471,4 +482,9 @@ QQC2.Control {
             textField.cursorPosition = index + format.start.length + format.end.length;
         }
     }
+
+    Component {
+        id: locationChooserComponent
+        LocationChooser {}
+    }
 }

src/qml/Component/ChatBox/LocationChooser.qml

@@ -0,0 +1,83 @@
+// SPDX-FileCopyrightText: 2021 Tobias Fella <fella@posteo.de>
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+import QtQuick 2.15
+import QtQuick.Controls 2.15
+import QtQuick.Layouts 1.15
+import QtLocation 5.15
+import QtPositioning 5.15
+
+import org.kde.kirigamiaddons.labs.components 1.0 as Components
+
+import org.kde.kirigami 2.15 as Kirigami
+
+Components.AbstractMaximizeComponent {
+    id: root
+
+    required property var room
+    property var location
+
+    title: i18n("Choose a Location")
+
+    actions: [
+        Kirigami.Action {
+            icon.name: "document-send"
+            text: i18n("Send this location")
+            onTriggered: {
+                root.room.sendLocation(root.location.latitude, root.location.longitude, "");
+                root.close();
+            }
+            enabled: !!root.location
+        }
+    ]
+
+    content: Map {
+        id: map
+        plugin: Plugin {
+            name: "osm"
+            PluginParameter {
+                name: "osm.useragent"
+                value: Application.name + "/" + Application.version + " (kde-devel@kde.org)"
+            }
+            PluginParameter {
+                name: "osm.mapping.providersrepository.address"
+                value: "https://autoconfig.kde.org/qtlocation/"
+            }
+        }
+
+        MouseArea {
+            anchors.fill: parent
+            onClicked: {
+                root.location = map.toCoordinate(Qt.point(mouseX, mouseY), false)
+            }
+        }
+
+        MapQuickItem {
+            id: point
+
+            visible: root.location
+            anchorPoint.x: sourceItem.width / 2
+            anchorPoint.y: sourceItem.height * 0.85
+            coordinate: root.location
+            autoFadeIn: false
+
+            sourceItem: Kirigami.Icon {
+                width: height
+                height: Kirigami.Units.iconSizes.huge
+                source: "gps"
+                isMask: true
+                color: Kirigami.Theme.highlightColor
+
+                Kirigami.Icon {
+                    anchors.centerIn: parent
+                    anchors.verticalCenterOffset: -parent.height / 8
+                    width: height
+                    height: parent.height / 3 + 1
+                    source: "pin"
+                    isMask: true
+                    color: Kirigami.Theme.highlightColor
+                }
+            }
+        }
+    }
+}

src/qml/Component/FullScreenImage.qml

@@ -1,312 +0,0 @@
-// SPDX-FileCopyrightText: 2019 Black Hat <bhat@encom.eu.org>
-// SPDX-License-Identifier: GPL-3.0-only
-
-import QtQuick 2.15
-import QtQuick.Controls 2.15 as QQC2
-import QtQuick.Layouts 1.15
-import Qt.labs.platform 1.1
-
-import org.kde.kirigami 2.15 as Kirigami
-
-import org.kde.neochat 1.0
-
-QQC2.Popup {
-    id: root
-
-    property alias source: image.source
-    property string filename
-    property string blurhash: ""
-    property int imageWidth: -1
-    property int imageHeight: -1
-    property var modelData
-
-    parent: QQC2.Overlay.overlay
-    closePolicy: QQC2.Popup.CloseOnEscape
-    width: parent.width
-    height: parent.height
-    modal: true
-    padding: 0
-    background: null
-
-    ColumnLayout {
-        anchors.fill: parent
-        spacing: Kirigami.Units.largeSpacing
-
-        QQC2.Control {
-            Layout.fillWidth: true
-
-            contentItem: RowLayout {
-                spacing: Kirigami.Units.largeSpacing
-
-                Kirigami.Avatar {
-                    id: avatar
-
-                    Layout.preferredWidth: Kirigami.Units.iconSizes.medium
-                    Layout.preferredHeight: Kirigami.Units.iconSizes.medium
-
-                    name: modelData.author.name ?? modelData.author.displayName
-                    source: modelData.author.avatarMediaId ? ("image://mxc/" + modelData.author.avatarMediaId) : ""
-                    color: modelData.author.color
-                }
-                ColumnLayout {
-                    Layout.fillWidth: true
-                    spacing: 0
-
-                    QQC2.Label {
-                        id: nameLabel
-
-                        text: modelData.author.displayName
-                        textFormat: Text.PlainText
-                        font.weight: Font.Bold
-                        color: author.color
-                    }
-                    QQC2.Label {
-                        id: timeLabel
-
-                        text: time.toLocaleString(Qt.locale(), Locale.ShortFormat)
-                    }
-                }
-                QQC2.Label {
-                    id: imageLabel
-                    Layout.fillWidth: true
-                    Layout.leftMargin: Kirigami.Units.largeSpacing
-
-                    text: modelData.display
-                    font.weight: Font.Bold
-                    elide: Text.ElideRight
-                }
-                QQC2.ToolButton {
-                    Layout.preferredWidth: Kirigami.Units.gridUnit * 2
-                    Layout.preferredHeight: Kirigami.Units.gridUnit * 2
-
-                    text: i18n("Zoom in")
-                    Accessible.name: text
-                    icon.name: "zoom-in"
-                    display: QQC2.AbstractButton.IconOnly
-                    onClicked: {
-                        image.scaleFactor = image.scaleFactor + 0.25
-                        if (image.scaleFactor > 3) {
-                            image.scaleFactor = 3
-                        }
-                    }
-
-                    QQC2.ToolTip.text: text
-                    QQC2.ToolTip.delay: Kirigami.Units.toolTipDelay
-                    QQC2.ToolTip.visible: hovered
-                }
-                QQC2.ToolButton {
-                    Layout.preferredWidth: Kirigami.Units.gridUnit * 2
-                    Layout.preferredHeight: Kirigami.Units.gridUnit * 2
-
-                    text: i18n("Zoom out")
-                    Accessible.name: text
-                    icon.name: "zoom-out"
-                    display: QQC2.AbstractButton.IconOnly
-                    onClicked: {
-                        image.scaleFactor = image.scaleFactor - 0.25
-                        if (image.scaleFactor < 0.25) {
-                            image.scaleFactor = 0.25
-                        }
-                    }
-
-                    QQC2.ToolTip.text: text
-                    QQC2.ToolTip.delay: Kirigami.Units.toolTipDelay
-                    QQC2.ToolTip.visible: hovered
-                }
-                QQC2.ToolButton {
-                    Layout.preferredWidth: Kirigami.Units.gridUnit * 2
-                    Layout.preferredHeight: Kirigami.Units.gridUnit * 2
-
-                    text: i18n("Rotate left")
-                    Accessible.name: text
-                    icon.name: "image-rotate-left-symbolic"
-                    display: QQC2.AbstractButton.IconOnly
-                    onClicked: image.rotationAngle = image.rotationAngle - 90
-
-                    QQC2.ToolTip.text: text
-                    QQC2.ToolTip.delay: Kirigami.Units.toolTipDelay
-                    QQC2.ToolTip.visible: hovered
-                }
-                QQC2.ToolButton {
-                    Layout.preferredWidth: Kirigami.Units.gridUnit * 2
-                    Layout.preferredHeight: Kirigami.Units.gridUnit * 2
-
-                    text: i18n("Rotate right")
-                    Accessible.name: text
-                    icon.name: "image-rotate-right-symbolic"
-                    display: QQC2.AbstractButton.IconOnly
-                    onClicked: image.rotationAngle = image.rotationAngle + 90
-
-                    QQC2.ToolTip.text: text
-                    QQC2.ToolTip.delay: Kirigami.Units.toolTipDelay
-                    QQC2.ToolTip.visible: hovered
-                }
-                QQC2.ToolButton {
-                    Layout.preferredWidth: Kirigami.Units.gridUnit * 2
-                    Layout.preferredHeight: Kirigami.Units.gridUnit * 2
-
-                    text: i18n("Save as")
-                    Accessible.name: text
-                    icon.name: "document-save"
-                    display: QQC2.AbstractButton.IconOnly
-                    onClicked: {
-                        var dialog = saveAsDialog.createObject(QQC2.ApplicationWindow.overlay)
-                        dialog.open()
-                        dialog.currentFile = dialog.folder + "/" + currentRoom.fileNameToDownload(eventId)
-                    }
-
-                    QQC2.ToolTip.text: text
-                    QQC2.ToolTip.delay: Kirigami.Units.toolTipDelay
-                    QQC2.ToolTip.visible: hovered
-                }
-                QQC2.ToolButton {
-                    Layout.preferredWidth: Kirigami.Units.gridUnit * 2
-                    Layout.preferredHeight: Kirigami.Units.gridUnit * 2
-
-                    text: i18n("Close")
-                    Accessible.name: text
-                    icon.name: "dialog-close"
-                    display: QQC2.AbstractButton.IconOnly
-                    onClicked: {
-                        root.close()
-                    }
-
-                    QQC2.ToolTip.text: text
-                    QQC2.ToolTip.delay: Kirigami.Units.toolTipDelay
-                    QQC2.ToolTip.visible: hovered
-                }
-            }
-
-            background: Rectangle {
-                color: Kirigami.Theme.alternateBackgroundColor
-            }
-
-            Kirigami.Separator {
-                anchors {
-                    left: parent.left
-                    right: parent.right
-                    bottom: parent.bottom
-                }
-                height: 1
-            }
-        }
-
-        QQC2.BusyIndicator {
-            Layout.fillWidth: true
-            visible: image.status !== Image.Ready && root.blurhash === ""
-            running: visible
-        }
-        // Provides container to fill the space that isn't taken up by the top controls and clips the image when zooming makes it larger than the available area.
-        Item {
-            id: imageContainer
-            Layout.fillWidth: true
-            Layout.fillHeight: true
-            Layout.leftMargin: Kirigami.Units.largeSpacing
-            Layout.rightMargin: Kirigami.Units.largeSpacing
-            Layout.bottomMargin: Kirigami.Units.largeSpacing
-            clip: true
-
-            AnimatedImage {
-                id: image
-
-                property var scaleFactor: 1
-                property int rotationAngle: 0
-                property var rotationInsensitiveWidth: Math.min(root.imageWidth > 0 ? root.imageWidth : sourceSize.width, imageContainer.width - Kirigami.Units.largeSpacing * 2)
-                property var rotationInsensitiveHeight: Math.min(root.imageHeight > 0 ? root.imageHeight : sourceSize.height, imageContainer.height - Kirigami.Units.largeSpacing * 2)
-
-                anchors.centerIn: parent
-                width: rotationAngle % 180 === 0 ? rotationInsensitiveWidth : rotationInsensitiveHeight
-                height: rotationAngle % 180 === 0 ? rotationInsensitiveHeight : rotationInsensitiveWidth
-                fillMode: Image.PreserveAspectFit
-                clip: true
-
-                Behavior on width {
-                    NumberAnimation {duration: Kirigami.Units.longDuration; easing.type: Easing.InOutCubic}
-                }
-                Behavior on height {
-                    NumberAnimation {duration: Kirigami.Units.longDuration; easing.type: Easing.InOutCubic}
-                }
-
-                Image {
-                    anchors.centerIn: parent
-                    width: image.width
-                    height: image.height
-                    source: root.blurhash !== "" ? ("image://blurhash/" + root.blurhash) : ""
-                    visible: root.blurhash !== "" && parent.status !== Image.Ready
-                }
-
-                transform: [
-                    Rotation {
-                        origin.x: image.width / 2
-                        origin.y: image.height / 2
-                        angle: image.rotationAngle
-
-                        Behavior on angle {
-                            RotationAnimation {duration: Kirigami.Units.longDuration; easing.type: Easing.InOutCubic}
-                        }
-                    },
-                    Scale {
-                        origin.x: image.width / 2
-                        origin.y: image.height / 2
-                        xScale: image.scaleFactor
-                        yScale: image.scaleFactor
-
-                        Behavior on xScale {
-                            NumberAnimation {duration: Kirigami.Units.longDuration; easing.type: Easing.InOutCubic}
-                        }
-                        Behavior on yScale {
-                            NumberAnimation {duration: Kirigami.Units.longDuration; easing.type: Easing.InOutCubic}
-                        }
-                    }
-                ]
-
-                MouseArea {
-                    anchors.fill: parent
-                    acceptedButtons: Qt.RightButton
-                    onClicked: {
-                        const contextMenu = fileDelegateContextMenu.createObject(parent, {
-                            author: modelData.author,
-                            message: modelData.message,
-                            eventId: modelData.eventId,
-                            source: modelData.source,
-                            file: root.parent,
-                            mimeType: modelData.mimeType,
-                            progressInfo: modelData.progressInfo,
-                            plainMessage: modelData.message,
-                        });
-                        contextMenu.closeFullscreen.connect(root.close)
-                        contextMenu.open();
-                    }
-                }
-            }
-            MouseArea {
-                anchors.fill: parent
-                acceptedButtons: Qt.LeftButton
-                onClicked: {
-                    root.close()
-                }
-            }
-        }
-    }
-
-    Component {
-        id: saveAsDialog
-        FileDialog {
-            fileMode: FileDialog.SaveFile
-            folder: Config.lastSaveDirectory.length > 0 ? Config.lastSaveDirectory : StandardPaths.writableLocation(StandardPaths.DownloadLocation)
-            onAccepted: {
-                Config.lastSaveDirectory = folder
-                Config.save()
-                if (!currentFile) {
-                    return;
-                }
-                currentRoom.downloadFile(eventId, currentFile)
-            }
-        }
-    }
-
-    onClosed: {
-        image.scaleFactor = 1
-        image.rotationAngle = 0
-    }
-}

src/qml/Component/FullScreenMap.qml

@@ -1,78 +0,0 @@
-// SPDX-FileCopyrightText: 2021 Tobias Fella <fella@posteo.de>
-// SPDX-License-Identifier: GPL-2.0-or-later
-
-import QtQuick 2.15
-import QtQuick.Controls 2.15
-import QtLocation 5.15
-import QtPositioning 5.15
-
-import org.kde.kirigami 2.15 as Kirigami
-
-ApplicationWindow {
-    id: root
-
-    required property var content
-
-    flags: Qt.FramelessWindowHint | Qt.WA_TranslucentBackground
-    visibility: Qt.WindowFullScreen
-
-    title: i18n("View Location")
-
-    Shortcut {
-        sequence: "Escape"
-        onActivated: root.destroy()
-    }
-
-    color: Kirigami.Theme.backgroundColor
-
-    background: AbstractButton {
-        onClicked: root.destroy()
-    }
-
-    Map {
-        id: map
-        anchors.fill: parent
-        property string latlong: root.content.geo_uri.split(':')[1]
-        property string latitude: latlong.split(',')[0]
-        property string longitude: latlong.split(',')[1]
-        center: QtPositioning.coordinate(latitude, longitude)
-        zoomLevel: 15
-        plugin: Plugin {
-            name: "osm"
-            PluginParameter {
-                name: "osm.useragent"
-                value: Application.name + "/" + Application.version + " (kde-devel@kde.org)"
-            }
-            PluginParameter {
-                name: "osm.mapping.providersrepository.address"
-                value: "https://autoconfig.kde.org/qtlocation/"
-            }
-        }
-        MapCircle {
-            radius: 1500 / map.zoomLevel
-            color: Kirigami.Theme.highlightColor
-            border.color: Kirigami.Theme.linkColor
-            border.width: Kirigami.Units.devicePixelRatio * 2
-            smooth: true
-            opacity: 0.25
-            center: QtPositioning.coordinate(map.latitude, map.longitude)
-        }
-        onCopyrightLinkActivated: {
-            Qt.openUrlExternally(link)
-        }
-    }
-
-    Button {
-        anchors.top: parent.top
-        anchors.right: parent.right
-
-        text: i18n("Close")
-        icon.name: "dialog-close"
-        display: AbstractButton.IconOnly
-
-        width: Kirigami.Units.gridUnit * 2
-        height: Kirigami.Units.gridUnit * 2
-
-        onClicked: root.destroy()
-    }
-}

src/qml/Component/LocationPage.qml

@@ -1,59 +0,0 @@
-// SPDX-FileCopyrightText: 2023 Tobias Fella <tobias.fella@kde.org>
-// SPDX-License-Identifier: GPL-2.0-or-later
-
-import QtQuick 2.15
-import QtQuick.Controls 2.15 as QQC2
-import QtLocation 5.15
-import QtPositioning 5.15
-
-import org.kde.kirigami 2.20 as Kirigami
-import org.kde.neochat 1.0
-
-Kirigami.Page {
-    id: locationsPage
-
-    required property var room
-
-    title: i18nc("Locations on a map", "Locations")
-
-    padding: 0
-
-    Map {
-        id: map
-        anchors.fill: parent
-        plugin: Plugin {
-            name: "osm"
-            PluginParameter {
-                name: "osm.useragent"
-                value: Application.name + "/" + Application.version + " (kde-devel@kde.org)"
-            }
-            PluginParameter {
-                name: "osm.mapping.providersrepository.address"
-                value: "https://autoconfig.kde.org/qtlocation/"
-            }
-        }
-
-        MapItemView {
-            model: LocationsModel {
-                room: locationsPage.room
-            }
-            delegate: MapQuickItem {
-                id: point
-
-                required property var longitude
-                required property var latitude
-                required property string text
-                anchorPoint.x: icon.width / 2
-                anchorPoint.y: icon.height / 2
-                coordinate: QtPositioning.coordinate(point.latitude, point.longitude)
-                autoFadeIn: false
-                sourceItem: Kirigami.Icon {
-                    id: icon
-                    width: height
-                    height: Kirigami.Units.iconSizes.medium
-                    source: "flag-blue"
-                }
-            }
-        }
-    }
-}

src/qml/Component/NeochatMaximizeComponent.qml

@@ -0,0 +1,93 @@
+// SPDX-FileCopyrightText: 2023 James Graham <james.h.graham@protonmail.com>
+// SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
+
+import QtQuick 2.15
+import QtQuick.Controls 2.15 as QQC2
+import QtQuick.Layouts 1.15
+import Qt.labs.platform 1.1
+
+import org.kde.kirigami 2.13 as Kirigami
+import org.kde.kirigamiaddons.labs.components 1.0 as Components
+
+import org.kde.neochat 1.0
+
+Components.AlbumMaximizeComponent {
+    id: root
+
+    property var modelData
+
+    property list<Components.AlbumModelItem> items: [
+        Components.AlbumModelItem {
+            type: root.modelData.delegateType === MessageEventModel.Image ? Components.AlbumModelItem.Image : Components.AlbumModelItem.Video
+            source: root.modelData.delegateType === MessageEventModel.Video ? modelData.progressInfo.localPath : modelData.mediaUrl
+            tempSource: modelData.content.info["xyz.amorgan.blurhash"] ? ("image://blurhash/" + modelData.content.info["xyz.amorgan.blurhash"]) : ""
+            caption: modelData.display
+        }
+    ]
+
+    model: items
+    initialIndex: 0
+
+    leading: RowLayout {
+        Kirigami.Avatar {
+            id: userAvatar
+            implicitWidth: Kirigami.Units.iconSizes.medium
+            implicitHeight: Kirigami.Units.iconSizes.medium
+
+            name: modelData.author.name ?? modelData.author.displayName
+            source: modelData.author.avatarMediaId ? ("image://mxc/" + modelData.author.avatarMediaId) : ""
+            color: modelData.author.color
+        }
+        ColumnLayout {
+            spacing: 0
+            QQC2.Label {
+                id: userLabel
+                text: modelData.author.name ?? modelData.author.displayName
+                color: modelData.author.color
+                font.weight: Font.Bold
+                elide: Text.ElideRight
+            }
+            QQC2.Label {
+                id: dateTimeLabel
+                text: modelData.time.toLocaleString(Qt.locale(), Locale.ShortFormat)
+                color: Kirigami.Theme.disabledTextColor
+                elide: Text.ElideRight
+            }
+        }
+    }
+    onItemRightClicked: {
+        const contextMenu = fileDelegateContextMenu.createObject(parent, {
+            author: modelData.author,
+            message: modelData.message,
+            eventId: modelData.eventId,
+            source: modelData.source,
+            file: parent,
+            mimeType: modelData.mimeType,
+            progressInfo: modelData.progressInfo,
+            plainMessage: modelData.message,
+        });
+        contextMenu.closeFullscreen.connect(root.close)
+        contextMenu.open();
+    }
+    onSaveItem: {
+        var dialog = saveAsDialog.createObject(QQC2.ApplicationWindow.overlay)
+        dialog.open()
+        dialog.currentFile = dialog.folder + "/" + currentRoom.fileNameToDownload(modelData.eventId)
+    }
+
+    Component {
+        id: saveAsDialog
+        FileDialog {
+            fileMode: FileDialog.SaveFile
+            folder: root.saveFolder
+            onAccepted: {
+                Config.lastSaveDirectory = folder
+                Config.save()
+                if (!currentFile) {
+                    return;
+                }
+                currentRoom.downloadFile(eventId, currentFile)
+            }
+        }
+    }
+}

src/qml/Component/QuickSwitcher.qml

@@ -1,115 +1,132 @@
-// SPDX-FileCopyrightText: 2021 Carson Black <uhhadd@gmail.com>
-// SPDX-License-Identifier: GPL-3.0-only
+// SPDX-FileCopyrightText: 2023 Tobias Fella <tobias.fella@kde.org>
+// SPDX-License-Identifier: GPL-2.0-or-later
 
 import QtQuick 2.15
-import QtQuick.Layouts 1.10
-import QtQuick.Controls 2.12 as QQC2
-import org.kde.kirigami 2.14 as Kirigami
+import QtQuick.Controls 2.15 as QQC2
+import QtQuick.Layouts 1.15
+
+import org.kde.kirigami 2.20 as Kirigami
 import org.kde.kitemmodels 1.0
+
 import org.kde.neochat 1.0
 
-QQC2.Popup {
-    id: _popup
+QQC2.Dialog {
+    id: root
+
+    parent: applicationWindow().overlay
+    width: Math.min(700, parent.width)
+    height: 400
+
+    leftPadding: 0
+    rightPadding: 0
+    bottomPadding: 0
+    topPadding: 0
+
+    anchors.centerIn: applicationWindow().overlay
+
+    Keys.forwardTo: searchField
 
     Shortcut {
         sequence: "Ctrl+K"
-        enabled: !Kirigami.Settings.hasPlatformMenuBar
-        onActivated: _popup.open()
+        onActivated: root.open()
     }
 
     onVisibleChanged: {
         if (!visible) {
             return
         }
-        quickSearch.forceActiveFocus()
-        quickSearch.text = ""
+        searchField.forceActiveFocus()
+        searchField.text = ""
+        roomList.currentIndex = 0
     }
 
-    anchors.centerIn: QQC2.Overlay.overlay
-    background: Kirigami.Card {}
-    height: 2 * Math.round(implicitHeight / 2)
-    padding: Kirigami.Units.largeSpacing * 2
-
-    contentItem: ColumnLayout {
-        spacing: Kirigami.Units.largeSpacing * 2
-
-        Kirigami.SearchField {
-            id: quickSearch
-
-            // TODO: get this broken property removed/disabled by default in Kirigami,
-            // we used to be able to expect that the text field wouldn't attempt to
-            // perform a mini-DDOS attack using signals.
-            autoAccept: false
-            /**
-             * The focus is manged by the popup and we don't want to use the standard
-             * shortcut as it could block other SearchFields from using it.
-             */
-            focusSequence: ""
-
-            Layout.preferredWidth: Kirigami.Units.gridUnit * 21 // 3 * 7 = 21, roughly 7 avatars on screen
-            Keys.onLeftPressed: cView.decrementCurrentIndex()
-            Keys.onRightPressed: cView.incrementCurrentIndex()
-            onAccepted: {
-                const item = cView.itemAtIndex(cView.currentIndex)
-
-                RoomManager.enterRoom(item.currentRoom)
-
-                _popup.close()
+    header: Kirigami.SearchField {
+        id: searchField
+        Keys.onDownPressed: {
+            roomList.forceActiveFocus()
+            if (roomList.currentIndex < roomList.count - 1) {
+                roomList.currentIndex++
+            } else {
+                roomList.currentIndex = 0
             }
         }
+        Keys.onUpPressed: {
+            if (roomList.currentIndex === 0) {
+                roomList.currentIndex = roomList.count - 1
+            } else {
+                roomList.currentIndex--
+            }
+        }
+        Keys.onEnterPressed: {
+            RoomManager.enterRoom(roomList.currentItem.currentRoom);
+            root.close();
+        }
+        Keys.onReturnPressed: {
+            RoomManager.enterRoom(roomList.currentItem.currentRoom);
+            root.close();
+        }
+    }
+
+    QQC2.ScrollView {
+        anchors.fill: parent
         ListView {
-            id: cView
-
-            orientation: Qt.Horizontal
-            spacing: Kirigami.Units.largeSpacing
+            id: roomList
 
+            currentIndex: 0
+            highlightMoveDuration: 200
+            Keys.forwardTo: searchField
+            keyNavigationEnabled: true
             model: SortFilterRoomListModel {
-                id: sortFilterRoomListModel
+                filterText: searchField.text
                 sourceModel: RoomListModel {
                     id: roomListModel
                     connection: Controller.activeConnection
                 }
-                filterText: quickSearch.text
-                roomSortOrder: SortFilterRoomListModel.LastActivity
             }
+            delegate: Kirigami.BasicListItem {
+                id: roomListItem
 
-            Layout.preferredHeight: Kirigami.Units.gridUnit * 3
-            Layout.fillWidth: true
-
-            delegate: Kirigami.Avatar {
-                id: del
-
-                implicitHeight: Kirigami.Units.gridUnit * 3
-                implicitWidth: Kirigami.Units.gridUnit * 3
-
-                required property string avatar
                 required property var currentRoom
+                required property string name
                 required property int index
+                required property int unreadCount
+                required property string subtitleText
+                required property string avatar
 
-                name: currentRoom.displayName
-
-                // When an item is hovered set the currentIndex of listview to it so that it is highlighted
-                onHoveredChanged: {
-                    if (!hovered) {
-                        return
-                    }
-                    cView.currentIndex = index
+                topPadding: Kirigami.Units.largeSpacing
+                bottomPadding: Kirigami.Units.largeSpacing
+                highlighted: roomList.currentIndex === roomListItem.index
+                focus: true
+                icon: undefined
+                onClicked: {
+                    RoomManager.enterRoom(roomListItem.currentRoom);
+                    root.close()
+                }
+                Keys.onEnterPressed: {
+                    RoomManager.enterRoom(roomListItem.currentRoom);
+                    root.close();
+                }
+                Keys.onReturnPressed: {
+                    RoomManager.enterRoom(roomListItem.currentRoom);
+                    root.close();
+                }
+                bold: roomListItem.unreadCount > 0
+                label: roomListItem.name ?? ""
+                labelItem.textFormat: Text.PlainText
+                subtitle: roomListItem.subtitleText
+                subtitleItem.textFormat: Text.PlainText
+                onPressAndHold: {
+                    createRoomListContextMenu()
                 }
 
-                actions.main: Kirigami.Action {
-                    id: enterRoomAction
-                    onTriggered: {
-                        RoomManager.enterRoom(currentRoom);
-
-                        _popup.close()
-                    }
+                leading: Kirigami.Avatar {
+                    source: roomListItem.avatar ? "image://mxc/" + roomListItem.avatar : ""
+                    name: roomListItem.name || i18n("No Name")
+                    implicitWidth: height
+                    sourceSize.width: Kirigami.Units.gridUnit + Kirigami.Units.largeSpacing * 2
+                    sourceSize.height: Kirigami.Units.gridUnit + Kirigami.Units.largeSpacing * 2
                 }
-
-                source: avatar != "" ? "image://mxc/" + avatar : ""
             }
         }
     }
-
-    modal: true
-    focus: true
 }

src/qml/Component/Timeline/EventDelegate.qml

@@ -11,7 +11,7 @@ import org.kde.kirigami 2.15 as Kirigami
 import org.kde.neochat 1.0
 
 DelegateChooser {
-    role: "eventType"
+    role: "delegateType"
 
     DelegateChoice {
         roleValue: MessageEventModel.State
@@ -20,9 +20,7 @@ DelegateChooser {
 
     DelegateChoice {
         roleValue: MessageEventModel.Emote
-        delegate: MessageDelegate {
-            isEmote: true
-        }
+        delegate: MessageDelegate {}
     }
 
     DelegateChoice {

src/qml/Component/Timeline/FileDelegate.qml

@@ -110,14 +110,18 @@ TimelineContainer {
         ColumnLayout {
             spacing: 0
             QQC2.Label {
+                Layout.fillWidth: true
                 text: model.display
                 wrapMode: Text.Wrap
+                elide: Text.ElideRight
             }
             QQC2.Label {
                 id: sizeLabel
-
+                Layout.fillWidth: true
                 text: Controller.formatByteSize(content.info ? content.info.size : 0)
                 opacity: 0.7
+                elide: Text.ElideRight
+                maximumLineCount: 1
             }
         }
 

src/qml/Component/Timeline/ImageDelegate.qml

@@ -4,9 +4,10 @@
 import QtQuick 2.15
 import QtQuick.Controls 2.15 as QQC2
 import QtQuick.Layouts 1.15
-import Qt.labs.platform 1.1
+import QtQml.Models 2.15
 
 import org.kde.kirigami 2.15 as Kirigami
+import org.kde.kirigamiaddons.labs.components 1.0 as Components
 
 import org.kde.neochat 1.0
 
@@ -115,37 +116,27 @@ TimelineContainer {
             }
         }
 
-        Component {
-            id: fileDialog
-
-            FileDialog {
-                fileMode: FileDialog.SaveFile
-                folder: StandardPaths.writableLocation(StandardPaths.DownloadLocation)
-                onAccepted: {
-                    currentRoom.downloadFile(eventId, file)
-                }
-            }
-        }
-
         TapHandler {
             acceptedButtons: Qt.LeftButton
             onTapped: {
                 img.QQC2.ToolTip.hide()
                 img.paused = true
-                fullScreenImage.open()
+                imageDelegate.ListView.view.interactive = false
+                var popup = maximizeImageComponent.createObject(QQC2.ApplicationWindow.overlay, {
+                    modelData: model,
+                })
+                popup.closed.connect(() => {
+                    imageDelegate.ListView.view.interactive = true
+                    img.paused = false
+                    popup.destroy()
+                })
+                popup.open()
             }
         }
 
-        FullScreenImage {
-            id: fullScreenImage
-            filename: eventId
-            source: mediaUrl
-            blurhash: model.content.info["xyz.amorgan.blurhash"]
-            imageWidth: content.info.w
-            imageHeight: content.info.h
-            modelData: model
-
-            onClosed: img.paused = false
+        Component {
+            id: maximizeImageComponent
+            NeochatMaximizeComponent {}
         }
 
         function downloadAndOpen() {

src/qml/Component/Timeline/LocationDelegate.qml

@@ -14,12 +14,6 @@ import org.kde.neochat 1.0
 TimelineContainer {
     id: locationDelegate
 
-    property string latlong: model.content.geo_uri.split(':')[1]
-    property string latitude: latlong.split(',')[0]
-    property string longitude: latlong.split(',')[1]
-
-    property string formattedBody: model.content.formatted_body
-
     ColumnLayout {
         Layout.maximumWidth: locationDelegate.contentMaxWidth
         Layout.preferredWidth: locationDelegate.contentMaxWidth
@@ -28,7 +22,7 @@ TimelineContainer {
             Layout.fillWidth: true
             Layout.preferredHeight: locationDelegate.contentMaxWidth / 16 * 9
 
-            center: QtPositioning.coordinate(locationDelegate.latitude, locationDelegate.longitude)
+            center: QtPositioning.coordinate(model.latitude, model.longitude)
             zoomLevel: 15
             plugin: Plugin {
                 name: "osm"
@@ -41,34 +35,56 @@ TimelineContainer {
                     value: "https://autoconfig.kde.org/qtlocation/"
                 }
             }
-            MapCircle {
-                radius: 1500 / map.zoomLevel
-                color: Kirigami.Theme.highlightColor
-                border.color: Kirigami.Theme.linkColor
-                border.width: Kirigami.Units.devicePixelRatio * 2
-                smooth: true
-                opacity: 0.25
-                center: QtPositioning.coordinate(latitude, longitude)
-            }
-            onCopyrightLinkActivated: {
-                Qt.openUrlExternally(link)
+
+            onCopyrightLinkActivated: Qt.openUrlExternally(link)
+
+
+            MapQuickItem {
+                id: point
+
+                anchorPoint.x: sourceItem.width / 2
+                anchorPoint.y: sourceItem.height
+                coordinate: QtPositioning.coordinate(model.latitude, model.longitude)
+                autoFadeIn: false
+
+                sourceItem: Kirigami.Icon {
+                    width: height
+                    height: Kirigami.Units.iconSizes.huge
+                    source: "gps"
+                    isMask: true
+                    color: Kirigami.Theme.highlightColor
+
+                    Kirigami.Icon {
+                        anchors.centerIn: parent
+                        anchors.verticalCenterOffset: -parent.height / 8
+                        visible: model.asset === "m.pin"
+                        width: height
+                        height: parent.height / 3 + 1
+                        source: "pin"
+                        isMask: true
+                        color: Kirigami.Theme.highlightColor
+                    }
+                    Kirigami.Avatar {
+                        anchors.centerIn: parent
+                        anchors.verticalCenterOffset: -parent.height / 8
+                        visible: model.asset === "m.self"
+                        width: height
+                        height: parent.height / 3 + 1
+                        name: model.author.name ?? model.author.displayName
+                        source: model.author.avatarMediaId ? ("image://mxc/" + model.author.avatarMediaId) : ""
+                        color: model.author.color
+                    }
+                }
             }
+
             TapHandler {
                 acceptedButtons: Qt.LeftButton
-                onTapped: {
-                    let map = fullScreenMap.createObject(parent, {content: model.content});
-                    map.open()
-                }
-                onLongPressed: openMessageContext(author, model.message, eventId, toolTip, eventType, model.formattedBody ?? model.body, parent.selectedText)
+                onLongPressed: openMessageContext(model, "", model.message)
             }
             TapHandler {
                 acceptedButtons: Qt.RightButton
-                onTapped: openMessageContext(author, model.message, eventId, toolTip, eventType, model.formattedBody ?? model.body, parent.selectedText)
+                onTapped: openMessageContext(model, "", model.message)
             }
         }
-        Component {
-            id: fullScreenMap
-            FullScreenMap { }
-        }
     }
 }

src/qml/Component/Timeline/MessageDelegate.qml

@@ -13,7 +13,6 @@ import org.kde.neochat 1.0
 TimelineContainer {
     id: messageDelegate
 
-    property bool isEmote: false
     onOpenContextMenu: openMessageContext(model, label.selectedText, Controller.plainText(label.textDocument))
 
     innerObject: ColumnLayout {
@@ -22,7 +21,6 @@ TimelineContainer {
             id: label
             Layout.fillWidth: true
             visible: currentRoom.chatBoxEditId !== model.eventId
-            isEmote: messageDelegate.isEmote
         }
         Loader {
             Layout.fillWidth: true

src/qml/Component/Timeline/MessageEditComponent.qml

@@ -119,6 +119,8 @@ QQC2.TextArea {
         selectionStart: root.selectionStart
         selectionEnd: root.selectionEnd
         room: root.room // We don't care about saving for edits so this is OK.
+        mentionColor: Kirigami.Theme.linkColor
+        errorColor: Kirigami.Theme.negativeTextColor
     }
 
     TextMetrics {

src/qml/Component/Timeline/ReplyComponent.qml

@@ -96,7 +96,6 @@ Item {
         RichLabel {
             textMessage: reply.display
             textFormat: Text.RichText
-            isReplyLabel: true
 
             HoverHandler {
                 enabled: !hoveredLink

src/qml/Component/Timeline/RichLabel.qml

@@ -14,8 +14,6 @@ TextEdit {
     readonly property var isEmoji: /^(<span style='.*'>)?(\u00a9|\u00ae|[\u20D0-\u2fff]|[\u3190-\u3300]|\ud83c[\ud000-\udfff]|\ud83d[\ud000-\udfff]|\ud83e[\ud000-\udfff])+(<\/span>)?$/
     readonly property var hasSpoiler: /data-mx-spoiler/g
 
-    property bool isEmote: false
-    property bool isReplyLabel: false
     property string textMessage: model.display
     property bool spoilerRevealed: !hasSpoiler.test(textMessage)
 
@@ -35,6 +33,9 @@ table {
     border-collapse: collapse;
     border-style: solid;
 }
+code {
+    background-color:" + Kirigami.Theme.alternateBackgroundColor + ";
+}
 table th,
 table td {
     border: 1px solid black;
@@ -57,7 +58,7 @@ a{
     background: " + Kirigami.Theme.textColor + ";
 }
 " : "") + "
-</style>" + (isEmote ? "* <a href='https://matrix.to/#/" + author.id + "' style='color: " + author.color + "'>" + author.displayName + "</a> " : "") + textMessage + (isEdited && !contentLabel.isReplyLabel ? (" <span style=\"color: " + Kirigami.Theme.disabledTextColor + "\">" + "<span style='font-size: " + Kirigami.Theme.defaultFont.pixelSize +"px'>" + i18n(" (edited)") + "</span>") : "")
+</style>" + textMessage
 
     color: Kirigami.Theme.textColor
     selectedTextColor: Kirigami.Theme.highlightedTextColor

src/qml/Component/Timeline/SectionDelegate.qml

@@ -42,6 +42,6 @@ QQC2.ItemDelegate {
     background: Rectangle {
         color: Config.blur ? "transparent" : Kirigami.Theme.backgroundColor
         Kirigami.Theme.inherit: false
-        Kirigami.Theme.colorSet: Kirigami.Theme.Window
+        Kirigami.Theme.colorSet: Config.compactLayout ? Kirigami.Theme.View : Kirigami.Theme.Window
     }
 }