KisProgressWidget Class Reference

#include <kis_progress_widget.h>

Inheritance diagram for KisProgressWidget:

Public Slots
void	cancel ()
void	correctVisibility (int progressValue)

Signals
void	sigCancellationRequested ()

Public Member Functions
void	attachUpdater (KoProgressUpdater *updater) override
void	detachUpdater (KoProgressUpdater *updater) override
	KisProgressWidget (QWidget *parent=0)
KoProgressProxy *	progressProxy ()
	~KisProgressWidget () override
Public Member Functions inherited from KisProgressInterface
virtual	~KisProgressInterface ()
virtual	~KoProgressInterface ()

Private Attributes
QList< KoProgressUpdater * >	m_activeUpdaters
QToolButton *	m_cancelButton
KoProgressBar *	m_progressBar

Detailed Description

KisProgressWidget combines a KoProgressBar with a button that can be pressed to cancel the current action.

Definition at line 27 of file kis_progress_widget.h.

Constructor & Destructor Documentation

KisProgressWidget()

KisProgressWidget::KisProgressWidget

(

QWidget *

parent = 0

)

Definition at line 21 of file kis_progress_widget.cpp.

        : QWidget(parent)
{
    QHBoxLayout* layout = new QHBoxLayout(this);
    m_cancelButton = new QToolButton(this);
    m_cancelButton->setIcon(KisIconUtils::loadIcon("process-stop"));
 
    QSizePolicy sizePolicy = m_cancelButton->sizePolicy();
    sizePolicy.setVerticalPolicy(QSizePolicy::Ignored);
    m_cancelButton->setSizePolicy(sizePolicy);
 
    connect(m_cancelButton, SIGNAL(clicked()), this, SLOT(cancel()));
 
    m_progressBar = new KoProgressBar(this);
    // fixme:connect to the visibility changed signal if exists
    connect(m_progressBar, SIGNAL(valueChanged(int)), SLOT(correctVisibility(int)));
    layout->addWidget(m_progressBar);
    layout->addWidget(m_cancelButton);
    layout->setContentsMargins(0, 0, 0, 0);
 
    m_progressBar->setVisible(false);
    m_cancelButton->setVisible(false);
 
    setMaximumWidth(225);
    setMinimumWidth(225);
}

References cancel(), connect(), correctVisibility(), KisIconUtils::loadIcon(), m_cancelButton, and m_progressBar.

~KisProgressWidget()

KisProgressWidget::~KisProgressWidget ( )

override

Definition at line 48 of file kis_progress_widget.cpp.

{
}

Member Function Documentation

attachUpdater()

void KisProgressWidget::attachUpdater ( KoProgressUpdater * updater )

overridevirtual

Implements KisProgressInterface.

Definition at line 83 of file kis_progress_widget.cpp.

{
    m_activeUpdaters << updater;
}

References m_activeUpdaters.

cancel

void KisProgressWidget::cancel ( )

slot

Definition at line 57 of file kis_progress_widget.cpp.

{
    Q_FOREACH (KoProgressUpdater* updater, m_activeUpdaters) {
        updater->cancel();
    }
    Q_EMIT sigCancellationRequested();
}

References KoProgressUpdater::cancel(), m_activeUpdaters, and sigCancellationRequested().

correctVisibility

void KisProgressWidget::correctVisibility ( int progressValue )

slot

Definition at line 65 of file kis_progress_widget.cpp.

{
    // TODO: this check duplicates code in KoProgressBar::setValue()
 
    const bool visibility =
        m_progressBar->minimum() == m_progressBar->maximum() ||
        (progressValue >= m_progressBar->minimum() &&
         progressValue < m_progressBar->maximum());
 
    m_progressBar->setVisible(visibility);
    m_cancelButton->setVisible(visibility);
}

References m_cancelButton, m_progressBar, and KoProgressBar::maximum().

detachUpdater()

void KisProgressWidget::detachUpdater ( KoProgressUpdater * updater )

overridevirtual

create a new KoProgressUpdater instance that is linked to this progress bar.

Note: it is your duty to call deleteLater on the koprogressupdater when you are done!

Implements KisProgressInterface.

Definition at line 78 of file kis_progress_widget.cpp.

{
    m_activeUpdaters.removeOne(updater);
}

References m_activeUpdaters.

progressProxy()

KoProgressProxy * KisProgressWidget::progressProxy

(

)

Definition at line 52 of file kis_progress_widget.cpp.

{
    return m_progressBar;
}

References m_progressBar.

sigCancellationRequested

void KisProgressWidget::sigCancellationRequested ( )

signal

Member Data Documentation

m_activeUpdaters

QList<KoProgressUpdater*> KisProgressWidget::m_activeUpdaters

private

Definition at line 62 of file kis_progress_widget.h.

m_cancelButton

QToolButton* KisProgressWidget::m_cancelButton

private

Definition at line 60 of file kis_progress_widget.h.

m_progressBar

KoProgressBar* KisProgressWidget::m_progressBar

private

Definition at line 61 of file kis_progress_widget.h.

---

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

• libs/ui/widgets/kis_progress_widget.h
• libs/ui/widgets/kis_progress_widget.cpp