Класс QQuickItem

Класс QQuickItem предоставляет самые базовые визуальные элементы в Qt Quick. Подробнее...

• Список всех членов, включая унаследованные

Типы

Свойства

Открытые функции

Public Slots

Signals

Защищенные функции

Реализованные защищённые функции

Подробное описание

Все визуальные элементы в Qt Quick наследуются от QQuickItem. Несмотря на то, что экземпляр QQuickItem не имеет визуального представления, он определяет все атрибуты, общие для визуальных элементов, такие как положение x и y, ширина и высота, привязка и поддержка обработки нажатий клавиш.

Вы можете создать подкласс QQuickItem, чтобы предоставить свой собственный пользовательский визуальный элемент, который наследует эти функции.

Пользовательские элементы сцены

Все визуальные элементы QML отрисовываются с использованием графа сцены, по умолчанию реализованного как низкоуровневый высокопроизводительный стек отрисовки, тесно связанный с OpenGL. Подклассы QQuickItem могут добавить свой собственный пользовательский контент в граф сцены, установив флаг QQuickItem::ItemHasContents и переопределив функцию QQuickItem::updatePaintNode().

Предупреждение: Крайне важно, чтобы операции OpenGL и взаимодействие с графом сцены происходили исключительно в потоке отрисовки, в первую очередь во время вызова updatePaintNode(). Лучшее правило – использовать только классы с префиксом «QSG» внутри функции QQuickItem::updatePaintNode().

Примечание: Все классы с префиксом QSG должны использоваться только в потоке отрисовки графа сцены. Дополнительную информацию см. в разделе Граф сцены и отрисовка.

Обработка графических ресурсов

Предпочтительный способ обработки очистки графических ресурсов, используемых в графе сцены, заключается в использовании автоматической очистки узлов. QSGNode, возвращаемый из QQuickItem::updatePaintNode(), автоматически удаляется в правильном потоке в нужное время. Деревья экземпляров QSGNode управляются с помощью QSGNode::OwnedByParent, который устанавливается по умолчанию. Таким образом, для большинства пользовательских элементов графа сцены дополнительная работа не потребуется.

Реализации, которые хранят графические ресурсы вне дерева узлов, например, элемент, реализующий QQuickItem::textureProvider(), должны позаботиться о правильной очистке в зависимости от того, как элемент используется в QML. Ситуации, которые нужно обработать:

• Граф сцены делает недействительным; Это может произойти, например, если окно скрыто с помощью QQuickWindow::hide(). Если класс элемента реализует слот с именем slot, этот слот будет вызван в потоке отрисовки, в то время как поток GUI заблокирован. Это эквивалентно подключению к QQuickWindow::sceneGraphInvalidated(). Контекст OpenGL окна данного элемента будет связан, когда этот слот вызывается. Исключением является случай, если собственный OpenGL был уничтожен вне контроля Qt, например, через EGL_CONTEXT_LOST.
• Элемент удаляется из сцены; Если элемент извлекается из сцены, например, потому что его родитель был установлен в null или элемент в другом окне, QQuickItem::releaseResources() будет вызван в потоке GUI. QQuickWindow::scheduleRenderJob() следует использовать для планирования очистки ресурсов отрисовки.
• Элемент удаляется; Когда выполняется деструктор элемента, он должен удалить все графические ресурсы, которые он имеет. Если ни одно из двух условий выше не было выполнено, элемент будет частью окна, и можно использовать QQuickWindow::scheduleRenderJob() для их очистки. Если реализация игнорирует вызов QQuickItem::releaseResources(), в многих случаях элемент больше не будет иметь доступа к QQuickWindow и, следовательно, не будет иметь средств для планирования очистки.

При планировании очистки графических ресурсов с помощью QQuickWindow::scheduleRenderJob(), следует использовать либо QQuickWindow::BeforeSynchronizingStage, либо QQuickWindow::AfterSynchronizingStage. Стадия синхронизации, где граф сцены изменяется в результате изменений в дереве QML. Если планировать очистку в любое другое время, это может привести к тому, что другие части графа сцены будут ссылаться на только что удаленные объекты, так как эти части не были обновлены.

Примечание: Не рекомендуется использовать QObject::deleteLater() для очистки графических ресурсов, поскольку это произойдет в произвольное время, и неизвестно, будет ли связан контекст OpenGL во время удаления.

Пользовательские элементы QPainter

QQuickItem предоставляет подкласс QQuickPaintedItem, который позволяет пользователю отрисовывать контент с помощью QPainter.

Предупреждение: Использование QQuickPaintedItem использует косвенную 2D-поверхность для отрисовки содержимого, либо с использованием программной растризации, либо с использованием объекта буфера кадра OpenGL (FBO), поэтому отрисовка является двухэтапной операцией. Сначала растрируйте поверхность, затем нарисуйте поверхность. Использование API графа сцены напрямую всегда значительно быстрее.

Анимации поведения

