KisWidgetWithIdleTask< BaseWidget > Class Template Reference

#include <KisWidgetWithIdleTask.h>

Inheritance diagram for KisWidgetWithIdleTask< BaseWidget >:

Public Member Functions
virtual void	clearCachedState ()=0
void	hideEvent (QHideEvent *event) override
	KisWidgetWithIdleTask (QWidget *parent=0, Qt::WindowFlags flags=Qt::WindowFlags())
virtual KisIdleTasksManager::TaskGuard	registerIdleTask (KisCanvas2 *canvas)=0
virtual void	setCanvas (KisCanvas2 *canvas)
void	showEvent (QShowEvent *event) override
void	triggerCacheUpdate ()
	~KisWidgetWithIdleTask () override=default

Protected Attributes
KisCanvas2 *	m_canvas {0}
KisIdleTasksManager::TaskGuard	m_idleTaskGuard
bool	m_isVisibleState {false}

Detailed Description

template<typename BaseWidget>
class KisWidgetWithIdleTask< BaseWidget >

Definition at line 16 of file KisWidgetWithIdleTask.h.

Constructor & Destructor Documentation

KisWidgetWithIdleTask()

template<typename BaseWidget >

KisWidgetWithIdleTask< BaseWidget >::KisWidgetWithIdleTask ( QWidget * parent = 0, Qt::WindowFlags flags = Qt::WindowFlags() )

inline

Definition at line 19 of file KisWidgetWithIdleTask.h.

        : BaseWidget (parent, flags)
    {
    }

~KisWidgetWithIdleTask()

template<typename BaseWidget >

KisWidgetWithIdleTask< BaseWidget >::~KisWidgetWithIdleTask ( )

overridedefault

Member Function Documentation

clearCachedState()

template<typename BaseWidget >

virtual void KisWidgetWithIdleTask< BaseWidget >::clearCachedState ( )

pure virtual

Implemented in ChannelDockerWidget, HistogramDockerWidget, and OverviewWidget.

hideEvent()

template<typename BaseWidget >

void KisWidgetWithIdleTask< BaseWidget >::hideEvent ( QHideEvent * event )

inlineoverride

Definition at line 63 of file KisWidgetWithIdleTask.h.

                                               {
        BaseWidget::hideEvent(event);
 
        // see a comment at the declaration of `m_isVisibleState`
        if (m_isVisibleState) {
            m_isVisibleState = false;
 
            KIS_SAFE_ASSERT_RECOVER_NOOP(!m_canvas || m_idleTaskGuard.isValid());
            m_idleTaskGuard = KisIdleTasksManager::TaskGuard();
 
            clearCachedState();
        }
    }

References KisWidgetWithIdleTask< BaseWidget >::clearCachedState(), KisIdleTasksManager::TaskGuard::isValid(), KIS_SAFE_ASSERT_RECOVER_NOOP, KisWidgetWithIdleTask< BaseWidget >::m_canvas, KisWidgetWithIdleTask< BaseWidget >::m_idleTaskGuard, and KisWidgetWithIdleTask< BaseWidget >::m_isVisibleState.

registerIdleTask()

template<typename BaseWidget >

virtual KisIdleTasksManager::TaskGuard KisWidgetWithIdleTask< BaseWidget >::registerIdleTask ( KisCanvas2 * canvas )

pure virtual

Implemented in ChannelDockerWidget, HistogramDockerWidget, and OverviewWidget.

setCanvas()

template<typename BaseWidget >

virtual void KisWidgetWithIdleTask< BaseWidget >::setCanvas ( KisCanvas2 * canvas )

inlinevirtual

Reimplemented in ChannelDockerWidget, and OverviewWidget.

Definition at line 26 of file KisWidgetWithIdleTask.h.

                                               {
        if (m_canvas) {
            m_idleTaskGuard = KisIdleTasksManager::TaskGuard();
        }
 
        m_canvas = canvas;
 
        if (m_canvas) {
            if (this->isVisible()) {
                m_idleTaskGuard = registerIdleTask(m_canvas);
            }
        }
 
        clearCachedState();
        this->update();
    }

References KisWidgetWithIdleTask< BaseWidget >::clearCachedState(), KisWidgetWithIdleTask< BaseWidget >::m_canvas, KisWidgetWithIdleTask< BaseWidget >::m_idleTaskGuard, and KisWidgetWithIdleTask< BaseWidget >::registerIdleTask().

showEvent()

template<typename BaseWidget >

void KisWidgetWithIdleTask< BaseWidget >::showEvent ( QShowEvent * event )

inlineoverride

Definition at line 43 of file KisWidgetWithIdleTask.h.

                                               {
        BaseWidget::showEvent(event);
 
        // see a comment at the declaration of `m_isVisibleState`
        if (!m_isVisibleState) {
            m_isVisibleState = true;
 
            KIS_SAFE_ASSERT_RECOVER(!m_idleTaskGuard.isValid()) {
                m_idleTaskGuard = KisIdleTasksManager::TaskGuard();
            }
 
            if (m_canvas) {
                m_idleTaskGuard = registerIdleTask(m_canvas);
            }
            if (m_idleTaskGuard.isValid()) {
                m_idleTaskGuard.trigger();
            }
        }
    }

References KisIdleTasksManager::TaskGuard::isValid(), KIS_SAFE_ASSERT_RECOVER, KisWidgetWithIdleTask< BaseWidget >::m_canvas, KisWidgetWithIdleTask< BaseWidget >::m_idleTaskGuard, KisWidgetWithIdleTask< BaseWidget >::m_isVisibleState, KisWidgetWithIdleTask< BaseWidget >::registerIdleTask(), and KisIdleTasksManager::TaskGuard::trigger().

triggerCacheUpdate()

template<typename BaseWidget >

void KisWidgetWithIdleTask< BaseWidget >::triggerCacheUpdate ( )

inline

Definition at line 77 of file KisWidgetWithIdleTask.h.

                              {
        if (m_idleTaskGuard.isValid()) {
            m_idleTaskGuard.trigger();
        }
    }

References KisIdleTasksManager::TaskGuard::isValid(), KisWidgetWithIdleTask< BaseWidget >::m_idleTaskGuard, and KisIdleTasksManager::TaskGuard::trigger().

Member Data Documentation

m_canvas

template<typename BaseWidget >

KisCanvas2* KisWidgetWithIdleTask< BaseWidget >::m_canvas {0}

protected

Definition at line 88 of file KisWidgetWithIdleTask.h.

{0};

m_idleTaskGuard

template<typename BaseWidget >

KisIdleTasksManager::TaskGuard KisWidgetWithIdleTask< BaseWidget >::m_idleTaskGuard

protected

Definition at line 89 of file KisWidgetWithIdleTask.h.

m_isVisibleState

template<typename BaseWidget >

bool KisWidgetWithIdleTask< BaseWidget >::m_isVisibleState {false}

protected

Hide/show events may be unbalanced so we track their parity with an internal state. Also, we cannot rely on this->isVisible(), because its state is different on different platforms during the event delivery.

Definition at line 97 of file KisWidgetWithIdleTask.h.

{false};

---

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

• libs/ui/KisWidgetWithIdleTask.h