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 ****************************************************************************/
42 #include "qquickitem.h"
44 #include "qquickcanvas.h"
45 #include <QtQml/qjsengine.h>
46 #include "qquickcanvas_p.h"
48 #include "qquickevents_p_p.h"
49 #include "qquickscreen_p.h"
51 #include <QtQml/qqmlengine.h>
52 #include <QtQml/qqmlcomponent.h>
53 #include <QtQml/qqmlinfo.h>
54 #include <QtGui/qpen.h>
55 #include <QtGui/qcursor.h>
56 #include <QtGui/qguiapplication.h>
57 #include <QtGui/qinputmethod.h>
58 #include <QtCore/qdebug.h>
59 #include <QtCore/qcoreevent.h>
60 #include <QtCore/qnumeric.h>
62 #include <private/qqmlglobal_p.h>
63 #include <private/qqmlengine_p.h>
64 #include <QtQuick/private/qquickstategroup_p.h>
65 #include <private/qqmlopenmetaobject_p.h>
66 #include <QtQuick/private/qquickstate_p.h>
67 #include <private/qlistmodelinterface_p.h>
68 #include <private/qquickitem_p.h>
69 #include <private/qqmlaccessors_p.h>
70 #include <QtQuick/private/qquickaccessibleattached_p.h>
74 // XXX todo Check that elements that create items handle memory correctly after visual ownership change
78 static void QQuickItem_parentNotifier(QObject *o, intptr_t, QQmlNotifier **n)
80 QQuickItemPrivate *d = QQuickItemPrivate::get(static_cast<QQuickItem *>(o));
81 *n = &d->parentNotifier;
84 QML_PRIVATE_ACCESSOR(QQuickItem, QQuickItem *, parent, parentItem)
85 QML_PRIVATE_ACCESSOR(QQuickItem, qreal, x, x)
86 QML_PRIVATE_ACCESSOR(QQuickItem, qreal, y, y)
87 QML_PRIVATE_ACCESSOR(QQuickItem, qreal, width, width)
88 QML_PRIVATE_ACCESSOR(QQuickItem, qreal, height, height)
90 static QQmlAccessors QQuickItem_parent = { QQuickItem_parentRead, QQuickItem_parentNotifier };
91 static QQmlAccessors QQuickItem_x = { QQuickItem_xRead, 0 };
92 static QQmlAccessors QQuickItem_y = { QQuickItem_yRead, 0 };
93 static QQmlAccessors QQuickItem_width = { QQuickItem_widthRead, 0 };
94 static QQmlAccessors QQuickItem_height = { QQuickItem_heightRead, 0 };
96 QML_DECLARE_PROPERTIES(QQuickItem) {
97 { QML_PROPERTY_NAME(parent), 0, &QQuickItem_parent },
98 { QML_PROPERTY_NAME(x), 0, &QQuickItem_x },
99 { QML_PROPERTY_NAME(y), 0, &QQuickItem_y },
100 { QML_PROPERTY_NAME(width), 0, &QQuickItem_width },
101 { QML_PROPERTY_NAME(height), 0, &QQuickItem_height }
104 void QQuickItemPrivate::registerAccessorProperties()
106 QML_DEFINE_PROPERTIES(QQuickItem);
110 \qmlclass Transform QQuickTransform
111 \inqmlmodule QtQuick 2
112 \ingroup qml-transform-elements
113 \brief The Transform elements provide a way of building advanced transformations on Items.
115 The Transform element is a base type which cannot be instantiated directly.
116 The following concrete Transform types are available:
124 The Transform elements let you create and control advanced transformations that can be configured
125 independently using specialized properties.
127 You can assign any number of Transform elements to an \l Item. Each Transform is applied in order,
132 \qmlclass Translate QQuickTranslate
133 \inqmlmodule QtQuick 2
134 \ingroup qml-transform-elements
135 \brief The Translate object provides a way to move an Item without changing its x or y properties.
137 The Translate object provides independent control over position in addition to the Item's x and y properties.
139 The following example moves the Y axis of the \l Rectangle elements while still allowing the \l Row element
140 to lay the items out as if they had not been transformed:
146 width: 100; height: 100
148 transform: Translate { y: 20 }
151 width: 100; height: 100
153 transform: Translate { y: -20 }
162 \qmlproperty real QtQuick2::Translate::x
164 The translation along the X axis.
168 \qmlproperty real QtQuick2::Translate::y
170 The translation along the Y axis.
174 \qmlclass Scale QQuickScale
175 \inqmlmodule QtQuick 2
176 \ingroup qml-transform-elements
177 \brief The Scale element provides a way to scale an Item.
179 The Scale element gives more control over scaling than using \l Item's \l{Item::scale}{scale} property. Specifically,
180 it allows a different scale for the x and y axes, and allows the scale to be relative to an
183 The following example scales the X axis of the Rectangle, relative to its interior point 25, 25:
186 width: 100; height: 100
188 transform: Scale { origin.x: 25; origin.y: 25; xScale: 3}
192 \sa Rotation, Translate
196 \qmlproperty real QtQuick2::Scale::origin.x
197 \qmlproperty real QtQuick2::Scale::origin.y
199 The point that the item is scaled from (i.e., the point that stays fixed relative to the parent as
200 the rest of the item grows). By default the origin is 0, 0.
204 \qmlproperty real QtQuick2::Scale::xScale
206 The scaling factor for the X axis.
210 \qmlproperty real QtQuick2::Scale::yScale
212 The scaling factor for the Y axis.
216 \qmlclass Rotation QQuickRotation
217 \inqmlmodule QtQuick 2
218 \ingroup qml-transform-elements
219 \brief The Rotation object provides a way to rotate an Item.
221 The Rotation object gives more control over rotation than using \l Item's \l{Item::rotation}{rotation} property.
222 Specifically, it allows (z axis) rotation to be relative to an arbitrary point.
224 The following example rotates a Rectangle around its interior point 25, 25:
227 width: 100; height: 100
229 transform: Rotation { origin.x: 25; origin.y: 25; angle: 45}
233 Rotation also provides a way to specify 3D-like rotations for Items. For these types of
234 rotations you must specify the axis to rotate around in addition to the origin point.
236 The following example shows various 3D-like rotations applied to an \l Image.
237 \snippet doc/src/snippets/qml/rotation.qml 0
239 \image axisrotation.png
241 \sa {declarative/ui-components/dialcontrol}{Dial Control example}, {declarative/toys/clocks}{Clocks example}
245 \qmlproperty real QtQuick2::Rotation::origin.x
246 \qmlproperty real QtQuick2::Rotation::origin.y
248 The origin point of the rotation (i.e., the point that stays fixed relative to the parent as
249 the rest of the item rotates). By default the origin is 0, 0.
253 \qmlproperty real QtQuick2::Rotation::axis.x
254 \qmlproperty real QtQuick2::Rotation::axis.y
255 \qmlproperty real QtQuick2::Rotation::axis.z
257 The axis to rotate around. For simple (2D) rotation around a point, you do not need to specify an axis,
258 as the default axis is the z axis (\c{ axis { x: 0; y: 0; z: 1 } }).
260 For a typical 3D-like rotation you will usually specify both the origin and the axis.
262 \image 3d-rotation-axis.png
266 \qmlproperty real QtQuick2::Rotation::angle
268 The angle to rotate, in degrees clockwise.
271 QQuickTransformPrivate::QQuickTransformPrivate()
275 QQuickTransform::QQuickTransform(QObject *parent)
276 : QObject(*(new QQuickTransformPrivate), parent)
280 QQuickTransform::QQuickTransform(QQuickTransformPrivate &dd, QObject *parent)
281 : QObject(dd, parent)
285 QQuickTransform::~QQuickTransform()
287 Q_D(QQuickTransform);
288 for (int ii = 0; ii < d->items.count(); ++ii) {
289 QQuickItemPrivate *p = QQuickItemPrivate::get(d->items.at(ii));
290 p->transforms.removeOne(this);
291 p->dirty(QQuickItemPrivate::Transform);
295 void QQuickTransform::update()
297 Q_D(QQuickTransform);
298 for (int ii = 0; ii < d->items.count(); ++ii) {
299 QQuickItemPrivate *p = QQuickItemPrivate::get(d->items.at(ii));
300 p->dirty(QQuickItemPrivate::Transform);
304 QQuickContents::QQuickContents(QQuickItem *item)
305 : m_item(item), m_x(0), m_y(0), m_width(0), m_height(0)
309 QQuickContents::~QQuickContents()
311 QList<QQuickItem *> children = m_item->childItems();
312 for (int i = 0; i < children.count(); ++i) {
313 QQuickItem *child = children.at(i);
314 QQuickItemPrivate::get(child)->removeItemChangeListener(this, QQuickItemPrivate::Geometry | QQuickItemPrivate::Destroyed);
318 bool QQuickContents::calcHeight(QQuickItem *changed)
321 qreal oldheight = m_height;
325 qreal bottom = oldy + oldheight;
326 qreal y = changed->y();
327 if (y + changed->height() > bottom)
328 bottom = y + changed->height();
332 m_height = bottom - top;
336 QList<QQuickItem *> children = m_item->childItems();
337 for (int i = 0; i < children.count(); ++i) {
338 QQuickItem *child = children.at(i);
339 qreal y = child->y();
340 if (y + child->height() > bottom)
341 bottom = y + child->height();
345 if (!children.isEmpty())
347 m_height = qMax(bottom - top, qreal(0.0));
350 return (m_height != oldheight || m_y != oldy);
353 bool QQuickContents::calcWidth(QQuickItem *changed)
356 qreal oldwidth = m_width;
360 qreal right = oldx + oldwidth;
361 qreal x = changed->x();
362 if (x + changed->width() > right)
363 right = x + changed->width();
367 m_width = right - left;
369 qreal left = FLT_MAX;
371 QList<QQuickItem *> children = m_item->childItems();
372 for (int i = 0; i < children.count(); ++i) {
373 QQuickItem *child = children.at(i);
374 qreal x = child->x();
375 if (x + child->width() > right)
376 right = x + child->width();
380 if (!children.isEmpty())
382 m_width = qMax(right - left, qreal(0.0));
385 return (m_width != oldwidth || m_x != oldx);
388 void QQuickContents::complete()
390 QQuickItemPrivate::get(m_item)->addItemChangeListener(this, QQuickItemPrivate::Children);
392 QList<QQuickItem *> children = m_item->childItems();
393 for (int i = 0; i < children.count(); ++i) {
394 QQuickItem *child = children.at(i);
395 QQuickItemPrivate::get(child)->addItemChangeListener(this, QQuickItemPrivate::Geometry | QQuickItemPrivate::Destroyed);
396 //###what about changes to visibility?
401 void QQuickContents::updateRect()
403 QQuickItemPrivate::get(m_item)->emitChildrenRectChanged(rectF());
406 void QQuickContents::itemGeometryChanged(QQuickItem *changed, const QRectF &newGeometry, const QRectF &oldGeometry)
409 bool wChanged = false;
410 bool hChanged = false;
411 //### we can only pass changed if the left edge has moved left, or the right edge has moved right
412 if (newGeometry.width() != oldGeometry.width() || newGeometry.x() != oldGeometry.x())
413 wChanged = calcWidth(/*changed*/);
414 if (newGeometry.height() != oldGeometry.height() || newGeometry.y() != oldGeometry.y())
415 hChanged = calcHeight(/*changed*/);
416 if (wChanged || hChanged)
420 void QQuickContents::itemDestroyed(QQuickItem *item)
423 QQuickItemPrivate::get(item)->removeItemChangeListener(this, QQuickItemPrivate::Geometry | QQuickItemPrivate::Destroyed);
427 void QQuickContents::itemChildRemoved(QQuickItem *, QQuickItem *item)
430 QQuickItemPrivate::get(item)->removeItemChangeListener(this, QQuickItemPrivate::Geometry | QQuickItemPrivate::Destroyed);
434 void QQuickContents::itemChildAdded(QQuickItem *, QQuickItem *item)
437 QQuickItemPrivate::get(item)->addItemChangeListener(this, QQuickItemPrivate::Geometry | QQuickItemPrivate::Destroyed);
441 QQuickItemKeyFilter::QQuickItemKeyFilter(QQuickItem *item)
442 : m_processPost(false), m_next(0)
444 QQuickItemPrivate *p = item?QQuickItemPrivate::get(item):0;
446 m_next = p->extra.value().keyHandler;
447 p->extra->keyHandler = this;
451 QQuickItemKeyFilter::~QQuickItemKeyFilter()
455 void QQuickItemKeyFilter::keyPressed(QKeyEvent *event, bool post)
457 if (m_next) m_next->keyPressed(event, post);
460 void QQuickItemKeyFilter::keyReleased(QKeyEvent *event, bool post)
462 if (m_next) m_next->keyReleased(event, post);
465 void QQuickItemKeyFilter::inputMethodEvent(QInputMethodEvent *event, bool post)
468 m_next->inputMethodEvent(event, post);
473 QVariant QQuickItemKeyFilter::inputMethodQuery(Qt::InputMethodQuery query) const
475 if (m_next) return m_next->inputMethodQuery(query);
479 void QQuickItemKeyFilter::componentComplete()
481 if (m_next) m_next->componentComplete();
484 \qmlclass KeyNavigation QQuickKeyNavigationAttached
485 \inqmlmodule QtQuick 2
486 \ingroup qml-basic-interaction-elements
487 \brief The KeyNavigation attached property supports key navigation by arrow keys.
489 Key-based user interfaces commonly allow the use of arrow keys to navigate between
490 focusable items. The KeyNavigation attached property enables this behavior by providing a
491 convenient way to specify the item that should gain focus when an arrow or tab key is pressed.
493 The following example provides key navigation for a 2x2 grid of items:
495 \snippet doc/src/snippets/qml/keynavigation.qml 0
497 The top-left item initially receives focus by setting \l {Item::}{focus} to
498 \c true. When an arrow key is pressed, the focus will move to the
499 appropriate item, as defined by the value that has been set for
500 the KeyNavigation \l left, \l right, \l up or \l down properties.
502 Note that if a KeyNavigation attached property receives the key press and release
503 events for a requested arrow or tab key, the event is accepted and does not
504 propagate any further.
506 By default, KeyNavigation receives key events after the item to which it is attached.
507 If the item accepts the key event, the KeyNavigation attached property will not
508 receive an event for that key. Setting the \l priority property to
509 \c KeyNavigation.BeforeItem allows the event to be used for key navigation
510 before the item, rather than after.
512 If item to which the focus is switching is not enabled or visible, an attempt will
513 be made to skip this item and focus on the next. This is possible if there are
514 a chain of items with the same KeyNavigation handler. If multiple items in a row are not enabled
515 or visible, they will also be skipped.
517 KeyNavigation will implicitly set the other direction to return focus to this item. So if you set
518 \l left to another item, \l right will be set on that item's KeyNavigation to set focus back to this
519 item. However, if that item's KeyNavigation has had right explicitly set then no change will occur.
520 This means that the above example could have been written, with the same behaviour, without specifing
521 KeyNavigation.right or KeyNavigation.down for any of the items.
523 \sa {Keys}{Keys attached property}
527 \qmlproperty Item QtQuick2::KeyNavigation::left
528 \qmlproperty Item QtQuick2::KeyNavigation::right
529 \qmlproperty Item QtQuick2::KeyNavigation::up
530 \qmlproperty Item QtQuick2::KeyNavigation::down
531 \qmlproperty Item QtQuick2::KeyNavigation::tab
532 \qmlproperty Item QtQuick2::KeyNavigation::backtab
534 These properties hold the item to assign focus to
535 when the left, right, up or down cursor keys, or the
540 \qmlproperty Item QtQuick2::KeyNavigation::tab
541 \qmlproperty Item QtQuick2::KeyNavigation::backtab
543 These properties hold the item to assign focus to
544 when the Tab key or Shift+Tab key combination (Backtab) are pressed.
547 QQuickKeyNavigationAttached::QQuickKeyNavigationAttached(QObject *parent)
548 : QObject(*(new QQuickKeyNavigationAttachedPrivate), parent),
549 QQuickItemKeyFilter(qobject_cast<QQuickItem*>(parent))
551 m_processPost = true;
554 QQuickKeyNavigationAttached *
555 QQuickKeyNavigationAttached::qmlAttachedProperties(QObject *obj)
557 return new QQuickKeyNavigationAttached(obj);
560 QQuickItem *QQuickKeyNavigationAttached::left() const
562 Q_D(const QQuickKeyNavigationAttached);
566 void QQuickKeyNavigationAttached::setLeft(QQuickItem *i)
568 Q_D(QQuickKeyNavigationAttached);
573 QQuickKeyNavigationAttached* other =
574 qobject_cast<QQuickKeyNavigationAttached*>(qmlAttachedPropertiesObject<QQuickKeyNavigationAttached>(i));
575 if (other && !other->d_func()->rightSet){
576 other->d_func()->right = qobject_cast<QQuickItem*>(parent());
577 emit other->rightChanged();
582 QQuickItem *QQuickKeyNavigationAttached::right() const
584 Q_D(const QQuickKeyNavigationAttached);
588 void QQuickKeyNavigationAttached::setRight(QQuickItem *i)
590 Q_D(QQuickKeyNavigationAttached);
595 QQuickKeyNavigationAttached* other =
596 qobject_cast<QQuickKeyNavigationAttached*>(qmlAttachedPropertiesObject<QQuickKeyNavigationAttached>(i));
597 if (other && !other->d_func()->leftSet){
598 other->d_func()->left = qobject_cast<QQuickItem*>(parent());
599 emit other->leftChanged();
604 QQuickItem *QQuickKeyNavigationAttached::up() const
606 Q_D(const QQuickKeyNavigationAttached);
610 void QQuickKeyNavigationAttached::setUp(QQuickItem *i)
612 Q_D(QQuickKeyNavigationAttached);
617 QQuickKeyNavigationAttached* other =
618 qobject_cast<QQuickKeyNavigationAttached*>(qmlAttachedPropertiesObject<QQuickKeyNavigationAttached>(i));
619 if (other && !other->d_func()->downSet){
620 other->d_func()->down = qobject_cast<QQuickItem*>(parent());
621 emit other->downChanged();
626 QQuickItem *QQuickKeyNavigationAttached::down() const
628 Q_D(const QQuickKeyNavigationAttached);
632 void QQuickKeyNavigationAttached::setDown(QQuickItem *i)
634 Q_D(QQuickKeyNavigationAttached);
639 QQuickKeyNavigationAttached* other =
640 qobject_cast<QQuickKeyNavigationAttached*>(qmlAttachedPropertiesObject<QQuickKeyNavigationAttached>(i));
641 if (other && !other->d_func()->upSet) {
642 other->d_func()->up = qobject_cast<QQuickItem*>(parent());
643 emit other->upChanged();
648 QQuickItem *QQuickKeyNavigationAttached::tab() const
650 Q_D(const QQuickKeyNavigationAttached);
654 void QQuickKeyNavigationAttached::setTab(QQuickItem *i)
656 Q_D(QQuickKeyNavigationAttached);
661 QQuickKeyNavigationAttached* other =
662 qobject_cast<QQuickKeyNavigationAttached*>(qmlAttachedPropertiesObject<QQuickKeyNavigationAttached>(i));
663 if (other && !other->d_func()->backtabSet) {
664 other->d_func()->backtab = qobject_cast<QQuickItem*>(parent());
665 emit other->backtabChanged();
670 QQuickItem *QQuickKeyNavigationAttached::backtab() const
672 Q_D(const QQuickKeyNavigationAttached);
676 void QQuickKeyNavigationAttached::setBacktab(QQuickItem *i)
678 Q_D(QQuickKeyNavigationAttached);
682 d->backtabSet = true;
683 QQuickKeyNavigationAttached* other =
684 qobject_cast<QQuickKeyNavigationAttached*>(qmlAttachedPropertiesObject<QQuickKeyNavigationAttached>(i));
685 if (other && !other->d_func()->tabSet) {
686 other->d_func()->tab = qobject_cast<QQuickItem*>(parent());
687 emit other->tabChanged();
689 emit backtabChanged();
693 \qmlproperty enumeration QtQuick2::KeyNavigation::priority
695 This property determines whether the keys are processed before
696 or after the attached item's own key handling.
699 \o KeyNavigation.BeforeItem - process the key events before normal
700 item key processing. If the event is used for key navigation, it will be accepted and will not
701 be passed on to the item.
702 \o KeyNavigation.AfterItem (default) - process the key events after normal item key
703 handling. If the item accepts the key event it will not be
704 handled by the KeyNavigation attached property handler.
707 QQuickKeyNavigationAttached::Priority QQuickKeyNavigationAttached::priority() const
709 return m_processPost ? AfterItem : BeforeItem;
712 void QQuickKeyNavigationAttached::setPriority(Priority order)
714 bool processPost = order == AfterItem;
715 if (processPost != m_processPost) {
716 m_processPost = processPost;
717 emit priorityChanged();
721 void QQuickKeyNavigationAttached::keyPressed(QKeyEvent *event, bool post)
723 Q_D(QQuickKeyNavigationAttached);
726 if (post != m_processPost) {
727 QQuickItemKeyFilter::keyPressed(event, post);
732 switch (event->key()) {
734 if (QQuickItem *parentItem = qobject_cast<QQuickItem*>(parent()))
735 mirror = QQuickItemPrivate::get(parentItem)->effectiveLayoutMirror;
736 QQuickItem* leftItem = mirror ? d->right : d->left;
738 setFocusNavigation(leftItem, mirror ? "right" : "left");
743 case Qt::Key_Right: {
744 if (QQuickItem *parentItem = qobject_cast<QQuickItem*>(parent()))
745 mirror = QQuickItemPrivate::get(parentItem)->effectiveLayoutMirror;
746 QQuickItem* rightItem = mirror ? d->left : d->right;
748 setFocusNavigation(rightItem, mirror ? "left" : "right");
755 setFocusNavigation(d->up, "up");
761 setFocusNavigation(d->down, "down");
767 setFocusNavigation(d->tab, "tab");
771 case Qt::Key_Backtab:
773 setFocusNavigation(d->backtab, "backtab");
781 if (!event->isAccepted()) QQuickItemKeyFilter::keyPressed(event, post);
784 void QQuickKeyNavigationAttached::keyReleased(QKeyEvent *event, bool post)
786 Q_D(QQuickKeyNavigationAttached);
789 if (post != m_processPost) {
790 QQuickItemKeyFilter::keyReleased(event, post);
795 switch (event->key()) {
797 if (QQuickItem *parentItem = qobject_cast<QQuickItem*>(parent()))
798 mirror = QQuickItemPrivate::get(parentItem)->effectiveLayoutMirror;
799 if (mirror ? d->right : d->left)
803 if (QQuickItem *parentItem = qobject_cast<QQuickItem*>(parent()))
804 mirror = QQuickItemPrivate::get(parentItem)->effectiveLayoutMirror;
805 if (mirror ? d->left : d->right)
823 case Qt::Key_Backtab:
832 if (!event->isAccepted()) QQuickItemKeyFilter::keyReleased(event, post);
835 void QQuickKeyNavigationAttached::setFocusNavigation(QQuickItem *currentItem, const char *dir)
837 QQuickItem *initialItem = currentItem;
838 bool isNextItem = false;
841 if (currentItem->isVisible() && currentItem->isEnabled()) {
842 currentItem->setFocus(true);
845 qmlAttachedPropertiesObject<QQuickKeyNavigationAttached>(currentItem, false);
847 QQuickItem *tempItem = qvariant_cast<QQuickItem*>(attached->property(dir));
849 currentItem = tempItem;
855 while (currentItem != initialItem && isNextItem);
858 const QQuickKeysAttached::SigMap QQuickKeysAttached::sigMap[] = {
859 { Qt::Key_Left, "leftPressed" },
860 { Qt::Key_Right, "rightPressed" },
861 { Qt::Key_Up, "upPressed" },
862 { Qt::Key_Down, "downPressed" },
863 { Qt::Key_Tab, "tabPressed" },
864 { Qt::Key_Backtab, "backtabPressed" },
865 { Qt::Key_Asterisk, "asteriskPressed" },
866 { Qt::Key_NumberSign, "numberSignPressed" },
867 { Qt::Key_Escape, "escapePressed" },
868 { Qt::Key_Return, "returnPressed" },
869 { Qt::Key_Enter, "enterPressed" },
870 { Qt::Key_Delete, "deletePressed" },
871 { Qt::Key_Space, "spacePressed" },
872 { Qt::Key_Back, "backPressed" },
873 { Qt::Key_Cancel, "cancelPressed" },
874 { Qt::Key_Select, "selectPressed" },
875 { Qt::Key_Yes, "yesPressed" },
876 { Qt::Key_No, "noPressed" },
877 { Qt::Key_Context1, "context1Pressed" },
878 { Qt::Key_Context2, "context2Pressed" },
879 { Qt::Key_Context3, "context3Pressed" },
880 { Qt::Key_Context4, "context4Pressed" },
881 { Qt::Key_Call, "callPressed" },
882 { Qt::Key_Hangup, "hangupPressed" },
883 { Qt::Key_Flip, "flipPressed" },
884 { Qt::Key_Menu, "menuPressed" },
885 { Qt::Key_VolumeUp, "volumeUpPressed" },
886 { Qt::Key_VolumeDown, "volumeDownPressed" },
890 bool QQuickKeysAttachedPrivate::isConnected(const char *signalName)
892 return isSignalConnected(signalIndex(signalName));
896 \qmlclass Keys QQuickKeysAttached
897 \inqmlmodule QtQuick 2
898 \ingroup qml-basic-interaction-elements
899 \brief The Keys attached property provides key handling to Items.
901 All visual primitives support key handling via the Keys
902 attached property. Keys can be handled via the onPressed
903 and onReleased signal properties.
905 The signal properties have a \l KeyEvent parameter, named
906 \e event which contains details of the event. If a key is
907 handled \e event.accepted should be set to true to prevent the
908 event from propagating up the item hierarchy.
910 \section1 Example Usage
912 The following example shows how the general onPressed handler can
913 be used to test for a certain key; in this case, the left cursor
916 \snippet doc/src/snippets/qml/keys/keys-pressed.qml key item
918 Some keys may alternatively be handled via specific signal properties,
919 for example \e onSelectPressed. These handlers automatically set
920 \e event.accepted to true.
922 \snippet doc/src/snippets/qml/keys/keys-handler.qml key item
924 See \l{Qt::Key}{Qt.Key} for the list of keyboard codes.
926 \section1 Key Handling Priorities
928 The Keys attached property can be configured to handle key events
929 before or after the item it is attached to. This makes it possible
930 to intercept events in order to override an item's default behavior,
931 or act as a fallback for keys not handled by the item.
933 If \l priority is Keys.BeforeItem (default) the order of key event processing is:
936 \o Items specified in \c forwardTo
937 \o specific key handlers, e.g. onReturnPressed
938 \o onKeyPress, onKeyRelease handlers
939 \o Item specific key handling, e.g. TextInput key handling
943 If priority is Keys.AfterItem the order of key event processing is:
946 \o Item specific key handling, e.g. TextInput key handling
947 \o Items specified in \c forwardTo
948 \o specific key handlers, e.g. onReturnPressed
949 \o onKeyPress, onKeyRelease handlers
953 If the event is accepted during any of the above steps, key
956 \sa KeyEvent, {KeyNavigation}{KeyNavigation attached property}
960 \qmlproperty bool QtQuick2::Keys::enabled
962 This flags enables key handling if true (default); otherwise
963 no key handlers will be called.
967 \qmlproperty enumeration QtQuick2::Keys::priority
969 This property determines whether the keys are processed before
970 or after the attached item's own key handling.
973 \o Keys.BeforeItem (default) - process the key events before normal
974 item key processing. If the event is accepted it will not
975 be passed on to the item.
976 \o Keys.AfterItem - process the key events after normal item key
977 handling. If the item accepts the key event it will not be
978 handled by the Keys attached property handler.
983 \qmlproperty list<Object> QtQuick2::Keys::forwardTo
985 This property provides a way to forward key presses, key releases, and keyboard input
986 coming from input methods to other items. This can be useful when you want
987 one item to handle some keys (e.g. the up and down arrow keys), and another item to
988 handle other keys (e.g. the left and right arrow keys). Once an item that has been
989 forwarded keys accepts the event it is no longer forwarded to items later in the
992 This example forwards key events to two lists:
1003 Keys.forwardTo: [list1, list2]
1010 \qmlsignal QtQuick2::Keys::onPressed(KeyEvent event)
1012 This handler is called when a key has been pressed. The \a event
1013 parameter provides information about the event.
1017 \qmlsignal QtQuick2::Keys::onReleased(KeyEvent event)
1019 This handler is called when a key has been released. The \a event
1020 parameter provides information about the event.
1024 \qmlsignal QtQuick2::Keys::onDigit0Pressed(KeyEvent event)
1026 This handler is called when the digit '0' has been pressed. The \a event
1027 parameter provides information about the event.
1031 \qmlsignal QtQuick2::Keys::onDigit1Pressed(KeyEvent event)
1033 This handler is called when the digit '1' has been pressed. The \a event
1034 parameter provides information about the event.
1038 \qmlsignal QtQuick2::Keys::onDigit2Pressed(KeyEvent event)
1040 This handler is called when the digit '2' has been pressed. The \a event
1041 parameter provides information about the event.
1045 \qmlsignal QtQuick2::Keys::onDigit3Pressed(KeyEvent event)
1047 This handler is called when the digit '3' has been pressed. The \a event
1048 parameter provides information about the event.
1052 \qmlsignal QtQuick2::Keys::onDigit4Pressed(KeyEvent event)
1054 This handler is called when the digit '4' has been pressed. The \a event
1055 parameter provides information about the event.
1059 \qmlsignal QtQuick2::Keys::onDigit5Pressed(KeyEvent event)
1061 This handler is called when the digit '5' has been pressed. The \a event
1062 parameter provides information about the event.
1066 \qmlsignal QtQuick2::Keys::onDigit6Pressed(KeyEvent event)
1068 This handler is called when the digit '6' has been pressed. The \a event
1069 parameter provides information about the event.
1073 \qmlsignal QtQuick2::Keys::onDigit7Pressed(KeyEvent event)
1075 This handler is called when the digit '7' has been pressed. The \a event
1076 parameter provides information about the event.
1080 \qmlsignal QtQuick2::Keys::onDigit8Pressed(KeyEvent event)
1082 This handler is called when the digit '8' has been pressed. The \a event
1083 parameter provides information about the event.
1087 \qmlsignal QtQuick2::Keys::onDigit9Pressed(KeyEvent event)
1089 This handler is called when the digit '9' has been pressed. The \a event
1090 parameter provides information about the event.
1094 \qmlsignal QtQuick2::Keys::onLeftPressed(KeyEvent event)
1096 This handler is called when the Left arrow has been pressed. The \a event
1097 parameter provides information about the event.
1101 \qmlsignal QtQuick2::Keys::onRightPressed(KeyEvent event)
1103 This handler is called when the Right arrow has been pressed. The \a event
1104 parameter provides information about the event.
1108 \qmlsignal QtQuick2::Keys::onUpPressed(KeyEvent event)
1110 This handler is called when the Up arrow has been pressed. The \a event
1111 parameter provides information about the event.
1115 \qmlsignal QtQuick2::Keys::onDownPressed(KeyEvent event)
1117 This handler is called when the Down arrow has been pressed. The \a event
1118 parameter provides information about the event.
1122 \qmlsignal QtQuick2::Keys::onTabPressed(KeyEvent event)
1124 This handler is called when the Tab key has been pressed. The \a event
1125 parameter provides information about the event.
1129 \qmlsignal QtQuick2::Keys::onBacktabPressed(KeyEvent event)
1131 This handler is called when the Shift+Tab key combination (Backtab) has
1132 been pressed. The \a event parameter provides information about the event.
1136 \qmlsignal QtQuick2::Keys::onAsteriskPressed(KeyEvent event)
1138 This handler is called when the Asterisk '*' has been pressed. The \a event
1139 parameter provides information about the event.
1143 \qmlsignal QtQuick2::Keys::onEscapePressed(KeyEvent event)
1145 This handler is called when the Escape key has been pressed. The \a event
1146 parameter provides information about the event.
1150 \qmlsignal QtQuick2::Keys::onReturnPressed(KeyEvent event)
1152 This handler is called when the Return key has been pressed. The \a event
1153 parameter provides information about the event.
1157 \qmlsignal QtQuick2::Keys::onEnterPressed(KeyEvent event)
1159 This handler is called when the Enter key has been pressed. The \a event
1160 parameter provides information about the event.
1164 \qmlsignal QtQuick2::Keys::onDeletePressed(KeyEvent event)
1166 This handler is called when the Delete key has been pressed. The \a event
1167 parameter provides information about the event.
1171 \qmlsignal QtQuick2::Keys::onSpacePressed(KeyEvent event)
1173 This handler is called when the Space key has been pressed. The \a event
1174 parameter provides information about the event.
1178 \qmlsignal QtQuick2::Keys::onBackPressed(KeyEvent event)
1180 This handler is called when the Back key has been pressed. The \a event
1181 parameter provides information about the event.
1185 \qmlsignal QtQuick2::Keys::onCancelPressed(KeyEvent event)
1187 This handler is called when the Cancel key has been pressed. The \a event
1188 parameter provides information about the event.
1192 \qmlsignal QtQuick2::Keys::onSelectPressed(KeyEvent event)
1194 This handler is called when the Select key has been pressed. The \a event
1195 parameter provides information about the event.
1199 \qmlsignal QtQuick2::Keys::onYesPressed(KeyEvent event)
1201 This handler is called when the Yes key has been pressed. The \a event
1202 parameter provides information about the event.
1206 \qmlsignal QtQuick2::Keys::onNoPressed(KeyEvent event)
1208 This handler is called when the No key has been pressed. The \a event
1209 parameter provides information about the event.
1213 \qmlsignal QtQuick2::Keys::onContext1Pressed(KeyEvent event)
1215 This handler is called when the Context1 key has been pressed. The \a event
1216 parameter provides information about the event.
1220 \qmlsignal QtQuick2::Keys::onContext2Pressed(KeyEvent event)
1222 This handler is called when the Context2 key has been pressed. The \a event
1223 parameter provides information about the event.
1227 \qmlsignal QtQuick2::Keys::onContext3Pressed(KeyEvent event)
1229 This handler is called when the Context3 key has been pressed. The \a event
1230 parameter provides information about the event.
1234 \qmlsignal QtQuick2::Keys::onContext4Pressed(KeyEvent event)
1236 This handler is called when the Context4 key has been pressed. The \a event
1237 parameter provides information about the event.
1241 \qmlsignal QtQuick2::Keys::onCallPressed(KeyEvent event)
1243 This handler is called when the Call key has been pressed. The \a event
1244 parameter provides information about the event.
1248 \qmlsignal QtQuick2::Keys::onHangupPressed(KeyEvent event)
1250 This handler is called when the Hangup key has been pressed. The \a event
1251 parameter provides information about the event.
1255 \qmlsignal QtQuick2::Keys::onFlipPressed(KeyEvent event)
1257 This handler is called when the Flip key has been pressed. The \a event
1258 parameter provides information about the event.
1262 \qmlsignal QtQuick2::Keys::onMenuPressed(KeyEvent event)
1264 This handler is called when the Menu key has been pressed. The \a event
1265 parameter provides information about the event.
1269 \qmlsignal QtQuick2::Keys::onVolumeUpPressed(KeyEvent event)
1271 This handler is called when the VolumeUp key has been pressed. The \a event
1272 parameter provides information about the event.
1276 \qmlsignal QtQuick2::Keys::onVolumeDownPressed(KeyEvent event)
1278 This handler is called when the VolumeDown key has been pressed. The \a event
1279 parameter provides information about the event.
1282 QQuickKeysAttached::QQuickKeysAttached(QObject *parent)
1283 : QObject(*(new QQuickKeysAttachedPrivate), parent),
1284 QQuickItemKeyFilter(qobject_cast<QQuickItem*>(parent))
1286 Q_D(QQuickKeysAttached);
1287 m_processPost = false;
1288 d->item = qobject_cast<QQuickItem*>(parent);
1291 QQuickKeysAttached::~QQuickKeysAttached()
1295 QQuickKeysAttached::Priority QQuickKeysAttached::priority() const
1297 return m_processPost ? AfterItem : BeforeItem;
1300 void QQuickKeysAttached::setPriority(Priority order)
1302 bool processPost = order == AfterItem;
1303 if (processPost != m_processPost) {
1304 m_processPost = processPost;
1305 emit priorityChanged();
1309 void QQuickKeysAttached::componentComplete()
1311 Q_D(QQuickKeysAttached);
1313 for (int ii = 0; ii < d->targets.count(); ++ii) {
1314 QQuickItem *targetItem = d->targets.at(ii);
1315 if (targetItem && (targetItem->flags() & QQuickItem::ItemAcceptsInputMethod)) {
1316 d->item->setFlag(QQuickItem::ItemAcceptsInputMethod);
1323 void QQuickKeysAttached::keyPressed(QKeyEvent *event, bool post)
1325 Q_D(QQuickKeysAttached);
1326 if (post != m_processPost || !d->enabled || d->inPress) {
1328 QQuickItemKeyFilter::keyPressed(event, post);
1332 // first process forwards
1333 if (d->item && d->item->canvas()) {
1335 for (int ii = 0; ii < d->targets.count(); ++ii) {
1336 QQuickItem *i = d->targets.at(ii);
1337 if (i && i->isVisible()) {
1338 d->item->canvas()->sendEvent(i, event);
1339 if (event->isAccepted()) {
1348 QQuickKeyEvent ke(*event);
1349 QByteArray keySignal = keyToSignal(event->key());
1350 if (!keySignal.isEmpty()) {
1351 keySignal += "(QQuickKeyEvent*)";
1352 if (d->isConnected(keySignal)) {
1353 // If we specifically handle a key then default to accepted
1354 ke.setAccepted(true);
1355 int idx = QQuickKeysAttached::staticMetaObject.indexOfSignal(keySignal);
1356 metaObject()->method(idx).invoke(this, Qt::DirectConnection, Q_ARG(QQuickKeyEvent*, &ke));
1359 if (!ke.isAccepted())
1361 event->setAccepted(ke.isAccepted());
1363 if (!event->isAccepted()) QQuickItemKeyFilter::keyPressed(event, post);
1366 void QQuickKeysAttached::keyReleased(QKeyEvent *event, bool post)
1368 Q_D(QQuickKeysAttached);
1369 if (post != m_processPost || !d->enabled || d->inRelease) {
1371 QQuickItemKeyFilter::keyReleased(event, post);
1375 if (d->item && d->item->canvas()) {
1376 d->inRelease = true;
1377 for (int ii = 0; ii < d->targets.count(); ++ii) {
1378 QQuickItem *i = d->targets.at(ii);
1379 if (i && i->isVisible()) {
1380 d->item->canvas()->sendEvent(i, event);
1381 if (event->isAccepted()) {
1382 d->inRelease = false;
1387 d->inRelease = false;
1390 QQuickKeyEvent ke(*event);
1392 event->setAccepted(ke.isAccepted());
1394 if (!event->isAccepted()) QQuickItemKeyFilter::keyReleased(event, post);
1397 void QQuickKeysAttached::inputMethodEvent(QInputMethodEvent *event, bool post)
1399 Q_D(QQuickKeysAttached);
1400 if (post == m_processPost && d->item && !d->inIM && d->item->canvas()) {
1402 for (int ii = 0; ii < d->targets.count(); ++ii) {
1403 QQuickItem *i = d->targets.at(ii);
1404 if (i && i->isVisible() && (i->flags() & QQuickItem::ItemAcceptsInputMethod)) {
1405 d->item->canvas()->sendEvent(i, event);
1406 if (event->isAccepted()) {
1415 QQuickItemKeyFilter::inputMethodEvent(event, post);
1418 QVariant QQuickKeysAttached::inputMethodQuery(Qt::InputMethodQuery query) const
1420 Q_D(const QQuickKeysAttached);
1422 for (int ii = 0; ii < d->targets.count(); ++ii) {
1423 QQuickItem *i = d->targets.at(ii);
1424 if (i && i->isVisible() && (i->flags() & QQuickItem::ItemAcceptsInputMethod) && i == d->imeItem) {
1425 //### how robust is i == d->imeItem check?
1426 QVariant v = i->inputMethodQuery(query);
1427 if (v.userType() == QVariant::RectF)
1428 v = d->item->mapRectFromItem(i, v.toRectF()); //### cost?
1433 return QQuickItemKeyFilter::inputMethodQuery(query);
1436 QQuickKeysAttached *QQuickKeysAttached::qmlAttachedProperties(QObject *obj)
1438 return new QQuickKeysAttached(obj);
1442 \qmlclass LayoutMirroring QQuickLayoutMirroringAttached
1443 \inqmlmodule QtQuick 2
1444 \ingroup qml-utility-elements
1445 \brief The LayoutMirroring attached property is used to mirror layout behavior.
1447 The LayoutMirroring attached property is used to horizontally mirror \l {anchor-layout}{Item anchors},
1448 \l{Using QML Positioner and Repeater Items}{positioner} elements (such as \l Row and \l Grid)
1449 and views (such as \l GridView and horizontal \l ListView). Mirroring is a visual change: left
1450 anchors become right anchors, and positioner elements like \l Grid and \l Row reverse the
1451 horizontal layout of child items.
1453 Mirroring is enabled for an item by setting the \l enabled property to true. By default, this
1454 only affects the item itself; setting the \l childrenInherit property to true propagates the mirroring
1455 behavior to all child elements as well. If the \c LayoutMirroring attached property has not been defined
1456 for an item, mirroring is not enabled.
1458 The following example shows mirroring in action. The \l Row below is specified as being anchored
1459 to the left of its parent. However, since mirroring has been enabled, the anchor is horizontally
1460 reversed and it is now anchored to the right. Also, since items in a \l Row are positioned
1461 from left to right by default, they are now positioned from right to left instead, as demonstrated
1462 by the numbering and opacity of the items:
1464 \snippet doc/src/snippets/qml/layoutmirroring.qml 0
1466 \image layoutmirroring.png
1468 Layout mirroring is useful when it is necessary to support both left-to-right and right-to-left
1469 layout versions of an application to target different language areas. The \l childrenInherit
1470 property allows layout mirroring to be applied without manually setting layout configurations
1471 for every item in an application. Keep in mind, however, that mirroring does not affect any
1472 positioning that is defined by the \l Item \l {Item::}{x} coordinate value, so even with
1473 mirroring enabled, it will often be necessary to apply some layout fixes to support the
1474 desired layout direction. Also, it may be necessary to disable the mirroring of individual
1475 child items (by setting \l {enabled}{LayoutMirroring.enabled} to false for such items) if
1476 mirroring is not the desired behavior, or if the child item already implements mirroring in
1479 See \l {QML Right-to-left User Interfaces} for further details on using \c LayoutMirroring and
1480 other related features to implement right-to-left support for an application.
1484 \qmlproperty bool QtQuick2::LayoutMirroring::enabled
1486 This property holds whether the item's layout is mirrored horizontally. Setting this to true
1487 horizontally reverses \l {anchor-layout}{anchor} settings such that left anchors become right,
1488 and right anchors become left. For \l{Using QML Positioner and Repeater Items}{positioner} elements
1489 (such as \l Row and \l Grid) and view elements (such as \l {GridView}{GridView} and \l {ListView}{ListView})
1490 this also mirrors the horizontal layout direction of the item.
1492 The default value is false.
1496 \qmlproperty bool QtQuick2::LayoutMirroring::childrenInherit
1498 This property holds whether the \l {enabled}{LayoutMirroring.enabled} value for this item
1499 is inherited by its children.
1501 The default value is false.
1505 QQuickLayoutMirroringAttached::QQuickLayoutMirroringAttached(QObject *parent) : QObject(parent), itemPrivate(0)
1507 if (QQuickItem *item = qobject_cast<QQuickItem*>(parent)) {
1508 itemPrivate = QQuickItemPrivate::get(item);
1509 itemPrivate->extra.value().layoutDirectionAttached = this;
1511 qmlInfo(parent) << tr("LayoutDirection attached property only works with Items");
1514 QQuickLayoutMirroringAttached * QQuickLayoutMirroringAttached::qmlAttachedProperties(QObject *object)
1516 return new QQuickLayoutMirroringAttached(object);
1519 bool QQuickLayoutMirroringAttached::enabled() const
1521 return itemPrivate ? itemPrivate->effectiveLayoutMirror : false;
1524 void QQuickLayoutMirroringAttached::setEnabled(bool enabled)
1529 itemPrivate->isMirrorImplicit = false;
1530 if (enabled != itemPrivate->effectiveLayoutMirror) {
1531 itemPrivate->setLayoutMirror(enabled);
1532 if (itemPrivate->inheritMirrorFromItem)
1533 itemPrivate->resolveLayoutMirror();
1537 void QQuickLayoutMirroringAttached::resetEnabled()
1539 if (itemPrivate && !itemPrivate->isMirrorImplicit) {
1540 itemPrivate->isMirrorImplicit = true;
1541 itemPrivate->resolveLayoutMirror();
1545 bool QQuickLayoutMirroringAttached::childrenInherit() const
1547 return itemPrivate ? itemPrivate->inheritMirrorFromItem : false;
1550 void QQuickLayoutMirroringAttached::setChildrenInherit(bool childrenInherit) {
1551 if (itemPrivate && childrenInherit != itemPrivate->inheritMirrorFromItem) {
1552 itemPrivate->inheritMirrorFromItem = childrenInherit;
1553 itemPrivate->resolveLayoutMirror();
1554 childrenInheritChanged();
1558 void QQuickItemPrivate::resolveLayoutMirror()
1561 if (QQuickItem *parentItem = q->parentItem()) {
1562 QQuickItemPrivate *parentPrivate = QQuickItemPrivate::get(parentItem);
1563 setImplicitLayoutMirror(parentPrivate->inheritedLayoutMirror, parentPrivate->inheritMirrorFromParent);
1565 setImplicitLayoutMirror(isMirrorImplicit ? false : effectiveLayoutMirror, inheritMirrorFromItem);
1569 void QQuickItemPrivate::setImplicitLayoutMirror(bool mirror, bool inherit)
1571 inherit = inherit || inheritMirrorFromItem;
1572 if (!isMirrorImplicit && inheritMirrorFromItem)
1573 mirror = effectiveLayoutMirror;
1574 if (mirror == inheritedLayoutMirror && inherit == inheritMirrorFromParent)
1577 inheritMirrorFromParent = inherit;
1578 inheritedLayoutMirror = inheritMirrorFromParent ? mirror : false;
1580 if (isMirrorImplicit)
1581 setLayoutMirror(inherit ? inheritedLayoutMirror : false);
1582 for (int i = 0; i < childItems.count(); ++i) {
1583 if (QQuickItem *child = qobject_cast<QQuickItem *>(childItems.at(i))) {
1584 QQuickItemPrivate *childPrivate = QQuickItemPrivate::get(child);
1585 childPrivate->setImplicitLayoutMirror(inheritedLayoutMirror, inheritMirrorFromParent);
1590 void QQuickItemPrivate::setLayoutMirror(bool mirror)
1592 if (mirror != effectiveLayoutMirror) {
1593 effectiveLayoutMirror = mirror;
1595 QQuickAnchorsPrivate *anchor_d = QQuickAnchorsPrivate::get(_anchors);
1596 anchor_d->fillChanged();
1597 anchor_d->centerInChanged();
1598 anchor_d->updateHorizontalAnchors();
1599 emit _anchors->mirroredChanged();
1602 if (extra.isAllocated() && extra->layoutDirectionAttached) {
1603 emit extra->layoutDirectionAttached->enabledChanged();
1608 void QQuickItemPrivate::setAccessibleFlagAndListener()
1611 QQuickItem *item = q;
1613 if (item->d_func()->isAccessible)
1614 break; // already set - grandparents should have the flag set as well.
1616 if (item->canvas() && item->canvas()->rootItem() == item)
1617 break; // don't add a listener to the canvas root item
1619 item->d_func()->isAccessible = true;
1620 item = item->d_func()->parentItem;
1626 \brief The QQuickItem class provides the most basic of all visual items in QML.
1630 All visual items in Qt Quick inherit from QQuickItem. Although QQuickItem
1631 has no visual appearance, it defines all the properties that are
1632 common across visual items - such as the x and y position, the
1633 width and height, \l {anchor-layout}{anchoring} and key handling.
1635 You can subclass QQuickItem to provide your own custom visual item that inherits
1636 these features. Note that, because it does not draw anything, QQuickItem sets the
1637 QGraphicsItem::ItemHasNoContents flag. If you subclass QQuickItem to create a visual
1638 item, you will need to unset this flag.
1643 \qmlclass Item QQuickItem
1645 \inqmlmodule QtQuick 2
1646 \ingroup qml-basic-visual-elements
1647 \brief The Item is the most basic of all visual items in QML.
1649 All visual items in Qt Quick inherit from Item. Although Item
1650 has no visual appearance, it defines all the properties that are
1651 common across visual items - such as the x and y position, the
1652 width and height, \l {anchor-layout}{anchoring} and key handling.
1654 Item is also useful for grouping items together.
1671 fillMode: Image.Tile
1678 \section1 Key Handling
1680 Key handling is available to all Item-based visual elements via the \l {Keys}{Keys}
1681 attached property. The \e Keys attached property provides basic handlers such
1682 as \l {Keys::onPressed}{onPressed} and \l {Keys::onReleased}{onReleased},
1683 as well as handlers for specific keys, such as
1684 \l {Keys::onCancelPressed}{onCancelPressed}. The example below
1685 assigns \l {qmlfocus}{focus} to the item and handles
1686 the Left key via the general \e onPressed handler and the Select key via the
1687 onSelectPressed handler:
1693 if (event.key == Qt.Key_Left) {
1694 console.log("move left");
1695 event.accepted = true;
1698 Keys.onSelectPressed: console.log("Selected");
1702 See the \l {Keys}{Keys} attached property for detailed documentation.
1704 \section1 Layout Mirroring
1706 Item layouts can be mirrored using the \l {LayoutMirroring}{LayoutMirroring} attached property.
1711 \fn void QQuickItem::childrenRectChanged(const QRectF &)
1716 \fn void QQuickItem::baselineOffsetChanged(qreal)
1721 \fn void QQuickItem::stateChanged(const QString &state)
1726 \fn void QQuickItem::parentChanged(QQuickItem *)
1731 \fn void QQuickItem::smoothChanged(bool)
1736 \fn void QQuickItem::clipChanged(bool)
1740 /*! \fn void QQuickItem::transformOriginChanged(TransformOrigin)
1745 \fn void QQuickItem::focusChanged(bool)
1750 \fn void QQuickItem::activeFocusChanged(bool)
1754 \fn QQuickItem::QQuickItem(QQuickItem *parent)
1756 Constructs a QQuickItem with the given \a parent.
1758 QQuickItem::QQuickItem(QQuickItem* parent)
1759 : QObject(*(new QQuickItemPrivate), parent)
1767 QQuickItem::QQuickItem(QQuickItemPrivate &dd, QQuickItem *parent)
1768 : QObject(dd, parent)
1775 static int qt_item_count = 0;
1777 static void qt_print_item_count()
1779 qDebug("Number of leaked items: %i", qt_item_count);
1785 Destroys the QQuickItem.
1787 QQuickItem::~QQuickItem()
1791 if (qt_item_count < 0)
1792 qDebug("Item destroyed after qt_print_item_count() was called.");
1799 else if (d->canvas && d->itemNodeInstance)
1800 QQuickCanvasPrivate::get(d->canvas)->cleanup(d->itemNodeInstance); // cleanup root
1801 // XXX todo - optimize
1802 while (!d->childItems.isEmpty())
1803 d->childItems.first()->setParentItem(0);
1805 for (int ii = 0; ii < d->changeListeners.count(); ++ii) {
1806 QQuickAnchorsPrivate *anchor = d->changeListeners.at(ii).listener->anchorPrivate();
1808 anchor->clearItem(this);
1812 update item anchors that depended on us unless they are our child (and will also be destroyed),
1813 or our sibling, and our parent is also being destroyed.
1815 for (int ii = 0; ii < d->changeListeners.count(); ++ii) {
1816 QQuickAnchorsPrivate *anchor = d->changeListeners.at(ii).listener->anchorPrivate();
1817 if (anchor && anchor->item && anchor->item->parentItem() && anchor->item->parentItem() != this)
1821 for (int ii = 0; ii < d->changeListeners.count(); ++ii) {
1822 const QQuickItemPrivate::ChangeListener &change = d->changeListeners.at(ii);
1823 if (change.types & QQuickItemPrivate::Destroyed)
1824 change.listener->itemDestroyed(this);
1827 d->changeListeners.clear();
1829 if (d->extra.isAllocated()) {
1830 delete d->extra->contents; d->extra->contents = 0;
1831 delete d->extra->layer; d->extra->layer = 0;
1834 delete d->_anchors; d->_anchors = 0;
1835 delete d->_stateGroup; d->_stateGroup = 0;
1839 \qmlproperty enumeration QtQuick2::Item::transformOrigin
1840 This property holds the origin point around which scale and rotation transform.
1842 Nine transform origins are available, as shown in the image below.
1844 \image declarative-transformorigin.png
1846 This example rotates an image around its bottom-right corner.
1849 source: "myimage.png"
1850 transformOrigin: Item.BottomRight
1855 The default transform origin is \c Item.Center.
1857 To set an arbitrary transform origin point use the \l Scale or \l Rotation
1862 \qmlproperty Item QtQuick2::Item::parent
1863 This property holds the parent of the item.
1867 \property QQuickItem::parent
1868 This property holds the parent of the item.
1870 void QQuickItem::setParentItem(QQuickItem *parentItem)
1873 if (parentItem == d->parentItem)
1877 QQuickItem *itemAncestor = parentItem->parentItem();
1878 while (itemAncestor != 0) {
1879 if (itemAncestor == this) {
1880 qWarning("QQuickItem::setParentItem: Parent is already part of this items subtree.");
1883 itemAncestor = itemAncestor->parentItem();
1887 d->removeFromDirtyList();
1889 QQuickItem *oldParentItem = d->parentItem;
1890 QQuickItem *scopeFocusedItem = 0;
1892 if (oldParentItem) {
1893 QQuickItemPrivate *op = QQuickItemPrivate::get(oldParentItem);
1895 QQuickItem *scopeItem = 0;
1897 if (d->canvas && hasFocus()) {
1898 scopeItem = oldParentItem;
1899 while (!scopeItem->isFocusScope()) scopeItem = scopeItem->parentItem();
1900 scopeFocusedItem = this;
1901 } else if (d->canvas && !isFocusScope() && d->subFocusItem) {
1902 scopeItem = oldParentItem;
1903 while (!scopeItem->isFocusScope()) scopeItem = scopeItem->parentItem();
1904 scopeFocusedItem = d->subFocusItem;
1907 if (scopeFocusedItem)
1908 QQuickCanvasPrivate::get(d->canvas)->clearFocusInScope(scopeItem, scopeFocusedItem,
1909 QQuickCanvasPrivate::DontChangeFocusProperty);
1911 const bool wasVisible = isVisible();
1912 op->removeChild(this);
1914 emit oldParentItem->visibleChildrenChanged();
1916 } else if (d->canvas) {
1917 QQuickCanvasPrivate::get(d->canvas)->parentlessItems.remove(this);
1920 d->parentItem = parentItem;
1922 QQuickCanvas *parentCanvas = parentItem?QQuickItemPrivate::get(parentItem)->canvas:0;
1923 if (d->canvas != parentCanvas) {
1924 QQuickItemPrivate::InitializationState initState;
1926 d->initCanvas(&initState, parentCanvas);
1929 d->dirty(QQuickItemPrivate::ParentChanged);
1932 QQuickItemPrivate::get(d->parentItem)->addChild(this);
1934 d->setEffectiveVisibleRecur(d->calcEffectiveVisible());
1935 d->setEffectiveEnableRecur(0, d->calcEffectiveEnable());
1937 if (scopeFocusedItem && d->parentItem && d->canvas) {
1938 // We need to test whether this item becomes scope focused
1939 QQuickItem *scopeItem = 0;
1940 scopeItem = d->parentItem;
1941 while (!scopeItem->isFocusScope()) scopeItem = scopeItem->parentItem();
1943 if (scopeItem->scopedFocusItem()) {
1944 QQuickItemPrivate::get(scopeFocusedItem)->focus = false;
1945 emit scopeFocusedItem->focusChanged(false);
1947 QQuickCanvasPrivate::get(d->canvas)->setFocusInScope(scopeItem, scopeFocusedItem,
1948 QQuickCanvasPrivate::DontChangeFocusProperty);
1952 d->resolveLayoutMirror();
1954 d->itemChange(ItemParentHasChanged, d->parentItem);
1956 d->parentNotifier.notify();
1957 if (d->isAccessible && d->parentItem) {
1958 d->parentItem->d_func()->setAccessibleFlagAndListener();
1961 emit parentChanged(d->parentItem);
1962 if (isVisible() && d->parentItem)
1963 emit d->parentItem->visibleChildrenChanged();
1966 void QQuickItem::stackBefore(const QQuickItem *sibling)
1969 if (!sibling || sibling == this || !d->parentItem || d->parentItem != QQuickItemPrivate::get(sibling)->parentItem) {
1970 qWarning("QQuickItem::stackBefore: Cannot stack before %p, which must be a sibling", sibling);
1974 QQuickItemPrivate *parentPrivate = QQuickItemPrivate::get(d->parentItem);
1976 int myIndex = parentPrivate->childItems.indexOf(this);
1977 int siblingIndex = parentPrivate->childItems.indexOf(const_cast<QQuickItem *>(sibling));
1979 Q_ASSERT(myIndex != -1 && siblingIndex != -1);
1981 if (myIndex == siblingIndex - 1)
1984 parentPrivate->childItems.removeAt(myIndex);
1986 if (myIndex < siblingIndex) --siblingIndex;
1988 parentPrivate->childItems.insert(siblingIndex, this);
1990 parentPrivate->dirty(QQuickItemPrivate::ChildrenStackingChanged);
1991 parentPrivate->markSortedChildrenDirty(this);
1993 for (int ii = qMin(siblingIndex, myIndex); ii < parentPrivate->childItems.count(); ++ii)
1994 QQuickItemPrivate::get(parentPrivate->childItems.at(ii))->siblingOrderChanged();
1997 void QQuickItem::stackAfter(const QQuickItem *sibling)
2000 if (!sibling || sibling == this || !d->parentItem || d->parentItem != QQuickItemPrivate::get(sibling)->parentItem) {
2001 qWarning("QQuickItem::stackAfter: Cannot stack after %p, which must be a sibling", sibling);
2005 QQuickItemPrivate *parentPrivate = QQuickItemPrivate::get(d->parentItem);
2007 int myIndex = parentPrivate->childItems.indexOf(this);
2008 int siblingIndex = parentPrivate->childItems.indexOf(const_cast<QQuickItem *>(sibling));
2010 Q_ASSERT(myIndex != -1 && siblingIndex != -1);
2012 if (myIndex == siblingIndex + 1)
2015 parentPrivate->childItems.removeAt(myIndex);
2017 if (myIndex < siblingIndex) --siblingIndex;
2019 parentPrivate->childItems.insert(siblingIndex + 1, this);
2021 parentPrivate->dirty(QQuickItemPrivate::ChildrenStackingChanged);
2022 parentPrivate->markSortedChildrenDirty(this);
2024 for (int ii = qMin(myIndex, siblingIndex + 1); ii < parentPrivate->childItems.count(); ++ii)
2025 QQuickItemPrivate::get(parentPrivate->childItems.at(ii))->siblingOrderChanged();
2029 Returns the QQuickItem parent of this item.
2031 QQuickItem *QQuickItem::parentItem() const
2033 Q_D(const QQuickItem);
2034 return d->parentItem;
2037 QSGEngine *QQuickItem::sceneGraphEngine() const
2039 return canvas()->sceneGraphEngine();
2042 QQuickCanvas *QQuickItem::canvas() const
2044 Q_D(const QQuickItem);
2048 static bool itemZOrder_sort(QQuickItem *lhs, QQuickItem *rhs)
2050 return lhs->z() < rhs->z();
2053 QList<QQuickItem *> QQuickItemPrivate::paintOrderChildItems() const
2055 if (sortedChildItems)
2056 return *sortedChildItems;
2058 // If none of the items have set Z then the paint order list is the same as
2059 // the childItems list. This is by far the most common case.
2061 for (int i = 0; i < childItems.count(); ++i) {
2062 if (QQuickItemPrivate::get(childItems.at(i))->z() != 0.) {
2068 sortedChildItems = new QList<QQuickItem*>(childItems);
2069 qStableSort(sortedChildItems->begin(), sortedChildItems->end(), itemZOrder_sort);
2070 return *sortedChildItems;
2073 sortedChildItems = const_cast<QList<QQuickItem*>*>(&childItems);
2078 void QQuickItemPrivate::addChild(QQuickItem *child)
2082 Q_ASSERT(!childItems.contains(child));
2084 childItems.append(child);
2086 markSortedChildrenDirty(child);
2087 dirty(QQuickItemPrivate::ChildrenChanged);
2089 itemChange(QQuickItem::ItemChildAddedChange, child);
2091 emit q->childrenChanged();
2094 void QQuickItemPrivate::removeChild(QQuickItem *child)
2099 Q_ASSERT(childItems.contains(child));
2100 childItems.removeOne(child);
2101 Q_ASSERT(!childItems.contains(child));
2103 markSortedChildrenDirty(child);
2104 dirty(QQuickItemPrivate::ChildrenChanged);
2106 itemChange(QQuickItem::ItemChildRemovedChange, child);
2108 emit q->childrenChanged();
2111 void QQuickItemPrivate::InitializationState::clear()
2116 void QQuickItemPrivate::InitializationState::clear(QQuickItem *fs)
2121 QQuickItem *QQuickItemPrivate::InitializationState::getFocusScope(QQuickItem *item)
2124 QQuickItem *fs = item->parentItem();
2125 while (fs->parentItem() && !fs->isFocusScope())
2126 fs = fs->parentItem();
2132 void QQuickItemPrivate::initCanvas(InitializationState *state, QQuickCanvas *c)
2137 removeFromDirtyList();
2138 QQuickCanvasPrivate *c = QQuickCanvasPrivate::get(canvas);
2139 if (polishScheduled)
2140 c->itemsToPolish.remove(q);
2141 if (c->mouseGrabberItem == q)
2142 c->mouseGrabberItem = 0;
2144 c->hoverItems.removeAll(q);
2145 if (itemNodeInstance)
2146 c->cleanup(itemNodeInstance);
2148 c->parentlessItems.remove(q);
2153 if (canvas && polishScheduled)
2154 QQuickCanvasPrivate::get(canvas)->itemsToPolish.insert(q);
2156 itemNodeInstance = 0;
2158 if (extra.isAllocated()) {
2159 extra->opacityNode = 0;
2160 extra->clipNode = 0;
2161 extra->rootNode = 0;
2162 extra->beforePaintNode = 0;
2168 InitializationState _dummy;
2169 InitializationState *childState = state;
2171 if (c && q->isFocusScope()) {
2173 childState = &_dummy;
2176 if (!parentItem && canvas)
2177 QQuickCanvasPrivate::get(canvas)->parentlessItems.insert(q);
2179 for (int ii = 0; ii < childItems.count(); ++ii) {
2180 QQuickItem *child = childItems.at(ii);
2181 QQuickItemPrivate::get(child)->initCanvas(childState, c);
2186 if (state->getFocusScope(q)->scopedFocusItem()) {
2188 emit q->focusChanged(false);
2190 QQuickCanvasPrivate::get(canvas)->setFocusInScope(state->getFocusScope(q), q);
2196 if (extra.isAllocated() && extra->screenAttached)
2197 extra->screenAttached->canvasChanged(c);
2198 itemChange(QQuickItem::ItemSceneChange, c);
2202 Returns a transform that maps points from canvas space into item space.
2204 QTransform QQuickItemPrivate::canvasToItemTransform() const
2206 // XXX todo - optimize
2207 return itemToCanvasTransform().inverted();
2211 Returns a transform that maps points from item space into canvas space.
2213 QTransform QQuickItemPrivate::itemToCanvasTransform() const
2216 QTransform rv = parentItem?QQuickItemPrivate::get(parentItem)->itemToCanvasTransform():QTransform();
2217 itemToParentTransform(rv);
2222 Motifies \a t with this items local transform relative to its parent.
2224 void QQuickItemPrivate::itemToParentTransform(QTransform &t) const
2229 if (!transforms.isEmpty()) {
2231 for (int ii = transforms.count() - 1; ii >= 0; --ii)
2232 transforms.at(ii)->applyTo(&m);
2233 t = m.toTransform();
2236 if (scale() != 1. || rotation() != 0.) {
2237 QPointF tp = computeTransformOrigin();
2238 t.translate(tp.x(), tp.y());
2239 t.scale(scale(), scale());
2240 t.rotate(rotation());
2241 t.translate(-tp.x(), -tp.y());
2247 \qmlproperty real QtQuick2::Item::childrenRect.x
2248 \qmlproperty real QtQuick2::Item::childrenRect.y
2249 \qmlproperty real QtQuick2::Item::childrenRect.width
2250 \qmlproperty real QtQuick2::Item::childrenRect.height
2252 The childrenRect properties allow an item access to the geometry of its
2253 children. This property is useful if you have an item that needs to be
2254 sized to fit its children.
2259 \qmlproperty list<Item> QtQuick2::Item::children
2260 \qmlproperty list<Object> QtQuick2::Item::resources
2262 The children property contains the list of visual children of this item.
2263 The resources property contains non-visual resources that you want to
2266 Generally you can rely on Item's default property to handle all this for
2267 you, but it can come in handy in some cases.
2286 Returns true if construction of the QML component is complete; otherwise
2289 It is often desirable to delay some processing until the component is
2292 \sa componentComplete()
2294 bool QQuickItem::isComponentComplete() const
2296 Q_D(const QQuickItem);
2297 return d->componentComplete;
2300 QQuickItemPrivate::QQuickItemPrivate()
2301 : _anchors(0), _stateGroup(0),
2302 flags(0), widthValid(false), heightValid(false), baselineOffsetValid(false), componentComplete(true),
2303 keepMouse(false), keepTouch(false), hoverEnabled(false), smooth(false), focus(false), activeFocus(false), notifiedFocus(false),
2304 notifiedActiveFocus(false), filtersChildMouseEvents(false), explicitVisible(true),
2305 effectiveVisible(true), explicitEnable(true), effectiveEnable(true), polishScheduled(false),
2306 inheritedLayoutMirror(false), effectiveLayoutMirror(false), isMirrorImplicit(true),
2307 inheritMirrorFromParent(false), inheritMirrorFromItem(false), childrenDoNotOverlap(false),
2308 staticSubtreeGeometry(false),
2309 isAccessible(false),
2311 dirtyAttributes(0), nextDirtyItem(0), prevDirtyItem(0),
2313 canvas(0), parentItem(0), sortedChildItems(&childItems),
2317 x(0), y(0), width(0), height(0), implicitWidth(0), implicitHeight(0),
2321 itemNodeInstance(0), groupNode(0), paintNode(0)
2325 QQuickItemPrivate::~QQuickItemPrivate()
2327 if (sortedChildItems != &childItems)
2328 delete sortedChildItems;
2331 void QQuickItemPrivate::init(QQuickItem *parent)
2335 static bool atexit_registered = false;
2336 if (!atexit_registered) {
2337 atexit(qt_print_item_count);
2338 atexit_registered = true;
2344 registerAccessorProperties();
2346 baselineOffsetValid = false;
2349 q->setParentItem(parent);
2350 QQuickItemPrivate *parentPrivate = QQuickItemPrivate::get(parent);
2351 setImplicitLayoutMirror(parentPrivate->inheritedLayoutMirror, parentPrivate->inheritMirrorFromParent);
2355 void QQuickItemPrivate::data_append(QQmlListProperty<QObject> *prop, QObject *o)
2360 QQuickItem *that = static_cast<QQuickItem *>(prop->object);
2362 // This test is measurably (albeit only slightly) faster than qobject_cast<>()
2363 const QMetaObject *mo = o->metaObject();
2364 while (mo && mo != &QQuickItem::staticMetaObject) {
2365 mo = mo->d.superdata;
2369 QQuickItem *item = static_cast<QQuickItem *>(o);
2370 item->setParentItem(that);
2372 if (o->inherits("QGraphicsItem"))
2373 qWarning("Cannot add a QtQuick 1.0 item (%s) into a QtQuick 2.0 scene!", o->metaObject()->className());
2375 // XXX todo - do we really want this behavior?
2381 \qmlproperty list<Object> QtQuick2::Item::data
2384 The data property allows you to freely mix visual children and resources
2385 in an item. If you assign a visual item to the data list it becomes
2386 a child and if you assign any other object type, it is added as a resource.
2410 data is a behind-the-scenes property: you should never need to explicitly
2414 int QQuickItemPrivate::data_count(QQmlListProperty<QObject> *prop)
2421 QObject *QQuickItemPrivate::data_at(QQmlListProperty<QObject> *prop, int i)
2429 void QQuickItemPrivate::data_clear(QQmlListProperty<QObject> *prop)
2435 QObject *QQuickItemPrivate::resources_at(QQmlListProperty<QObject> *prop, int index)
2437 const QObjectList children = prop->object->children();
2438 if (index < children.count())
2439 return children.at(index);
2444 void QQuickItemPrivate::resources_append(QQmlListProperty<QObject> *prop, QObject *o)
2446 // XXX todo - do we really want this behavior?
2447 o->setParent(prop->object);
2450 int QQuickItemPrivate::resources_count(QQmlListProperty<QObject> *prop)
2452 return prop->object->children().count();
2455 void QQuickItemPrivate::resources_clear(QQmlListProperty<QObject> *prop)
2457 // XXX todo - do we really want this behavior?
2458 const QObjectList children = prop->object->children();
2459 for (int index = 0; index < children.count(); index++)
2460 children.at(index)->setParent(0);
2463 QQuickItem *QQuickItemPrivate::children_at(QQmlListProperty<QQuickItem> *prop, int index)
2465 QQuickItemPrivate *p = QQuickItemPrivate::get(static_cast<QQuickItem *>(prop->object));
2466 if (index >= p->childItems.count() || index < 0)
2469 return p->childItems.at(index);
2472 void QQuickItemPrivate::children_append(QQmlListProperty<QQuickItem> *prop, QQuickItem *o)
2477 QQuickItem *that = static_cast<QQuickItem *>(prop->object);
2478 if (o->parentItem() == that)
2479 o->setParentItem(0);
2481 o->setParentItem(that);
2484 int QQuickItemPrivate::children_count(QQmlListProperty<QQuickItem> *prop)
2486 QQuickItemPrivate *p = QQuickItemPrivate::get(static_cast<QQuickItem *>(prop->object));
2487 return p->childItems.count();
2490 void QQuickItemPrivate::children_clear(QQmlListProperty<QQuickItem> *prop)
2492 QQuickItem *that = static_cast<QQuickItem *>(prop->object);
2493 QQuickItemPrivate *p = QQuickItemPrivate::get(that);
2494 while (!p->childItems.isEmpty())
2495 p->childItems.at(0)->setParentItem(0);
2498 void QQuickItemPrivate::visibleChildren_append(QQmlListProperty<QQuickItem>*, QQuickItem *self)
2501 qmlInfo(self) << "QQuickItem: visibleChildren property is readonly and cannot be assigned to.";
2504 int QQuickItemPrivate::visibleChildren_count(QQmlListProperty<QQuickItem> *prop)
2506 QQuickItemPrivate *p = QQuickItemPrivate::get(static_cast<QQuickItem *>(prop->object));
2507 int visibleCount = 0;
2508 int c = p->childItems.count();
2510 if (p->childItems.at(c)->isVisible()) visibleCount++;
2513 return visibleCount;
2516 QQuickItem *QQuickItemPrivate::visibleChildren_at(QQmlListProperty<QQuickItem> *prop, int index)
2518 QQuickItemPrivate *p = QQuickItemPrivate::get(static_cast<QQuickItem *>(prop->object));
2519 const int childCount = p->childItems.count();
2520 if (index >= childCount || index < 0)
2523 int visibleCount = -1;
2524 for (int i = 0; i < childCount; i++) {
2525 if (p->childItems.at(i)->isVisible()) visibleCount++;
2526 if (visibleCount == index) return p->childItems.at(i);
2531 int QQuickItemPrivate::transform_count(QQmlListProperty<QQuickTransform> *prop)
2533 QQuickItem *that = static_cast<QQuickItem *>(prop->object);
2534 QQuickItemPrivate *p = QQuickItemPrivate::get(that);
2536 return p->transforms.count();
2539 void QQuickTransform::appendToItem(QQuickItem *item)
2541 Q_D(QQuickTransform);
2545 QQuickItemPrivate *p = QQuickItemPrivate::get(item);
2547 if (!d->items.isEmpty() && !p->transforms.isEmpty() && p->transforms.contains(this)) {
2548 p->transforms.removeOne(this);
2549 p->transforms.append(this);
2551 p->transforms.append(this);
2552 d->items.append(item);
2555 p->dirty(QQuickItemPrivate::Transform);
2558 void QQuickTransform::prependToItem(QQuickItem *item)
2560 Q_D(QQuickTransform);
2564 QQuickItemPrivate *p = QQuickItemPrivate::get(item);
2566 if (!d->items.isEmpty() && !p->transforms.isEmpty() && p->transforms.contains(this)) {
2567 p->transforms.removeOne(this);
2568 p->transforms.prepend(this);
2570 p->transforms.prepend(this);
2571 d->items.append(item);
2574 p->dirty(QQuickItemPrivate::Transform);
2577 void QQuickItemPrivate::transform_append(QQmlListProperty<QQuickTransform> *prop, QQuickTransform *transform)
2582 QQuickItem *that = static_cast<QQuickItem *>(prop->object);
2583 transform->appendToItem(that);
2586 QQuickTransform *QQuickItemPrivate::transform_at(QQmlListProperty<QQuickTransform> *prop, int idx)
2588 QQuickItem *that = static_cast<QQuickItem *>(prop->object);
2589 QQuickItemPrivate *p = QQuickItemPrivate::get(that);
2591 if (idx < 0 || idx >= p->transforms.count())
2594 return p->transforms.at(idx);
2597 void QQuickItemPrivate::transform_clear(QQmlListProperty<QQuickTransform> *prop)
2599 QQuickItem *that = static_cast<QQuickItem *>(prop->object);
2600 QQuickItemPrivate *p = QQuickItemPrivate::get(that);
2602 for (int ii = 0; ii < p->transforms.count(); ++ii) {
2603 QQuickTransform *t = p->transforms.at(ii);
2604 QQuickTransformPrivate *tp = QQuickTransformPrivate::get(t);
2605 tp->items.removeOne(that);
2608 p->transforms.clear();
2610 p->dirty(QQuickItemPrivate::Transform);
2614 \property QQuickItem::childrenRect
2615 \brief The geometry of an item's children.
2617 This property holds the (collective) position and size of the item's children.
2621 \qmlproperty real QtQuick2::Item::x
2622 \qmlproperty real QtQuick2::Item::y
2623 \qmlproperty real QtQuick2::Item::width
2624 \qmlproperty real QtQuick2::Item::height
2626 Defines the item's position and size relative to its parent.
2629 Item { x: 100; y: 100; width: 100; height: 100 }
2634 \qmlproperty real QtQuick2::Item::z
2636 Sets the stacking order of sibling items. By default the stacking order is 0.
2638 Items with a higher stacking value are drawn on top of siblings with a
2639 lower stacking order. Items with the same stacking value are drawn
2640 bottom up in the order they appear. Items with a negative stacking
2641 value are drawn under their parent's content.
2643 The following example shows the various effects of stacking order.
2647 \o \image declarative-item_stacking1.png
2648 \o Same \c z - later children above earlier children:
2653 width: 100; height: 100
2657 x: 50; y: 50; width: 100; height: 100
2662 \o \image declarative-item_stacking2.png
2663 \o Higher \c z on top:
2669 width: 100; height: 100
2673 x: 50; y: 50; width: 100; height: 100
2678 \o \image declarative-item_stacking3.png
2679 \o Same \c z - children above parents:
2684 width: 100; height: 100
2687 x: 50; y: 50; width: 100; height: 100
2693 \o \image declarative-item_stacking4.png
2694 \o Lower \c z below:
2699 width: 100; height: 100
2703 x: 50; y: 50; width: 100; height: 100
2712 \qmlproperty bool QtQuick2::Item::visible
2714 This property holds whether the item is visible. By default this is true.
2716 Setting this property directly affects the \c visible value of child
2717 items. When set to \c false, the \c visible values of all child items also
2718 become \c false. When set to \c true, the \c visible values of child items
2719 are returned to \c true, unless they have explicitly been set to \c false.
2721 (Because of this flow-on behavior, using the \c visible property may not
2722 have the intended effect if a property binding should only respond to
2723 explicit property changes. In such cases it may be better to use the
2724 \l opacity property instead.)
2726 Setting this property to \c false automatically causes \l focus to be set
2727 to \c false, and this item will longer receive mouse and keyboard events.
2728 (In contrast, setting the \l opacity to 0 does not affect the \l focus
2729 property and the receiving of key events.)
2731 \note This property's value is only affected by changes to this property or
2732 the parent's \c visible property. It does not change, for example, if this
2733 item moves off-screen, or if the \l opacity changes to 0.
2738 \qmlproperty AnchorLine QtQuick2::Item::anchors.top
2739 \qmlproperty AnchorLine QtQuick2::Item::anchors.bottom
2740 \qmlproperty AnchorLine QtQuick2::Item::anchors.left
2741 \qmlproperty AnchorLine QtQuick2::Item::anchors.right
2742 \qmlproperty AnchorLine QtQuick2::Item::anchors.horizontalCenter
2743 \qmlproperty AnchorLine QtQuick2::Item::anchors.verticalCenter
2744 \qmlproperty AnchorLine QtQuick2::Item::anchors.baseline
2746 \qmlproperty Item QtQuick2::Item::anchors.fill
2747 \qmlproperty Item QtQuick2::Item::anchors.centerIn
2749 \qmlproperty real QtQuick2::Item::anchors.margins
2750 \qmlproperty real QtQuick2::Item::anchors.topMargin
2751 \qmlproperty real QtQuick2::Item::anchors.bottomMargin
2752 \qmlproperty real QtQuick2::Item::anchors.leftMargin
2753 \qmlproperty real QtQuick2::Item::anchors.rightMargin
2754 \qmlproperty real QtQuick2::Item::anchors.horizontalCenterOffset
2755 \qmlproperty real QtQuick2::Item::anchors.verticalCenterOffset
2756 \qmlproperty real QtQuick2::Item::anchors.baselineOffset
2758 \qmlproperty bool QtQuick2::Item::anchors.mirrored
2760 Anchors provide a way to position an item by specifying its
2761 relationship with other items.
2763 Margins apply to top, bottom, left, right, and fill anchors.
2764 The \c anchors.margins property can be used to set all of the various margins at once, to the same value.
2765 Note that margins are anchor-specific and are not applied if an item does not
2768 Offsets apply for horizontal center, vertical center, and baseline anchors.
2772 \o \image declarative-anchors_example.png
2773 \o Text anchored to Image, horizontally centered and vertically below, with a margin.
2782 anchors.horizontalCenter: pic.horizontalCenter
2783 anchors.top: pic.bottom
2784 anchors.topMargin: 5
2790 \o \image declarative-anchors_example2.png
2792 Left of Text anchored to right of Image, with a margin. The y
2793 property of both defaults to 0.
2803 anchors.left: pic.right
2804 anchors.leftMargin: 5
2811 \c anchors.fill provides a convenient way for one item to have the
2812 same geometry as another item, and is equivalent to connecting all
2813 four directional anchors.
2815 To clear an anchor value, set it to \c undefined.
2817 \c anchors.mirrored returns true it the layout has been \l {LayoutMirroring}{mirrored}.
2819 \note You can only anchor an item to siblings or a parent.
2821 For more information see \l {anchor-layout}{Anchor Layouts}.
2825 \property QQuickItem::baselineOffset
2826 \brief The position of the item's baseline in local coordinates.
2828 The baseline of a \l Text item is the imaginary line on which the text
2829 sits. Controls containing text usually set their baseline to the
2830 baseline of their text.
2832 For non-text items, a default baseline offset of 0 is used.
2834 QQuickAnchors *QQuickItemPrivate::anchors() const
2837 Q_Q(const QQuickItem);
2838 _anchors = new QQuickAnchors(const_cast<QQuickItem *>(q));
2839 if (!componentComplete)
2840 _anchors->classBegin();
2845 void QQuickItemPrivate::siblingOrderChanged()
2848 for (int ii = 0; ii < changeListeners.count(); ++ii) {
2849 const QQuickItemPrivate::ChangeListener &change = changeListeners.at(ii);
2850 if (change.types & QQuickItemPrivate::SiblingOrder) {
2851 change.listener->itemSiblingOrderChanged(q);
2856 QQmlListProperty<QObject> QQuickItemPrivate::data()
2858 return QQmlListProperty<QObject>(q_func(), 0, QQuickItemPrivate::data_append,
2859 QQuickItemPrivate::data_count,
2860 QQuickItemPrivate::data_at,
2861 QQuickItemPrivate::data_clear);
2864 QRectF QQuickItem::childrenRect()
2867 if (!d->extra.isAllocated() || !d->extra->contents) {
2868 d->extra.value().contents = new QQuickContents(this);
2869 if (d->componentComplete)
2870 d->extra->contents->complete();
2872 return d->extra->contents->rectF();
2875 QList<QQuickItem *> QQuickItem::childItems() const
2877 Q_D(const QQuickItem);
2878 return d->childItems;
2881 bool QQuickItem::clip() const
2883 return flags() & ItemClipsChildrenToShape;
2886 void QQuickItem::setClip(bool c)
2891 setFlag(ItemClipsChildrenToShape, c);
2893 emit clipChanged(c);
2898 This function is called to handle this item's changes in
2899 geometry from \a oldGeometry to \a newGeometry. If the two
2900 geometries are the same, it doesn't do anything.
2902 void QQuickItem::geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry)
2907 QQuickAnchorsPrivate::get(d->_anchors)->updateMe();
2909 bool xChange = (newGeometry.x() != oldGeometry.x());
2910 bool yChange = (newGeometry.y() != oldGeometry.y());
2911 bool widthChange = (newGeometry.width() != oldGeometry.width());
2912 bool heightChange = (newGeometry.height() != oldGeometry.height());
2914 for (int ii = 0; ii < d->changeListeners.count(); ++ii) {
2915 const QQuickItemPrivate::ChangeListener &change = d->changeListeners.at(ii);
2916 if (change.types & QQuickItemPrivate::Geometry) {
2917 if (change.gTypes == QQuickItemPrivate::GeometryChange) {
2918 change.listener->itemGeometryChanged(this, newGeometry, oldGeometry);
2919 } else if ((xChange && (change.gTypes & QQuickItemPrivate::XChange)) ||
2920 (yChange && (change.gTypes & QQuickItemPrivate::YChange)) ||
2921 (widthChange && (change.gTypes & QQuickItemPrivate::WidthChange)) ||
2922 (heightChange && (change.gTypes & QQuickItemPrivate::HeightChange))) {
2923 change.listener->itemGeometryChanged(this, newGeometry, oldGeometry);
2933 emit widthChanged();
2935 emit heightChanged();
2939 Called by the rendering thread when it is time to sync the state of the QML objects with the
2940 scene graph objects. The function should return the root of the scene graph subtree for
2941 this item. \a oldNode is the node that was returned the last time the function was called.
2943 The main thread is blocked while this function is executed so it is safe to read
2944 values from the QQuickItem instance and other objects in the main thread.
2946 \warning This is the only function in which it is allowed to make use of scene graph
2947 objects from the main thread. Use of scene graph objects outside this function will
2948 result in race conditions and potential crashes.
2951 QSGNode *QQuickItem::updatePaintNode(QSGNode *oldNode, UpdatePaintNodeData *)
2957 QSGTransformNode *QQuickItemPrivate::createTransformNode()
2959 return new QSGTransformNode;
2962 void QQuickItem::updatePolish()
2966 void QQuickItem::sendAccessibilityUpdate()
2970 void QQuickItemPrivate::addItemChangeListener(QQuickItemChangeListener *listener, ChangeTypes types)
2972 changeListeners.append(ChangeListener(listener, types));
2975 void QQuickItemPrivate::removeItemChangeListener(QQuickItemChangeListener *listener, ChangeTypes types)
2977 ChangeListener change(listener, types);
2978 changeListeners.removeOne(change);
2981 void QQuickItemPrivate::updateOrAddGeometryChangeListener(QQuickItemChangeListener *listener, GeometryChangeTypes types)
2983 ChangeListener change(listener, types);
2984 int index = changeListeners.find(change);
2986 changeListeners[index].gTypes = change.gTypes; //we may have different GeometryChangeTypes
2988 changeListeners.append(change);
2991 void QQuickItemPrivate::updateOrRemoveGeometryChangeListener(QQuickItemChangeListener *listener,
2992 GeometryChangeTypes types)
2994 ChangeListener change(listener, types);
2995 if (types == NoChange) {
2996 changeListeners.removeOne(change);
2998 int index = changeListeners.find(change);
3000 changeListeners[index].gTypes = change.gTypes; //we may have different GeometryChangeTypes
3004 void QQuickItem::keyPressEvent(QKeyEvent *event)
3009 void QQuickItem::keyReleaseEvent(QKeyEvent *event)
3014 void QQuickItem::inputMethodEvent(QInputMethodEvent *event)
3019 void QQuickItem::focusInEvent(QFocusEvent *)
3021 QAccessible::updateAccessibility(QAccessibleEvent(QAccessible::Focus, this, 0));
3024 void QQuickItem::focusOutEvent(QFocusEvent *)
3028 void QQuickItem::mousePressEvent(QMouseEvent *event)
3033 void QQuickItem::mouseMoveEvent(QMouseEvent *event)
3038 void QQuickItem::mouseReleaseEvent(QMouseEvent *event)
3043 void QQuickItem::mouseDoubleClickEvent(QMouseEvent *event)
3045 mousePressEvent(event);
3048 void QQuickItem::mouseUngrabEvent()
3053 void QQuickItem::touchUngrabEvent()
3058 void QQuickItem::wheelEvent(QWheelEvent *event)
3063 void QQuickItem::touchEvent(QTouchEvent *event)
3068 void QQuickItem::hoverEnterEvent(QHoverEvent *event)
3073 void QQuickItem::hoverMoveEvent(QHoverEvent *event)
3078 void QQuickItem::hoverLeaveEvent(QHoverEvent *event)
3083 void QQuickItem::dragEnterEvent(QDragEnterEvent *event)
3088 void QQuickItem::dragMoveEvent(QDragMoveEvent *event)
3094 void QQuickItem::dragLeaveEvent(QDragLeaveEvent *event)
3100 void QQuickItem::dropEvent(QDropEvent *event)
3105 bool QQuickItem::childMouseEventFilter(QQuickItem *, QEvent *)
3110 void QQuickItem::windowDeactivateEvent()
3112 foreach (QQuickItem* item, childItems()) {
3113 item->windowDeactivateEvent();
3117 QVariant QQuickItem::inputMethodQuery(Qt::InputMethodQuery query) const
3119 Q_D(const QQuickItem);
3124 v = (bool)(flags() & ItemAcceptsInputMethod);
3127 case Qt::ImCursorRectangle:
3129 case Qt::ImCursorPosition:
3130 case Qt::ImSurroundingText:
3131 case Qt::ImCurrentSelection:
3132 case Qt::ImMaximumTextLength:
3133 case Qt::ImAnchorPosition:
3134 case Qt::ImPreferredLanguage:
3135 if (d->extra.isAllocated() && d->extra->keyHandler)
3136 v = d->extra->keyHandler->inputMethodQuery(query);
3144 QQuickAnchorLine QQuickItemPrivate::left() const
3146 Q_Q(const QQuickItem);
3147 return QQuickAnchorLine(const_cast<QQuickItem *>(q), QQuickAnchorLine::Left);
3150 QQuickAnchorLine QQuickItemPrivate::right() const
3152 Q_Q(const QQuickItem);
3153 return QQuickAnchorLine(const_cast<QQuickItem *>(q), QQuickAnchorLine::Right);
3156 QQuickAnchorLine QQuickItemPrivate::horizontalCenter() const
3158 Q_Q(const QQuickItem);
3159 return QQuickAnchorLine(const_cast<QQuickItem *>(q), QQuickAnchorLine::HCenter);
3162 QQuickAnchorLine QQuickItemPrivate::top() const
3164 Q_Q(const QQuickItem);
3165 return QQuickAnchorLine(const_cast<QQuickItem *>(q), QQuickAnchorLine::Top);
3168 QQuickAnchorLine QQuickItemPrivate::bottom() const
3170 Q_Q(const QQuickItem);
3171 return QQuickAnchorLine(const_cast<QQuickItem *>(q), QQuickAnchorLine::Bottom);
3174 QQuickAnchorLine QQuickItemPrivate::verticalCenter() const
3176 Q_Q(const QQuickItem);
3177 return QQuickAnchorLine(const_cast<QQuickItem *>(q), QQuickAnchorLine::VCenter);
3180 QQuickAnchorLine QQuickItemPrivate::baseline() const
3182 Q_Q(const QQuickItem);
3183 return QQuickAnchorLine(const_cast<QQuickItem *>(q), QQuickAnchorLine::Baseline);
3186 qreal QQuickItem::baselineOffset() const
3188 Q_D(const QQuickItem);
3189 if (d->baselineOffsetValid) {
3190 return d->baselineOffset;
3196 void QQuickItem::setBaselineOffset(qreal offset)
3199 if (offset == d->baselineOffset)
3202 d->baselineOffset = offset;
3203 d->baselineOffsetValid = true;
3205 for (int ii = 0; ii < d->changeListeners.count(); ++ii) {
3206 const QQuickItemPrivate::ChangeListener &change = d->changeListeners.at(ii);
3207 if (change.types & QQuickItemPrivate::Geometry) {
3208 QQuickAnchorsPrivate *anchor = change.listener->anchorPrivate();
3210 anchor->updateVerticalAnchors();
3213 emit baselineOffsetChanged(offset);
3216 void QQuickItem::update()
3219 Q_ASSERT(flags() & ItemHasContents);
3220 d->dirty(QQuickItemPrivate::Content);
3223 void QQuickItem::polish()
3226 if (!d->polishScheduled) {
3227 d->polishScheduled = true;
3229 QQuickCanvasPrivate *p = QQuickCanvasPrivate::get(d->canvas);
3230 bool maybeupdate = p->itemsToPolish.isEmpty();
3231 p->itemsToPolish.insert(this);
3232 if (maybeupdate) d->canvas->maybeUpdate();
3237 void QQuickItem::mapFromItem(QQmlV8Function *args) const
3239 if (args->Length() != 0) {
3240 v8::Local<v8::Value> item = (*args)[0];
3241 QV8Engine *engine = args->engine();
3243 QQuickItem *itemObj = 0;
3244 if (!item->IsNull())
3245 itemObj = qobject_cast<QQuickItem*>(engine->toQObject(item));
3247 if (!itemObj && !item->IsNull()) {
3248 qmlInfo(this) << "mapFromItem() given argument \"" << engine->toString(item->ToString())
3249 << "\" which is neither null nor an Item";
3253 v8::Local<v8::Object> rv = v8::Object::New();
3254 args->returnValue(rv);
3256 qreal x = (args->Length() > 1)?(*args)[1]->NumberValue():0;
3257 qreal y = (args->Length() > 2)?(*args)[2]->NumberValue():0;
3259 QPointF p = mapFromItem(itemObj, QPointF(x, y));
3261 rv->Set(v8::String::New("x"), v8::Number::New(p.x()));
3262 rv->Set(v8::String::New("y"), v8::Number::New(p.y()));
3266 QTransform QQuickItem::itemTransform(QQuickItem *other, bool *ok) const
3268 Q_D(const QQuickItem);
3270 // XXX todo - we need to be able to handle common parents better and detect
3274 QTransform t = d->itemToCanvasTransform();
3275 if (other) t *= QQuickItemPrivate::get(other)->canvasToItemTransform();
3280 void QQuickItem::mapToItem(QQmlV8Function *args) const
3282 if (args->Length() != 0) {
3283 v8::Local<v8::Value> item = (*args)[0];
3284 QV8Engine *engine = args->engine();
3286 QQuickItem *itemObj = 0;
3287 if (!item->IsNull())
3288 itemObj = qobject_cast<QQuickItem*>(engine->toQObject(item));
3290 if (!itemObj && !item->IsNull()) {
3291 qmlInfo(this) << "mapToItem() given argument \"" << engine->toString(item->ToString())
3292 << "\" which is neither null nor an Item";
3296 v8::Local<v8::Object> rv = v8::Object::New();
3297 args->returnValue(rv);
3299 qreal x = (args->Length() > 1)?(*args)[1]->NumberValue():0;
3300 qreal y = (args->Length() > 2)?(*args)[2]->NumberValue():0;
3302 QPointF p = mapToItem(itemObj, QPointF(x, y));
3304 rv->Set(v8::String::New("x"), v8::Number::New(p.x()));
3305 rv->Set(v8::String::New("y"), v8::Number::New(p.y()));
3309 void QQuickItem::forceActiveFocus()
3312 QQuickItem *parent = parentItem();
3314 if (parent->flags() & QQuickItem::ItemIsFocusScope) {
3315 parent->setFocus(true);
3317 parent = parent->parentItem();
3321 QQuickItem *QQuickItem::childAt(qreal x, qreal y) const
3323 // XXX todo - should this include transform etc.?
3324 const QList<QQuickItem *> children = childItems();
3325 for (int i = children.count()-1; i >= 0; --i) {
3326 QQuickItem *child = children.at(i);
3327 if (child->isVisible() && child->x() <= x
3328 && child->x() + child->width() >= x
3330 && child->y() + child->height() >= y)
3336 QQmlListProperty<QObject> QQuickItemPrivate::resources()
3338 return QQmlListProperty<QObject>(q_func(), 0, QQuickItemPrivate::resources_append,
3339 QQuickItemPrivate::resources_count,
3340 QQuickItemPrivate::resources_at,
3341 QQuickItemPrivate::resources_clear);
3344 QQmlListProperty<QQuickItem> QQuickItemPrivate::children()
3346 return QQmlListProperty<QQuickItem>(q_func(), 0, QQuickItemPrivate::children_append,
3347 QQuickItemPrivate::children_count,
3348 QQuickItemPrivate::children_at,
3349 QQuickItemPrivate::children_clear);
3354 \qmlproperty real QtQuick2::Item::visibleChildren
3355 This read-only property lists all of the item's children that are currently visible.
3356 Note that a child's visibility may have changed explicitly, or because the visibility
3357 of this (it's parent) item or another grandparent changed.
3359 QQmlListProperty<QQuickItem> QQuickItemPrivate::visibleChildren()
3361 return QQmlListProperty<QQuickItem>(q_func(), 0, QQuickItemPrivate::visibleChildren_append,
3362 QQuickItemPrivate::visibleChildren_count,
3363 QQuickItemPrivate::visibleChildren_at);
3367 QQmlListProperty<QQuickState> QQuickItemPrivate::states()
3369 return _states()->statesProperty();
3372 QQmlListProperty<QQuickTransition> QQuickItemPrivate::transitions()
3374 return _states()->transitionsProperty();
3377 QString QQuickItemPrivate::state() const
3382 return _stateGroup->state();
3385 void QQuickItemPrivate::setState(const QString &state)
3387 _states()->setState(state);
3390 QString QQuickItem::state() const
3392 Q_D(const QQuickItem);
3396 void QQuickItem::setState(const QString &state)
3402 QQmlListProperty<QQuickTransform> QQuickItem::transform()
3404 return QQmlListProperty<QQuickTransform>(this, 0, QQuickItemPrivate::transform_append,
3405 QQuickItemPrivate::transform_count,
3406 QQuickItemPrivate::transform_at,
3407 QQuickItemPrivate::transform_clear);
3410 void QQuickItem::classBegin()
3413 d->componentComplete = false;
3415 d->_stateGroup->classBegin();
3417 d->_anchors->classBegin();
3418 if (d->extra.isAllocated() && d->extra->layer)
3419 d->extra->layer->classBegin();
3422 void QQuickItem::componentComplete()
3425 d->componentComplete = true;
3427 d->_stateGroup->componentComplete();
3429 d->_anchors->componentComplete();
3430 QQuickAnchorsPrivate::get(d->_anchors)->updateOnComplete();
3433 if (d->extra.isAllocated() && d->extra->layer)
3434 d->extra->layer->componentComplete();
3436 if (d->extra.isAllocated() && d->extra->keyHandler)
3437 d->extra->keyHandler->componentComplete();
3439 if (d->extra.isAllocated() && d->extra->contents)
3440 d->extra->contents->complete();
3443 QQuickStateGroup *QQuickItemPrivate::_states()
3447 _stateGroup = new QQuickStateGroup;
3448 if (!componentComplete)
3449 _stateGroup->classBegin();
3450 FAST_CONNECT(_stateGroup, SIGNAL(stateChanged(QString)),
3451 q, SIGNAL(stateChanged(QString)))
3457 QPointF QQuickItemPrivate::computeTransformOrigin() const
3461 case QQuickItem::TopLeft:
3462 return QPointF(0, 0);
3463 case QQuickItem::Top:
3464 return QPointF(width / 2., 0);
3465 case QQuickItem::TopRight:
3466 return QPointF(width, 0);
3467 case QQuickItem::Left:
3468 return QPointF(0, height / 2.);
3469 case QQuickItem::Center:
3470 return QPointF(width / 2., height / 2.);
3471 case QQuickItem::Right:
3472 return QPointF(width, height / 2.);
3473 case QQuickItem::BottomLeft:
3474 return QPointF(0, height);
3475 case QQuickItem::Bottom:
3476 return QPointF(width / 2., height);
3477 case QQuickItem::BottomRight:
3478 return QPointF(width, height);
3482 void QQuickItemPrivate::transformChanged()
3484 if (extra.isAllocated() && extra->layer)
3485 extra->layer->updateMatrix();
3488 void QQuickItemPrivate::deliverKeyEvent(QKeyEvent *e)
3492 Q_ASSERT(e->isAccepted());
3493 if (extra.isAllocated() && extra->keyHandler) {
3494 if (e->type() == QEvent::KeyPress)
3495 extra->keyHandler->keyPressed(e, false);
3497 extra->keyHandler->keyReleased(e, false);
3499 if (e->isAccepted())
3505 if (e->type() == QEvent::KeyPress)
3506 q->keyPressEvent(e);
3508 q->keyReleaseEvent(e);
3510 if (e->isAccepted())
3513 if (extra.isAllocated() && extra->keyHandler) {
3516 if (e->type() == QEvent::KeyPress)
3517 extra->keyHandler->keyPressed(e, true);
3519 extra->keyHandler->keyReleased(e, true);
3523 void QQuickItemPrivate::deliverInputMethodEvent(QInputMethodEvent *e)
3527 Q_ASSERT(e->isAccepted());
3528 if (extra.isAllocated() && extra->keyHandler) {
3529 extra->keyHandler->inputMethodEvent(e, false);
3531 if (e->isAccepted())
3537 q->inputMethodEvent(e);
3539 if (e->isAccepted())
3542 if (extra.isAllocated() && extra->keyHandler) {
3545 extra->keyHandler->inputMethodEvent(e, true);
3549 void QQuickItemPrivate::deliverFocusEvent(QFocusEvent *e)
3553 if (e->type() == QEvent::FocusIn) {
3556 q->focusOutEvent(e);
3560 void QQuickItemPrivate::deliverMouseEvent(QMouseEvent *e)
3564 Q_ASSERT(e->isAccepted());
3566 switch (e->type()) {
3568 Q_ASSERT(!"Unknown event type");
3569 case QEvent::MouseMove:
3570 q->mouseMoveEvent(e);
3572 case QEvent::MouseButtonPress:
3573 q->mousePressEvent(e);
3575 case QEvent::MouseButtonRelease:
3576 q->mouseReleaseEvent(e);
3578 case QEvent::MouseButtonDblClick:
3579 q->mouseDoubleClickEvent(e);
3584 void QQuickItemPrivate::deliverWheelEvent(QWheelEvent *e)
3590 void QQuickItemPrivate::deliverTouchEvent(QTouchEvent *e)
3596 void QQuickItemPrivate::deliverHoverEvent(QHoverEvent *e)
3599 switch (e->type()) {
3601 Q_ASSERT(!"Unknown event type");
3602 case QEvent::HoverEnter:
3603 q->hoverEnterEvent(e);
3605 case QEvent::HoverLeave:
3606 q->hoverLeaveEvent(e);
3608 case QEvent::HoverMove:
3609 q->hoverMoveEvent(e);
3614 void QQuickItemPrivate::deliverDragEvent(QEvent *e)
3617 switch (e->type()) {
3619 Q_ASSERT(!"Unknown event type");
3620 case QEvent::DragEnter:
3621 q->dragEnterEvent(static_cast<QDragEnterEvent *>(e));
3623 case QEvent::DragLeave:
3624 q->dragLeaveEvent(static_cast<QDragLeaveEvent *>(e));
3626 case QEvent::DragMove:
3627 q->dragMoveEvent(static_cast<QDragMoveEvent *>(e));
3630 q->dropEvent(static_cast<QDropEvent *>(e));
3635 void QQuickItem::itemChange(ItemChange change, const ItemChangeData &value)
3642 Notify input method on updated query values if needed. \a indicates changed attributes.
3644 void QQuickItem::updateInputMethod(Qt::InputMethodQueries queries)
3646 if (hasActiveFocus())
3647 qApp->inputMethod()->update(queries);
3651 // XXX todo - do we want/need this anymore?
3652 QRectF QQuickItem::boundingRect() const
3654 Q_D(const QQuickItem);
3655 return QRectF(0, 0, d->width, d->height);
3659 QRectF QQuickItem::clipRect() const
3661 Q_D(const QQuickItem);
3662 return QRectF(0, 0, d->width, d->height);
3666 QQuickItem::TransformOrigin QQuickItem::transformOrigin() const
3668 Q_D(const QQuickItem);
3672 void QQuickItem::setTransformOrigin(TransformOrigin origin)
3675 if (origin == d->origin())
3678 d->extra.value().origin = origin;
3679 d->dirty(QQuickItemPrivate::TransformOrigin);
3681 emit transformOriginChanged(d->origin());
3684 QPointF QQuickItem::transformOriginPoint() const
3686 Q_D(const QQuickItem);
3687 if (d->extra.isAllocated() && !d->extra->userTransformOriginPoint.isNull())
3688 return d->extra->userTransformOriginPoint;
3689 return d->computeTransformOrigin();
3692 void QQuickItem::setTransformOriginPoint(const QPointF &point)
3695 if (d->extra.value().userTransformOriginPoint == point)
3698 d->extra->userTransformOriginPoint = point;
3699 d->dirty(QQuickItemPrivate::TransformOrigin);
3702 qreal QQuickItem::z() const
3704 Q_D(const QQuickItem);
3708 void QQuickItem::setZ(qreal v)
3714 d->extra.value().z = v;
3716 d->dirty(QQuickItemPrivate::ZValue);
3717 if (d->parentItem) {
3718 QQuickItemPrivate::get(d->parentItem)->dirty(QQuickItemPrivate::ChildrenStackingChanged);
3719 QQuickItemPrivate::get(d->parentItem)->markSortedChildrenDirty(this);
3724 if (d->extra.isAllocated() && d->extra->layer)
3725 d->extra->layer->updateZ();
3730 \qmlproperty real QtQuick2::Item::rotation
3731 This property holds the rotation of the item in degrees clockwise.
3733 This specifies how many degrees to rotate the item around its transformOrigin.
3734 The default rotation is 0 degrees (i.e. not rotated at all).
3738 \o \image declarative-rotation.png
3743 width: 100; height: 100
3746 x: 25; y: 25; width: 50; height: 50
3753 \sa transform, Rotation
3757 \qmlproperty real QtQuick2::Item::scale
3758 This property holds the scale of the item.
3760 A scale of less than 1 means the item will be displayed smaller than
3761 normal, and a scale of greater than 1 means the item will be
3762 displayed larger than normal. A negative scale means the item will
3765 By default, items are displayed at a scale of 1 (i.e. at their
3768 Scaling is from the item's transformOrigin.
3772 \o \image declarative-scale.png
3777 width: 100; height: 100
3780 width: 25; height: 25
3784 x: 25; y: 25; width: 50; height: 50
3791 \sa transform, Scale
3795 \qmlproperty real QtQuick2::Item::opacity
3797 This property holds the opacity of the item. Opacity is specified as a
3798 number between 0 (fully transparent) and 1 (fully opaque). The default is 1.
3800 When this property is set, the specified opacity is also applied
3801 individually to child items. In almost all cases this is what you want,
3802 but in some cases it may produce undesired results. For example in the
3803 second set of rectangles below, the red rectangle has specified an opacity
3804 of 0.5, which affects the opacity of its blue child rectangle even though
3805 the child has not specified an opacity.
3809 \o \image declarative-item_opacity1.png
3815 width: 100; height: 100
3818 x: 50; y: 50; width: 100; height: 100
3824 \o \image declarative-item_opacity2.png
3831 width: 100; height: 100
3834 x: 50; y: 50; width: 100; height: 100
3841 If an item's opacity is set to 0, the item will no longer receive mouse
3842 events, but will continue to receive key events and will retain the keyboard
3843 \l focus if it has been set. (In contrast, setting the \l visible property
3844 to \c false stops both mouse and keyboard events, and also removes focus
3849 Returns a value indicating whether mouse input should
3850 remain with this item exclusively.
3852 \sa setKeepMouseGrab()
3855 qreal QQuickItem::rotation() const
3857 Q_D(const QQuickItem);
3858 return d->rotation();
3861 void QQuickItem::setRotation(qreal r)
3864 if (d->rotation() == r)
3867 d->extra.value().rotation = r;
3869 d->dirty(QQuickItemPrivate::BasicTransform);
3871 d->itemChange(ItemRotationHasChanged, r);
3873 emit rotationChanged();
3876 qreal QQuickItem::scale() const
3878 Q_D(const QQuickItem);
3882 void QQuickItem::setScale(qreal s)
3885 if (d->scale() == s)
3888 d->extra.value().scale = s;
3890 d->dirty(QQuickItemPrivate::BasicTransform);
3892 emit scaleChanged();
3895 qreal QQuickItem::opacity() const
3897 Q_D(const QQuickItem);
3898 return d->opacity();
3901 void QQuickItem::setOpacity(qreal o)
3904 if (d->opacity() == o)
3907 d->extra.value().opacity = o;
3909 d->dirty(QQuickItemPrivate::OpacityValue);
3911 d->itemChange(ItemOpacityHasChanged, o);
3913 emit opacityChanged();
3916 bool QQuickItem::isVisible() const
3918 Q_D(const QQuickItem);
3919 return d->effectiveVisible;
3922 void QQuickItem::setVisible(bool v)
3925 if (v == d->explicitVisible)
3928 d->explicitVisible = v;
3930 const bool childVisibilityChanged = d->setEffectiveVisibleRecur(d->calcEffectiveVisible());
3931 if (childVisibilityChanged && d->parentItem)
3932 emit d->parentItem->visibleChildrenChanged(); // signal the parent, not this!
3935 bool QQuickItem::isEnabled() const
3937 Q_D(const QQuickItem);
3938 return d->effectiveEnable;
3941 void QQuickItem::setEnabled(bool e)
3944 if (e == d->explicitEnable)
3947 d->explicitEnable = e;
3949 QQuickItem *scope = parentItem();
3950 while (scope && !scope->isFocusScope())
3951 scope = scope->parentItem();
3953 d->setEffectiveEnableRecur(scope, d->calcEffectiveEnable());
3956 bool QQuickItemPrivate::calcEffectiveVisible() const
3958 // XXX todo - Should the effective visible of an element with no parent just be the current
3959 // effective visible? This would prevent pointless re-processing in the case of an element
3960 // moving to/from a no-parent situation, but it is different from what graphics view does.
3961 return explicitVisible && (!parentItem || QQuickItemPrivate::get(parentItem)->effectiveVisible);
3964 bool QQuickItemPrivate::setEffectiveVisibleRecur(bool newEffectiveVisible)
3968 if (newEffectiveVisible && !explicitVisible) {
3969 // This item locally overrides visibility
3970 return false; // effective visibility didn't change
3973 if (newEffectiveVisible == effectiveVisible) {
3974 // No change necessary
3975 return false; // effective visibility didn't change
3978 effectiveVisible = newEffectiveVisible;
3980 if (parentItem) QQuickItemPrivate::get(parentItem)->dirty(ChildrenStackingChanged);
3983 QQuickCanvasPrivate *canvasPriv = QQuickCanvasPrivate::get(canvas);
3984 if (canvasPriv->mouseGrabberItem == q)
3988 bool childVisibilityChanged = false;
3989 for (int ii = 0; ii < childItems.count(); ++ii)
3990 childVisibilityChanged |= QQuickItemPrivate::get(childItems.at(ii))->setEffectiveVisibleRecur(newEffectiveVisible);
3992 itemChange(QQuickItem::ItemVisibleHasChanged, effectiveVisible);
3995 QAccessible::updateAccessibility(QAccessibleEvent(effectiveVisible ? QAccessible::ObjectShow : QAccessible::ObjectHide, q, 0));
3997 emit q->visibleChanged();
3998 if (childVisibilityChanged)
3999 emit q->visibleChildrenChanged();
4001 return true; // effective visibility DID change
4004 bool QQuickItemPrivate::calcEffectiveEnable() const
4006 // XXX todo - Should the effective enable of an element with no parent just be the current
4007 // effective enable? This would prevent pointless re-processing in the case of an element
4008 // moving to/from a no-parent situation, but it is different from what graphics view does.
4009 return explicitEnable && (!parentItem || QQuickItemPrivate::get(parentItem)->effectiveEnable);
4012 void QQuickItemPrivate::setEffectiveEnableRecur(QQuickItem *scope, bool newEffectiveEnable)
4016 if (newEffectiveEnable && !explicitEnable) {
4017 // This item locally overrides enable
4021 if (newEffectiveEnable == effectiveEnable) {
4022 // No change necessary
4026 effectiveEnable = newEffectiveEnable;
4029 QQuickCanvasPrivate *canvasPriv = QQuickCanvasPrivate::get(canvas);
4030 if (canvasPriv->mouseGrabberItem == q)
4032 if (scope && !effectiveEnable && activeFocus) {
4033 canvasPriv->clearFocusInScope(
4034 scope, q, QQuickCanvasPrivate::DontChangeFocusProperty | QQuickCanvasPrivate::DontChangeSubFocusItem);
4038 for (int ii = 0; ii < childItems.count(); ++ii) {
4039 QQuickItemPrivate::get(childItems.at(ii))->setEffectiveEnableRecur(
4040 flags & QQuickItem::ItemIsFocusScope ? q : scope, newEffectiveEnable);
4043 if (canvas && scope && effectiveEnable && focus) {
4044 QQuickCanvasPrivate::get(canvas)->setFocusInScope(
4045 scope, q, QQuickCanvasPrivate::DontChangeFocusProperty | QQuickCanvasPrivate::DontChangeSubFocusItem);
4048 emit q->enabledChanged();
4051 QString QQuickItemPrivate::dirtyToString() const
4053 #define DIRTY_TO_STRING(value) if (dirtyAttributes & value) { \
4054 if (!rv.isEmpty()) \
4055 rv.append(QLatin1String("|")); \
4056 rv.append(QLatin1String(#value)); \
4059 // QString rv = QLatin1String("0x") + QString::number(dirtyAttributes, 16);
4062 DIRTY_TO_STRING(TransformOrigin);
4063 DIRTY_TO_STRING(Transform);
4064 DIRTY_TO_STRING(BasicTransform);
4065 DIRTY_TO_STRING(Position);
4066 DIRTY_TO_STRING(Size);
4067 DIRTY_TO_STRING(ZValue);
4068 DIRTY_TO_STRING(Content);
4069 DIRTY_TO_STRING(Smooth);
4070 DIRTY_TO_STRING(OpacityValue);
4071 DIRTY_TO_STRING(ChildrenChanged);
4072 DIRTY_TO_STRING(ChildrenStackingChanged);
4073 DIRTY_TO_STRING(ParentChanged);
4074 DIRTY_TO_STRING(Clip);
4075 DIRTY_TO_STRING(Canvas);
4076 DIRTY_TO_STRING(EffectReference);
4077 DIRTY_TO_STRING(Visible);
4078 DIRTY_TO_STRING(HideReference);
4079 DIRTY_TO_STRING(PerformanceHints);
4084 void QQuickItemPrivate::dirty(DirtyType type)
4087 if (type & (TransformOrigin | Transform | BasicTransform | Position | Size))
4090 if (!(dirtyAttributes & type) || (canvas && !prevDirtyItem)) {
4091 dirtyAttributes |= type;
4094 QQuickCanvasPrivate::get(canvas)->dirtyItem(q);
4099 void QQuickItemPrivate::addToDirtyList()
4104 if (!prevDirtyItem) {
4105 Q_ASSERT(!nextDirtyItem);
4107 QQuickCanvasPrivate *p = QQuickCanvasPrivate::get(canvas);
4108 nextDirtyItem = p->dirtyItemList;
4109 if (nextDirtyItem) QQuickItemPrivate::get(nextDirtyItem)->prevDirtyItem = &nextDirtyItem;
4110 prevDirtyItem = &p->dirtyItemList;
4111 p->dirtyItemList = q;
4114 Q_ASSERT(prevDirtyItem);
4117 void QQuickItemPrivate::removeFromDirtyList()
4119 if (prevDirtyItem) {
4120 if (nextDirtyItem) QQuickItemPrivate::get(nextDirtyItem)->prevDirtyItem = prevDirtyItem;
4121 *prevDirtyItem = nextDirtyItem;
4125 Q_ASSERT(!prevDirtyItem);
4126 Q_ASSERT(!nextDirtyItem);
4129 void QQuickItemPrivate::refFromEffectItem(bool hide)
4131 ++extra.value().effectRefCount;
4132 if (1 == extra->effectRefCount) {
4133 dirty(EffectReference);
4134 if (parentItem) QQuickItemPrivate::get(parentItem)->dirty(ChildrenStackingChanged);
4137 if (++extra->hideRefCount == 1)
4138 dirty(HideReference);
4142 void QQuickItemPrivate::derefFromEffectItem(bool unhide)
4144 Q_ASSERT(extra->effectRefCount);
4145 --extra->effectRefCount;
4146 if (0 == extra->effectRefCount) {
4147 dirty(EffectReference);
4148 if (parentItem) QQuickItemPrivate::get(parentItem)->dirty(ChildrenStackingChanged);
4151 if (--extra->hideRefCount == 0)
4152 dirty(HideReference);
4156 void QQuickItemPrivate::itemChange(QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &data)
4160 case QQuickItem::ItemChildAddedChange:
4161 q->itemChange(change, data);
4162 for (int ii = 0; ii < changeListeners.count(); ++ii) {
4163 const QQuickItemPrivate::ChangeListener &change = changeListeners.at(ii);
4164 if (change.types & QQuickItemPrivate::Children) {
4165 change.listener->itemChildAdded(q, data.item);
4169 case QQuickItem::ItemChildRemovedChange:
4170 q->itemChange(change, data);
4171 for (int ii = 0; ii < changeListeners.count(); ++ii) {
4172 const QQuickItemPrivate::ChangeListener &change = changeListeners.at(ii);
4173 if (change.types & QQuickItemPrivate::Children) {
4174 change.listener->itemChildRemoved(q, data.item);
4178 case QQuickItem::ItemSceneChange:
4179 q->itemChange(change, data);
4181 case QQuickItem::ItemVisibleHasChanged:
4182 q->itemChange(change, data);
4183 for (int ii = 0; ii < changeListeners.count(); ++ii) {
4184 const QQuickItemPrivate::ChangeListener &change = changeListeners.at(ii);
4185 if (change.types & QQuickItemPrivate::Visibility) {
4186 change.listener->itemVisibilityChanged(q);
4190 case QQuickItem::ItemParentHasChanged:
4191 q->itemChange(change, data);
4192 for (int ii = 0; ii < changeListeners.count(); ++ii) {
4193 const QQuickItemPrivate::ChangeListener &change = changeListeners.at(ii);
4194 if (change.types & QQuickItemPrivate::Parent) {
4195 change.listener->itemParentChanged(q, data.item);
4199 case QQuickItem::ItemOpacityHasChanged:
4200 q->itemChange(change, data);
4201 for (int ii = 0; ii < changeListeners.count(); ++ii) {
4202 const QQuickItemPrivate::ChangeListener &change = changeListeners.at(ii);
4203 if (change.types & QQuickItemPrivate::Opacity) {
4204 change.listener->itemOpacityChanged(q);
4208 case QQuickItem::ItemActiveFocusHasChanged:
4209 q->itemChange(change, data);
4211 case QQuickItem::ItemRotationHasChanged:
4212 q->itemChange(change, data);
4213 for (int ii = 0; ii < changeListeners.count(); ++ii) {
4214 const QQuickItemPrivate::ChangeListener &change = changeListeners.at(ii);
4215 if (change.types & QQuickItemPrivate::Rotation) {
4216 change.listener->itemRotationChanged(q);
4224 \property QQuickItem::smooth
4225 \brief whether the item is smoothly transformed.
4227 This property is provided purely for the purpose of optimization. Turning
4228 smooth transforms off is faster, but looks worse; turning smooth
4229 transformations on is slower, but looks better.
4231 By default smooth transformations are off.
4235 Returns true if the item should be drawn with antialiasing and
4236 smooth pixmap filtering, false otherwise.
4238 The default is false.
4242 bool QQuickItem::smooth() const
4244 Q_D(const QQuickItem);
4249 Sets whether the item should be drawn with antialiasing and
4250 smooth pixmap filtering to \a smooth.
4254 void QQuickItem::setSmooth(bool smooth)
4257 if (d->smooth == smooth)
4261 d->dirty(QQuickItemPrivate::Smooth);
4263 emit smoothChanged(smooth);
4266 QQuickItem::Flags QQuickItem::flags() const
4268 Q_D(const QQuickItem);
4269 return (QQuickItem::Flags)d->flags;
4272 void QQuickItem::setFlag(Flag flag, bool enabled)
4276 setFlags((Flags)(d->flags | (quint32)flag));
4278 setFlags((Flags)(d->flags & ~(quint32)flag));
4281 void QQuickItem::setFlags(Flags flags)
4285 if ((flags & ItemIsFocusScope) != (d->flags & ItemIsFocusScope)) {
4286 if (flags & ItemIsFocusScope && !d->childItems.isEmpty() && d->canvas) {
4287 qWarning("QQuickItem: Cannot set FocusScope once item has children and is in a canvas.");
4288 flags &= ~ItemIsFocusScope;
4289 } else if (d->flags & ItemIsFocusScope) {
4290 qWarning("QQuickItem: Cannot unset FocusScope flag.");
4291 flags |= ItemIsFocusScope;
4295 if ((flags & ItemClipsChildrenToShape ) != (d->flags & ItemClipsChildrenToShape))
4296 d->dirty(QQuickItemPrivate::Clip);
4301 qreal QQuickItem::x() const
4303 Q_D(const QQuickItem);
4307 qreal QQuickItem::y() const
4309 Q_D(const QQuickItem);
4313 QPointF QQuickItem::pos() const
4315 Q_D(const QQuickItem);
4316 return QPointF(d->x, d->y);
4319 void QQuickItem::setX(qreal v)
4328 d->dirty(QQuickItemPrivate::Position);
4330 geometryChanged(QRectF(x(), y(), width(), height()),
4331 QRectF(oldx, y(), width(), height()));
4334 void QQuickItem::setY(qreal v)
4343 d->dirty(QQuickItemPrivate::Position);
4345 geometryChanged(QRectF(x(), y(), width(), height()),
4346 QRectF(x(), oldy, width(), height()));
4349 void QQuickItem::setPos(const QPointF &pos)
4352 if (QPointF(d->x, d->y) == pos)
4361 d->dirty(QQuickItemPrivate::Position);
4363 geometryChanged(QRectF(x(), y(), width(), height()),
4364 QRectF(oldx, oldy, width(), height()));
4367 qreal QQuickItem::width() const
4369 Q_D(const QQuickItem);
4373 void QQuickItem::setWidth(qreal w)
4379 d->widthValid = true;
4383 qreal oldWidth = d->width;
4386 d->dirty(QQuickItemPrivate::Size);
4388 geometryChanged(QRectF(x(), y(), width(), height()),
4389 QRectF(x(), y(), oldWidth, height()));
4392 void QQuickItem::resetWidth()
4395 d->widthValid = false;
4396 setImplicitWidth(implicitWidth());
4399 void QQuickItemPrivate::implicitWidthChanged()
4402 emit q->implicitWidthChanged();
4405 qreal QQuickItemPrivate::getImplicitWidth() const
4407 return implicitWidth;
4410 Returns the width of the item that is implied by other properties that determine the content.
4412 qreal QQuickItem::implicitWidth() const
4414 Q_D(const QQuickItem);
4415 return d->getImplicitWidth();
4419 \qmlproperty real QtQuick2::Item::implicitWidth
4420 \qmlproperty real QtQuick2::Item::implicitHeight
4422 Defines the natural width or height of the Item if no \l width or \l height is specified.
4424 The default implicit size for most items is 0x0, however some elements have an inherent
4425 implicit size which cannot be overridden, e.g. Image, Text.
4427 Setting the implicit size is useful for defining components that have a preferred size
4428 based on their content, for example:
4435 property alias icon: image.source
4436 property alias label: text.text
4437 implicitWidth: text.implicitWidth + image.implicitWidth
4438 implicitHeight: Math.max(text.implicitHeight, image.implicitHeight)
4443 anchors.left: image.right; anchors.right: parent.right
4444 anchors.verticalCenter: parent.verticalCenter
4449 \bold Note: using implicitWidth of Text or TextEdit and setting the width explicitly
4450 incurs a performance penalty as the text must be laid out twice.
4454 Sets the implied width of the item to \a w.
4455 This is the width implied by other properties that determine the content.
4457 void QQuickItem::setImplicitWidth(qreal w)
4460 bool changed = w != d->implicitWidth;
4461 d->implicitWidth = w;
4462 if (d->width == w || widthValid()) {
4464 d->implicitWidthChanged();
4468 qreal oldWidth = d->width;
4471 d->dirty(QQuickItemPrivate::Size);
4473 geometryChanged(QRectF(x(), y(), width(), height()),
4474 QRectF(x(), y(), oldWidth, height()));
4477 d->implicitWidthChanged();
4481 Returns whether the width property has been set explicitly.
4483 bool QQuickItem::widthValid() const
4485 Q_D(const QQuickItem);
4486 return d->widthValid;
4489 qreal QQuickItem::height() const
4491 Q_D(const QQuickItem);
4495 void QQuickItem::setHeight(qreal h)
4501 d->heightValid = true;
4505 qreal oldHeight = d->height;
4508 d->dirty(QQuickItemPrivate::Size);
4510 geometryChanged(QRectF(x(), y(), width(), height()),
4511 QRectF(x(), y(), width(), oldHeight));
4514 void QQuickItem::resetHeight()
4517 d->heightValid = false;
4518 setImplicitHeight(implicitHeight());
4521 void QQuickItemPrivate::implicitHeightChanged()
4524 emit q->implicitHeightChanged();
4527 qreal QQuickItemPrivate::getImplicitHeight() const
4529 return implicitHeight;
4533 Returns the height of the item that is implied by other properties that determine the content.
4535 qreal QQuickItem::implicitHeight() const
4537 Q_D(const QQuickItem);
4538 return d->getImplicitHeight();
4543 Sets the implied height of the item to \a h.
4544 This is the height implied by other properties that determine the content.
4546 void QQuickItem::setImplicitHeight(qreal h)
4549 bool changed = h != d->implicitHeight;
4550 d->implicitHeight = h;
4551 if (d->height == h || heightValid()) {
4553 d->implicitHeightChanged();
4557 qreal oldHeight = d->height;
4560 d->dirty(QQuickItemPrivate::Size);
4562 geometryChanged(QRectF(x(), y(), width(), height()),
4563 QRectF(x(), y(), width(), oldHeight));
4566 d->implicitHeightChanged();
4569 void QQuickItem::setImplicitSize(qreal w, qreal h)
4572 bool wChanged = w != d->implicitWidth;
4573 bool hChanged = h != d->implicitHeight;
4575 d->implicitWidth = w;
4576 d->implicitHeight = h;
4580 if (d->width == w || widthValid()) {
4582 d->implicitWidthChanged();
4585 if (d->height == h || heightValid()) {
4587 d->implicitHeightChanged();
4593 qreal oldWidth = d->width;
4594 qreal oldHeight = d->height;
4600 d->dirty(QQuickItemPrivate::Size);
4602 geometryChanged(QRectF(x(), y(), width(), height()),
4603 QRectF(x(), y(), oldWidth, oldHeight));
4605 if (!wDone && wChanged)
4606 d->implicitWidthChanged();
4607 if (!hDone && hChanged)
4608 d->implicitHeightChanged();
4612 Returns whether the height property has been set explicitly.
4614 bool QQuickItem::heightValid() const
4616 Q_D(const QQuickItem);
4617 return d->heightValid;
4620 void QQuickItem::setSize(const QSizeF &size)
4623 d->heightValid = true;
4624 d->widthValid = true;
4626 if (QSizeF(d->width, d->height) == size)
4629 qreal oldHeight = d->height;
4630 qreal oldWidth = d->width;
4631 d->height = size.height();
4632 d->width = size.width();
4634 d->dirty(QQuickItemPrivate::Size);
4636 geometryChanged(QRectF(x(), y(), width(), height()),
4637 QRectF(x(), y(), oldWidth, oldHeight));
4640 bool QQuickItem::hasActiveFocus() const
4642 Q_D(const QQuickItem);
4643 return d->activeFocus;
4646 bool QQuickItem::hasFocus() const
4648 Q_D(const QQuickItem);
4652 void QQuickItem::setFocus(bool focus)
4655 if (d->focus == focus)
4659 // Need to find our nearest focus scope
4660 QQuickItem *scope = parentItem();
4661 while (scope && !scope->isFocusScope())
4662 scope = scope->parentItem();
4664 QQuickCanvasPrivate::get(d->canvas)->setFocusInScope(scope, this);
4666 QQuickCanvasPrivate::get(d->canvas)->clearFocusInScope(scope, this);
4669 emit focusChanged(focus);
4673 bool QQuickItem::isFocusScope() const
4675 return flags() & ItemIsFocusScope;
4678 QQuickItem *QQuickItem::scopedFocusItem() const
4680 Q_D(const QQuickItem);
4681 if (!isFocusScope())
4684 return d->subFocusItem;
4688 Qt::MouseButtons QQuickItem::acceptedMouseButtons() const
4690 Q_D(const QQuickItem);
4691 return d->acceptedMouseButtons();
4694 void QQuickItem::setAcceptedMouseButtons(Qt::MouseButtons buttons)
4697 if (buttons & Qt::LeftButton)
4700 d->extra.clearFlag();
4702 buttons &= ~Qt::LeftButton;
4703 if (buttons || d->extra.isAllocated())
4704 d->extra.value().acceptedMouseButtons = buttons;
4707 bool QQuickItem::filtersChildMouseEvents() const
4709 Q_D(const QQuickItem);
4710 return d->filtersChildMouseEvents;
4713 void QQuickItem::setFiltersChildMouseEvents(bool filter)
4716 d->filtersChildMouseEvents = filter;
4719 bool QQuickItem::isUnderMouse() const
4721 Q_D(const QQuickItem);
4725 QPoint cursorPos = QCursor::pos();
4726 if (QRectF(0, 0, width(), height()).contains(mapFromScene(cursorPos))) // ### refactor: d->canvas->mapFromGlobal(cursorPos))))
4731 bool QQuickItem::acceptHoverEvents() const
4733 Q_D(const QQuickItem);
4734 return d->hoverEnabled;
4737 void QQuickItem::setAcceptHoverEvents(bool enabled)
4740 d->hoverEnabled = enabled;
4743 void QQuickItem::grabMouse()
4748 QQuickCanvasPrivate *canvasPriv = QQuickCanvasPrivate::get(d->canvas);
4749 if (canvasPriv->mouseGrabberItem == this)
4752 QQuickItem *oldGrabber = canvasPriv->mouseGrabberItem;
4753 canvasPriv->mouseGrabberItem = this;
4755 oldGrabber->mouseUngrabEvent();
4758 void QQuickItem::ungrabMouse()
4763 QQuickCanvasPrivate *canvasPriv = QQuickCanvasPrivate::get(d->canvas);
4764 if (canvasPriv->mouseGrabberItem != this) {
4765 qWarning("QQuickItem::ungrabMouse(): Item is not the mouse grabber.");
4769 canvasPriv->mouseGrabberItem = 0;
4773 bool QQuickItem::keepMouseGrab() const
4775 Q_D(const QQuickItem);
4776 return d->keepMouse;
4780 The flag indicating whether the mouse should remain
4781 with this item is set to \a keep.
4783 This is useful for items that wish to grab and keep mouse
4784 interaction following a predefined gesture. For example,
4785 an item that is interested in horizontal mouse movement
4786 may set keepMouseGrab to true once a threshold has been
4787 exceeded. Once keepMouseGrab has been set to true, filtering
4788 items will not react to mouse events.
4790 If the item does not indicate that it wishes to retain mouse grab,
4791 a filtering item may steal the grab. For example, Flickable may attempt
4792 to steal a mouse grab if it detects that the user has begun to
4797 void QQuickItem::setKeepMouseGrab(bool keep)
4800 d->keepMouse = keep;
4804 Grabs the touch points specified by \a ids.
4806 These touch points will be owned by the item until
4807 they are released. Alternatively, the grab can be stolen
4808 by a filtering item like Flickable. Use setKeepTouchGrab()
4809 to prevent the grab from being stolen.
4811 \sa ungrabTouchPoints(), setKeepTouchGrab()
4813 void QQuickItem::grabTouchPoints(const QList<int> &ids)
4818 QQuickCanvasPrivate *canvasPriv = QQuickCanvasPrivate::get(d->canvas);
4820 QSet<QQuickItem*> ungrab;
4821 for (int i = 0; i < ids.count(); ++i) {
4822 QQuickItem *oldGrabber = canvasPriv->itemForTouchPointId.value(ids.at(i));
4823 if (oldGrabber == this)
4826 canvasPriv->itemForTouchPointId[ids.at(i)] = this;
4828 ungrab.insert(oldGrabber);
4830 foreach (QQuickItem *oldGrabber, ungrab)
4831 oldGrabber->touchUngrabEvent();
4835 Ungrabs the touch points owned by this item.
4837 \sa grabTouchPoints()
4839 void QQuickItem::ungrabTouchPoints()
4844 QQuickCanvasPrivate *canvasPriv = QQuickCanvasPrivate::get(d->canvas);
4846 QMutableHashIterator<int, QQuickItem*> i(canvasPriv->itemForTouchPointId);
4847 while (i.hasNext()) {
4849 if (i.value() == this)
4856 Returns a value indicating whether the touch points grabbed by this item
4857 should remain with this item exclusively.
4859 \sa setKeepTouchGrab(), keepMouseGrab()
4861 bool QQuickItem::keepTouchGrab() const
4863 Q_D(const QQuickItem);
4864 return d->keepTouch;
4868 The flag indicating whether the touch points grabbed
4869 by this item should remain with this item is set to \a keep.
4871 This is useful for items that wish to grab and keep specific touch
4872 points following a predefined gesture. For example,
4873 an item that is interested in horizontal touch point movement
4874 may set setKeepTouchGrab to true once a threshold has been
4875 exceeded. Once setKeepTouchGrab has been set to true, filtering
4876 items will not react to the relevant touch points.
4878 If the item does not indicate that it wishes to retain touch point grab,
4879 a filtering item may steal the grab. For example, Flickable may attempt
4880 to steal a touch point grab if it detects that the user has begun to
4883 \sa keepTouchGrab(), setKeepMouseGrab()
4885 void QQuickItem::setKeepTouchGrab(bool keep)
4888 d->keepTouch = keep;
4892 \qmlmethod object QtQuick2::Item::mapFromItem(Item item, real x, real y)
4894 Maps the point (\a x, \a y), which is in \a item's coordinate system, to
4895 this item's coordinate system, and returns an object with \c x and \c y
4896 properties matching the mapped coordinate.
4898 If \a item is a \c null value, this maps the point from the coordinate
4899 system of the root QML view.
4902 \qmlmethod object QtQuick2::Item::mapToItem(Item item, real x, real y)
4904 Maps the point (\a x, \a y), which is in this item's coordinate system, to
4905 \a item's coordinate system, and returns an object with \c x and \c y
4906 properties matching the mapped coordinate.
4908 If \a item is a \c null value, this maps \a x and \a y to the coordinate
4909 system of the root QML view.
4911 QPointF QQuickItem::mapToItem(const QQuickItem *item, const QPointF &point) const
4913 QPointF p = mapToScene(point);
4915 p = item->mapFromScene(p);
4919 QPointF QQuickItem::mapToScene(const QPointF &point) const
4921 Q_D(const QQuickItem);
4922 return d->itemToCanvasTransform().map(point);
4925 QRectF QQuickItem::mapRectToItem(const QQuickItem *item, const QRectF &rect) const
4927 Q_D(const QQuickItem);
4928 QTransform t = d->itemToCanvasTransform();
4930 t *= QQuickItemPrivate::get(item)->canvasToItemTransform();
4931 return t.mapRect(rect);
4934 QRectF QQuickItem::mapRectToScene(const QRectF &rect) const
4936 Q_D(const QQuickItem);
4937 return d->itemToCanvasTransform().mapRect(rect);
4940 QPointF QQuickItem::mapFromItem(const QQuickItem *item, const QPointF &point) const
4942 QPointF p = item?item->mapToScene(point):point;
4943 return mapFromScene(p);
4946 QPointF QQuickItem::mapFromScene(const QPointF &point) const
4948 Q_D(const QQuickItem);
4949 return d->canvasToItemTransform().map(point);
4952 QRectF QQuickItem::mapRectFromItem(const QQuickItem *item, const QRectF &rect) const
4954 Q_D(const QQuickItem);
4955 QTransform t = item?QQuickItemPrivate::get(item)->itemToCanvasTransform():QTransform();
4956 t *= d->canvasToItemTransform();
4957 return t.mapRect(rect);
4960 QRectF QQuickItem::mapRectFromScene(const QRectF &rect) const
4962 Q_D(const QQuickItem);
4963 return d->canvasToItemTransform().mapRect(rect);
4968 \qmlmethod QtQuick2::Item::forceActiveFocus()
4970 Forces active focus on the item.
4972 This method sets focus on the item and makes sure that all the focus scopes
4973 higher in the object hierarchy are also given the focus.
4977 Forces active focus on the item.
4979 This method sets focus on the item and makes sure that all the focus scopes
4980 higher in the object hierarchy are also given the focus.
4984 \qmlmethod QtQuick2::Item::childAt(real x, real y)
4986 Returns the visible child item at point (\a x, \a y), which is in this
4987 item's coordinate system, or \c null if there is no such item.
4991 Returns the visible child item at point (\a x, \a y), which is in this
4992 item's coordinate system, or 0 if there is no such item.
4996 \qmlproperty list<State> QtQuick2::Item::states
4997 This property holds a list of states defined by the item.
5013 \sa {qmlstate}{States}
5016 \qmlproperty list<Transition> QtQuick2::Item::transitions
5017 This property holds a list of transitions defined by the item.
5033 \sa {QML Animation and Transitions}{Transitions}
5036 \qmlproperty list<Filter> QtQuick2::Item::filter
5037 This property holds a list of graphical filters to be applied to the item.
5039 \l {Filter}{Filters} include things like \l {Blur}{blurring}
5040 the item, or giving it a \l Reflection. Some
5041 filters may not be available on all canvases; if a filter is not
5042 available on a certain canvas, it will simply not be applied for
5043 that canvas (but the QML will still be considered valid).
5061 \qmlproperty bool QtQuick2::Item::clip
5062 This property holds whether clipping is enabled. The default clip value is \c false.
5064 If clipping is enabled, an item will clip its own painting, as well
5065 as the painting of its children, to its bounding rectangle.
5067 Non-rectangular clipping regions are not supported for performance reasons.
5071 \property QQuickItem::clip
5072 This property holds whether clipping is enabled. The default clip value is \c false.
5074 If clipping is enabled, an item will clip its own painting, as well
5075 as the painting of its children, to its bounding rectangle. If you set
5076 clipping during an item's paint operation, remember to re-set it to
5077 prevent clipping the rest of your scene.
5079 Non-rectangular clipping regions are not supported for performance reasons.
5083 \qmlproperty string QtQuick2::Item::state
5085 This property holds the name of the current state of the item.
5087 This property is often used in scripts to change between states. For
5092 if (button.state == 'On')
5093 button.state = 'Off';
5095 button.state = 'On';
5099 If the item is in its base state (i.e. no explicit state has been
5100 set), \c state will be a blank string. Likewise, you can return an
5101 item to its base state by setting its current state to \c ''.
5103 \sa {qmlstates}{States}
5107 \qmlproperty list<Transform> QtQuick2::Item::transform
5108 This property holds the list of transformations to apply.
5110 For more information see \l Transform.
5114 \enum QQuickItem::TransformOrigin
5116 Controls the point about which simple transforms like scale apply.
5118 \value TopLeft The top-left corner of the item.
5119 \value Top The center point of the top of the item.
5120 \value TopRight The top-right corner of the item.
5121 \value Left The left most point of the vertical middle.
5122 \value Center The center of the item.
5123 \value Right The right most point of the vertical middle.
5124 \value BottomLeft The bottom-left corner of the item.
5125 \value Bottom The center point of the bottom of the item.
5126 \value BottomRight The bottom-right corner of the item.
5131 \qmlproperty bool QtQuick2::Item::activeFocus
5133 This property indicates whether the item has active focus.
5135 An item with active focus will receive keyboard input,
5136 or is a FocusScope ancestor of the item that will receive keyboard input.
5138 Usually, activeFocus is gained by setting focus on an item and its enclosing
5139 FocusScopes. In the following example \c input will have activeFocus.
5152 \sa focus, {qmlfocus}{Keyboard Focus}
5156 \qmlproperty bool QtQuick2::Item::focus
5157 This property indicates whether the item has focus within the enclosing focus scope. If true, this item
5158 will gain active focus when the enclosing focus scope gains active focus.
5159 In the following example, \c input will be given active focus when \c scope gains active focus.
5172 For the purposes of this property, the scene as a whole is assumed to act like a focus scope.
5173 On a practical level, that means the following QML will give active focus to \c input on startup.
5184 \sa activeFocus, {qmlfocus}{Keyboard Focus}
5189 \property QQuickItem::anchors
5194 \property QQuickItem::left
5199 \property QQuickItem::right
5204 \property QQuickItem::horizontalCenter
5209 \property QQuickItem::top
5214 \property QQuickItem::bottom
5219 \property QQuickItem::verticalCenter
5224 \property QQuickItem::focus
5229 \property QQuickItem::transform
5234 \property QQuickItem::transformOrigin
5239 \property QQuickItem::activeFocus
5244 \property QQuickItem::baseline
5249 \property QQuickItem::data
5254 \property QQuickItem::resources
5259 \property QQuickItem::state
5264 \property QQuickItem::states
5269 \property QQuickItem::transformOriginPoint
5274 \property QQuickItem::transitions
5278 bool QQuickItem::event(QEvent *ev)
5281 if (ev->type() == QEvent::PolishRequest) {
5283 d->polishScheduled = false;
5287 return QObject::event(ev);
5290 if (ev->type() == QEvent::InputMethodQuery) {
5291 QInputMethodQueryEvent *query = static_cast<QInputMethodQueryEvent *>(ev);
5292 Qt::InputMethodQueries queries = query->queries();
5293 for (uint i = 0; i < 32; ++i) {
5294 Qt::InputMethodQuery q = (Qt::InputMethodQuery)(int)(queries & (1<<i));
5296 QVariant v = inputMethodQuery(q);
5297 query->setValue(q, v);
5302 } else if (ev->type() == QEvent::InputMethod) {
5303 inputMethodEvent(static_cast<QInputMethodEvent *>(ev));
5306 return QObject::event(ev);
5309 #ifndef QT_NO_DEBUG_STREAM
5310 QDebug operator<<(QDebug debug, QQuickItem *item)
5313 debug << "QQuickItem(0)";
5317 debug << item->metaObject()->className() << "(this =" << ((void*)item)
5318 << ", name=" << item->objectName()
5319 << ", parent =" << ((void*)item->parentItem())
5320 << ", geometry =" << QRectF(item->pos(), QSizeF(item->width(), item->height()))
5321 << ", z =" << item->z() << ')';
5326 qint64 QQuickItemPrivate::consistentTime = -1;
5327 void QQuickItemPrivate::setConsistentTime(qint64 t)
5332 class QElapsedTimerConsistentTimeHack
5336 t1 = QQuickItemPrivate::consistentTime;
5340 return QQuickItemPrivate::consistentTime - t1;
5343 qint64 val = QQuickItemPrivate::consistentTime - t1;
5344 t1 = QQuickItemPrivate::consistentTime;
5354 void QQuickItemPrivate::start(QElapsedTimer &t)
5356 if (QQuickItemPrivate::consistentTime == -1)
5359 ((QElapsedTimerConsistentTimeHack*)&t)->start();
5362 qint64 QQuickItemPrivate::elapsed(QElapsedTimer &t)
5364 if (QQuickItemPrivate::consistentTime == -1)
5367 return ((QElapsedTimerConsistentTimeHack*)&t)->elapsed();
5370 qint64 QQuickItemPrivate::restart(QElapsedTimer &t)
5372 if (QQuickItemPrivate::consistentTime == -1)
5375 return ((QElapsedTimerConsistentTimeHack*)&t)->restart();
5379 \fn bool QQuickItem::isTextureProvider() const
5381 Returns true if this item is a texture provider. The default
5382 implementation returns false.
5384 This function can be called from any thread.
5387 bool QQuickItem::isTextureProvider() const
5389 Q_D(const QQuickItem);
5390 return d->extra.isAllocated() && d->extra->layer && d->extra->layer->effectSource() ?
5391 d->extra->layer->effectSource()->isTextureProvider() : false;
5395 \fn QSGTextureProvider *QQuickItem::textureProvider() const
5397 Returns the texture provider for an item. The default implementation
5400 This function may only be called on the rendering thread.
5403 QSGTextureProvider *QQuickItem::textureProvider() const
5405 Q_D(const QQuickItem);
5406 return d->extra.isAllocated() && d->extra->layer && d->extra->layer->effectSource() ?
5407 d->extra->layer->effectSource()->textureProvider() : 0;
5410 QQuickItemLayer *QQuickItemPrivate::layer() const
5412 if (!extra.isAllocated() || !extra->layer) {
5413 extra.value().layer = new QQuickItemLayer(const_cast<QQuickItem *>(q_func()));
5414 if (!componentComplete)
5415 extra->layer->classBegin();
5417 return extra->layer;
5420 QQuickItemLayer::QQuickItemLayer(QQuickItem *item)
5425 , m_componentComplete(true)
5426 , m_wrapMode(QQuickShaderEffectSource::ClampToEdge)
5427 , m_format(QQuickShaderEffectSource::RGBA)
5429 , m_effectComponent(0)
5435 QQuickItemLayer::~QQuickItemLayer()
5437 delete m_effectSource;
5444 \qmlproperty bool QtQuick2::Item::layer.enabled
5446 Holds wether the item is layered or not. Layering is disabled by default.
5448 A layered item is rendered into an offscreen surface and cached until
5449 it is changed. Enabling layering for complex QML item hierarchies can
5450 some times be an optimization.
5452 None of the other layer properties have any effect when the layer
5456 void QQuickItemLayer::setEnabled(bool e)
5461 if (m_componentComplete) {
5468 emit enabledChanged(e);
5471 void QQuickItemLayer::classBegin()
5473 Q_ASSERT(!m_effectSource);
5474 Q_ASSERT(!m_effect);
5475 m_componentComplete = false;
5478 void QQuickItemLayer::componentComplete()
5480 Q_ASSERT(!m_componentComplete);
5481 m_componentComplete = true;
5486 void QQuickItemLayer::activate()
5488 Q_ASSERT(!m_effectSource);
5489 m_effectSource = new QQuickShaderEffectSource();
5491 QQuickItem *parentItem = m_item->parentItem();
5493 m_effectSource->setParentItem(parentItem);
5494 m_effectSource->stackAfter(m_item);
5497 m_effectSource->setSourceItem(m_item);
5498 m_effectSource->setHideSource(true);
5499 m_effectSource->setSmooth(m_smooth);
5500 m_effectSource->setTextureSize(m_size);
5501 m_effectSource->setSourceRect(m_sourceRect);
5502 m_effectSource->setMipmap(m_mipmap);
5503 m_effectSource->setWrapMode(m_wrapMode);
5504 m_effectSource->setFormat(m_format);
5506 if (m_effectComponent)
5509 m_effectSource->setVisible(m_item->isVisible() && !m_effect);
5516 QQuickItemPrivate *id = QQuickItemPrivate::get(m_item);
5517 id->addItemChangeListener(this, QQuickItemPrivate::Geometry | QQuickItemPrivate::Opacity | QQuickItemPrivate::Parent | QQuickItemPrivate::Visibility | QQuickItemPrivate::SiblingOrder);
5520 void QQuickItemLayer::deactivate()
5522 Q_ASSERT(m_effectSource);
5524 if (m_effectComponent)
5527 delete m_effectSource;
5530 QQuickItemPrivate *id = QQuickItemPrivate::get(m_item);
5531 id->removeItemChangeListener(this, QQuickItemPrivate::Geometry | QQuickItemPrivate::Opacity | QQuickItemPrivate::Parent | QQuickItemPrivate::Visibility | QQuickItemPrivate::SiblingOrder);
5534 void QQuickItemLayer::activateEffect()
5536 Q_ASSERT(m_effectSource);
5537 Q_ASSERT(m_effectComponent);
5538 Q_ASSERT(!m_effect);
5540 QObject *created = m_effectComponent->create();
5541 m_effect = qobject_cast<QQuickItem *>(created);
5543 qWarning("Item: layer.effect is not a QML Item.");
5547 QQuickItem *parentItem = m_item->parentItem();
5549 m_effect->setParentItem(parentItem);
5550 m_effect->stackAfter(m_effectSource);
5552 m_effect->setVisible(m_item->isVisible());
5553 m_effect->setProperty(m_name, qVariantFromValue<QObject *>(m_effectSource));
5556 void QQuickItemLayer::deactivateEffect()
5558 Q_ASSERT(m_effectSource);
5559 Q_ASSERT(m_effectComponent);
5567 \qmlproperty Component QtQuick2::Item::layer.effect
5569 Holds the effect that is applied to this layer.
5571 The effect is typically a \l ShaderEffect component, although any \l Item component can be
5572 assigned. The effect should have a source texture property with a name matching \l samplerName.
5577 void QQuickItemLayer::setEffect(QQmlComponent *component)
5579 if (component == m_effectComponent)
5582 bool updateNeeded = false;
5583 if (m_effectSource && m_effectComponent) {
5585 updateNeeded = true;
5588 m_effectComponent = component;
5590 if (m_effectSource && m_effectComponent) {
5592 updateNeeded = true;
5600 m_effectSource->setVisible(m_item->isVisible() && !m_effect);
5603 emit effectChanged(component);
5608 \qmlproperty bool QtQuick2::Item::layer.mipmap
5610 If this property is true, mipmaps are generated for the texture.
5612 \note Some OpenGL ES 2 implementations do not support mipmapping of
5613 non-power-of-two textures.
5616 void QQuickItemLayer::setMipmap(bool mipmap)
5618 if (mipmap == m_mipmap)
5623 m_effectSource->setMipmap(m_mipmap);
5625 emit mipmapChanged(mipmap);
5630 \qmlproperty enumeration QtQuick2::Item::layer.format
5632 This property defines the internal OpenGL format of the texture.
5633 Modifying this property makes most sense when the \a layer.effect is also
5634 specified. Depending on the OpenGL implementation, this property might
5635 allow you to save some texture memory.
5638 \o ShaderEffectSource.Alpha - GL_ALPHA
5639 \o ShaderEffectSource.RGB - GL_RGB
5640 \o ShaderEffectSource.RGBA - GL_RGBA
5643 \note Some OpenGL implementations do not support the GL_ALPHA format.
5646 void QQuickItemLayer::setFormat(QQuickShaderEffectSource::Format f)
5653 m_effectSource->setFormat(m_format);
5655 emit formatChanged(m_format);
5660 \qmlproperty enumeration QtQuick2::Item::layer.sourceRect
5662 This property defines which rectangular area of the \l sourceItem to
5663 render into the texture. The source rectangle can be larger than
5664 \l sourceItem itself. If the rectangle is null, which is the default,
5665 the whole \l sourceItem is rendered to texture.
5668 void QQuickItemLayer::setSourceRect(const QRectF &sourceRect)
5670 if (sourceRect == m_sourceRect)
5672 m_sourceRect = sourceRect;
5675 m_effectSource->setSourceRect(m_sourceRect);
5677 emit sourceRectChanged(sourceRect);
5683 \qmlproperty bool QtQuick2::Item::layer.smooth
5685 Holds whether the layer is smoothly transformed.
5688 void QQuickItemLayer::setSmooth(bool s)
5695 m_effectSource->setSmooth(m_smooth);
5697 emit smoothChanged(s);
5703 \qmlproperty size QtQuick2::Item::layer.textureSize
5705 This property holds the requested pixel size of the layers texture. If it is empty,
5706 which is the default, the size of the item is used.
5708 \note Some platforms have a limit on how small framebuffer objects can be,
5709 which means the actual texture size might be larger than the requested
5713 void QQuickItemLayer::setSize(const QSize &size)
5720 m_effectSource->setTextureSize(size);
5722 emit sizeChanged(size);
5728 \qmlproperty enumeration QtQuick2::Item::layer.wrapMode
5730 This property defines the OpenGL wrap modes associated with the texture.
5731 Modifying this property makes most sense when the \a layer.effect is
5735 \o ShaderEffectSource.ClampToEdge - GL_CLAMP_TO_EDGE both horizontally and vertically
5736 \o ShaderEffectSource.RepeatHorizontally - GL_REPEAT horizontally, GL_CLAMP_TO_EDGE vertically
5737 \o ShaderEffectSource.RepeatVertically - GL_CLAMP_TO_EDGE horizontally, GL_REPEAT vertically
5738 \o ShaderEffectSource.Repeat - GL_REPEAT both horizontally and vertically
5741 \note Some OpenGL ES 2 implementations do not support the GL_REPEAT
5742 wrap mode with non-power-of-two textures.
5745 void QQuickItemLayer::setWrapMode(QQuickShaderEffectSource::WrapMode mode)
5747 if (mode != m_wrapMode)
5752 m_effectSource->setWrapMode(m_wrapMode);
5754 emit wrapModeChanged(mode);
5758 \qmlproperty string QtQuick2::Item::layer.samplerName
5760 Holds the name of the effect's source texture property.
5762 samplerName needs to match the name of the effect's source texture property
5763 so that the Item can pass the layer's offscreen surface to the effect correctly.
5765 \sa effect, ShaderEffect
5768 void QQuickItemLayer::setName(const QByteArray &name) {
5772 m_effect->setProperty(m_name, QVariant());
5773 m_effect->setProperty(name, qVariantFromValue<QObject *>(m_effectSource));
5776 emit nameChanged(name);
5779 void QQuickItemLayer::itemOpacityChanged(QQuickItem *item)
5785 void QQuickItemLayer::itemGeometryChanged(QQuickItem *, const QRectF &, const QRectF &)
5790 void QQuickItemLayer::itemParentChanged(QQuickItem *item, QQuickItem *parent)
5793 Q_ASSERT(item == m_item);
5794 Q_ASSERT(parent != m_effectSource);
5795 Q_ASSERT(parent == 0 || parent != m_effect);
5797 m_effectSource->setParentItem(parent);
5799 m_effectSource->stackAfter(m_item);
5802 m_effect->setParentItem(parent);
5804 m_effect->stackAfter(m_effectSource);
5808 void QQuickItemLayer::itemSiblingOrderChanged(QQuickItem *)
5810 m_effectSource->stackAfter(m_item);
5812 m_effect->stackAfter(m_effectSource);
5815 void QQuickItemLayer::itemVisibilityChanged(QQuickItem *)
5817 QQuickItem *l = m_effect ? (QQuickItem *) m_effect : (QQuickItem *) m_effectSource;
5819 l->setVisible(m_item->isVisible());
5822 void QQuickItemLayer::updateZ()
5824 if (!m_componentComplete || !m_enabled)
5826 QQuickItem *l = m_effect ? (QQuickItem *) m_effect : (QQuickItem *) m_effectSource;
5828 l->setZ(m_item->z());
5831 void QQuickItemLayer::updateOpacity()
5833 QQuickItem *l = m_effect ? (QQuickItem *) m_effect : (QQuickItem *) m_effectSource;
5835 l->setOpacity(m_item->opacity());
5838 void QQuickItemLayer::updateGeometry()
5840 QQuickItem *l = m_effect ? (QQuickItem *) m_effect : (QQuickItem *) m_effectSource;
5842 QRectF bounds = m_item->clipRect();
5843 l->setWidth(bounds.width());
5844 l->setHeight(bounds.height());
5845 l->setX(bounds.x() + m_item->x());
5846 l->setY(bounds.y() + m_item->y());
5849 void QQuickItemLayer::updateMatrix()
5851 // Called directly from transformChanged(), so needs some extra
5853 if (!m_componentComplete || !m_enabled)
5855 QQuickItem *l = m_effect ? (QQuickItem *) m_effect : (QQuickItem *) m_effectSource;
5857 QQuickItemPrivate *ld = QQuickItemPrivate::get(l);
5858 l->setScale(m_item->scale());
5859 l->setRotation(m_item->rotation());
5860 ld->transforms = QQuickItemPrivate::get(m_item)->transforms;
5861 if (ld->origin() != QQuickItemPrivate::get(m_item)->origin())
5862 ld->extra.value().origin = QQuickItemPrivate::get(m_item)->origin();
5863 ld->dirty(QQuickItemPrivate::Transform);
5866 QQuickItemPrivate::ExtraData::ExtraData()
5867 : z(0), scale(1), rotation(0), opacity(1),
5868 contents(0), screenAttached(0), layoutDirectionAttached(0),
5869 keyHandler(0), layer(0), effectRefCount(0), hideRefCount(0),
5870 opacityNode(0), clipNode(0), rootNode(0), beforePaintNode(0),
5871 acceptedMouseButtons(0), origin(QQuickItem::Center)
5877 #include <moc_qquickitem.cpp>