Если ваш элемент использует тип Behavior для определения анимаций изменений свойств, всегда используйте QObject::setProperty(), QQmlProperty() или QMetaProperty::write(), когда вам нужно изменить эти свойства из C++. Это гарантирует, что движок QML знает о изменении свойства. В противном случае движок не сможет выполнить запрошенную анимацию. Обратите внимание, что эти функции вносят небольшую потерю производительности. Более подробную информацию см. в разделе Доступ к членам типа объекта QML из C++.

См. также QQuickWindow и QQuickPaintedItem.

Документация по типу членов

перечисление QQuickItem::Flagфлаги QQuickItem::Flags

Этот тип перечисления используется для указания различных свойств элемента.

Тип Flags является псевдонимом для QFlags<Flag>. Он хранит логическое ИЛИ сочетание значений Flag.

См. также setFlag(), setFlags() и flags().

перечисление QQuickItem::ItemChange

Используется совместно с QQuickItem::itemChange() для уведомления элемента о определенных типах изменений.

перечисление QQuickItem::TransformOrigin

Управляет точкой, относительно которой применяются простые преобразования, такие как масштабирование.

См. также transformOrigin() и setTransformOrigin().

// Label.qml
import QtQuick 2.0

Item {
    property alias icon: image.source
    property alias label: text.text
    implicitWidth: text.implicitWidth + image.implicitWidth
    implicitHeight: Math.max(text.implicitHeight, image.implicitHeight)
    Image { id: image }
    Text {
        id: text
        wrapMode: Text.Wrap
        anchors.left: image.right; anchors.right: parent.right
        anchors.verticalCenter: parent.verticalCenter
    }
}

import QtQuick 2.0

Rectangle {
    width: 100; height: 100

    FocusScope {
        focus: true

        TextInput {
            id: input
            focus: true
        }
    }
}

import QtQuick 2.0

Rectangle {
    width: 100; height: 100

    FocusScope {
        id: scope

        TextInput {
            id: input
            focus: true
        }
    }
}

Rectangle {
    width: 100; height: 100

    TextInput {
          id: input
          focus: true
    }
}

Item {
    Rectangle {
        color: "red"
        width: 100; height: 100
        Rectangle {
            color: "blue"
            x: 50; y: 50; width: 100; height: 100
        }
    }
}

Item {
    Rectangle {
        opacity: 0.5
        color: "red"
        width: 100; height: 100
        Rectangle {
            color: "blue"
            x: 50; y: 50; width: 100; height: 100
        }
    }
}

Rectangle {
    color: "blue"
    width: 100; height: 100
    Rectangle {
        color: "red"
        x: 25; y: 25; width: 50; height: 50
        rotation: 30
    }
}

import QtQuick 2.0

Rectangle {
    color: "blue"
    width: 100; height: 100

    Rectangle {
        color: "green"
        width: 25; height: 25
    }

    Rectangle {
        color: "red"
        x: 25; y: 25; width: 50; height: 50
        scale: 1.4
    }
}

Item {
    Rectangle {
        color: "red"
        width: 100; height: 100
    }
    Rectangle {
        color: "blue"
        x: 50; y: 50; width: 100; height: 100
    }
}

Item {
    Rectangle {
        z: 1
        color: "red"
        width: 100; height: 100
    }
    Rectangle {
        color: "blue"
        x: 50; y: 50; width: 100; height: 100
    }
}

Item {
    Rectangle {
        color: "red"
        width: 100; height: 100
        Rectangle {
            color: "blue"
            x: 50; y: 50; width: 100; height: 100
        }
    }
}

Item {
    Rectangle {
        color: "red"
        width: 100; height: 100
        Rectangle {
            z: -1
            color: "blue"
            x: 50; y: 50; width: 100; height: 100
        }
    }
}

Документация по членам-функциям

QQuickItem::QQuickItem(QQuickItem *parent = nullptr)

Создает QQuickItem с заданным parent.

parent будет использоваться как визуальный родитель и родительский элемент QObject.

[slot] void QQuickItem::update()

Планирует вызов updatePaintNode() для данного элемента.

Вызов QQuickItem::updatePaintNode() всегда происходит, если элемент отображается в QQuickWindow.

Вызывать QQuickItem::update() разрешается только для элементов, которые задают QQuickItem::ItemHasContents.

[signal] void QQuickItem::windowChanged(QQuickWindow *window)

Этот сигнал испускается, когда окно элемента window изменяется.

[override virtual] QQuickItem::~QQuickItem()

Удаляет QQuickItem.

bool QQuickItem::acceptHoverEvents() const

Возвращает значение, указывающее, принимаются ли события наведения на элемент.

Значение по умолчанию — false.

Если значение false, то элемент не будет получать события наведения через функции hoverEnterEvent(), hoverMoveEvent() и hoverLeaveEvent().

См. также setAcceptHoverEvents().

bool QQuickItem::acceptTouchEvents() const

Возвращает значение, указывающее, принимаются ли события касания данным элементом.

Значение по умолчанию — false.

Если значение false, элемент не будет получать события касания через функцию touchEvent().

Эта функция была введена в Qt 5.10.

См. также setAcceptTouchEvents().

Qt::MouseButtons QQuickItem::acceptedMouseButtons() const

