KisBusyProgressIndicator Class Reference

#include <kis_busy_progress_indicator.h>

Inheritance diagram for KisBusyProgressIndicator:

Classes
struct	Private

Public Slots
void	update ()

Signals
void	sigStartTimer ()

Public Member Functions
	KisBusyProgressIndicator (KoProgressProxy *progressProxy)
void	prepareDestroying ()
	~KisBusyProgressIndicator () override

Private Slots
void	slotStartTimer ()
void	timerFinished ()

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

Definition at line 15 of file kis_busy_progress_indicator.h.

Constructor & Destructor Documentation

KisBusyProgressIndicator()

KisBusyProgressIndicator::KisBusyProgressIndicator ( KoProgressProxy * progressProxy )

explicit

Definition at line 50 of file kis_busy_progress_indicator.cpp.

    : m_d(new Private(this))
{
    connect(m_d->timer, SIGNAL(timeout()), SLOT(timerFinished()));
    connect(this, SIGNAL(sigStartTimer()), SLOT(slotStartTimer()));
    m_d->timer->setInterval(200);
    m_d->progressProxy = progressProxy;
}

References connect(), m_d, sigStartTimer(), slotStartTimer(), and timerFinished().

~KisBusyProgressIndicator()

KisBusyProgressIndicator::~KisBusyProgressIndicator ( )

override

Definition at line 59 of file kis_busy_progress_indicator.cpp.

{
    m_d->stopProgressReport();
}

References m_d.

Member Function Documentation

prepareDestroying()

void KisBusyProgressIndicator::prepareDestroying

(

)

To be called when progressProxy is and will be no longer available and this object is going to be deleted as well.

Definition at line 64 of file kis_busy_progress_indicator.cpp.

{
    m_d->progressProxy = 0;
}

References m_d.

sigStartTimer

void KisBusyProgressIndicator::sigStartTimer ( )

signal

slotStartTimer

void KisBusyProgressIndicator::slotStartTimer ( )

privateslot

Call only via emitting sigStartTimer, to ensure it is called in the context of the QObject's thread.

Definition at line 95 of file kis_busy_progress_indicator.cpp.

{
    m_d->timerStarted.ref();
    m_d->timer->start();
    m_d->startProgressReport();
}

References m_d.

timerFinished

void KisBusyProgressIndicator::timerFinished ( )

privateslot

Definition at line 69 of file kis_busy_progress_indicator.cpp.

{
    int value = m_d->numUpdates.fetchAndStoreOrdered(0);
 
    if (!value) {
        m_d->numEmptyTicks++;
 
        if (m_d->numEmptyTicks > 2) {
            m_d->timerStarted = 0;
            m_d->timer->stop();
            m_d->stopProgressReport();
        }
    } else {
        m_d->numEmptyTicks = 0;
    }
}

References m_d, and value().

update

void KisBusyProgressIndicator::update ( )

slot

Trigger update of progress state.

Definition at line 86 of file kis_busy_progress_indicator.cpp.

{
    m_d->numUpdates.ref();
 
    if (!m_d->timerStarted) {
        Q_EMIT sigStartTimer();
    }
}

References m_d, and sigStartTimer().

Member Data Documentation

m_d

const QScopedPointer<Private> KisBusyProgressIndicator::m_d

private

Definition at line 48 of file kis_busy_progress_indicator.h.

---

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

• libs/image/kis_busy_progress_indicator.h
• libs/image/kis_busy_progress_indicator.cpp