kde-playground/kdepimlibs/akonadi/kdsignalblocker.cpp
2015-04-14 21:49:29 +00:00

92 lines
2.4 KiB
C++

/****************************************************************************
** Copyright (C) 2001-2012 Klaralvdalens Datakonsult AB. All rights reserved.
**
** This file is part of the KD Tools library.
**
** Licensees holding valid commercial KD Tools licenses may use this file in
** accordance with the KD Tools Commercial License Agreement provided with
** the Software.
**
**
** This file may be distributed and/or modified under the terms of the GNU
** Lesser General Public License version 2 and version 3 as published by the
** Free Software Foundation and appearing in the file LICENSE.LGPL included.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** Contact info@kdab.net if any conditions of this licensing are not
** clear to you.
**
**********************************************************************/
#include "kdsignalblocker.h"
#include <QObject>
using namespace Akonadi;
/*!
\class KDSignalBlocker
\ingroup raii core
\brief Exception-safe and convenient wrapper around QObject::blockSignals()
All methods in this class are nothrow if QObject::blockSignals() and
QObject::signalsBlocked() are nothrow, which they normally are.
*/
/*!
Constructor. Blocks signals on \a o.
\post o->signalsBlocked() == true
*/
KDSignalBlocker::KDSignalBlocker(QObject *o)
: wasBlocked(o->signalsBlocked())
, object(o)
{
o->blockSignals(true);
}
/*!
\overload
\post o.signalsBlocked() == true
*/
KDSignalBlocker::KDSignalBlocker(QObject &o)
: wasBlocked(o.signalsBlocked())
, object(&o)
{
o.blockSignals(true);
}
/*!
Destructor. Unblocks signals (unless they were blocked before), if not already
done by unblock().
\post o->signalsBlocked() is the same as just before this instance has been constructed.
*/
KDSignalBlocker::~KDSignalBlocker()
{
unblock();
}
/*
Unblocks signals (unless they were blocked before).
You can use reblock() to block them again.
There is no need to reblock before destruction.
\post o->signalsBlocked() is the same as just before this instance has been constructed.
*/
void KDSignalBlocker::unblock()
{
object->blockSignals(wasBlocked);
}
/*
Unblocks signals (unless they were blocked before)
\post o->signalsBlocked() is the same as just before this instance has been constructed.
*/
void KDSignalBlocker::reblock()
{
object->blockSignals(true);
}