#include <qquickborderimage_p.h>

Inheritance diagram for QQuickBorderImage:

Collaboration diagram for QQuickBorderImage:

Public Types
enum	TileMode { Stretch = Qt::StretchTile , Repeat = Qt::RepeatTile , Round = Qt::RoundTile }

Public Types inherited from QQuickImageBase
enum	LoadPixmapOption { NoOption = 0x0000 , HandleDPR = 0x0001 , UseProviderOptions = 0x0002 }

enum	Status { Null , Ready , Loading , Error }

Public Types inherited from QQuickItem
enum	Flag { ItemClipsChildrenToShape = 0x01 , ItemIsFocusScope = 0x04 , ItemHasContents = 0x08 , ItemAcceptsDrops = 0x10 , ItemIsViewport = 0x20 , ItemObservesViewport = 0x40 }
	\qmltype Item \instantiates QQuickItem \inherits QtObject \inqmlmodule QtQuick More...

enum	ItemChange { ItemChildAddedChange , ItemChildRemovedChange , ItemSceneChange , ItemVisibleHasChanged , ItemParentHasChanged , ItemOpacityHasChanged , ItemActiveFocusHasChanged , ItemRotationHasChanged , ItemAntialiasingHasChanged , ItemDevicePixelRatioHasChanged , ItemEnabledHasChanged }
	Used in conjunction with QQuickItem::itemChange() to notify the item about certain types of changes. More...

enum	TransformOrigin { TopLeft , Top , TopRight , Left , Center , Right , BottomLeft , Bottom , BottomRight }
	\variable QQuickItem::ItemChangeData::realValue The numeric value that has changed: \l {QQuickItem::opacity()}{opacity}, \l {QQuickItem::rotation()}{rotation}, or \l {QScreen::devicePixelRatio}{device pixel ratio}. More...

Signals
void	horizontalTileModeChanged ()

void	verticalTileModeChanged ()

void	sourceSizeChanged ()

Signals inherited from QQuickImageBase
void	sourceChanged (const QUrl &)

void	sourceSizeChanged ()

void	statusChanged (QQuickImageBase::Status)

void	progressChanged (qreal progress)

void	asynchronousChanged ()

void	cacheChanged ()

void	mirrorChanged ()

	Q_REVISION (2, 14) void currentFrameChanged()

	Q_REVISION (2, 14) void frameCountChanged()

	Q_REVISION (2, 15) void sourceClipRectChanged()

	Q_REVISION (2, 15) void colorSpaceChanged()

	Q_REVISION (6, 2) void mirrorVerticallyChanged()

Signals inherited from QQuickItem
void	childrenRectChanged (const QRectF &)

void	baselineOffsetChanged (qreal)

void	stateChanged (const QString &)

void	focusChanged (bool)

void	activeFocusChanged (bool)

Q_REVISION(6, 7) void focusPolicyChanged(Qt	Q_REVISION (2, 1) void activeFocusOnTabChanged(bool)

void	parentChanged (QQuickItem *)

void	transformOriginChanged (TransformOrigin)

void	smoothChanged (bool)

void	antialiasingChanged (bool)

void	clipChanged (bool)

	Q_REVISION (2, 1) void windowChanged(QQuickWindow *window)

void	childrenChanged ()

void	opacityChanged ()

void	enabledChanged ()

void	visibleChanged ()

void	visibleChildrenChanged ()

void	rotationChanged ()

void	scaleChanged ()

void	xChanged ()

void	yChanged ()

void	widthChanged ()

void	heightChanged ()

void	zChanged ()

void	implicitWidthChanged ()

void	implicitHeightChanged ()

	Q_REVISION (2, 11) void containmentMaskChanged()

	Q_REVISION (6, 0) void paletteChanged()

	Q_REVISION (6, 0) void paletteCreated()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickBorderImage (QQuickItem *parent=nullptr)
	\qmltype BorderImage \instantiates QQuickBorderImage \inqmlmodule QtQuick

	~QQuickBorderImage ()

QQuickScaleGrid *	border ()

TileMode	horizontalTileMode () const
	\qmlproperty enumeration QtQuick::BorderImage::horizontalTileMode \qmlproperty enumeration QtQuick::BorderImage::verticalTileMode

void	setHorizontalTileMode (TileMode)

TileMode	verticalTileMode () const

void	setVerticalTileMode (TileMode)

void	setSource (const QUrl &url) override
	\qmlproperty enumeration QtQuick::BorderImage::status

Public Member Functions inherited from QQuickImageBase
	QQuickImageBase (QQuickItem *parent=nullptr)

	~QQuickImageBase ()

Status	status () const

qreal	progress () const

QUrl	source () const

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)