Возвращает набор кнопок мыши, принимаемых этим элементом.

Значение по умолчанию — Qt::NoButton; то есть не принимается ни одна кнопка мыши.

Если элемент не принимает кнопку мыши для определенного события мыши, то это событие не будет передано элементу, а будет передано следующему элементу в иерархии элементов.

См. также setAcceptedMouseButtons().

QQuickItem *QQuickItem::childAt(qreal x, qreal y) const

Возвращает первый видимый дочерний элемент, найденный в точке (x, y) в системе координат этого элемента.

Возвращает nullptr, если такого элемента нет.

Примечание: Эта функция может быть вызвана через механизм метаобъектов и из QML. См. Q_INVOKABLE.

QList<QQuickItem *> QQuickItem::childItems() const

Возвращает дочерние элементы этого элемента.

[virtual protected] bool QQuickItem::childMouseEventFilter(QQuickItem *item, QEvent *event)

Переопределите этот метод для фильтрации событий мыши, получаемых дочерними элементами этого элемента.

Этот метод вызывается только если filtersChildMouseEvents() имеет значение true.

Возвращает true, если указанное событие event не должно передаваться указанному дочернему элементу item, и false в противном случае.

См. также setFiltersChildMouseEvents().

[override virtual protected] void QQuickItem::classBegin()

Переопределяет: QQmlParserStatus::classBegin().

Производные классы должны вызывать метод базового класса перед добавлением собственного действия для выполнения в classBegin.

[override virtual protected] void QQuickItem::componentComplete()

Переопределяет: QQmlParserStatus::componentComplete().

Производные классы должны вызывать метод базового класса перед добавлением собственных действий для выполнения в componentComplete.

[virtual] bool QQuickItem::contains(const QPointF &point) const

Возвращает true, если этот элемент содержит point (в локальных координатах), и false в противном случае.

Этот метод может быть переопределен для обработки коллизий точек в элементах с настраиваемыми формами. По умолчанию проверяется, находится ли точка внутри прямоугольника ограничивающей рамки элемента.

Обратите внимание, что этот метод обычно используется для проверки, находится ли элемент под курсором мыши, и по этой причине реализация этой функции должна быть максимально легкой.

Примечание: Эту функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.

QCursor QQuickItem::cursor() const

Возвращает форму курсора для этого элемента.

Курсор мыши примет эту форму, когда он будет над этим элементом, если не установлен курсор-переопределение. Список предопределенных объектов курсора см. в списке предопределенных объектов курсора для различных полезных форм.

Если форма курсора не была установлена, возвращается курсор с формой Qt::ArrowCursor, однако может отображаться другая форма курсора, если у перекрывающего элемента есть допустимый курсор.

См. также setCursor() и unsetCursor().

