File indexing completed on 2024-05-12 09:02:07

 // SPDX-FileCopyrightText: 2020 Tobias Fella <tobias.fella@kde.org>
 // SPDX-License-Identifier: GPL-2.0-or-later
 
 #pragma once
 
 #include <QQmlEngine>
 #include <QSortFilterProxyModel>
 
 /**
  * @class SortFilterRoomListModel
  *
  * This model sorts and filters the room list.
  *
  * There are numerous room sort orders available:
  *  - Categories - sort rooms by their NeoChatRoomType and then by last activty within
  *                 each category.
  *  - LastActivity - sort rooms by the last active time in the room.
  *  - Alphabetical - sort the rooms alphabetically by room name.
  *
  * The model can be given a filter string that will only show rooms who's name includes
  * the text.
  *
  * The model can also be given an active space ID and will only show rooms within
  * that space.
  *
  * All space rooms and upgraded rooms will also be filtered out.
  */
 class SortFilterRoomListModel : public QSortFilterProxyModel
 {
     Q_OBJECT
     QML_ELEMENT
 
     /**
      * @brief The order by which the rooms will be sorted.
      *
      * @sa RoomSortOrder
      */
     Q_PROPERTY(RoomSortOrder roomSortOrder READ roomSortOrder WRITE setRoomSortOrder NOTIFY roomSortOrderChanged)
 
     /**
      * @brief The text to use to filter room names.
      */
     Q_PROPERTY(QString filterText READ filterText READ filterText WRITE setFilterText NOTIFY filterTextChanged)
 
     /**
      * @brief Set the ID of the space to show rooms for.
      */
     Q_PROPERTY(QString activeSpaceId READ activeSpaceId WRITE setActiveSpaceId NOTIFY activeSpaceIdChanged)
 
 public:
     enum RoomSortOrder {
         Alphabetical,
         LastActivity,
         Categories,
     };
     Q_ENUM(RoomSortOrder)
 
     explicit SortFilterRoomListModel(QObject *parent = nullptr);
 
     void setRoomSortOrder(RoomSortOrder sortOrder);
     [[nodiscard]] RoomSortOrder roomSortOrder() const;
 
     void setFilterText(const QString &text);
     [[nodiscard]] QString filterText() const;
 
     QString activeSpaceId() const;
     void setActiveSpaceId(const QString &spaceId);
 
 protected:
     /**
      * @brief Returns true if the value of source_left is less than source_right.
      *
      * @sa QSortFilterProxyModel::lessThan
      */
     [[nodiscard]] bool lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const override;
 
     /**
      * @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;
 
 Q_SIGNALS:
     void roomSortOrderChanged();
     void filterTextChanged();
     void activeSpaceIdChanged();
 
 private:
     RoomSortOrder m_sortOrder = Categories;
     QString m_filterText;
     QString m_activeSpaceId;
 };