Improve documentation.
[profile/ivi/qtdeclarative.git] / src / qml / qml / qqmlpropertyvalueinterceptor.cpp
1 /****************************************************************************
2 **
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtQml module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia.  For licensing terms and
14 ** conditions see http://qt.digia.com/licensing.  For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file.  Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights.  These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file.  Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41
42 #include "qqmlpropertyvalueinterceptor_p.h"
43
44 #include "qqml.h"
45
46 QT_BEGIN_NAMESPACE
47
48 /*!
49     \class QQmlPropertyValueInterceptor
50     \brief The QQmlPropertyValueInterceptor class is inherited by property interceptors such as Behavior.
51     \internal
52
53     This class intercepts property writes, allowing for custom handling. For example, Behavior uses this
54     interception to provide a default animation for all changes to a property's value.
55  */
56
57 /*!
58     Constructs a QQmlPropertyValueInterceptor.
59 */
60 QQmlPropertyValueInterceptor::QQmlPropertyValueInterceptor() : m_next(0)
61 {
62 }
63
64 QQmlPropertyValueInterceptor::~QQmlPropertyValueInterceptor()
65 {
66 }
67
68 /*!
69     \fn void QQmlPropertyValueInterceptor::setTarget(const QQmlProperty &property)
70     Set the target \a property for the value interceptor.  This method will
71     be called by the QML engine when assigning a value interceptor.
72 */
73
74 /*!
75     \fn void QQmlPropertyValueInterceptor::write(const QVariant &value)
76     This method will be called when a new \a value is assigned to the property being intercepted.
77 */
78
79 QT_END_NAMESPACE