KisAsyncActionFeedback Class Reference

#include <kis_async_action_feedback.h>

Classes
struct	DefaultWaitingMessageCallback
struct	MutexLike
struct	MutexLikeBase
class	MutexWrapper
struct	Private

Public Member Functions
	KisAsyncActionFeedback (const QString &message, QWidget *parent)
KisImportExportErrorCode	runAction (std::function< KisImportExportErrorCode()> func)
void	runVoidAction (std::function< void()> func)
template<typename Mutex >
void	waitForMutex (Mutex &mutex)
	~KisAsyncActionFeedback ()

Private Member Functions
void	waitForMutexLikeImpl (std::unique_ptr< MutexLikeBase > &&mutex)

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

Definition at line 17 of file kis_async_action_feedback.h.

Constructor & Destructor Documentation

KisAsyncActionFeedback()

KisAsyncActionFeedback::KisAsyncActionFeedback	(	const QString &	message,
		QWidget *	parent )

Definition at line 18 of file kis_async_action_feedback.cpp.

    : m_d(new Private)
{
    m_d->progress.reset(new QProgressDialog(message, "", 0, 0, parent));
    m_d->progress->setWindowModality(Qt::ApplicationModal);
    m_d->progress->setCancelButton(0);
    m_d->progress->setMinimumDuration(1000);
    m_d->progress->setValue(0);
 
    // disable close button
    m_d->progress->setWindowFlags(Qt::CustomizeWindowHint | Qt::WindowTitleHint);
}

References m_d.

~KisAsyncActionFeedback()

KisAsyncActionFeedback::~KisAsyncActionFeedback

(

)

Definition at line 31 of file kis_async_action_feedback.cpp.

{
}

Member Function Documentation

runAction()

KisImportExportErrorCode KisAsyncActionFeedback::runAction

(

std::function< KisImportExportErrorCode()>

func

)

Definition at line 50 of file kis_async_action_feedback.cpp.

{
    return runActionImpl(func);
}

References runActionImpl().

runVoidAction()

void KisAsyncActionFeedback::runVoidAction

(

std::function< void()>

func

)

Definition at line 55 of file kis_async_action_feedback.cpp.

{
    QFuture<void> result = QtConcurrent::run(func);
    QFutureWatcher<void> watcher;
    watcher.setFuture(result);
 
    while (watcher.isRunning()) {
        qApp->processEvents(QEventLoop::ExcludeUserInputEvents);
    }
 
    watcher.waitForFinished();
}

waitForMutex()

template<typename Mutex >

void KisAsyncActionFeedback::waitForMutex ( Mutex & mutex )

inline

Definition at line 32 of file kis_async_action_feedback.h.

                                    {
        waitForMutexLikeImpl(std::make_unique<MutexLike<Mutex>>(mutex));
    }

References mutex, and waitForMutexLikeImpl().

waitForMutexLikeImpl()

void KisAsyncActionFeedback::waitForMutexLikeImpl ( std::unique_ptr< MutexLikeBase > && mutex )

private

Definition at line 68 of file kis_async_action_feedback.cpp.

{
    while (!mutex->try_lock()) {
        qApp->processEvents(QEventLoop::ExcludeUserInputEvents);
    }
 
    mutex->unlock();
}

References mutex.

Member Data Documentation

m_d

const QScopedPointer<Private> KisAsyncActionFeedback::m_d

private

Definition at line 94 of file kis_async_action_feedback.h.

---

The documentation for this class was generated from the following files:

• libs/ui/kis_async_action_feedback.h
• libs/ui/kis_async_action_feedback.cpp