Files
neochat/src/models/statemodel.h
2023-04-22 08:31:28 +00:00

67 lines
1.5 KiB
C++

// SPDX-FileCopyrightText: 2022 Tobias Fella <tobias.fella@kde.org>
// SPDX-License-Identifier: LGPL-2.0-or-later
#pragma once
#include <QAbstractListModel>
#include "neochatroom.h"
/**
* @class StateModel
*
* This class defines the model for visualising the state events in a room.
*/
class StateModel : public QAbstractListModel
{
Q_OBJECT
/**
* @brief The current room that the model is getting its state events from.
*/
Q_PROPERTY(NeoChatRoom *room READ room WRITE setRoom NOTIFY roomChanged)
public:
/**
* @brief Defines the model roles.
*/
enum Roles {
TypeRole, /**< The type of the state event. */
StateKeyRole, /**< The state key of the state event. */
SourceRole, /**< The full event source JSON. */
};
Q_ENUM(Roles);
StateModel(QObject *parent = nullptr);
NeoChatRoom *room() const;
void setRoom(NeoChatRoom *room);
/**
* @brief Get the given role value at the given index.
*
* @sa QAbstractItemModel::data
*/
QVariant data(const QModelIndex &index, int role) 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;
Q_SIGNALS:
void roomChanged();
private:
NeoChatRoom *m_room = nullptr;
};