virtual void	emitAutoTransformBaseChanged ()

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 the specified sibling item to the index before this item within the list of children.

void	stackAfter (const QQuickItem *)
	Moves the specified sibling item to the index after this 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	boundingRect () const
	Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().

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 {0, 0} to \l width() and \l height().

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 QtQuick::Item::childAt(real x, real y)

	Q_REVISION (6, 3) Q_INVOKABLE void ensurePolished()

	Q_REVISION (6, 3) Q_INVOKABLE void dumpItemTree() const

virtual bool	isTextureProvider () const
	Returns true if this item is a texture provider.

virtual QSGTextureProvider *	textureProvider () const
	Returns the texture provider for an item.

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	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
void	load () override

void	pixmapChange () 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)

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.

virtual void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry)

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 void	releaseResources ()
	This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode().

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
QQuickScaleGrid *	border

TileMode	horizontalTileMode

TileMode	verticalTileMode

QSize	sourceSize

Properties inherited from QQuickImageBase
Status	status

QUrl	source

qreal	progress

bool	asynchronous

bool	cache

bool	mirror

bool	mirrorVertically

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 This property holds the list of transformations to apply.

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

Private Slots
void	requestFinished () override

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)

Detailed Description

Definition at line 25 of file qquickborderimage_p.h.

Member Enumeration Documentation

◆ TileMode

enum QQuickBorderImage::TileMode

Enumerator
Stretch
Repeat
Round

Definition at line 43 of file qquickborderimage_p.h.

Constructor & Destructor Documentation

◆ QQuickBorderImage()

QT_BEGIN_NAMESPACE QQuickBorderImage::QQuickBorderImage ( QQuickItem * parent = nullptr )

\qmltype BorderImage \instantiates QQuickBorderImage \inqmlmodule QtQuick

Paints a border based on an image. \inherits Item

The BorderImage type is used to create borders out of images by scaling or tiling parts of each image.

A BorderImage breaks a source image, specified using the \l source property, into 9 regions, as shown below:

When the image is scaled, regions of the source image are scaled or tiled to create the displayed border image in the following way:

\list

The corners (regions 1, 3, 7, and 9) are not scaled at all.
Regions 2 and 8 are scaled according to \l{BorderImage::horizontalTileMode}{horizontalTileMode}.
Regions 4 and 6 are scaled according to \l{BorderImage::verticalTileMode}{verticalTileMode}.
The middle (region 5) is scaled according to both \l{BorderImage::horizontalTileMode}{horizontalTileMode} and \l{BorderImage::verticalTileMode}{verticalTileMode}. \endlist

The regions of the image are defined using the \l border property group, which describes the distance from each edge of the source image to use as a border.

Definition at line 142 of file qquickborderimage.cpp.

References connect(), sourceSizeChanged(), and QQuickImageBase::sourceSizeChanged().

Here is the call graph for this function:

◆ ~QQuickBorderImage()

QQuickBorderImage::~QQuickBorderImage ( )

Definition at line 148 of file qquickborderimage.cpp.

References d.

Member Function Documentation

◆ border()

QQuickScaleGrid * QQuickBorderImage::border ( )

◆ horizontalTileMode()

QQuickBorderImage::TileMode QQuickBorderImage::horizontalTileMode ( ) const

\qmlproperty enumeration QtQuick::BorderImage::horizontalTileMode \qmlproperty enumeration QtQuick::BorderImage::verticalTileMode

