user_list_widget.h

Go to the documentation of this file.

 
#ifndef USERLIST_H
#define USERLIST_H
 
#include "libcockatrice/protocol/pb/serverinfo_user.pb.h"
 
#include <QGroupBox>
#include <QList>
#include <QMap>
#include <QSet>
#include <QString>
#include <QStyledItemDelegate>
#include <QTreeWidgetItem>
#include <functional>
#include <qtmetamacros.h>
#include <utility>
 
class AbstractClient;
class TabSupervisor;
class UserContextMenu;
class UserListWidget;
class QModelIndex;
class QPixmap;
class QPoint;
class QTimer;
class QWidget;
class UserAvatarProvider;
class UserCardArtProvider;
class UserInfoPopup;
class UserListManager;
struct CardArtParams;
struct GameInviteOption;
 
class UserListItemDelegate : public QStyledItemDelegate
{
    QTreeWidget *tree;
    UserListWidget *owner;
    const QMap<QString, QPixmap> *avatarCache;
    const QMap<QString, QPixmap> *cardArtCache;
    const QMap<QString, CardArtParams> *cardArtParamsMap;
 
public:
    explicit UserListItemDelegate(UserListWidget *owner,
                                  QTreeWidget *tree,
                                  const QMap<QString, QPixmap> *avatarCache,
                                  const QMap<QString, QPixmap> *cardArtCache,
                                  const QMap<QString, CardArtParams> *cardArtParamsMap);
    bool editorEvent(QEvent *event,
                     QAbstractItemModel *model,
                     const QStyleOptionViewItem &option,
                     const QModelIndex &index) override;
    void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override;
    QSize sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const override;
};
 
class UserListTWI : public QTreeWidgetItem
{
private:
    ServerInfo_User userInfo;
 
public:
    explicit UserListTWI(const ServerInfo_User &_userInfo);
    const ServerInfo_User &getUserInfo() const
    {
        return userInfo;
    }
    void setUserInfo(const ServerInfo_User &_userInfo);
    void setOnline(bool online);
    bool operator<(const QTreeWidgetItem &other) const override;
};
 
class UserListWidget : public QGroupBox
{
    Q_OBJECT
public:
    enum UserListType
    {
        AllUsersList,
        RoomList,
        BuddyList,
        IgnoreList
    };
    enum class Section
    {
        Buddy,
        Online,
        Ignore
    };
 
private:
    UserListManager *manager = nullptr;
    UserAvatarProvider *avatarProvider = nullptr;
    UserCardArtProvider *cardArtProvider = nullptr;
    QMap<QString, CardArtParams> cardArtParamsMap;
    // ── Hover popup ───────────────────────────────────────────────────────────
    UserInfoPopup *userInfoPopup = nullptr;
    QTimer *showPopupTimer = nullptr;
    QTimer *hidePopupTimer = nullptr;
    QString hoveredUser;
    bool popupPinned = false;
    bool bulkLoading = false;
    bool hasUserInfoPopup = true;
    std::function<bool(const QString &userName, bool online)> userFilter;

    void showPopupForUser(UserListTWI *item);
    void hidePopup(bool immediate = false);
    void positionPopup(UserListTWI *item);
    void connectPopupSignals();
    bool isPressInsideListUi(const QWidget *widget) const;
    void clearSelectionAndClosePopup();
    bool isItemNearViewport(const UserListTWI *item) const;
    void requestVisibleItemResources();
 
    // Sectioned mode (single tree with inline dividers)
    bool sectioned = false;
    QList<Section> sectionIds;
    QMap<Section, QTreeWidgetItem *> sectionItems;
    // One row per (section, user): a user that is online AND a buddy appears in
    // both the "Online" and the "Buddies" sections, so the same user can own
    // several rows, each hanging off its section's divider.
    QMap<Section, QMap<QString, UserListTWI *>> sectionUsers;
    QSet<Section> expandedSections;
    void createSectionItems();
    QTreeWidgetItem *createSectionItem(Section section);
    [[nodiscard]] QString sectionTitle(Section section) const;
    void updateSectionDivider(Section section);
    void handleSectionExpansion(QTreeWidgetItem *item, bool expanded);
    void setExpandedProgrammatically(QTreeWidgetItem *item, bool expanded);
    void handleOnlineChange(const ServerInfo_User &user);
    void handleOnlineChangeLeft(const QString &userName);
    void handleListAdd(Section section, const ServerInfo_User &user);
    void handleListRemove(Section section, const QString &userName);
    UserListTWI *ensureSectionMembership(Section section, const ServerInfo_User &user, bool online);
    bool dropSectionMembership(Section section, const QString &userName);
    void finishSectionedMutation();
    void updateCardArtParams(const ServerInfo_User &user, const QString &userName);
    void processUserInfo(Section section, const ServerInfo_User &user, bool online);
 
    QMap<QString, UserListTWI *> users;
    TabSupervisor *tabSupervisor;
    AbstractClient *client;
    UserListType type;
    QTreeWidget *userTree = nullptr;
    UserListItemDelegate *itemDelegate;
    UserContextMenu *userContextMenu;
    int onlineCount;
    QString titleStr;
    QString filterText;
    bool showTitle = true;
    void updateCount();
    void applyFilter();
    void refreshPopupButtons(const QString &userName);
private slots:
    void userClicked(QTreeWidgetItem *item, int column);
    void refreshVisibleUserHeader(const QString &name);
signals:
    void openMessageDialog(const QString &userName, bool focus);
    void addBuddy(const QString &userName);
    void removeBuddy(const QString &userName);
    void addIgnore(const QString &userName);
    void removeIgnore(const QString &userName);
    void sectionExpanded(Section section, bool expanded);
    void userActivated(const QString &userName);
    void currentUserChanged(const QString &userName);
    void userListChanged();
 
public:
    UserListWidget(TabSupervisor *_tabSupervisor,
                   AbstractClient *_client,
                   UserListType _type,
                   QWidget *parent = nullptr,
                   bool hasUserInfoPopup = true);
    ~UserListWidget() override;
    void bind(UserListManager *mgr);
    void applyDisplayMode();
    void beginBulkLoad();
    void endBulkLoad();
    bool eventFilter(QObject *obj, QEvent *event) override;
    void retranslateUi();
    void rebuild();
    void processUserInfo(const ServerInfo_User &user, bool online);
    bool deleteUser(const QString &userName);
    void setUserOnline(const QString &userName, bool online);
    void setFilterText(const QString &text);
    void setShowTitle(bool showTitle);
    void setSectioned(const QList<Section> &ids);
    void setSectionExpanded(Section section, bool expanded);
    void setUserFilter(std::function<bool(const QString &userName, bool online)> filter)
    {
        userFilter = std::move(filter);
    }
    [[nodiscard]] int visibleUserRowCount() const;
    [[nodiscard]] bool getHasUserInfoPopup() const
    {
        return hasUserInfoPopup;
    }
    [[nodiscard]] const QList<Section> &getSectionIds() const
    {
        return sectionIds;
    }
    [[nodiscard]] const QMap<QString, UserListTWI *> &getUsers() const
    {
        return users;
    }
    void showContextMenu(const QPoint &pos, const QModelIndex &index);
    void sortItems();
    void setGameInviteLinkProvider(std::function<QList<GameInviteOption>()> provider);
 
protected:
    void hideEvent(QHideEvent *e) override;
    void showEvent(QShowEvent *e) override;
};
 
#endif