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

 /*
     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 <QObject>
 
 #include "taskmanager_export.h"
 
 namespace TaskManager
 {
 /**
  * @short Pure virtual method interface for tasks model implementations.
  *
  * This is the pure virtual method interface implemented by AbstractTasksModel,
  * as well as other model classes in this library which cannot inherit from
  * AbstractTasksModel.
  *
  * @author Eike Hein <hein@kde.org>
  **/
 
 class TASKMANAGER_EXPORT AbstractTasksModelIface
 {
 public:
     virtual ~AbstractTasksModelIface()
     {
     }
 
     /**
      * Request activation of the task at the given index. Implementing classes
      * are free to interpret the meaning of "activate" themselves depending on
      * the nature and state of the task, e.g. launch or raise a window task.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestActivate(const QModelIndex &index) = 0;
 
     /**
      * Request an additional instance of the application backing the task at
      * the given index.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestNewInstance(const QModelIndex &index) = 0;
 
     /**
      * Requests to open the given URLs with the application backing the task
      * at the given index.
      *
      * @param index An index in this tasks model.
      * @param urls The URLs to be passed to the application.
      **/
     virtual void requestOpenUrls(const QModelIndex &index, const QList<QUrl> &urls) = 0;
 
     /**
      * Request the task at the given index be closed.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestClose(const QModelIndex &index) = 0;
 
     /**
      * Request starting an interactive move for the task at the given index.
      *
      * This is meant for tasks that have an associated window, and may be
      * a no-op when there is no window.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestMove(const QModelIndex &index) = 0;
 
     /**
      * Request starting an interactive resize for the task at the given index.
      *
      * This is meant for tasks that have an associated window, and may be a
      * no-op when there is no window.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestResize(const QModelIndex &index) = 0;
 
     /**
      * Request toggling the minimized state of the task at the given index.
      *
      * This is meant for tasks that have an associated window, and may be
      * a no-op when there is no window.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestToggleMinimized(const QModelIndex &index) = 0;
 
     /**
      * Request toggling the maximized state of the task at the given index.
      *
      * This is meant for tasks that have an associated window, and may be
      * a no-op when there is no window.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestToggleMaximized(const QModelIndex &index) = 0;
 
     /**
      * Request toggling the keep-above state of the task at the given index.
      *
      * This is meant for tasks that have an associated window, and may be
      * a no-op when there is no window.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestToggleKeepAbove(const QModelIndex &index) = 0;
 
     /**
      * Request toggling the keep-below state of the task at the given index.
      *
      * This is meant for tasks that have an associated window, and may be
      * a no-op when there is no window.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestToggleKeepBelow(const QModelIndex &index) = 0;
 
     /**
      * Request toggling the fullscreen state of the task at the given index.
      *
      * This is meant for tasks that have an associated window, and may be
      * a no-op when there is no window.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestToggleFullScreen(const QModelIndex &index) = 0;
 
     /**
      * Request toggling the shaded state of the task at the given index.
      *
      * This is meant for tasks that have an associated window, and may be
      * a no-op when there is no window.
      *
      * @param index An index in this tasks model.
      **/
     virtual void requestToggleShaded(const QModelIndex &index) = 0;
 
     /**
      * Request entering the window at the given index on the specified virtual desktops,
      * leaving any other desktops.
      *
      * On Wayland, virtual desktop ids are QStrings. On X11, they are uint >0.
      *
      * An empty list has a special meaning: The window is entered on all virtual desktops
      * in the session.
      *
      * On X11, a window can only be on one or all virtual desktops. Therefore, only the
      * first list entry is actually used.
      *
      * On X11, the id 0 has a special meaning: The window is entered on all virtual
      * desktops in the session.
      *
      * @param index An index in this window tasks model.
      * @param desktops A list of virtual desktop ids.
      **/
     virtual void requestVirtualDesktops(const QModelIndex &index, const QVariantList &desktops) = 0;
 
     /**
      * Request entering the window at the given index on a new virtual desktop,
      * which is created in response to this request.
      *
      * @param index An index in this window tasks model.
      **/
     virtual void requestNewVirtualDesktop(const QModelIndex &index) = 0;
 
     /**
      * Request moving the task at the given index to the specified virtual
      * activities.
      *
      * This is meant for tasks that have an associated window, and may be
      * a no-op when there is no window.
      *
      * @param index An index in this tasks model.
      * @param activities The new list of activities.
      **/
     virtual void requestActivities(const QModelIndex &index, const QStringList &activities) = 0;
 
     /**
      * Request informing the window manager of new geometry for a visual
      * delegate for the task at the given index. The geometry should be in
      * screen coordinates.
      *
      * FIXME: Doesn't deal with the long-standing problem of multiple
      * delegates in multiple applets.
      *
      * @param index An index in this tasks model.
      * @param geometry Visual delegate geometry in screen coordinates.
      * @param delegate The delegate. Implementations are on their own with
      * regard to extracting information from this, and should take care to
      * reject invalid objects.
      **/
     virtual void requestPublishDelegateGeometry(const QModelIndex &index, const QRect &geometry, QObject *delegate = nullptr) = 0;
 };
 
 }