 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include <qquickimage_p.h>
Public Member Functions | |
| QQuickImage (QQuickItem *parent=nullptr) | |
| \qmltype Image \nativetype QQuickImage \inqmlmodule QtQuick\inherits Item | |
| ~QQuickImage () | |
| FillMode | fillMode () const |
| \qmlproperty enumeration QtQuick::Image::fillMode | |
| void | setFillMode (FillMode) |
| qreal | paintedWidth () const |
| \qmlproperty real QtQuick::Image::paintedWidth \qmlproperty real QtQuick::Image::paintedHeight \readonly | |
| qreal | paintedHeight () const |
| QRectF | boundingRect () const override |
Returns the extents of the item in its own coordinate system: a rectangle from | |
| HAlignment | horizontalAlignment () const |
| void | setHorizontalAlignment (HAlignment align) |
| VAlignment | verticalAlignment () const |
| void | setVerticalAlignment (VAlignment align) |
| bool | isTextureProvider () const override |
| Returns true if this item is a texture provider. | |
| QSGTextureProvider * | textureProvider () const override |
| Returns the texture provider for an item. | |
| bool | mipmap () const |
| \qmlproperty bool QtQuick::Image::mipmap | |
| void | setMipmap (bool use) |
| void | emitAutoTransformBaseChanged () override |
| Public Member Functions inherited from QQuickImageBase | |
| QQuickImageBase (QQuickItem *parent=nullptr) | |
| ~QQuickImageBase () | |
| Status | status () const |
| qreal | progress () const |
| QUrl | source () const |
| virtual void | setSource (const QUrl &url) |
| bool | asynchronous () const |
| void | setAsynchronous (bool) |
| bool | cache () const |
| void | setCache (bool) |
| QImage | image () const |
| virtual void | setSourceSize (const QSize &) |
| QSize | sourceSize () const |
| void | resetSourceSize () |
| QRectF | sourceClipRect () const |
| void | setSourceClipRect (const QRectF &r) |
| void | resetSourceClipRect () |
| virtual void | setMirror (bool mirror) |
| bool | mirror () const |
| virtual void | setMirrorVertically (bool mirror) |
| bool | mirrorVertically () const |
| virtual void | setCurrentFrame (int frame) |
| virtual int | currentFrame () const |
| virtual int | frameCount () const |
| virtual void | setAutoTransform (bool transform) |
| bool | autoTransform () const |
| QColorSpace | colorSpace () const |
| virtual void | setColorSpace (const QColorSpace &colorSpace) |
| bool | retainWhileLoading () const |
| void | setRetainWhileLoading (bool retain) |
| Public Member Functions inherited from QQuickItem | |
| QQuickItem (QQuickItem *parent=nullptr) | |
| Constructs a QQuickItem with the given parent. | |
| ~QQuickItem () override | |
| Destroys the QQuickItem. | |
| QQuickWindow * | window () const |
| Returns the window in which this item is rendered. | |
| QQuickItem * | parentItem () const |
| void | setParentItem (QQuickItem *parent) |
| void | stackBefore (const QQuickItem *) |
| Moves this item to the index before the specified sibling item within the list of children. | |
| void | stackAfter (const QQuickItem *) |
| Moves this item to the index after the specified sibling item within the list of children. | |
| QRectF | childrenRect () |
| \qmlpropertygroup QtQuick::Item::childrenRect \qmlproperty real QtQuick::Item::childrenRect.x \qmlproperty real QtQuick::Item::childrenRect.y \qmlproperty real QtQuick::Item::childrenRect.width \qmlproperty real QtQuick::Item::childrenRect.height \readonly | |
| QList< QQuickItem * > | childItems () const |
| Returns the children of this item. | |
| bool | clip () const |
| \qmlproperty bool QtQuick::Item::clip This property holds whether clipping is enabled. | |
| void | setClip (bool) |
| QString | state () const |
| \qmlproperty string QtQuick::Item::state | |
| void | setState (const QString &) |
| qreal | baselineOffset () const |
| \qmlproperty int QtQuick::Item::baselineOffset | |
| void | setBaselineOffset (qreal) |
| QQmlListProperty< QQuickTransform > | transform () |
| qreal | x () const |
| qreal | y () const |
| QPointF | position () const |
| void | setX (qreal) |
| void | setY (qreal) |
| void | setPosition (const QPointF &) |
| QBindable< qreal > | bindableX () |
| QBindable< qreal > | bindableY () |
| qreal | width () const |
| void | setWidth (qreal) |
| void | resetWidth () |
| void | setImplicitWidth (qreal) |
| qreal | implicitWidth () const |
| Returns the width of the item that is implied by other properties that determine the content. | |
| QBindable< qreal > | bindableWidth () |
| qreal | height () const |
| void | setHeight (qreal) |
| void | resetHeight () |
| void | setImplicitHeight (qreal) |
| qreal | implicitHeight () const |
| QBindable< qreal > | bindableHeight () |
| QSizeF | size () const |
| void | setSize (const QSizeF &size) |
| TransformOrigin | transformOrigin () const |
| void | setTransformOrigin (TransformOrigin) |
| QPointF | transformOriginPoint () const |
| void | setTransformOriginPoint (const QPointF &) |
| qreal | z () const |
| void | setZ (qreal) |
| qreal | rotation () const |
| void | setRotation (qreal) |
| qreal | scale () const |
| void | setScale (qreal) |
| qreal | opacity () const |
| void | setOpacity (qreal) |
| bool | isVisible () const |
| void | setVisible (bool) |
| bool | isEnabled () const |
| void | setEnabled (bool) |
| bool | smooth () const |
| void | setSmooth (bool) |
| bool | activeFocusOnTab () const |
| \qmlproperty bool QtQuick::Item::activeFocusOnTab | |
| void | setActiveFocusOnTab (bool) |
| bool | antialiasing () const |
| void | setAntialiasing (bool) |
| void | resetAntialiasing () |
| Flags | flags () const |
| Returns the item flags for this item. | |
| void | setFlag (Flag flag, bool enabled=true) |
| Enables the specified flag for this item if enabled is true; if enabled is false, the flag is disabled. | |
| void | setFlags (Flags flags) |
| Enables the specified flags for this item. | |
| virtual QRectF | clipRect () const |
Returns the rectangular area within this item that is currently visible in \l viewportItem(), if there is a viewport and the \l ItemObservesViewport flag is set; otherwise, the extents of this item in its own coordinate system: a rectangle from | |
| QQuickItem * | viewportItem () const |
| If the \l ItemObservesViewport flag is set, returns the nearest parent with the \l ItemIsViewport flag. | |
| bool | hasActiveFocus () const |
| bool | hasFocus () const |
| void | setFocus (bool) |
| void | setFocus (bool focus, Qt::FocusReason reason) |
| bool | isFocusScope () const |
| Returns true if this item is a focus scope, and false otherwise. | |
| QQuickItem * | scopedFocusItem () const |
| If this item is a focus scope, this returns the item in its focus chain that currently has focus. | |
| Qt::FocusPolicy | focusPolicy () const |
| void | setFocusPolicy (Qt::FocusPolicy policy) |
| Sets the focus policy of this item to policy. | |
| bool | isAncestorOf (const QQuickItem *child) const |
Returns true if this item is an ancestor of child (i.e., if this item is child's parent, or one of child's parent's ancestors). | |
| Qt::MouseButtons | acceptedMouseButtons () const |
| Returns the mouse buttons accepted by this item. | |
| void | setAcceptedMouseButtons (Qt::MouseButtons buttons) |
| Sets the mouse buttons accepted by this item to buttons. | |
| bool | acceptHoverEvents () const |
| Returns whether hover events are accepted by this item. | |
| void | setAcceptHoverEvents (bool enabled) |
| If enabled is true, this sets the item to accept hover events; otherwise, hover events are not accepted by this item. | |
| bool | acceptTouchEvents () const |
| Returns whether touch events are accepted by this item. | |
| void | setAcceptTouchEvents (bool accept) |
| If enabled is true, this sets the item to accept touch events; otherwise, touch events are not accepted by this item. | |
| bool | isUnderMouse () const |
| void | grabMouse () |
| void | ungrabMouse () |
| bool | keepMouseGrab () const |
| Returns whether mouse input should exclusively remain with this item. | |
| void | setKeepMouseGrab (bool) |
| Sets whether the mouse input should remain exclusively with this item. | |
| bool | filtersChildMouseEvents () const |
| Returns whether pointer events intended for this item's children should be filtered through this item. | |
| void | setFiltersChildMouseEvents (bool filter) |
| Sets whether pointer events intended for this item's children should be filtered through this item. | |
| void | grabTouchPoints (const QList< int > &ids) |
| void | ungrabTouchPoints () |
| bool | keepTouchGrab () const |
| Returns whether the touch points grabbed by this item should exclusively remain with this item. | |
| void | setKeepTouchGrab (bool) |
| Sets whether the touch points grabbed by this item should remain exclusively with this item. | |
| Q_REVISION (2, 4) Q_INVOKABLE bool grabToImage(const QJSValue &callback | |
| QSharedPointer< QQuickItemGrabResult > | grabToImage (const QSize &targetSize=QSize()) |
| Grabs the item into an in-memory image. | |
| virtual Q_INVOKABLE bool | contains (const QPointF &point) const |
| \qmlmethod bool QtQuick::Item::contains(point point) | |
| QObject * | containmentMask () const |
| void | setContainmentMask (QObject *mask) |
| QTransform | itemTransform (QQuickItem *, bool *) const |
| \qmlmethod point QtQuick::Item::mapFromItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapFromItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, rect r) | |
| QPointF | mapToScene (const QPointF &point) const |
| Maps the given point in this item's coordinate system to the equivalent point within the scene's coordinate system, and returns the mapped coordinate. | |
| QRectF | mapRectToItem (const QQuickItem *item, const QRectF &rect) const |
| Maps the given rect in this item's coordinate system to the equivalent rectangular area within item's coordinate system, and returns the mapped rectangle value. | |
| QRectF | mapRectToScene (const QRectF &rect) const |
| Maps the given rect in this item's coordinate system to the equivalent rectangular area within the scene's coordinate system, and returns the mapped rectangle value. | |
| QPointF | mapFromScene (const QPointF &point) const |
| Maps the given point in the scene's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate. | |
| QRectF | mapRectFromItem (const QQuickItem *item, const QRectF &rect) const |
| Maps the given rect in item's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value. | |
| QRectF | mapRectFromScene (const QRectF &rect) const |
| Maps the given rect in the scene's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value. | |
| void | polish () |
| Schedules a polish event for this item. | |
| Q_INVOKABLE QPointF | mapFromItem (const QQuickItem *item, const QPointF &point) const |
| Maps the given point in item's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate. | |
| Q_INVOKABLE QPointF | mapFromItem (const QQuickItem *item, qreal x, qreal y) |
| Q_INVOKABLE QRectF | mapFromItem (const QQuickItem *item, const QRectF &rect) const |
| Q_INVOKABLE QRectF | mapFromItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const |
| Q_INVOKABLE QPointF | mapToItem (const QQuickItem *item, const QPointF &point) const |
| Maps the given point in this item's coordinate system to the equivalent point within item's coordinate system, and returns the mapped coordinate. | |
| Q_INVOKABLE QPointF | mapToItem (const QQuickItem *item, qreal x, qreal y) |
| Q_INVOKABLE QRectF | mapToItem (const QQuickItem *item, const QRectF &rect) const |
| Q_INVOKABLE QRectF | mapToItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const |
| Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(qreal x | |
| Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(const QPointF &point) const | |
| Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(qreal x | |
| Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(const QPointF &point) const | |
| Q_INVOKABLE void | forceActiveFocus () |
| \qmlmethod point QtQuick::Item::mapToItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapToItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapToItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapToItem(Item item, rect r) | |
| Q_INVOKABLE void | forceActiveFocus (Qt::FocusReason reason) |
| \qmlmethod QtQuick::Item::forceActiveFocus(Qt::FocusReason reason) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Forces active focus on the item with the given reason. | |
| Q_REVISION (2, 1) Q_INVOKABLE QQuickItem *nextItemInFocusChain(bool forward | |
| Q_INVOKABLE QQuickItem * | childAt (qreal x, qreal y) const |
| \qmlmethod Item QtQuick::Item::childAt(real x, real y) | |
| Q_REVISION (6, 3) Q_INVOKABLE void ensurePolished() | |
| Q_REVISION (6, 3) Q_INVOKABLE void dumpItemTree() const | |
| Public Member Functions inherited from QObject | |
| Q_INVOKABLE | QObject (QObject *parent=nullptr) |
| Constructs an object with parent object parent. | |
| virtual | ~QObject () |
| Destroys the object, deleting all its child objects. | |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| Filters events if this object has been installed as an event filter for the watched object. | |
| QString | objectName () const |
| Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
| Sets the object's name to name. | |
| void | setObjectName (QAnyStringView name) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QBindable< QString > | bindableObjectName () |
| bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false. | |
| bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false. | |
| bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false. | |
| bool | isQmlObjectType () const |
| Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership(). | |
| bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false. | |
| bool | blockSignals (bool b) noexcept |
| If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
| QThread * | thread () const |
| Returns the thread in which the object lives. | |
| bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
| int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
| This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
| int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. | |
| void | killTimer (Qt::TimerId id) |
| template<typename T> | |
| T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
| template<typename T> | |
| QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
| template<typename T> | |
| T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| template<typename T> | |
| QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| const QObjectList & | children () const |
| Returns a list of child objects. | |
| void | setParent (QObject *parent) |
| Makes the object a child of parent. | |
| void | installEventFilter (QObject *filterObj) |
| Installs an event filter filterObj on this object. | |
| void | removeEventFilter (QObject *obj) |
| Removes an event filter object obj from this object. | |
| QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
| bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
| bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
| void | dumpObjectTree () const |
| Dumps a tree of children to the debug output. | |
| void | dumpObjectInfo () const |
| Dumps information about signal connections, etc. | |
| bool | setProperty (const char *name, const QVariant &value) |
| Sets the value of the object's name property to value. | |
| bool | setProperty (const char *name, QVariant &&value) |
| QVariant | property (const char *name) const |
| Returns the value of the object's name property. | |
| QList< QByteArray > | dynamicPropertyNames () const |
| QBindingStorage * | bindingStorage () |
| const QBindingStorage * | bindingStorage () const |
| QObject * | parent () const |
| Returns a pointer to the parent object. | |
| bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. | |
| Public Member Functions inherited from QQmlParserStatus | |
| QQmlParserStatus () | |
| virtual | ~QQmlParserStatus () |
Protected Member Functions | |
| QQuickImage (QQuickImagePrivate &dd, QQuickItem *parent) | |
| void | pixmapChange () override |
| void | updatePaintedGeometry () |
| \qmlproperty enumeration QtQuick::Image::status \readonly | |
| void | releaseResources () override |
| This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode(). | |
| void | geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override |
| QSGNode * | updatePaintNode (QSGNode *, UpdatePaintNodeData *) override |
| Called on the render thread when it is time to sync the state of the item with the scene graph. | |
| Protected Member Functions inherited from QQuickImageBase | |
| void | loadEmptyUrl () |
| void | loadPixmap (const QUrl &url, LoadPixmapOptions loadOptions=NoOption) |
| virtual void | load () |
| void | componentComplete () override |
| Invoked after the root component that caused this instantiation has completed construction. | |
| void | itemChange (ItemChange change, const ItemChangeData &value) override |
| Called when change occurs for this item. | |
| QQuickImageBase (QQuickImageBasePrivate &dd, QQuickItem *parent) | |
| Protected Member Functions inherited from QQuickImplicitSizeItem | |
| QQuickImplicitSizeItem (QQuickImplicitSizeItemPrivate &dd, QQuickItem *parent) | |
| Protected Member Functions inherited from QQuickItem | |
| bool | event (QEvent *) override |
| \reimp | |
| bool | isComponentComplete () const |
| Returns true if construction of the QML component is complete; otherwise returns false. | |
| bool | widthValid () const |
| Returns whether the width property has been set explicitly. | |
| bool | heightValid () const |
| Returns whether the height property has been set explicitly. | |
| void | setImplicitSize (qreal, qreal) |
| void | classBegin () override |
| \reimp Derived classes should call the base class method before adding their own action to perform at classBegin. | |
| void | componentComplete () override |
| \reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete. | |
| virtual void | keyPressEvent (QKeyEvent *event) |
| This event handler can be reimplemented in a subclass to receive key press events for an item. | |
| virtual void | keyReleaseEvent (QKeyEvent *event) |
| This event handler can be reimplemented in a subclass to receive key release events for an item. | |
| virtual void | focusInEvent (QFocusEvent *) |
| This event handler can be reimplemented in a subclass to receive focus-in events for an item. | |
| virtual void | focusOutEvent (QFocusEvent *) |
| This event handler can be reimplemented in a subclass to receive focus-out events for an item. | |
| virtual void | mousePressEvent (QMouseEvent *event) |
| This event handler can be reimplemented in a subclass to receive mouse press events for an item. | |
| virtual void | mouseMoveEvent (QMouseEvent *event) |
| This event handler can be reimplemented in a subclass to receive mouse move events for an item. | |
| virtual void | mouseReleaseEvent (QMouseEvent *event) |
| This event handler can be reimplemented in a subclass to receive mouse release events for an item. | |
| virtual void | mouseDoubleClickEvent (QMouseEvent *event) |
| This event handler can be reimplemented in a subclass to receive mouse double-click events for an item. | |
| virtual void | mouseUngrabEvent () |
| This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item. | |
| virtual void | touchUngrabEvent () |
| This event handler can be reimplemented in a subclass to be notified when a touch ungrab event has occurred on this item. | |
| virtual void | touchEvent (QTouchEvent *event) |
| This event handler can be reimplemented in a subclass to receive touch events for an item. | |
| virtual void | hoverEnterEvent (QHoverEvent *event) |
| This event handler can be reimplemented in a subclass to receive hover-enter events for an item. | |
| virtual void | hoverMoveEvent (QHoverEvent *event) |
| This event handler can be reimplemented in a subclass to receive hover-move events for an item. | |
| virtual void | hoverLeaveEvent (QHoverEvent *event) |
| This event handler can be reimplemented in a subclass to receive hover-leave events for an item. | |
| virtual bool | childMouseEventFilter (QQuickItem *, QEvent *) |
| Reimplement this method to filter the pointer events that are received by this item's children. | |
| virtual bool | contextMenuEvent (QContextMenuEvent *event) |
| virtual void | updatePolish () |
| This function should perform any layout as required for this item. | |
| QQuickItem (QQuickItemPrivate &dd, QQuickItem *parent=nullptr) | |
| Protected Member Functions inherited from QObject | |
| QObject * | sender () const |
| Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
| int | senderSignalIndex () const |
| int | receivers (const char *signal) const |
| Returns the number of receivers connected to the signal. | |
| bool | isSignalConnected (const QMetaMethod &signal) const |
| virtual void | timerEvent (QTimerEvent *event) |
| This event handler can be reimplemented in a subclass to receive timer events for the object. | |
| virtual void | childEvent (QChildEvent *event) |
| This event handler can be reimplemented in a subclass to receive child events. | |
| virtual void | customEvent (QEvent *event) |
| This event handler can be reimplemented in a subclass to receive custom events. | |
| virtual void | connectNotify (const QMetaMethod &signal) |
| virtual void | disconnectNotify (const QMetaMethod &signal) |
| QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
Properties | |
| FillMode | fillMode |
| qreal | paintedWidth |
| qreal | paintedHeight |
| HAlignment | horizontalAlignment |
| VAlignment | verticalAlignment |
| QSize | sourceSize |
| bool | mipmap |
| bool | autoTransform |
| QRectF | sourceClipRect |
| Properties inherited from QQuickImageBase | |
| Status | status |
| QUrl | source |
| qreal | progress |
| bool | asynchronous |
| bool | cache |
| bool | mirror |
| bool | mirrorVertically |
| bool | retainWhileLoading |
| int | currentFrame |
| int | frameCount |
| QColorSpace | colorSpace |
| Properties inherited from QQuickImplicitSizeItem | |
| qreal | implicitWidth |
| qreal | implicitHeight |
| Properties inherited from QQuickItem | |
| QQuickItem * | parent |
| \qmlproperty Item QtQuick::Item::parent This property holds the visual parent of the item. | |
| qreal | x |
| \qmlproperty real QtQuick::Item::x \qmlproperty real QtQuick::Item::y \qmlproperty real QtQuick::Item::width \qmlproperty real QtQuick::Item::height | |
| qreal | y |
| Defines the item's y position relative to its parent. | |
| qreal | z |
| \qmlproperty real QtQuick::Item::z | |
| qreal | width |
| This property holds the width of this item. | |
| qreal | height |
| This property holds the height of this item. | |
| qreal | opacity |
| \qmlproperty real QtQuick::Item::opacity | |
| bool | enabled |
| \qmlproperty bool QtQuick::Item::enabled | |
| bool | visible |
| \qmlproperty bool QtQuick::Item::visible | |
| Qt::FocusPolicy | focusPolicy |
| \qmlproperty enumeration QtQuick::Item::focusPolicy | |
| qreal | rotation |
| \qmlproperty real QtQuick::Item::rotation This property holds the rotation of the item in degrees clockwise around its transformOrigin. | |
| qreal | scale |
| \qmlproperty real QtQuick::Item::scale This property holds the scale factor for this item. | |
| TransformOrigin | transformOrigin |
| \qmlproperty enumeration QtQuick::Item::transformOrigin This property holds the origin point around which scale and rotation transform. | |
| QPointF | transformOriginPoint |
| QQmlListProperty< QQuickTransform > | transform |
| \qmlproperty list<Transform> QtQuick::Item::transform | |
| bool | smooth |
| \qmlproperty bool QtQuick::Item::smooth | |
| bool | antialiasing |
| \qmlproperty bool QtQuick::Item::antialiasing | |
| qreal | implicitWidth |
| qreal | implicitHeight |
| QObject * | containmentMask |
| \qmlproperty QObject* QtQuick::Item::containmentMask | |
| Properties inherited from QObject | |
| QString | objectName |
| the name of this object | |
Additional Inherited Members | |
| Public Slots inherited from QQuickItem | |
| void | update () |
| Schedules a call to updatePaintNode() for this item. | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
| Static Public Member Functions inherited from QQuickImageBase | |
| static void | resolve2xLocalFile (const QUrl &url, qreal targetDevicePixelRatio, QUrl *sourceUrl, qreal *sourceDevicePixelRatio) |
| Static Public Member Functions inherited from QObject | |
| static QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
| \threadsafe | |
| static QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
| template<typename Func1, typename Func2> | |
| static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection) |
| template<typename Func1, typename Func2> | |
| static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot) |
| static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
| \threadsafe | |
| static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
| static bool | disconnect (const QMetaObject::Connection &) |
| Disconnect a connection. | |
| template<typename Func1, typename Func2> | |
| static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot) |
| template<typename Func1> | |
| static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero) |
| Public Attributes inherited from QQuickItem | |
| const QSize & | targetSize = QSize()) |
| qreal y | const |
| Protected Attributes inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Related Symbols inherited from QObject | |
| template< class T > T | qobject_cast (const QObject *object) |
| Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
| template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QObjectList | |
| \macro Q_CLASSINFO(Name, Value) | |
Definition at line 25 of file qquickimage_p.h.
| Enumerator | |
|---|---|
| Stretch | |
| PreserveAspectFit | |
| PreserveAspectCrop | |
| Tile | |
| TileVertically | |
| TileHorizontally | |
| Pad | |
Definition at line 54 of file qquickimage_p.h.
| Enumerator | |
|---|---|
| AlignLeft | |
| AlignRight | |
| AlignHCenter | |
Definition at line 45 of file qquickimage_p.h.
| Enumerator | |
|---|---|
| AlignTop | |
| AlignBottom | |
| AlignVCenter | |
Definition at line 49 of file qquickimage_p.h.
| QQuickImage::QQuickImage | ( | QQuickItem * | parent = nullptr | ) |
\qmltype Image \nativetype QQuickImage \inqmlmodule QtQuick\inherits Item
Displays an image.
The Image type displays an image.
The source of the image is specified as a URL using the \l source property. Images can be supplied in any of the standard image formats supported by Qt, including bitmap formats such as PNG and JPEG, and vector graphics formats such as SVG. If you need to display animated images, use \l AnimatedSprite or \l AnimatedImage.
If the \l{Item::width}{width} and \l{Item::height}{height} properties are not specified, the Image automatically uses the size of the loaded image. By default, specifying the width and height of the item causes the image to be scaled to that size. This behavior can be changed by setting the \l fillMode property, allowing the image to be stretched and tiled instead.
It is possible to provide \l {High Resolution Versions of Images}{"@nx" high DPI syntax}.
Definition at line 209 of file qquickimage.cpp.
| QQuickImage::~QQuickImage | ( | ) |
Definition at line 219 of file qquickimage.cpp.
|
protected |
Definition at line 214 of file qquickimage.cpp.
|
overridevirtual |
Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().
Reimplemented from QQuickItem.
Definition at line 672 of file qquickimage.cpp.
|
inlineoverridevirtual |
Reimplemented from QQuickImageBase.
Definition at line 77 of file qquickimage_p.h.
| QQuickImage::FillMode QQuickImage::fillMode | ( | ) | const |
\qmlproperty enumeration QtQuick::Image::fillMode
Set this property to define what happens when the source image has a different size than the item.
\value Image.Stretch the image is scaled to fit \value Image.PreserveAspectFit the image is scaled uniformly to fit without cropping \value Image.PreserveAspectCrop the image is scaled uniformly to fill, cropping if necessary \value Image.Tile the image is duplicated horizontally and vertically \value Image.TileVertically the image is stretched horizontally and tiled vertically \value Image.TileHorizontally the image is stretched vertically and tiled horizontally \value Image.Pad the image is not transformed \br
\table
\row
\row
\row
\row
\row
\row
\endtable
Note that clip is false by default which means that the item might paint outside its bounding rectangle even if the fillMode is set to PreserveAspectCrop.
Definition at line 339 of file qquickimage.cpp.
|
signal |
|
overrideprotectedvirtual |
This function is called to handle this item's changes in geometry from oldGeometry to newGeometry. If the two geometries are the same, it doesn't do anything.
Derived classes must call the base class method within their implementation.
Reimplemented from QQuickItem.
Definition at line 665 of file qquickimage.cpp.
| QQuickImage::HAlignment QQuickImage::horizontalAlignment | ( | ) | const |
Definition at line 905 of file qquickimage.cpp.
|
signal |
|
inlineoverridevirtual |
Returns true if this item is a texture provider.
The default implementation returns false.
This function can be called from any thread.
Reimplemented from QQuickItem.
Definition at line 71 of file qquickimage_p.h.
| bool QQuickImage::mipmap | ( | ) | const |
\qmlproperty bool QtQuick::Image::mipmap
This property holds whether the image uses mipmap filtering when scaled or transformed.
Mipmap filtering gives better visual quality when scaling down compared to smooth, but it may come at a performance cost (both when initializing the image and during rendering).
By default, this property is set to false.
Definition at line 939 of file qquickimage.cpp.
|
signal |
| qreal QQuickImage::paintedHeight | ( | ) | const |
Definition at line 382 of file qquickimage.cpp.
| qreal QQuickImage::paintedWidth | ( | ) | const |
\qmlproperty real QtQuick::Image::paintedWidth \qmlproperty real QtQuick::Image::paintedHeight \readonly
These properties hold the size of the image that is actually painted. In most cases it is the same as width and height, but when using an \l {fillMode}{Image.PreserveAspectFit} or an \l {fillMode}{Image.PreserveAspectCrop} paintedWidth or paintedHeight can be smaller or larger than width and height of the Image item.
Definition at line 376 of file qquickimage.cpp.
|
overrideprotectedvirtual |
Reimplemented from QQuickImageBase.
Reimplemented in QQuickNinePatchImage.
Definition at line 871 of file qquickimage.cpp.
|
signal |
|
signal |
|
overrideprotectedvirtual |
This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode().
This happens when the item is about to be removed from the window it was previously rendering to. The item is guaranteed to have a \l {QQuickItem::window()}{window} when the function is called.
The function is called on the GUI thread and the state of the rendering thread, when it is used, is unknown. Objects should not be deleted directly, but instead scheduled for cleanup using QQuickWindow::scheduleRenderJob().
Reimplemented from QQuickItem.
Definition at line 712 of file qquickimage.cpp.
Definition at line 345 of file qquickimage.cpp.
| void QQuickImage::setHorizontalAlignment | ( | HAlignment | align | ) |
Definition at line 911 of file qquickimage.cpp.
| void QQuickImage::setMipmap | ( | bool | use | ) |
Definition at line 945 of file qquickimage.cpp.
| void QQuickImage::setVerticalAlignment | ( | VAlignment | align | ) |
Definition at line 893 of file qquickimage.cpp.
|
overridevirtual |
Returns the texture provider for an item.
The default implementation returns \nullptr.
This function may only be called on the rendering thread.
Reimplemented from QQuickItem.
Definition at line 678 of file qquickimage.cpp.
|
protected |
\qmlproperty enumeration QtQuick::Image::status \readonly
This property holds the status of image loading. It can be one of:
\value Image.Null No image has been set \value Image.Ready The image has been loaded \value Image.Loading The image is currently being loaded \value Image.Error An error occurred while loading the image
Use this status to provide an update or respond to the status change in some way. For example, you could:
\list
onStatusChanged signal handler: \qml Image { id: image onStatusChanged: if (image.status == Image.Ready) console.log('Loaded') } \endqml\qmlproperty real QtQuick::Image::progress \readonly
This property holds the progress of image loading, from 0.0 (nothing loaded) to 1.0 (finished).
\qmlproperty bool QtQuick::Image::smooth
This property holds whether the image is smoothly filtered when scaled or transformed. Smooth filtering gives better visual quality, but it may be slower on some hardware. If the image is displayed at its natural size, this property has no visual or performance effect.
By default, this property is set to true.
\qmlproperty size QtQuick::Image::sourceSize
This property holds the scaled width and height of the full-frame image.
Unlike the \l {Item::}{width} and \l {Item::}{height} properties, which scale the painting of the image, this property sets the maximum number of pixels stored for the loaded image so that large images do not use more memory than necessary. For example, this ensures the image in memory is no larger than 1024x1024 pixels, regardless of the Image's \l {Item::}{width} and \l {Item::}{height} values:
If the image's actual size is larger than the sourceSize, the image is scaled down. If only one dimension of the size is set to greater than 0, the other dimension is set in proportion to preserve the source image's aspect ratio. (The \l fillMode is independent of this.)
If both the sourceSize.width and sourceSize.height are set, the image will be scaled down to fit within the specified size (unless PreserveAspectCrop or PreserveAspectFit are used, then it will be scaled to match the optimal size for cropping/fitting), maintaining the image's aspect ratio. The actual size of the image after scaling is available via \l Item::implicitWidth and \l Item::implicitHeight.
If the source is an intrinsically scalable image (eg. SVG), this property determines the size of the loaded image regardless of intrinsic size. Avoid changing this property dynamically; rendering an SVG is slow compared to an image.
If the source is a non-scalable image (eg. JPEG), the loaded image will be no greater than this property specifies. For some formats (currently only JPEG), the whole image will never actually be loaded into memory.
If the \l sourceClipRect property is also set, sourceSize determines the scale, but it will be clipped to the size of the clip rectangle.
sourceSize can be cleared to the natural size of the image by setting sourceSize to undefined.
\qmlproperty rect QtQuick::Image::sourceClipRect
This property, if set, holds the rectangular region of the source image to be loaded.
The sourceClipRect works together with the \l sourceSize property to conserve system resources when only a portion of an image needs to be loaded.
In the above example, we conceptually scale the SVG graphic to 1024x1024 first, and then cut out a region of interest that is 512x512 pixels from a location 100 pixels from the top and left edges. Thus sourceSize determines the scale, but the actual output image is 512x512 pixels.
Some image formats are able to conserve CPU time by rendering only the specified region. Others will need to load the entire image first and then clip it to the specified region.
This property can be cleared to reload the entire image by setting sourceClipRect to undefined.
\qmlproperty url QtQuick::Image::source
Image can handle any image format supported by Qt, loaded from any URL scheme supported by Qt.
The URL may be absolute, or relative to the URL of the component.
\qmlproperty bool QtQuick::Image::asynchronous
Specifies that images on the local filesystem should be loaded asynchronously in a separate thread. The default value is false, causing the user interface thread to block while the image is loaded. Setting asynchronous to true is useful where maintaining a responsive user interface is more desirable than having images immediately visible.
Note that this property is only valid for images read from the local filesystem. Images loaded via a network resource (e.g. HTTP) are always loaded asynchronously.
\qmlproperty bool QtQuick::Image::cache
Specifies whether the image should be cached. The default value is true. Setting cache to false is useful when dealing with large images, to make sure that they aren't cached at the expense of small 'ui element' images.
\qmlproperty bool QtQuick::Image::mirror
This property holds whether the image should be horizontally inverted (effectively displaying a mirrored image).
The default value is false.
\qmlproperty bool QtQuick::Image::mirrorVertically
This property holds whether the image should be vertically inverted (effectively displaying a mirrored image).
The default value is false.
\qmlproperty enumeration QtQuick::Image::horizontalAlignment \qmlproperty enumeration QtQuick::Image::verticalAlignment
Sets the horizontal and vertical alignment of the image. By default, the image is center aligned.
The valid values for horizontalAlignment are Image.AlignLeft, Image.AlignRight and Image.AlignHCenter. The valid values for verticalAlignment are Image.AlignTop, Image.AlignBottom and Image.AlignVCenter.
Definition at line 614 of file qquickimage.cpp.
|
overrideprotectedvirtual |
Called on the render thread when it is time to sync the state of the item with the scene graph.
The function is called as a result of QQuickItem::update(), if the user has set the QQuickItem::ItemHasContents flag on the item.
The function should return the root of the scene graph subtree for this item. Most implementations will return a single QSGGeometryNode containing the visual representation of this item. oldNode is the node that was returned the last time the function was called. updatePaintNodeData provides a pointer to the QSGTransformNode associated with this QQuickItem.
The main thread is blocked while this function is executed so it is safe to read values from the QQuickItem instance and other objects in the main thread.
If no call to QQuickItem::updatePaintNode() result in actual scene graph changes, like QSGNode::markDirty() or adding and removing nodes, then the underlying implementation may decide to not render the scene again as the visual outcome is identical.
Reimplemented from QQuickItem.
Reimplemented in QQuickNinePatchImage.
Definition at line 721 of file qquickimage.cpp.
| QQuickImage::VAlignment QQuickImage::verticalAlignment | ( | ) | const |
Definition at line 887 of file qquickimage.cpp.
|
signal |
|
readwrite |
Definition at line 36 of file qquickimage_p.h.
|
readwrite |
Definition at line 29 of file qquickimage_p.h.
|
readwrite |
Definition at line 32 of file qquickimage_p.h.
|
readwrite |
Definition at line 35 of file qquickimage_p.h.
|
read |
Definition at line 31 of file qquickimage_p.h.
|
read |
Definition at line 30 of file qquickimage_p.h.
|
readwrite |
Definition at line 37 of file qquickimage_p.h.
|
readwrite |
Definition at line 34 of file qquickimage_p.h.
|
readwrite |
Definition at line 33 of file qquickimage_p.h.
1.14.0