This property describes how to repeat or stretch the middle parts of the border image.

\value BorderImage.Stretch Scales the image to fit to the available area. \value BorderImage.Repeat Tile the image until there is no more space. May crop the last image. \value BorderImage.Round Like Repeat, but scales the images down to ensure that the last image is not cropped.

The default tile mode for each property is BorderImage.Stretch.

Definition at line 348 of file qquickborderimage.cpp.

References d.

◆ horizontalTileModeChanged

void QQuickBorderImage::horizontalTileModeChanged ( )

signal

Referenced by setHorizontalTileMode().

Here is the caller graph for this function:

◆ load()

void QQuickBorderImage::load ( )

overrideprotectedvirtual

Reimplemented from QQuickImageBase.

Definition at line 266 of file qquickborderimage.cpp.

References context, d, QQuickImageBase::Error, file, QQuickImageBase::HandleDPR, QString::isEmpty(), QQuickImageBase::loadEmptyUrl(), QQuickImageBase::Loading, QQuickImageBase::loadPixmap(), QFile::open(), qmlContext(), qmlEngine(), qmlobject_connect, QIODeviceBase::ReadOnly, SIGNAL, SLOT, QQmlFile::urlToLocalFileOrQrc(), and QQuickImageBase::UseProviderOptions.

Referenced by setSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pixmapChange()

void QQuickBorderImage::pixmapChange ( )

overrideprotectedvirtual

Reimplemented from QQuickImageBase.

Definition at line 561 of file qquickborderimage.cpp.

References d, and QQuickItem::update().

Referenced by requestFinished().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHorizontalTileMode()

void QQuickBorderImage::setHorizontalTileMode ( TileMode t )

Definition at line 354 of file qquickborderimage.cpp.

References d, emit, horizontalTileModeChanged(), and QQuickItem::update().

Here is the call graph for this function:

◆ setSource()

void QQuickBorderImage::setSource ( const QUrl & url )

overridevirtual

\qmlproperty enumeration QtQuick::BorderImage::status

This property describes the status of image loading. It can be one of:

\value BorderImage.Null No image has been set \value BorderImage.Ready The image has been loaded \value BorderImage.Loading The image is currently being loaded \value BorderImage.Error An error occurred while loading the image

See also: progress

\qmlproperty real QtQuick::BorderImage::progress

This property holds the progress of image loading, from 0.0 (nothing loaded) to 1.0 (finished).

See also: status

\qmlproperty bool QtQuick::BorderImage::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 bool QtQuick::BorderImage::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::BorderImage::mirror

This property holds whether the image should be horizontally inverted (effectively displaying a mirrored image).

The default value is false.

\qmlproperty url QtQuick::BorderImage::source

This property holds the URL that refers to the source image.

BorderImage can handle any image format supported by Qt, loaded from any URL scheme supported by Qt.

This property can also be used to refer to .sci files, which are written in a QML-specific, text-based format that specifies the borders, the image file and the tile rules for a given border image.

The following .sci file sets the borders to 10 on each side for the image picture.png:

border.left: 10
border.top: 10
border.bottom: 10
border.right: 10
source: "picture.png"

The URL may be absolute, or relative to the URL of the component.

See also: QQuickImageProvider

\qmlproperty QSize QtQuick::BorderImage::sourceSize

This property holds the actual width and height of the loaded image.

In BorderImage, this property is read-only.

See also: Image::sourceSize

Reimplemented from QQuickImageBase.

Definition at line 244 of file qquickborderimage.cpp.

References d, emit, QQuickItem::isComponentComplete(), load(), QQuickImageBase::sourceChanged(), url, and QUrl::url().

Here is the call graph for this function:

◆ setVerticalTileMode()

void QQuickBorderImage::setVerticalTileMode ( TileMode t )

Definition at line 370 of file qquickborderimage.cpp.

References d, emit, QQuickItem::update(), and verticalTileModeChanged().

Here is the call graph for this function:

◆ sourceSizeChanged

void QQuickBorderImage::sourceSizeChanged ( )

