blob: 3ebe567e11765fbe9b105953f8041f0c298b73b5 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qmouseeventtransition.h"
#ifndef QT_NO_STATEMACHINE
#include "qbasicmouseeventtransition_p.h"
#include <QtCore/qstatemachine.h>
#include <QtGui/qpainterpath.h>
#include <private/qeventtransition_p.h>
QT_BEGIN_NAMESPACE
/*!
\class QMouseEventTransition
\brief The QMouseEventTransition class provides a transition for mouse events.
\since 4.6
\ingroup statemachine
QMouseEventTransition is part of \l{The State Machine Framework}.
\sa QState::addTransition()
*/
/*!
\property QMouseEventTransition::button
\brief the button that this mouse event transition is associated with
*/
/*!
\property QMouseEventTransition::modifierMask
\brief the keyboard modifier mask that this mouse event transition checks for
*/
class QMouseEventTransitionPrivate : public QEventTransitionPrivate
{
Q_DECLARE_PUBLIC(QMouseEventTransition)
public:
QMouseEventTransitionPrivate();
QBasicMouseEventTransition *transition;
};
QMouseEventTransitionPrivate::QMouseEventTransitionPrivate()
{
}
/*!
Constructs a new mouse event transition with the given \a sourceState.
*/
QMouseEventTransition::QMouseEventTransition(QState *sourceState)
: QEventTransition(*new QMouseEventTransitionPrivate, sourceState)
{
Q_D(QMouseEventTransition);
d->transition = new QBasicMouseEventTransition();
}
/*!
Constructs a new mouse event transition for events of the given \a type for
the given \a object, with the given \a button and \a sourceState.
*/
QMouseEventTransition::QMouseEventTransition(QObject *object, QEvent::Type type,
Qt::MouseButton button,
QState *sourceState)
: QEventTransition(*new QMouseEventTransitionPrivate, object, type, sourceState)
{
Q_D(QMouseEventTransition);
d->transition = new QBasicMouseEventTransition(type, button);
}
/*!
Destroys this mouse event transition.
*/
QMouseEventTransition::~QMouseEventTransition()
{
Q_D(QMouseEventTransition);
delete d->transition;
}
/*!
Returns the button that this mouse event transition checks for.
*/
Qt::MouseButton QMouseEventTransition::button() const
{
Q_D(const QMouseEventTransition);
return d->transition->button();
}
/*!
Sets the \a button that this mouse event transition will check for.
*/
void QMouseEventTransition::setButton(Qt::MouseButton button)
{
Q_D(QMouseEventTransition);
d->transition->setButton(button);
}
/*!
Returns the keyboard modifier mask that this mouse event transition checks
for.
*/
Qt::KeyboardModifiers QMouseEventTransition::modifierMask() const
{
Q_D(const QMouseEventTransition);
return d->transition->modifierMask();
}
/*!
Sets the keyboard modifier mask that this mouse event transition will
check for to \a modifierMask.
*/
void QMouseEventTransition::setModifierMask(Qt::KeyboardModifiers modifierMask)
{
Q_D(QMouseEventTransition);
d->transition->setModifierMask(modifierMask);
}
/*!
Returns the hit test path for this mouse event transition.
*/
QPainterPath QMouseEventTransition::hitTestPath() const
{
Q_D(const QMouseEventTransition);
return d->transition->hitTestPath();
}
/*!
Sets the hit test path for this mouse event transition to \a path.
If a valid path has been set, the transition will only trigger if the mouse
event position (QMouseEvent::pos()) is inside the path.
\sa QPainterPath::contains()
*/
void QMouseEventTransition::setHitTestPath(const QPainterPath &path)
{
Q_D(QMouseEventTransition);
d->transition->setHitTestPath(path);
}
/*!
\reimp
*/
bool QMouseEventTransition::eventTest(QEvent *event)
{
Q_D(const QMouseEventTransition);
if (!QEventTransition::eventTest(event))
return false;
QStateMachine::WrappedEvent *we = static_cast<QStateMachine::WrappedEvent*>(event);
d->transition->setEventType(we->event()->type());
return QAbstractTransitionPrivate::get(d->transition)->callEventTest(we->event());
}
/*!
\reimp
*/
void QMouseEventTransition::onTransition(QEvent *event)
{
QEventTransition::onTransition(event);
}
QT_END_NAMESPACE
#endif //QT_NO_STATEMACHINE