KisSignalsBlocker Class Reference

#include <kis_signals_blocker.h>

Public Member Functions
	KisSignalsBlocker (QObject *o1, QObject *o2, QObject *o3=0, QObject *o4=0, QObject *o5=0, QObject *o6=0)
	KisSignalsBlocker (QObject *object)
	~KisSignalsBlocker ()

Private Member Functions
void	addObject (QObject *object)
void	blockObjects ()

Private Attributes
QVector< QPair< QObject *, bool > >	m_objects

Detailed Description

Block QObject's signals in a safe and sane way.

Avoid using direct calls to QObject::blockSignals(bool), because:

1) They are not safe. One beautifully sunny day someone (it might easily be you yourself) will forget about these call and will put a 'return' statement somewhere among the lines. Surely this is not what you expect to happen.

2) Two lines of blocking for every line of access can easily make the code unreadable.

Definition at line 28 of file kis_signals_blocker.h.

Constructor & Destructor Documentation

KisSignalsBlocker() [1/2]

KisSignalsBlocker::KisSignalsBlocker ( QObject * o1, QObject * o2, QObject * o3 = 0, QObject * o4 = 0, QObject * o5 = 0, QObject * o6 = 0 )

inline

Six should be enough for all usage cases! (c)

Definition at line 34 of file kis_signals_blocker.h.

    {
        if (o1) addObject(o1);
        if (o2) addObject(o2);
        if (o3) addObject(o3);
        if (o4) addObject(o4);
        if (o5) addObject(o5);
        if (o6) addObject(o6);
 
        blockObjects();
    }

References addObject(), and blockObjects().

KisSignalsBlocker() [2/2]

KisSignalsBlocker::KisSignalsBlocker ( QObject * object )

inline

Definition at line 51 of file kis_signals_blocker.h.

    {
        addObject(object);
        blockObjects();
    }

References addObject(), and blockObjects().

~KisSignalsBlocker()

KisSignalsBlocker::~KisSignalsBlocker ( )

inline

Definition at line 57 of file kis_signals_blocker.h.

    {
        auto it = m_objects.end();
        auto begin = m_objects.begin();
 
        while (it != begin) {
            --it;
            it->first->blockSignals(it->second);
        }
    }

References m_objects.

Member Function Documentation

addObject()

void KisSignalsBlocker::addObject ( QObject * object )

inlineprivate

Definition at line 75 of file kis_signals_blocker.h.

                                           {
        m_objects.append(qMakePair(object, object->signalsBlocked()));
    }

References m_objects.

blockObjects()

void KisSignalsBlocker::blockObjects ( )

inlineprivate

Definition at line 69 of file kis_signals_blocker.h.

                        {
        for (auto it = m_objects.begin(); it != m_objects.end(); ++it) {
            it->first->blockSignals(true);
        }
    }

References m_objects.

Member Data Documentation

m_objects

QVector<QPair<QObject*,bool> > KisSignalsBlocker::m_objects

private

Definition at line 83 of file kis_signals_blocker.h.

---

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

• libs/global/kis_signals_blocker.h