signal

Referenced by QQuickBorderImage(), and requestFinished().

Here is the caller graph for this function:

◆ updatePaintNode()

QSGNode * QQuickBorderImage::updatePaintNode	(	QSGNode *	oldNode,
		UpdatePaintNodeData *	updatePaintNodeData )

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.

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;
}

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.

Warning: It is crucial that graphics operations and interaction with the scene graph happens exclusively on the render thread, primarily during the QQuickItem::updatePaintNode() call. The best rule of thumb is to only use classes with the "QSG" prefix inside the QQuickItem::updatePaintNode() function.; This function is called on the render thread. This means any QObjects or thread local storage that is created will have affinity to the render thread, so apply caution when doing anything other than rendering in this function. Similarly for signals, these will be emitted on the render thread and will thus often be delivered via queued connections.

Note: All classes with QSG prefix should be used solely on the scene graph's rendering thread. See \l {Scene Graph and Rendering} for more information.

See also: QSGMaterial, QSGGeometryNode, QSGGeometry, QSGFlatColorMaterial, QSGTextureMaterial, QSGNode::markDirty(), {Graphics Resource Handling}

Reimplemented from QQuickItem.

Definition at line 506 of file qquickborderimage.cpp.

Here is the call graph for this function:

◆ verticalTileMode()

QQuickBorderImage::TileMode QQuickBorderImage::verticalTileMode ( ) const

Definition at line 364 of file qquickborderimage.cpp.

References d.

◆ verticalTileModeChanged

void QQuickBorderImage::verticalTileModeChanged ( )

signal

Referenced by setVerticalTileMode().

Here is the caller graph for this function:

Property Documentation

◆ border

QQuickScaleGrid * QQuickBorderImage::border

read

\qmlpropertygroup QtQuick::BorderImage::border
\qmlproperty int QtQuick::BorderImage::border.left
\qmlproperty int QtQuick::BorderImage::border.right
\qmlproperty int QtQuick::BorderImage::border.top
\qmlproperty int QtQuick::BorderImage::border.bottom

The 4 border lines (2 horizontal and 2 vertical) break the image into 9 sections,
as shown below:

\image declarative-scalegrid.png

Each border line (left, right, top, and bottom) specifies an offset in pixels
from the respective edge of the source image. By default, each border line has
a value of 0.

For example, the following definition sets the bottom line 10 pixels up from
the bottom of the image:

\qml
BorderImage {
    border.bottom: 10

... } \endqml

The border lines can also be specified using a \l {BorderImage::source}{.sci file}.

Definition at line 29 of file qquickborderimage_p.h.

◆ horizontalTileMode

TileMode QQuickBorderImage::horizontalTileMode

readwrite

Definition at line 30 of file qquickborderimage_p.h.

◆ sourceSize

QSize QQuickBorderImage::sourceSize

read

Definition at line 33 of file qquickborderimage_p.h.

Referenced by requestFinished().

◆ verticalTileMode

TileMode QQuickBorderImage::verticalTileMode

readwrite

Definition at line 31 of file qquickborderimage_p.h.

The documentation for this class was generated from the following files:

qtdeclarative/src/quick/items/qquickborderimage_p.h (bd131dcbf579f822ac8cee98324dc1355f7cd314)
qtdeclarative/src/quick/items/qquickborderimage.cpp (15592b8bfef50ac5f4ce8ece5432475bb39fc463)

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Private Slots

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TileMode

Constructor & Destructor Documentation

◆ QQuickBorderImage()

◆ ~QQuickBorderImage()

Member Function Documentation

◆ border()

◆ horizontalTileMode()

◆ horizontalTileModeChanged

◆ load()

◆ pixmapChange()

◆ setHorizontalTileMode()

◆ setSource()

◆ setVerticalTileMode()

◆ sourceSizeChanged

◆ updatePaintNode()

◆ verticalTileMode()

◆ verticalTileModeChanged

Property Documentation

◆ border

◆ horizontalTileMode

◆ sourceSize

◆ verticalTileMode