KisIdleTasksManager::TaskGuard Struct Reference

#include <KisIdleTasksManager.h>

Public Member Functions
bool	isValid () const
TaskGuard &	operator= (const TaskGuard &rhs)=delete
TaskGuard &	operator= (TaskGuard &&rhs)
	TaskGuard ()
	TaskGuard (const TaskGuard &rhs)=delete
	TaskGuard (int _taskId, QPointer< KisIdleTasksManager > _manager)
	TaskGuard (TaskGuard &&rhs)
void	trigger ()
	~TaskGuard ()

Public Attributes
QPointer< KisIdleTasksManager >	manager
int	taskId = -1

Detailed Description

A simple movable handle that represents a task registered in the manager. When the handle is destroyed, the task it automatically de-registered.

Definition at line 56 of file KisIdleTasksManager.h.

Constructor & Destructor Documentation

TaskGuard() [1/4]

KisIdleTasksManager::TaskGuard::TaskGuard ( )

inline

Definition at line 57 of file KisIdleTasksManager.h.

{}

TaskGuard() [2/4]

KisIdleTasksManager::TaskGuard::TaskGuard ( int _taskId, QPointer< KisIdleTasksManager > _manager )

inline

Definition at line 58 of file KisIdleTasksManager.h.

            : taskId(_taskId)
            , manager(_manager)
        {}

TaskGuard() [3/4]

KisIdleTasksManager::TaskGuard::TaskGuard ( const TaskGuard & rhs )

delete

TaskGuard() [4/4]

KisIdleTasksManager::TaskGuard::TaskGuard ( TaskGuard && rhs )

inline

Definition at line 67 of file KisIdleTasksManager.h.

                                   {
            std::swap(taskId, rhs.taskId);
            std::swap(manager, rhs.manager);
        };

~TaskGuard()

KisIdleTasksManager::TaskGuard::~TaskGuard ( )

inline

Definition at line 78 of file KisIdleTasksManager.h.

                     {
            if (manager) {
                manager->removeIdleTask(taskId);
            }
        }

Member Function Documentation

isValid()

bool KisIdleTasksManager::TaskGuard::isValid ( ) const

inline

Returns

true if the task is valid and registered at the manager

Definition at line 87 of file KisIdleTasksManager.h.

                             {
            return manager;
        }

operator=() [1/2]

TaskGuard & KisIdleTasksManager::TaskGuard::operator= ( const TaskGuard & rhs )

delete

operator=() [2/2]

TaskGuard & KisIdleTasksManager::TaskGuard::operator= ( TaskGuard && rhs )

inline

Definition at line 72 of file KisIdleTasksManager.h.

                                              {
            std::swap(taskId, rhs.taskId);
            std::swap(manager, rhs.manager);
            return *this;
        }

trigger()

void KisIdleTasksManager::TaskGuard::trigger ( )

inline

Explicitly request restart of the task, e.g. explicitly restart recalculation of the overview image when the display profile is changed

Definition at line 96 of file KisIdleTasksManager.h.

                       {
            KIS_SAFE_ASSERT_RECOVER_RETURN(manager);
            manager->triggerIdleTask(taskId);
        }

References KIS_SAFE_ASSERT_RECOVER_RETURN.

Member Data Documentation

manager

QPointer<KisIdleTasksManager> KisIdleTasksManager::TaskGuard::manager

Definition at line 102 of file KisIdleTasksManager.h.

taskId

int KisIdleTasksManager::TaskGuard::taskId = -1

Definition at line 101 of file KisIdleTasksManager.h.

---

The documentation for this struct was generated from the following file:

• libs/ui/KisIdleTasksManager.h