#include <kis_queues_progress_updater.h>

Inheritance diagram for KisQueuesProgressUpdater:

Signals
void	sigStartTicking ()

void	sigStopTicking ()

Public Member Functions
void	hide ()

	KisQueuesProgressUpdater (KoProgressProxy progressProxy, QObject parent=0)

	Private (KisQueuesProgressUpdater *q)

void	updateProgress (int queueSizeMetric, const QString &jobName)

	~KisQueuesProgressUpdater () override

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Public Attributes
int	initialQueueSizeMetric

QString	jobName

QMutex	mutex

KoProgressProxy *	progressProxy

int	queueSizeMetric

QTimer	startDelayTimer

bool	tickingRequested

QTimer	timer

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Static Public Attributes
static const int	PROGRESS_DELAY = 1000

static const int	TIMER_INTERVAL = 500

Private Slots
void	startTicking ()

void	stopTicking ()

void	timerTicked ()

Private Attributes
Private *const	m_d

Detailed Description

Definition at line 15 of file kis_queues_progress_updater.cpp.

Constructor & Destructor Documentation

◆ KisQueuesProgressUpdater()

KisQueuesProgressUpdater::KisQueuesProgressUpdater	(	KoProgressProxy *	progressProxy,
		QObject *	parent = 0 )

Definition at line 44 of file kis_queues_progress_updater.cpp.

    : QObject(parent),
      m_d(new Private(this))
{
    m_d->progressProxy = progressProxy;
 
    m_d->timer.setInterval(Private::TIMER_INTERVAL);
    m_d->timer.setSingleShot(false);
 
    connect(this, SIGNAL(sigStartTicking()), SLOT(startTicking()), Qt::QueuedConnection);
    connect(this, SIGNAL(sigStopTicking()), SLOT(stopTicking()), Qt::QueuedConnection);
    connect(&m_d->timer, SIGNAL(timeout()), SLOT(timerTicked()));
 
    m_d->startDelayTimer.setInterval(Private::PROGRESS_DELAY);
    m_d->startDelayTimer.setSingleShot(true);
 
    connect(&m_d->startDelayTimer, SIGNAL(timeout()), &m_d->timer, SLOT(start()));
    connect(&m_d->startDelayTimer, SIGNAL(timeout()), SLOT(timerTicked()));
}

References connect(), m_d, progressProxy, sigStartTicking(), sigStopTicking(), startTicking(), stopTicking(), and timerTicked().

◆ ~KisQueuesProgressUpdater()

KisQueuesProgressUpdater::~KisQueuesProgressUpdater ( )

override

Definition at line 64 of file kis_queues_progress_updater.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

◆ hide()

void KisQueuesProgressUpdater::hide ( )

Definition at line 97 of file kis_queues_progress_updater.cpp.

{
    updateProgress(0, "");
}

References updateProgress().

◆ Private()

KisQueuesProgressUpdater::Private ( KisQueuesProgressUpdater * q )

inline

Definition at line 17 of file kis_queues_progress_updater.cpp.

        : timer(q)
        , startDelayTimer(q)
        , queueSizeMetric(0)
        , initialQueueSizeMetric(0)
        , progressProxy(0)
        , tickingRequested(false)
    {
    }

◆ sigStartTicking

void KisQueuesProgressUpdater::sigStartTicking ( )

signal

◆ sigStopTicking

void KisQueuesProgressUpdater::sigStopTicking ( )

signal

◆ startTicking

void KisQueuesProgressUpdater::startTicking ( )

privateslot

Definition at line 102 of file kis_queues_progress_updater.cpp.

{
    m_d->startDelayTimer.start();
}

References m_d.

◆ stopTicking

void KisQueuesProgressUpdater::stopTicking ( )

privateslot

Definition at line 107 of file kis_queues_progress_updater.cpp.

{
    m_d->startDelayTimer.stop();
    m_d->timer.stop();
    timerTicked();
}

References m_d, and timerTicked().

◆ timerTicked

void KisQueuesProgressUpdater::timerTicked ( )

privateslot

Definition at line 114 of file kis_queues_progress_updater.cpp.

{
    QMutexLocker locker(&m_d->mutex);
 
    if (!m_d->initialQueueSizeMetric) {
        m_d->progressProxy->setRange(0, 100);
        m_d->progressProxy->setValue(100);
        m_d->progressProxy->setFormat("%p%");
    } else {
        m_d->progressProxy->setRange(0, m_d->initialQueueSizeMetric);
        m_d->progressProxy->setValue(m_d->initialQueueSizeMetric - m_d->queueSizeMetric);
        m_d->progressProxy->setFormat(m_d->jobName);
    }
}

References m_d.

◆ updateProgress()

void KisQueuesProgressUpdater::updateProgress	(	int	queueSizeMetric,
		const QString &	jobName )

Definition at line 69 of file kis_queues_progress_updater.cpp.

{
    QMutexLocker locker(&m_d->mutex);
 
    m_d->queueSizeMetric = queueSizeMetric;
 
    if (queueSizeMetric &&
        (jobName != m_d->jobName ||
         m_d->queueSizeMetric > m_d->initialQueueSizeMetric)) {
 
        m_d->jobName = jobName;
        m_d->initialQueueSizeMetric = m_d->queueSizeMetric;
    }
 
    if (m_d->queueSizeMetric && !m_d->tickingRequested) {
 
        m_d->tickingRequested = true;
        Q_EMIT sigStartTicking();
 
    } else if (!m_d->queueSizeMetric && m_d->tickingRequested) {
 
        m_d->initialQueueSizeMetric = 0;
        m_d->jobName.clear();
        m_d->tickingRequested = false;
        Q_EMIT sigStopTicking();
    }
}