File indexing completed on 2024-05-05 05:38:34

 /*
     SPDX-FileCopyrightText: 2016 Eike Hein <hein@kde.org>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #pragma once
 
 #include <QRect>
 #include <QSortFilterProxyModel>
 
 #include <memory>
 
 #include "abstracttasksproxymodeliface.h"
 #include "regionfiltermode.h"
 
 #include "taskmanager_export.h"
 
 namespace TaskManager
 {
 /**
  * @short A proxy tasks model filtering its source model by various properties.
  *
  * This proxy model class filters its source tasks model by properties such as
  * virtual desktop or minimixed state. The values to filter for or by are set
  * as properties on the proxy model instance.
  *
  * @author Eike Hein <hein@kde.org>
  **/
 
 class TASKMANAGER_EXPORT TaskFilterProxyModel : public QSortFilterProxyModel, public AbstractTasksProxyModelIface
 {
     Q_OBJECT
 
     Q_PROPERTY(QVariant virtualDesktop READ virtualDesktop WRITE setVirtualDesktop NOTIFY virtualDesktopChanged)
     Q_PROPERTY(QRect screenGeometry READ screenGeometry WRITE setScreenGeometry NOTIFY screenGeometryChanged)
     Q_PROPERTY(QRect regionGeometry READ regionGeometry WRITE setRegionGeometry NOTIFY regionGeometryChanged)
     Q_PROPERTY(QString activity READ activity WRITE setActivity NOTIFY activityChanged)
 
     Q_PROPERTY(bool filterByVirtualDesktop READ filterByVirtualDesktop WRITE setFilterByVirtualDesktop NOTIFY filterByVirtualDesktopChanged)
     Q_PROPERTY(bool filterByScreen READ filterByScreen WRITE setFilterByScreen NOTIFY filterByScreenChanged)
     Q_PROPERTY(bool filterByActivity READ filterByActivity WRITE setFilterByActivity NOTIFY filterByActivityChanged)
     Q_PROPERTY(RegionFilterMode::Mode filterByRegion READ filterByRegion WRITE setFilterByRegion NOTIFY filterByRegionChanged)
     Q_PROPERTY(bool filterMinimized READ filterMinimized WRITE setFilterMinimized NOTIFY filterMinimizedChanged)
     Q_PROPERTY(bool filterNotMinimized READ filterNotMinimized WRITE setFilterNotMinimized NOTIFY filterNotMinimizedChanged)
     Q_PROPERTY(bool filterNotMaximized READ filterNotMaximized WRITE setFilterNotMaximized NOTIFY filterNotMaximizedChanged)
     Q_PROPERTY(bool filterHidden READ filterHidden WRITE setFilterHidden NOTIFY filterHiddenChanged)
     Q_PROPERTY(bool filterSkipTaskbar READ filterSkipTaskbar WRITE setFilterSkipTaskbar NOTIFY filterSkipTaskbarChanged)
     Q_PROPERTY(bool filterSkipPager READ filterSkipPager WRITE setFilterSkipPager NOTIFY filterSkipPagerChanged)
 
     Q_PROPERTY(bool demandingAttentionSkipsFilters READ demandingAttentionSkipsFilters WRITE setDemandingAttentionSkipsFilters NOTIFY
                    demandingAttentionSkipsFiltersChanged)
 
 public:
     explicit TaskFilterProxyModel(QObject *parent = nullptr);
     ~TaskFilterProxyModel() override;
 
     void setSourceModel(QAbstractItemModel *sourceModel) override;
 
     /**
      * The id of the virtual desktop used in filtering by virtual
      * desktop. Usually set to the id of the current virtual desktop.
      * Defaults to empty.
      *
      * @see setVirtualDesktop
      * @returns the number of the virtual desktop used in filtering.
      **/
     QVariant virtualDesktop() const;
 
     /**
      * Set the id of the virtual desktop to use in filtering by virtual
      * desktop.
      *
      * If set to an empty id, filtering by virtual desktop is disabled.
      *
      * @see virtualDesktop
      * @param desktop A virtual desktop id (QString on Wayland; uint >0 on X11).
      **/
     void setVirtualDesktop(const QVariant &desktop = QVariant());
 
     /**
      * The geometry of the screen used in filtering by screen. Defaults
      * to a null QRect.
      *
      * @see setGeometryScreen
      * @returns the geometry of the screen used in filtering.
      **/
     QRect screenGeometry() const;
 
     /**
      * Set the geometry of the screen to use in filtering by screen.
      *
      * If set to an invalid QRect, filtering by screen is disabled.
      *
      * @see screenGeometry
      * @param geometry A screen geometry.
      **/
     void setScreenGeometry(const QRect &geometry);
 
     /**
      * The geometry of the region used in filtering by region. Defaults
      * to a null QRect.
      *
      * @see setRegionGeometry
      * @since 6.0
      * @returns the geometry of the region used in filtering.
      **/
     QRect regionGeometry() const;
 
     /**
      * Set the geometry of the screen to use in filtering by region.
      *
      * If set to an invalid QRect, filtering by region is disabled.
      *
      * @see regionGeometry
      * @since 6.0
      * @param geometry A region geometry.
      **/
     void setRegionGeometry(const QRect &geometry);
 
     /**
      * The id of the activity used in filtering by activity. Usually
      * set to the id of the current activity. Defaults to an empty id.
      *
      * @see setActivity
      * @returns the id of the activity used in filtering.
      **/
     QString activity() const;
 
     /**
      * Set the id of the activity to use in filtering by activity.
      *
      * @see activity
      * @param activity An activity id.
      **/
     void setActivity(const QString &activity);
 
     /**
      * Whether tasks should be filtered by virtual desktop. Defaults to
      * @c false.
      *
      * Filtering by virtual desktop only happens if a virtual desktop
      * number greater than -1 is set, even if this returns @c true.
      *
      * @see setFilterByVirtualDesktop
      * @see setVirtualDesktop
      * @returns @c true if tasks should be filtered by virtual desktop.
      **/
     bool filterByVirtualDesktop() const;
 
     /**
      * Set whether tasks should be filtered by virtual desktop.
      *
      * Filtering by virtual desktop only happens if a virtual desktop
      * number is set, even if this is set to @c true.
      *
      * @see filterByVirtualDesktop
      * @see setVirtualDesktop
      * @param filter Whether tasks should be filtered by virtual desktop.
      **/
     void setFilterByVirtualDesktop(bool filter);
 
     /**
      * Whether tasks should be filtered by screen. Defaults to @c false.
      *
      * Filtering by screen only happens if a screen number is set, even
      * if this returns @c true.
      *
      * @see setFilterByScreen
      * @see setScreenGeometry
      * @returns @c true if tasks should be filtered by screen.
      **/
     bool filterByScreen() const;
 
     /**
      * Set whether tasks should be filtered by screen.
      *
      * Filtering by screen only happens if a screen number is set, even
      * if this is set to @c true.
      *
      * @see filterByScreen
      * @see setScreenGeometry
      * @param filter Whether tasks should be filtered by screen.
      **/
     void setFilterByScreen(bool filter);
 
     /**
      * Whether tasks should be filtered by activity. Defaults to @c false.
      *
      * Filtering by activity only happens if an activity id is set, even
      * if this returns @c true.
      *
      * @see setFilterByActivity
      * @see setActivity
      * @returns @ctrue if tasks should be filtered by activity.
      **/
     bool filterByActivity() const;
 
     /**
      * Set whether tasks should be filtered by activity. Defaults to
      * @c false.
      *
      * Filtering by activity only happens if an activity id is set,
      * even if this is set to @c true.
      *
      * @see filterByActivity
      * @see setActivity
      * @param filter Whether tasks should be filtered by activity.
      **/
     void setFilterByActivity(bool filter);
 
     /**
      * Whether tasks should be filtered by region. Defaults to @c RegionFilterMode::Disabled.
      *
      * Filtering by region only happens if a region is set, even
      * if the filter is enabled.
      *
      * @see RegionFilterMode
      * @see setFilterByRegion
      * @see setRegionGeometry
      * @since 6.0
      * @returns Region filter mode.
      **/
     RegionFilterMode::Mode filterByRegion() const;
 
     /**
      * Set whether tasks should be filtered by region. Defaults to
      * @c RegionFilterMode::Disabled.
      *
      * Filtering by region only happens if a region is set,
      * even if the filter is enabled.
      *
      * @see RegionFilterMode
      * @see filterByRegion
      * @see setRegionGeometry
      * @since 6.0
      * @param mode Region filter mode.
      **/
     void setFilterByRegion(RegionFilterMode::Mode mode);
 
     /**
      * Whether minimized tasks should be filtered out. Defaults to
      * @c false.
      *
      * @returns @c true if minimized tasks should be filtered out.
      * @see setFilterMinimized
      * @since 5.27
      **/
     bool filterMinimized() const;
 
     /**
      * Sets whether non-minimized tasks should be filtered out.
      *
      * @param filter Whether minimized tasks should be filtered out.
      * @see filterMinimized
      * @since 5.27
      **/
     void setFilterMinimized(bool filter);
 
     /**
      * Whether non-minimized tasks should be filtered. Defaults to
      * @c false.
      *
      * @see setFilterNotMinimized
      * @returns @c true if non-minimized tasks should be filtered.
      **/
     bool filterNotMinimized() const;
 
     /**
      * Set whether non-minimized tasks should be filtered.
      *
      * @see filterNotMinimized
      * @param filter Whether non-minimized tasks should be filtered.
      **/
     void setFilterNotMinimized(bool filter);
 
     /**
      * Whether non-maximized tasks should be filtered. Defaults to
      * @c false.
      *
      * @see setFilterNotMaximized
      * @returns @c true if non-maximized tasks should be filtered.
      **/
     bool filterNotMaximized() const;
 
     /**
      * Set whether non-maximized tasks should be filtered.
      *
      * @see filterNotMaximized
      * @param filter Whether non-maximized tasks should be filtered.
      **/
     void setFilterNotMaximized(bool filter);
 
     /**
      * Whether hidden tasks should be filtered. Defaults to
      * @c false.
      *
      * @see setFilterHidden
      * @returns @c true if hidden tasks should be filtered.
      **/
     bool filterHidden() const;
 
     /**
      * Set whether hidden tasks should be filtered.
      *
      * @see filterHidden
      * @param filter Whether hidden tasks should be filtered.
      **/
     void setFilterHidden(bool filter);
 
     /**
      * Whether tasks which should be omitted from 'task bars' should be
      * filtered. Defaults to @c true.
      *
      * @see setFilterSkipTaskbar
      * @returns @c true if tasks which should not be on the 'task bar'
      * should be filtered.
      **/
     bool filterSkipTaskbar() const;
 
     /**
      * Set whether tasks which should be omitted from 'task bars' should be
      * filtered.
      *
      * @see filterSkipTaskbar
      * @param filter Whether tasks whichs should not be on the 'task bar'
      * should be filtered.
      **/
     void setFilterSkipTaskbar(bool filter);
 
     /**
      * Whether tasks which should be omitted from 'pagers' should be
      * filtered. Defaults to @c true.
      *
      * @see setFilterSkipPager
      * @returns @c true if tasks which should not be on the 'pager' should
      * be filtered.
      **/
     bool filterSkipPager() const;
 
     /**
      * Set whether tasks which should be omitted from 'pagers' should be
      * filtered.
      *
      * @see filterSkipPager
      * @param filter Whether tasks which should not be on the 'pager' should
      * be filtered.
      **/
     void setFilterSkipPager(bool filter);
 
     /**
      * Whether tasks which demand attention skip filters by virtual desktop
      * or activity. Defaults to @c true.
      *
      * @see setDemandingAttentionSkipsFilters
      * @returns @c true if tasks which demand attention skip filters.
      **/
     bool demandingAttentionSkipsFilters() const;
 
     /**
      * Sets whether tasks which demand attention should bypass filters by
      * virtual desktop or activity.
      *
      * @see demandingAttentionSkipsFilters
      * @param skip Whether tasks which demand attention should skip filters.
      **/
     void setDemandingAttentionSkipsFilters(bool skip);
 
     /**
      * Returns whether the filter model accepts this source row.
      *
      * @param int A row in the source model.
      */
     bool acceptsRow(int sourceRow) const;
 
 Q_SIGNALS:
     void virtualDesktopChanged() const;
     void screenGeometryChanged() const;
     void regionGeometryChanged();
     void activityChanged() const;
     void filterByVirtualDesktopChanged() const;
     void filterByScreenChanged() const;
     void filterByActivityChanged() const;
     void filterByRegionChanged();
     void filterMinimizedChanged();
     void filterNotMinimizedChanged() const;
     void filterNotMaximizedChanged() const;
     void filterHiddenChanged() const;
     void filterSkipTaskbarChanged() const;
     void filterSkipPagerChanged() const;
     void demandingAttentionSkipsFiltersChanged() const;
 
 protected:
     bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override;
     QModelIndex mapIfaceToSource(const QModelIndex &index) const override;
 
 private:
     class Private;
     std::unique_ptr<Private> d;
 };
 
 }