aboutsummaryrefslogtreecommitdiff
path: root/lib/user.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2018-03-31 13:16:02 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2018-03-31 14:23:55 +0900
commitefeb50a46ad824aa258472f6ac8da74810f05a55 (patch)
treea89c6f35d56986c60e73f870530c9d6ee0527e6d /lib/user.h
parent29093379b707bfe620234c2968b37aa86666542a (diff)
downloadlibquotient-efeb50a46ad824aa258472f6ac8da74810f05a55.tar.gz
libquotient-efeb50a46ad824aa258472f6ac8da74810f05a55.zip
Move source files to a separate folder
It's been long overdue to separate them from the rest of the stuff (docs etc.). Also, this allows installing to a directory within the checked out git tree (say, ./install/, similar to ./build/).
Diffstat (limited to 'lib/user.h')
-rw-r--r--lib/user.h125
1 files changed, 125 insertions, 0 deletions
diff --git a/lib/user.h b/lib/user.h
new file mode 100644
index 00000000..f76f9e0a
--- /dev/null
+++ b/lib/user.h
@@ -0,0 +1,125 @@
+/******************************************************************************
+ * Copyright (C) 2015 Felix Rohrbach <kde@fxrh.de>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#pragma once
+
+#include <QtCore/QString>
+#include <QtCore/QObject>
+#include "avatar.h"
+
+namespace QMatrixClient
+{
+ class Connection;
+ class Room;
+ class RoomMemberEvent;
+
+ class User: public QObject
+ {
+ Q_OBJECT
+ Q_PROPERTY(QString id READ id CONSTANT)
+ Q_PROPERTY(bool isGuest READ isGuest CONSTANT)
+ Q_PROPERTY(QString name READ name NOTIFY nameChanged)
+ Q_PROPERTY(QString displayName READ displayname NOTIFY nameChanged STORED false)
+ Q_PROPERTY(QString fullName READ fullName NOTIFY nameChanged STORED false)
+ Q_PROPERTY(QString bridgeName READ bridged NOTIFY nameChanged STORED false)
+ Q_PROPERTY(QString avatarMediaId READ avatarMediaId NOTIFY avatarChanged STORED false)
+ Q_PROPERTY(QUrl avatarUrl READ avatarUrl NOTIFY avatarChanged)
+ public:
+ User(QString userId, Connection* connection);
+ ~User() override;
+
+ /** Get unique stable user id
+ * User id is generated by the server and is not changed ever.
+ */
+ QString id() const;
+
+ /** Get the name chosen by the user
+ * This may be empty if the user didn't choose the name or cleared
+ * it.
+ * \sa displayName
+ */
+ QString name(const Room* room = nullptr) const;
+
+ /** Get the displayed user name
+ * This method returns the result of name() if its non-empty;
+ * otherwise it returns user id. This is convenient to show a user
+ * name outside of a room context. In a room context, user names
+ * should be disambiguated.
+ * \sa name, id, fullName Room::roomMembername
+ */
+ QString displayname(const Room* room = nullptr) const;
+
+ /** Get user name and id in one string
+ * The constructed string follows the format 'name (id)'
+ * used for users disambiguation in a room context and in other
+ * places.
+ * \sa displayName, Room::roomMembername
+ */
+ QString fullName(const Room* room = nullptr) const;
+
+ /**
+ * Returns the name of bridge the user is connected from or empty.
+ */
+ QString bridged() const;
+
+ /** Whether the user is a guest
+ * As of now, the function relies on the convention used in Synapse
+ * that guests and only guests have all-numeric IDs. This may or
+ * may not work with non-Synapse servers.
+ */
+ bool isGuest() const;
+
+ const Avatar& avatarObject(const Room* room = nullptr) const;
+ Q_INVOKABLE QImage avatar(int dimension, const Room* room = nullptr);
+ Q_INVOKABLE QImage avatar(int requestedWidth, int requestedHeight,
+ const Room* room = nullptr);
+ QImage avatar(int width, int height, const Room* room,
+ Avatar::get_callback_t callback);
+
+ QString avatarMediaId(const Room* room = nullptr) const;
+ QUrl avatarUrl(const Room* room = nullptr) const;
+
+ void processEvent(RoomMemberEvent* event, const Room* r = nullptr);
+
+ public slots:
+ void rename(const QString& newName);
+ void rename(const QString& newName, const Room* r);
+ bool setAvatar(const QString& fileName);
+ bool setAvatar(QIODevice* source);
+ void requestDirectChat();
+
+ signals:
+ void nameAboutToChange(QString newName, QString oldName,
+ const Room* roomContext);
+ void nameChanged(QString newName, QString oldName,
+ const Room* roomContext);
+ void avatarChanged(User* user, const Room* roomContext);
+
+ private slots:
+ void updateName(const QString& newName, const Room* room = nullptr);
+ void updateName(const QString& newName, const QString& oldName,
+ const Room* room = nullptr);
+ void updateAvatarUrl(const QUrl& newUrl, const QUrl& oldUrl,
+ const Room* room = nullptr);
+
+ private:
+ class Private;
+ QScopedPointer<Private> d;
+ };
+}
+Q_DECLARE_METATYPE(QMatrixClient::User*)