[virtual protected] void QQuickItem::dragEnterEvent(QDragEnterEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий drag-enter для элемента. Информация о событии предоставляется параметром event.

События перетаскивания и放下 предоставляются только в том случае, если для этого элемента установлен флаг ItemAcceptsDrops.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределили эту функцию. Если вы не принимаете событие, вызовите event->ignore().

См. также Перетаскивание и Перетаскивание и放下.

[virtual protected] void QQuickItem::dragLeaveEvent(QDragLeaveEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий drag-leave для элемента. Информация о событии предоставляется параметром event.

События перетаскивания и放下 предоставляются только в том случае, если для этого элемента установлен флаг ItemAcceptsDrops.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределили эту функцию. Если вы не принимаете событие, вызовите event->ignore().

См. также Перетаскивание и Перетаскивание и放下.

[virtual protected] void QQuickItem::dragMoveEvent(QDragMoveEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий drag-move для элемента. Информация о событии предоставляется параметром event.

События перетаскивания и放下 предоставляются только в том случае, если для этого элемента установлен флаг ItemAcceptsDrops.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределили эту функцию. Если вы не принимаете событие, вызовите event->ignore().

См. также Перетаскивание и Перетаскивание и放下.

[virtual protected] void QQuickItem::dropEvent(QDropEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий drop для элемента. Информация о событии предоставляется параметром event.

События перетаскивания и放下 предоставляются только в том случае, если для этого элемента установлен флаг ItemAcceptsDrops.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределили эту функцию. Если вы не принимаете событие, вызовите event->ignore().

См. также Перетаскивание и Перетаскивание и放下.

[override virtual protected] bool QQuickItem::event(QEvent *ev)

Переопределяет: QObject::event(QEvent *e).

bool QQuickItem::filtersChildMouseEvents() const

Возвращает значение, указывающее, должны ли события мыши и касания для дочерних элементов этого элемента фильтроваться через этот элемент.

См. также setFiltersChildMouseEvents() и childMouseEventFilter().

QQuickItem::Flags QQuickItem::flags() const

Возвращает флаги элемента для этого элемента.

См. также setFlags() и setFlag().

[virtual protected] void QQuickItem::focusInEvent(QFocusEvent *)

Этот обработчик событий можно переопределить в подклассе для получения событий focus-in для элемента. Информация о событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределили эту функцию. Если вы не принимаете событие, вызовите event->ignore().

Если вы переопределяете эту функцию, вы должны вызвать реализацию базового класса.

[virtual protected] void QQuickItem::focusOutEvent(QFocusEvent *)

Этот обработчик событий можно переопределить в подклассе для получения событий focus-out для элемента. Информация о событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределили эту функцию. Если вы не принимаете событие, вызовите event->ignore().

void QQuickItem::forceActiveFocus()

Принудительно устанавливает активный фокус на элемент.

Этот метод устанавливает фокус на элемент и гарантирует, что все родительские объекты FocusScope в иерархии объектов также получат фокус focus.

Причина изменения фокуса — Qt::OtherFocusReason. Используйте перегруженный метод для указания причины изменения фокуса, чтобы обеспечить более эффективную обработку изменения фокуса.

Примечание: Эту функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.

См. также activeFocus.

void QQuickItem::forceActiveFocus(Qt::FocusReason reason)

Это перегруженная функция.

Принудительно устанавливает активный фокус на элемент с заданной reason.

Этот метод устанавливает фокус на элемент и гарантирует, что все родительские объекты FocusScope в иерархии объектов также получат фокус focus.

Функция была введена в Qt 5.1.

Примечание: Эту функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.

См. также activeFocus и Qt::FocusReason.

[virtual protected] void QQuickItem::geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry)

Эта функция вызывается для обработки изменений геометрии этого элемента от oldGeometry до newGeometry. Если обе геометрии одинаковы, ничего не делается.

Подклассы должны вызывать метод базового класса в своей реализации.

void QQuickItem::grabMouse()

Захватывает входные данные мыши.

Этот элемент будет получать все события мыши до тех пор, пока не будет вызван ungrabMouse(). Обычно эту функцию вызывать не нужно, так как принятие, например, события нажатия мыши гарантирует, что последующие события будут доставлены элементу. Если элемент хочет взять на себя события мыши от текущего получателя, ему нужно вызвать эту функцию.

Предупреждение: эту функцию следует использовать с осторожностью.

QSharedPointer<QQuickItemGrabResult> QQuickItem::grabToImage(const QSize &targetSize = QSize())

Захватывает элемент в изображение в оперативной памяти.

Захват происходит асинхронно, и сигнал QQuickItemGrabResult::ready() генерируется, когда захват завершен.

Используйте targetSize для задания размера целевого изображения. По умолчанию результат будет иметь тот же размер, что и элемент.

Если захват не может быть инициирован, функция возвращает null.

Примечание: Эта функция будет рендерить элемент на скрытой поверхности и копировать эту поверхность из памяти видеоадаптера в оперативную память, что может быть довольно дорого. Для "живого" предварительного просмотра используйте слои или ShaderEffectSource.

См. также QQuickWindow::grabWindow().

void QQuickItem::grabTouchPoints(const QVector<int> &ids)

Захватывает точки касания, указанные в ids.

Эти точки касания будут принадлежать элементу до тех пор, пока они не будут освобождены. В качестве альтернативы, захват может быть украден фильтрующим элементом, таким как Flickable. Используйте setKeepTouchGrab(), чтобы предотвратить кражу захвата.

См. также ungrabTouchPoints() и setKeepTouchGrab().

[protected] bool QQuickItem::heightValid() const

Возвращает значение, указывающее, был ли свойство высоты явно задан.

[virtual protected] void QQuickItem::hoverEnterEvent(QHoverEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий hover-enter для элемента. Информация о событии предоставляется параметром event.

События наведения курсора предоставляются только если acceptHoverEvents() имеет значение true.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределяете эту функцию. Если вы не хотите принимать событие, вызовите event->ignore().

[virtual protected] void QQuickItem::hoverLeaveEvent(QHoverEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий выхода курсора для элемента. Информация о событии предоставляется параметром event.

События наведения курсора предоставляются только если acceptHoverEvents() имеет значение true.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределяете эту функцию. Если вы не хотите принимать событие, вызовите event->ignore().

[virtual protected] void QQuickItem::hoverMoveEvent(QHoverEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий перемещения курсора для элемента. Информация о событии предоставляется параметром event.

События наведения курсора предоставляются только если acceptHoverEvents() имеет значение true.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределяете эту функцию. Если вы не хотите принимать событие, вызовите event->ignore().

qreal QQuickItem::implicitWidth() const

Возвращает ширину элемента, которая подразумевается другими свойствами, определяющими содержимое.

Примечание: Функция-геттер для свойства implicitWidth.

См. также setImplicitWidth().

[virtual protected] void QQuickItem::inputMethodEvent(QInputMethodEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий ввода для элемента. Информация о событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределяете эту функцию. Если вы не хотите принимать событие, вызовите event->ignore().

[virtual] QVariant QQuickItem::inputMethodQuery(Qt::InputMethodQuery query) const

Этот метод актуален только для элементов ввода.

Если этот элемент является элементом ввода, этот метод должен быть переопределён для возвращения соответствующих флагов метода ввода для заданного query.

См. также QWidget::inputMethodQuery().

bool QQuickItem::isAncestorOf(const QQuickItem *child) const

Возвращает true, если этот элемент является предком child (т.е., если этот элемент является родителем child или одним из предков родителя child).

Эта функция была добавлена в Qt 5.7.

См. также parentItem().

[protected] bool QQuickItem::isComponentComplete() const

Возвращает true, если создание компонента QML завершено; в противном случае возвращает false.

Зачастую желательно отложить некоторую обработку до завершения создания компонента.

См. также componentComplete().

bool QQuickItem::isFocusScope() const

Возвращает true, если этот элемент является областью фокуса, и false в противном случае.

[virtual] bool QQuickItem::isTextureProvider() const

Возвращает true, если этот элемент является поставщиком текстур. По умолчанию возвращает false.

Эта функция может вызываться из любого потока.

[virtual protected] void QQuickItem::itemChange(QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &value)

Вызывается при наступлении change для данного элемента.

value содержит дополнительную информацию, относящуюся к изменению, если применимо.

Если вы переопределяете этот метод в подклассе, убедитесь, что вызываете

QQuickItem::itemChange(change, value);

обычно в конце вашей реализации, чтобы гарантировать, что сигнал windowChanged() будет отправлен.

bool QQuickItem::keepMouseGrab() const

Возвращает значение, указывающее, нужно ли сохранить захват мыши исключительно этим элементом.

См. также setKeepMouseGrab().

bool QQuickItem::keepTouchGrab() const

Возвращает значение, указывающее, нужно ли сохранить захват касаний, взятых этим элементом, исключительно этим элементом.

См. также setKeepTouchGrab() и keepMouseGrab().

[virtual protected] void QQuickItem::keyPressEvent(QKeyEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий нажатия клавиш для элемента. Информация о событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределяете эту функцию. Если вы не хотите принимать событие, вызовите event->ignore().

[virtual protected] void QQuickItem::keyReleaseEvent(QKeyEvent *event)

Этот обработчик событий можно переопределить в подклассе для получения событий отпускания клавиш для элемента. Информация о событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределяете эту функцию. Если вы не хотите принимать событие, вызовите event->ignore().

QPointF QQuickItem::mapFromGlobal(const QPointF &point) const

Преобразует указанную точку point в глобальной системе координат экрана в эквивалентную точку в системе координат данного элемента и возвращает преобразованную координату.

В преобразовании используются следующие свойства элемента: x, y, scale, rotation, transformOrigin и transform.

Например, это может быть полезно для добавления всплывающего окна к компоненту Qt Quick.

Примечание: Позиционирование окна выполняется менеджером окон, и это значение рассматривается только как подсказка. Таким образом, фактическая позиция окна может отличаться от ожидаемой.

Эта функция была добавлена в Qt 5.7.

См. также Концепции - Визуальные координаты в Qt Quick.

QPointF QQuickItem::mapFromItem(const QQuickItem *item, const QPointF &point) const

Преобразует заданную точку point в системе координат item в эквивалентную точку в системе координат данного элемента и возвращает преобразованную координату.

В преобразовании используются следующие свойства элемента: x, y, scale, rotation, transformOrigin и transform.

Если item равен 0, это преобразование выполняется из системы координат сцены.

См. также Концепции - Визуальные координаты в Qt Quick.

QPointF QQuickItem::mapFromScene(const QPointF &point) const

Преобразует заданную точку point в системе координат сцены в эквивалентную точку в системе координат данного элемента и возвращает преобразованную координату.

В преобразовании используются следующие свойства элемента: x, y, scale, rotation, transformOrigin и transform.

См. также Концепции - Визуальные координаты в Qt Quick.

QRectF QQuickItem::mapRectFromItem(const QQuickItem *item, const QRectF &rect) const

Преобразует заданный прямоугольник rect в системе координат item в эквивалентную прямоугольную область в системе координат данного элемента и возвращает значение преобразованного прямоугольника.

В преобразовании используются следующие свойства элемента: x, y, scale, rotation, transformOrigin и transform.

Если item равен 0, это преобразование выполняется из системы координат сцены.

См. также Концепции - Визуальные координаты в Qt Quick.

QRectF QQuickItem::mapRectFromScene(const QRectF &rect) const

Преобразует заданный прямоугольник rect в системе координат сцены в эквивалентную прямоугольную область в системе координат данного элемента и возвращает значение преобразованного прямоугольника.

В отображении используются следующие свойства элемента: x, y, масштаб, вращение, transformOrigin и transform.

См. также Концепции — Визуальные координаты в Qt Quick.

QRectF QQuickItem::mapRectToItem(const QQuickItem *item, const QRectF &rect) const

Преобразует заданный прямоугольник rect в системе координат текущего элемента в эквивалентную прямоугольную область в системе координат элемента item и возвращает преобразованный прямоугольник.

В отображении используются следующие свойства элемента: x, y, масштаб, вращение, transformOrigin и transform.

Если item равен 0, это преобразует rect в систему координат сцены.

См. также Концепции — Визуальные координаты в Qt Quick.

QRectF QQuickItem::mapRectToScene(const QRectF &rect) const

Преобразует заданный прямоугольник rect в системе координат текущего элемента в эквивалентную прямоугольную область в системе координат сцены и возвращает преобразованный прямоугольник.

В отображении используются следующие свойства элемента: x, y, масштаб, вращение, transformOrigin и transform.

См. также Концепции — Визуальные координаты в Qt Quick.

QPointF QQuickItem::mapToGlobal(const QPointF &point) const

Преобразует заданную точку point в системе координат текущего элемента в эквивалентную точку в глобальной системе координат экрана и возвращает преобразованную координату.

В отображении используются следующие свойства элемента: x, y, масштаб, вращение, transformOrigin и transform.

Например, это может быть полезно для добавления всплывающего окна к компоненту Qt Quick.

Примечание: Размещение окна выполняется менеджером окон, и это значение рассматривается только как подсказка. Поэтому фактическое расположение окна может отличаться от ожидаемого.

Эта функция была добавлена в Qt 5.7.

См. также Концепции — Визуальные координаты в Qt Quick.

QPointF QQuickItem::mapToItem(const QQuickItem *item, const QPointF &point) const

Преобразует заданную точку point в системе координат текущего элемента в эквивалентную точку в системе координат элемента item и возвращает преобразованную координату.

В отображении используются следующие свойства элемента: x, y, масштаб, вращение, transformOrigin и transform.

Если item равен 0, это преобразует point в систему координат сцены.

См. также Концепции — Визуальные координаты в Qt Quick.

QPointF QQuickItem::mapToScene(const QPointF &point) const

Преобразует заданную точку point в системе координат текущего элемента в эквивалентную точку в системе координат сцены и возвращает преобразованную координату.

В отображении используются следующие свойства элемента: x, y, масштаб, вращение, transformOrigin и transform.

См. также Концепции — Визуальные координаты в Qt Quick.

[virtual protected] void QQuickItem::mouseDoubleClickEvent(QMouseEvent *event)

Этот обработчик событий может быть переопределен в подклассе для получения двойных щелчков мыши для элемента. Информация об событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие при переопределении этой функции. Если вы не принимаете событие, вызовите event->ignore().

[virtual protected] void QQuickItem::mouseMoveEvent(QMouseEvent *event)

Этот обработчик событий может быть переопределен в подклассе для получения событий перемещения мыши для элемента. Информация об событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие при переопределении этой функции. Если вы не принимаете событие, вызовите event->ignore().

[virtual protected] void QQuickItem::mousePressEvent(QMouseEvent *event)

Этот обработчик событий может быть переопределен в подклассе для получения событий нажатия мыши для элемента. Информация об событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие при переопределении этой функции. Если вы не принимаете событие, вызовите event->ignore().

[virtual protected] void QQuickItem::mouseReleaseEvent(QMouseEvent *event)

Этот обработчик событий может быть переопределен в подклассе для получения событий отпускания мыши для элемента. Информация об событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие при переопределении этой функции. Если вы не принимаете событие, вызовите event->ignore().

[virtual protected] void QQuickItem::mouseUngrabEvent()

Этот обработчик событий может быть переопределен в подклассе, чтобы получать уведомления о событии отпускания мыши на этом элементе.

QQuickItem *QQuickItem::nextItemInFocusChain(bool forward = true)

Возвращает элемент в цепочке фокуса, следующий за этим элементом. Если forward имеет значение true, или не указано, это следующий элемент в прямом направлении. Если forward имеет значение false, это следующий элемент в обратном направлении.

Примечание: К этой функции можно обратиться через систему метаобъектов и из QML. См. Q_INVOKABLE.

void QQuickItem::polish()

Планирует событие обработки для этого элемента.

Когда граф сцены обработает запрос, он вызовет updatePolish() для этого элемента.

См. также updatePolish() и QQuickTest::qIsPolishScheduled().

[virtual protected] void QQuickItem::releaseResources()

Эта функция вызывается, когда элемент должен освободить графические ресурсы, которые не управляются узлами, возвращаемыми из QQuickItem::updatePaintNode().

Это происходит, когда элемент собирается быть удалён из окна, в котором он ранее отображался. Элемент гарантированно имеет окно при вызове функции.

Функция вызывается в потоке графического интерфейса, а состояние потока отрисовки, если он используется, неизвестно. Объекты не должны удаляться напрямую, а вместо этого планируются на очистку с помощью QQuickWindow::scheduleRenderJob().

См. также Обработка графических ресурсов.

QQuickItem *QQuickItem::scopedFocusItem() const

Если этот элемент является областью фокуса, он возвращает элемент в цепочке фокуса, который в настоящее время имеет фокус.

Возвращает nullptr если этот элемент не является областью фокуса.

void QQuickItem::setAcceptHoverEvents(bool enabled)

Если enabled имеет значение true, это задаёт элементу приём событий наведения; в противном случае события наведения этим элементом не принимаются.

См. также acceptHoverEvents().

void QQuickItem::setAcceptTouchEvents(bool enabled)

Если enabled имеет значение true, это задаёт элементу приём событий касания; в противном случае события касания этим элементом не принимаются.

Эта функция была добавлена в Qt 5.10.

См. также acceptTouchEvents().

void QQuickItem::setAcceptedMouseButtons(Qt::MouseButtons buttons)

Устанавливает кнопки мыши, принимаемые этим элементом, в buttons.

См. также acceptedMouseButtons().

void QQuickItem::setCursor(const QCursor &cursor)

Устанавливает форму курсора для данного элемента.

См. также cursor() и unsetCursor().

void QQuickItem::setFiltersChildMouseEvents(bool filter)

Устанавливает, должны ли события мыши и касания дочерних элементов этого элемента фильтроваться через этот элемент.

Если filter имеет значение true, childMouseEventFilter() будет вызван при возникновении события мыши для дочернего элемента.

См. также filtersChildMouseEvents().

void QQuickItem::setFlag(QQuickItem::Flag flag, bool enabled = true)

Включает указанный flag для этого элемента, если enabled имеет значение true; если enabled имеет значение false, флаг отключается.

Эти флаги предоставляют различные подсказки для элемента; например, флаг ItemClipsChildrenToShape указывает, что все дочерние элементы этого элемента должны обрезаться, чтобы уместиться в области элемента.

void QQuickItem::setFlags(QQuickItem::Flags flags)

Включает указанные flags для этого элемента.

См. также flags() и setFlag().

void QQuickItem::setKeepMouseGrab(bool keep)

Устанавливает, должно ли управление вводом мыши оставаться исключительно у этого элемента.

Это полезно для элементов, которые хотят захватывать и удерживать взаимодействие с мышкой после выполнения определённого жеста. Например, элемент, заинтересованный в горизонтальном перемещении мыши, может установить keepMouseGrab в значение true после превышения порога. После установки keepMouseGrab в значение true, фильтрующие элементы не будут реагировать на события мыши.

Если keep имеет значение false, фильтрующий элемент может захватить управление. Например, Flickable может попытаться захватить управление мышью, если обнаружит, что пользователь начал перемещать область просмотра.

См. также keepMouseGrab().

void QQuickItem::setKeepTouchGrab(bool keep)

Устанавливает, должны ли касания, захваченные этим элементом, оставаться исключительно у этого элемента.

Это полезно для элементов, которые хотят захватывать и удерживать определённые точки касания после выполнения определённого жеста. Например, элемент, заинтересованный в горизонтальном перемещении точки касания, может установить setKeepTouchGrab в значение true после превышения порога. После установки setKeepTouchGrab в значение true, фильтрующие элементы не будут реагировать на соответствующие точки касания.

Если keep имеет значение false, фильтрующий элемент может захватить управление. Например, Flickable может попытаться захватить управление точкой касания, если обнаружит, что пользователь начал перемещать область просмотра.

См. также keepTouchGrab() и setKeepMouseGrab().

void QQuickItem::setSize(const QSizeF &size)

Устанавливает размер элемента в size.

Эта функция была введена в Qt 5.10.

См. также size, setWidth и setHeight.

QSizeF QQuickItem::size() const

Возвращает размер элемента.

Эта функция была введена в Qt 5.10.

См. также setSize, width и height.

void QQuickItem::stackAfter(const QQuickItem *sibling)

Перемещает указанный элемент sibling на позицию после этого элемента в списке дочерних элементов. Порядок дочерних элементов влияет как на визуальный порядок отображения, так и на порядок навигации по табу.

Предполагая, что значения z обоих элементов одинаковы, это приведёт к отображению sibling под этим элементом.

Если оба элемента имеют activeFocusOnTab установленным в true, это также приведёт к изменению порядка фокуса при нажатии клавиши Tab, и sibling получит фокус перед этим элементом.

Указанный sibling должен быть дочерним элементом этого элемента; то есть, они должны иметь одного и того же непосредственного parent.

См. также Концепции - Визуальный родитель в Qt Quick.

void QQuickItem::stackBefore(const QQuickItem *sibling)

Перемещает указанный элемент sibling на позицию перед этим элементом в списке дочерних элементов. Порядок дочерних элементов влияет как на визуальный порядок отображения, так и на порядок навигации по табу.

Предполагая, что значения z обоих элементов одинаковы, это приведёт к отображению sibling над этим элементом.

Если оба элемента имеют activeFocusOnTab установленным в true, это также приведёт к изменению порядка фокуса при нажатии клавиши Tab, и sibling получит фокус после этого элемента.

Указанный sibling должен быть дочерним элементом этого элемента; то есть, они должны иметь одного и того же непосредственного parent.

См. также Концепции - Визуальный родитель в Qt Quick.

[virtual] QSGTextureProvider *QQuickItem::textureProvider() const

Возвращает поставщика текстур для элемента. Реализация по умолчанию возвращает nullptr.

Эту функцию можно вызывать только в потоке отрисовки.

[virtual protected] void QQuickItem::touchEvent(QTouchEvent *event)

Этот обработчик событий может быть переопределён в подклассе для получения событий касания для элемента. Информация об событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределяете эту функцию. Если вы не принимаете событие, вызовите event->ignore().

[virtual protected] void QQuickItem::touchUngrabEvent()

Этот обработчик событий может быть переопределён в подклассе, чтобы получать уведомления о событии отмены захвата касания для этого элемента.

void QQuickItem::ungrabMouse()

Освобождает захват мыши после вызова grabMouse().

Обратите внимание, что эту функцию следует вызывать только в том случае, если элемент хочет прекратить обработку дальнейших событий. Нет необходимости вызывать эту функцию после события освобождения или отмены, так как в любом случае дальнейшие события не будут получены. После вызова этой функции события перемещения или освобождения не будут доставлены.

void QQuickItem::ungrabTouchPoints()

Освобождает захват точек касания, принадлежащих этому элементу.

Примечание: вряд ли есть причина вызывать эту функцию. Её следует вызывать только в том случае, если элемент не хочет получать дальнейшие события, поэтому после вызова этой функции события перемещения или освобождения не будут доставлены.

См. также grabTouchPoints().

void QQuickItem::unsetCursor()

Очищает форму курсора для этого элемента.

См. также cursor() и setCursor().

[protected] void QQuickItem::updateInputMethod(Qt::InputMethodQueries queries = Qt::ImQueryInput)

Уведомляет механизм ввода о новых значениях запроса, если необходимо. queries указывает изменённые атрибуты.

[virtual protected] QSGNode *QQuickItem::updatePaintNode(QSGNode *oldNode, QQuickItem::UpdatePaintNodeData *updatePaintNodeData)

Вызывается в потоке отрисовки, когда пришло время синхронизировать состояние элемента с графическим деревом сцены.

Функция вызывается в результате QQuickItem::update(), если пользователь установил флаг QQuickItem::ItemHasContents для элемента.

Функция должна возвращать корень поддерева графического дерева сцены для этого элемента. Большинство реализаций вернут один QSGGeometryNode, содержащий визуальное представление этого элемента. oldNode — это узел, который был возвращён в последний раз, когда функция была вызвана. updatePaintNodeData предоставляет указатель на QSGTransformNode, связанный с этим QQuickItem.

QSGNode *MyItem::updatePaintNode(QSGNode *node, UpdatePaintNodeData *)
{
    QSGSimpleRectNode *n = static_cast<QSGSimpleRectNode *>(node);
    if (!n) {
        n = new QSGSimpleRectNode();
        n->setColor(Qt::red);
    }
    n->setRect(boundingRect());
    return n;
}

Главный поток заблокирован во время выполнения этой функции, поэтому безопасно читать значения из экземпляра QQuickItem и других объектов в главном потоке.

Если ни один вызов QQuickItem::updatePaintNode() не привёл к фактическим изменениям в графическом дереве сцены, например, к вызову QSGNode::markDirty() или добавлению и удалению узлов, то реализация может принять решение не перерисовывать сцену, так как визуальный результат идентичен.

Предупреждение: Крайне важно, чтобы операции OpenGL и взаимодействие с графическим деревом сцены происходили исключительно в потоке отрисовки, главным образом во время вызова QQuickItem::updatePaintNode(). Лучшее правило — использовать только классы с префиксом «QSG» внутри функции QQuickItem::updatePaintNode().

Предупреждение: Эта функция вызывается в потоке отрисовки. Это означает, что любые QObjects или локальное хранилище потока, созданные в ней, будут иметь отношение к потоку отрисовки, поэтому будьте осторожны, выполняя что-либо, кроме отрисовки, в этой функции. Точно так же для сигналов, они будут испускаться в потоке отрисовки и, следовательно, часто будут доставлены через очереди.

Примечание: Все классы с префиксом QSG должны использоваться только в потоке отрисовки графического дерева сцены. Подробнее см. Графическое дерево сцены и отрисовка.

См. также QSGMaterial, QSGSimpleMaterial, QSGGeometryNode, QSGGeometry, QSGFlatColorMaterial, QSGTextureMaterial, QSGNode::markDirty() и Обработка ресурсов графики.

[virtual protected] void QQuickItem::updatePolish()

Эта функция должна выполнять необходимый для этого элемента макет.

При вызове polish() графический процессор планирует событие polish для этого элемента. Когда графический процессор готов отобразить этот элемент, он вызывает updatePolish(), чтобы выполнить любой необходимый макет элемента перед отрисовкой следующего кадра.

[virtual protected] void QQuickItem::wheelEvent(QWheelEvent *event)

Этот обработчик событий может быть переопределен в подклассе для получения событий колесика для элемента. Информация о событии предоставляется параметром event.

Событие принимается по умолчанию, поэтому нет необходимости явно принимать событие, если вы переопределите эту функцию. Если вы не принимаете событие, вызовите event->ignore().

[protected] bool QQuickItem::widthValid() const

Возвращает, установлена ли свойство ширины явно.

QQuickWindow *QQuickItem::window() const

Возвращает окно, в котором отображается этот элемент.

У элемента нет окна, пока он не будет назначен в сцену. Сигнал windowChanged() предоставляет уведомление как при вводе элемента в сцену, так и при удалении его из сцены.