1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtQml module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
45 #include <QtQuick/qtquickglobal.h>
46 #include <QtQml/qqml.h>
47 #include <QtQml/qqmlcomponent.h>
49 #include <QtCore/QObject>
50 #include <QtCore/QList>
51 #include <QtGui/qevent.h>
52 #include <QtGui/qfont.h>
53 #include <QtGui/qaccessible.h>
60 class QQuickTransformPrivate;
61 class QQuickTransform : public QObject
65 QQuickTransform(QObject *parent = 0);
68 void appendToItem(QQuickItem *);
69 void prependToItem(QQuickItem *);
71 virtual void applyTo(QMatrix4x4 *matrix) const = 0;
77 QQuickTransform(QQuickTransformPrivate &dd, QObject *parent);
80 Q_DECLARE_PRIVATE(QQuickTransform)
83 class QQuickItemLayer;
86 class QQuickAnchorLine;
87 class QQuickTransition;
90 class QQuickItemPrivate;
95 class QSGTransformNode;
96 class QSGTextureProvider;
98 class Q_QUICK_EXPORT QQuickItem : public QObject, public QQmlParserStatus
101 Q_INTERFACES(QQmlParserStatus)
103 Q_PROPERTY(QQuickItem *parent READ parentItem WRITE setParentItem NOTIFY parentChanged DESIGNABLE false FINAL)
104 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQmlListProperty<QObject> data READ data DESIGNABLE false)
105 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQmlListProperty<QObject> resources READ resources DESIGNABLE false)
106 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQmlListProperty<QQuickItem> children READ children NOTIFY childrenChanged DESIGNABLE false)
108 Q_PROPERTY(QPointF pos READ pos FINAL)
109 Q_PROPERTY(qreal x READ x WRITE setX NOTIFY xChanged FINAL)
110 Q_PROPERTY(qreal y READ y WRITE setY NOTIFY yChanged FINAL)
111 Q_PROPERTY(qreal z READ z WRITE setZ NOTIFY zChanged FINAL)
112 Q_PROPERTY(qreal width READ width WRITE setWidth NOTIFY widthChanged RESET resetWidth FINAL)
113 Q_PROPERTY(qreal height READ height WRITE setHeight NOTIFY heightChanged RESET resetHeight FINAL)
115 Q_PROPERTY(qreal opacity READ opacity WRITE setOpacity NOTIFY opacityChanged FINAL)
116 Q_PROPERTY(bool enabled READ isEnabled WRITE setEnabled NOTIFY enabledChanged)
117 Q_PROPERTY(bool visible READ isVisible WRITE setVisible NOTIFY visibleChanged FINAL)
118 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQmlListProperty<QQuickItem> visibleChildren READ visibleChildren NOTIFY visibleChildrenChanged DESIGNABLE false)
120 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQmlListProperty<QQuickState> states READ states DESIGNABLE false)
121 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQmlListProperty<QQuickTransition> transitions READ transitions DESIGNABLE false)
122 Q_PROPERTY(QString state READ state WRITE setState NOTIFY stateChanged)
123 Q_PROPERTY(QRectF childrenRect READ childrenRect NOTIFY childrenRectChanged DESIGNABLE false FINAL)
124 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQuickAnchors * anchors READ anchors DESIGNABLE false CONSTANT FINAL)
125 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQuickAnchorLine left READ left CONSTANT FINAL)
126 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQuickAnchorLine right READ right CONSTANT FINAL)
127 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQuickAnchorLine horizontalCenter READ horizontalCenter CONSTANT FINAL)
128 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQuickAnchorLine top READ top CONSTANT FINAL)
129 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQuickAnchorLine bottom READ bottom CONSTANT FINAL)
130 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQuickAnchorLine verticalCenter READ verticalCenter CONSTANT FINAL)
131 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQuickAnchorLine baseline READ baseline CONSTANT FINAL)
132 Q_PROPERTY(qreal baselineOffset READ baselineOffset WRITE setBaselineOffset NOTIFY baselineOffsetChanged)
134 Q_PROPERTY(bool clip READ clip WRITE setClip NOTIFY clipChanged)
136 Q_PROPERTY(bool focus READ hasFocus WRITE setFocus NOTIFY focusChanged FINAL)
137 Q_PROPERTY(bool activeFocus READ hasActiveFocus NOTIFY activeFocusChanged FINAL)
139 Q_PROPERTY(qreal rotation READ rotation WRITE setRotation NOTIFY rotationChanged)
140 Q_PROPERTY(qreal scale READ scale WRITE setScale NOTIFY scaleChanged)
141 Q_PROPERTY(TransformOrigin transformOrigin READ transformOrigin WRITE setTransformOrigin NOTIFY transformOriginChanged)
142 Q_PROPERTY(QPointF transformOriginPoint READ transformOriginPoint) // XXX todo - notify?
143 Q_PROPERTY(QQmlListProperty<QQuickTransform> transform READ transform DESIGNABLE false FINAL)
145 Q_PROPERTY(bool smooth READ smooth WRITE setSmooth NOTIFY smoothChanged)
146 Q_PROPERTY(qreal implicitWidth READ implicitWidth WRITE setImplicitWidth NOTIFY implicitWidthChanged)
147 Q_PROPERTY(qreal implicitHeight READ implicitHeight WRITE setImplicitHeight NOTIFY implicitHeightChanged)
149 Q_PRIVATE_PROPERTY(QQuickItem::d_func(), QQuickItemLayer *layer READ layer DESIGNABLE false CONSTANT FINAL)
151 Q_ENUMS(TransformOrigin)
152 Q_CLASSINFO("DefaultProperty", "data")
153 Q_CLASSINFO("qt_HasQmlAccessors", "true")
157 ItemClipsChildrenToShape = 0x01,
158 ItemAcceptsInputMethod = 0x02,
159 ItemIsFocusScope = 0x04,
160 ItemHasContents = 0x08,
161 ItemAcceptsDrops = 0x10
162 // Remember to increment the size of QQuickItemPrivate::flags
164 Q_DECLARE_FLAGS(Flags, Flag)
167 ItemChildAddedChange, // value.item
168 ItemChildRemovedChange, // value.item
169 ItemSceneChange, // value.canvas
170 ItemVisibleHasChanged, // value.boolValue
171 ItemParentHasChanged, // value.item
172 ItemOpacityHasChanged, // value.realValue
173 ItemActiveFocusHasChanged, // value.boolValue
174 ItemRotationHasChanged // value.realValue
177 union ItemChangeData {
178 ItemChangeData(QQuickItem *v) : item(v) {}
179 ItemChangeData(QQuickCanvas *v) : canvas(v) {}
180 ItemChangeData(qreal v) : realValue(v) {}
181 ItemChangeData(bool v) : boolValue(v) {}
184 QQuickCanvas *canvas;
189 enum TransformOrigin {
190 TopLeft, Top, TopRight,
192 BottomLeft, Bottom, BottomRight
195 QQuickItem(QQuickItem *parent = 0);
196 virtual ~QQuickItem();
198 QSGEngine *sceneGraphEngine() const;
200 QQuickCanvas *canvas() const;
201 QQuickItem *parentItem() const;
202 void setParentItem(QQuickItem *parent);
203 void stackBefore(const QQuickItem *);
204 void stackAfter(const QQuickItem *);
206 QRectF childrenRect();
207 QList<QQuickItem *> childItems() const;
212 QString state() const;
213 void setState(const QString &);
215 qreal baselineOffset() const;
216 void setBaselineOffset(qreal);
218 QQmlListProperty<QQuickTransform> transform();
225 void setPos(const QPointF &);
228 void setWidth(qreal);
230 qreal implicitWidth() const;
232 qreal height() const;
233 void setHeight(qreal);
235 qreal implicitHeight() const;
237 void setSize(const QSizeF &size);
239 TransformOrigin transformOrigin() const;
240 void setTransformOrigin(TransformOrigin);
241 QPointF transformOriginPoint() const;
242 void setTransformOriginPoint(const QPointF &);
247 qreal rotation() const;
248 void setRotation(qreal);
250 void setScale(qreal);
252 qreal opacity() const;
253 void setOpacity(qreal);
255 bool isVisible() const;
256 void setVisible(bool);
258 bool isEnabled() const;
259 void setEnabled(bool);
262 void setSmooth(bool);
265 void setFlag(Flag flag, bool enabled = true);
266 void setFlags(Flags flags);
268 virtual QRectF boundingRect() const;
269 virtual QRectF clipRect() const;
271 bool hasActiveFocus() const;
272 bool hasFocus() const;
274 bool isFocusScope() const;
275 QQuickItem *scopedFocusItem() const;
277 Qt::MouseButtons acceptedMouseButtons() const;
278 void setAcceptedMouseButtons(Qt::MouseButtons buttons);
279 bool acceptHoverEvents() const;
280 void setAcceptHoverEvents(bool enabled);
282 bool isUnderMouse() const;
285 bool keepMouseGrab() const;
286 void setKeepMouseGrab(bool);
287 bool filtersChildMouseEvents() const;
288 void setFiltersChildMouseEvents(bool filter);
290 void grabTouchPoints(const QList<int> &ids);
291 void ungrabTouchPoints();
292 bool keepTouchGrab() const;
293 void setKeepTouchGrab(bool);
295 Q_INVOKABLE virtual bool contains(const QPointF &point) const;
297 QTransform itemTransform(QQuickItem *, bool *) const;
298 QPointF mapToItem(const QQuickItem *item, const QPointF &point) const;
299 QPointF mapToScene(const QPointF &point) const;
300 QRectF mapRectToItem(const QQuickItem *item, const QRectF &rect) const;
301 QRectF mapRectToScene(const QRectF &rect) const;
302 QPointF mapFromItem(const QQuickItem *item, const QPointF &point) const;
303 QPointF mapFromScene(const QPointF &point) const;
304 QRectF mapRectFromItem(const QQuickItem *item, const QRectF &rect) const;
305 QRectF mapRectFromScene(const QRectF &rect) const;
309 Q_INVOKABLE void mapFromItem(QQmlV8Function*) const;
310 Q_INVOKABLE void mapToItem(QQmlV8Function*) const;
311 Q_INVOKABLE void forceActiveFocus();
312 Q_INVOKABLE QQuickItem *childAt(qreal x, qreal y) const;
314 virtual QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
316 struct UpdatePaintNodeData {
317 QSGTransformNode *transformNode;
319 friend class QQuickCanvasPrivate;
320 UpdatePaintNodeData();
323 virtual bool isTextureProvider() const;
324 virtual QSGTextureProvider *textureProvider() const;
330 void childrenRectChanged(const QRectF &);
331 void baselineOffsetChanged(qreal);
332 void stateChanged(const QString &);
333 void focusChanged(bool);
334 void activeFocusChanged(bool);
335 void parentChanged(QQuickItem *);
336 void transformOriginChanged(TransformOrigin);
337 void smoothChanged(bool);
338 void clipChanged(bool);
341 void childrenChanged();
342 void opacityChanged();
343 void enabledChanged();
344 void visibleChanged();
345 void visibleChildrenChanged();
346 void rotationChanged();
352 void heightChanged();
354 void implicitWidthChanged();
355 void implicitHeightChanged();
358 virtual bool event(QEvent *);
360 bool isComponentComplete() const;
361 virtual void itemChange(ItemChange, const ItemChangeData &);
363 void updateInputMethod(Qt::InputMethodQueries queries = Qt::ImQueryInput);
365 void setImplicitWidth(qreal);
366 bool widthValid() const; // ### better name?
367 void setImplicitHeight(qreal);
368 bool heightValid() const; // ### better name?
369 void setImplicitSize(qreal, qreal);
371 virtual void classBegin();
372 virtual void componentComplete();
374 virtual void keyPressEvent(QKeyEvent *event);
375 virtual void keyReleaseEvent(QKeyEvent *event);
376 virtual void inputMethodEvent(QInputMethodEvent *);
377 virtual void focusInEvent(QFocusEvent *);
378 virtual void focusOutEvent(QFocusEvent *);
379 virtual void mousePressEvent(QMouseEvent *event);
380 virtual void mouseMoveEvent(QMouseEvent *event);
381 virtual void mouseReleaseEvent(QMouseEvent *event);
382 virtual void mouseDoubleClickEvent(QMouseEvent *event);
383 virtual void mouseUngrabEvent(); // XXX todo - params?
384 virtual void touchUngrabEvent();
385 virtual void wheelEvent(QWheelEvent *event);
386 virtual void touchEvent(QTouchEvent *event);
387 virtual void hoverEnterEvent(QHoverEvent *event);
388 virtual void hoverMoveEvent(QHoverEvent *event);
389 virtual void hoverLeaveEvent(QHoverEvent *event);
390 virtual void dragEnterEvent(QDragEnterEvent *);
391 virtual void dragMoveEvent(QDragMoveEvent *);
392 virtual void dragLeaveEvent(QDragLeaveEvent *);
393 virtual void dropEvent(QDropEvent *);
394 virtual bool childMouseEventFilter(QQuickItem *, QEvent *);
395 virtual void windowDeactivateEvent();
397 virtual void geometryChanged(const QRectF &newGeometry,
398 const QRectF &oldGeometry);
400 virtual QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *);
401 virtual void releaseResources();
402 virtual void updatePolish();
405 QQuickItem(QQuickItemPrivate &dd, QQuickItem *parent = 0);
408 friend class QQuickCanvas;
409 friend class QQuickCanvasPrivate;
410 friend class QSGRenderer;
411 friend class QAccessibleQuickItem;
412 friend class QQuickAccessibleAttached;
413 Q_DISABLE_COPY(QQuickItem)
414 Q_DECLARE_PRIVATE(QQuickItem)
418 Q_DECLARE_OPERATORS_FOR_FLAGS(QQuickItem::Flags)
420 #ifndef QT_NO_DEBUG_STREAM
421 QDebug Q_QUICK_EXPORT operator<<(QDebug debug, QQuickItem *item);
426 QML_DECLARE_TYPE(QQuickItem)
427 QML_DECLARE_TYPE(QQuickTransform)
431 #endif // QQUICKITEM_H