#include <qquickpixmapcache_p.h>

Inheritance diagram for QQuickImageProviderWithOptions:

Collaboration diagram for QQuickImageProviderWithOptions:

Public Member Functions
	QQuickImageProviderWithOptions (ImageType type, Flags flags=Flags())

QImage	requestImage (const QString &id, QSize *size, const QSize &requestedSize) override
	Implement this method to return the image with id.

QPixmap	requestPixmap (const QString &id, QSize *size, const QSize &requestedSize) override
	Implement this method to return the pixmap with id.

QQuickTextureFactory *	requestTexture (const QString &id, QSize *size, const QSize &requestedSize) override
	Implement this method to return the texture with id.

QQuickImageResponse *	requestImageResponse (const QString &id, const QSize &requestedSize) override
	Implement this method to return the job that will provide the texture with id.

virtual QImage	requestImage (const QString &id, QSize *size, const QSize &requestedSize, const QQuickImageProviderOptions &options)

virtual QPixmap	requestPixmap (const QString &id, QSize *size, const QSize &requestedSize, const QQuickImageProviderOptions &options)

virtual QQuickTextureFactory *	requestTexture (const QString &id, QSize *size, const QSize &requestedSize, const QQuickImageProviderOptions &options)

virtual QQuickImageResponse *	requestImageResponse (const QString &id, const QSize &requestedSize, const QQuickImageProviderOptions &options)

Public Member Functions inherited from QQuickAsyncImageProvider
	QQuickAsyncImageProvider ()

	~QQuickAsyncImageProvider () override

virtual QQuickImageResponse *	requestImageResponse (const QString &id, const QSize &requestedSize)=0
	Implement this method to return the job that will provide the texture with id.

Public Member Functions inherited from QQuickImageProvider
	QQuickImageProvider (ImageType type, Flags flags=Flags())
	Creates an image provider that will provide images of the given type and behave according to the given flags.

	~QQuickImageProvider () override
	Destroys the QQuickImageProvider.

ImageType	imageType () const override
	Returns the image type supported by this provider.

Flags	flags () const override
	Returns the flags set for this provider.

virtual QImage	requestImage (const QString &id, QSize *size, const QSize &requestedSize)
	Implement this method to return the image with id.

virtual QPixmap	requestPixmap (const QString &id, QSize *size, const QSize &requestedSize)
	Implement this method to return the pixmap with id.

virtual QQuickTextureFactory *	requestTexture (const QString &id, QSize *size, const QSize &requestedSize)
	Implement this method to return the texture with id.

Public Member Functions inherited from QQmlImageProviderBase
virtual	~QQmlImageProviderBase ()

virtual ImageType	imageType () const =0
	Implement this method to return the image type supported by this image provider.

virtual Flags	flags () const =0
	Implement this to return the properties of this image provider.

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	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

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.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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`.

Static Public Member Functions
static QSize	loadSize (const QSize &originalSize, const QSize &requestedSize, const QByteArray &format, const QQuickImageProviderOptions &options, qreal devicePixelRatio=1.0)
	Returns the recommended scaled image size for loading and storage.

static QQuickImageProviderWithOptions *	checkedCast (QQuickImageProvider *provider)

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)

Additional Inherited Members
Public Types inherited from QQmlImageProviderBase
enum	ImageType : int { Invalid = 0 , Image , Pixmap , Texture , ImageResponse }
	Defines the type of image supported by this image provider. More...

enum	Flag { ForceAsynchronousImageLoading = 0x01 }
	Defines specific requirements or features of this image provider. More...

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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.

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)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

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 170 of file qquickpixmapcache_p.h.

Constructor & Destructor Documentation

◆ QQuickImageProviderWithOptions()

QQuickImageProviderWithOptions::QQuickImageProviderWithOptions	(	ImageType	type,
		Flags	flags = `Flags()`
	)

Definition at line 585 of file qquickimageprovider.cpp.

References QQuickImageProvider::flags(), QQuickImageProviderPrivate::flags, QQuickImageProviderPrivate::isProviderWithOptions, and QQuickImageProviderPrivate::type.

Here is the call graph for this function:

Member Function Documentation

◆ checkedCast()

QQuickImageProviderWithOptions * QQuickImageProviderWithOptions::checkedCast ( QQuickImageProvider * provider )

static

Definition at line 689 of file qquickimageprovider.cpp.

References QQuickImageProviderPrivate::isProviderWithOptions.

Referenced by createPixmapDataSync().

Here is the caller graph for this function:

◆ loadSize()

QSize QQuickImageProviderWithOptions::loadSize	(	const QSize &	originalSize,
		const QSize &	requestedSize,
		const QByteArray &	format,
		const QQuickImageProviderOptions &	options,
		qreal	devicePixelRatio = `1.0`
	)

static

Returns the recommended scaled image size for loading and storage.

This is calculated according to the native pixel size of the image originalSize, the requested sourceSize requestedSize, the image file format format, and options. If the calculation otherwise concludes that scaled loading is not recommended, an invalid size is returned.

Definition at line 648 of file qquickimageprovider.cpp.

References QSize::height(), QSize::isEmpty(), QQuickImageProviderOptions::preserveAspectRatioCrop(), QQuickImageProviderOptions::preserveAspectRatioFit(), qRound(), and QSize::width().

Referenced by QuickSharedImageLoader::loadFile(), and readImage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requestImage() [1/2]

QImage QQuickImageProviderWithOptions::requestImage	(	const QString &	id,
		QSize *	size,
		const QSize &	requestedSize
	)

overridevirtual

Implement this method to return the image with id.

The default implementation returns an empty image.

The id is the requested image source, with the "image:" scheme and provider identifier removed. For example, if the image \l{Image::}{source} was "image://myprovider/icons/home", the given id would be "icons/home".

The requestedSize corresponds to the \l {Image::sourceSize} requested by an Image item. If requestedSize is a valid size, the image returned should be of that size.

In all cases, size must be set to the original size of the image. This is used to set the \l {Item::}{width} and \l {Item::}{height} of the relevant \l Image if these values have not been set explicitly.

Note: this method may be called by multiple threads, so ensure the implementation of this method is reentrant.

Reimplemented from QQuickImageProvider.

Definition at line 593 of file qquickimageprovider.cpp.

References requestImage().

Referenced by requestImage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requestImage() [2/2]

QImage QQuickImageProviderWithOptions::requestImage	(	const QString &	id,
		QSize *	size,
		const QSize &	requestedSize,
		const QQuickImageProviderOptions &	options
	)

virtual

Reimplemented in SharedImageProvider.

Definition at line 608 of file qquickimageprovider.cpp.

References Q_UNUSED, and QQuickImageProvider::requestImage().

Here is the call graph for this function:

◆ requestImageResponse() [1/2]

QQuickImageResponse * QQuickImageProviderWithOptions::requestImageResponse	(	const QString &	id,
		const QSize &	requestedSize
	)

overridevirtual

Implement this method to return the job that will provide the texture with id.

The id is the requested image source, with the "image:" scheme and provider identifier removed. For example, if the image \l{Image::}{source} was "image://myprovider/icons/home", the given id would be "icons/home".

The requestedSize corresponds to the \l {Image::sourceSize} requested by an Image item. If requestedSize is a valid size, the image returned should be of that size.

Note: this method may be called by multiple threads, so ensure the implementation of this method is reentrant.

Implements QQuickAsyncImageProvider.

Definition at line 626 of file qquickimageprovider.cpp.

References QQmlImageProviderBase::ImageResponse, QQuickImageProvider::imageType(), Q_UNUSED, and qWarning.

Referenced by requestImageResponse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requestImageResponse() [2/2]

QQuickImageResponse * QQuickImageProviderWithOptions::requestImageResponse	(	const QString &	id,
		const QSize &	requestedSize,
		const QQuickImageProviderOptions &	options
	)

virtual

Definition at line 635 of file qquickimageprovider.cpp.

References Q_UNUSED, and requestImageResponse().

Here is the call graph for this function:

◆ requestPixmap() [1/2]

QPixmap QQuickImageProviderWithOptions::requestPixmap	(	const QString &	id,
		QSize *	size,
		const QSize &	requestedSize
	)

overridevirtual

Implement this method to return the pixmap with id.

The default implementation returns an empty pixmap.

The id is the requested image source, with the "image:" scheme and provider identifier removed. For example, if the image \l{Image::}{source} was "image://myprovider/icons/home", the given id would be "icons/home".

The requestedSize corresponds to the \l {Image::sourceSize} requested by an Image item. If requestedSize is a valid size, the image returned should be of that size.

In all cases, size must be set to the original size of the image. This is used to set the \l {Item::}{width} and \l {Item::}{height} of the relevant \l Image if these values have not been set explicitly.

Note: this method may be called by multiple threads, so ensure the implementation of this method is reentrant.

Reimplemented from QQuickImageProvider.

Definition at line 598 of file qquickimageprovider.cpp.

References requestPixmap().

Referenced by requestPixmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requestPixmap() [2/2]

QPixmap QQuickImageProviderWithOptions::requestPixmap	(	const QString &	id,
		QSize *	size,
		const QSize &	requestedSize,
		const QQuickImageProviderOptions &	options
	)

virtual

Definition at line 614 of file qquickimageprovider.cpp.

References Q_UNUSED, and QQuickImageProvider::requestPixmap().

Here is the call graph for this function:

◆ requestTexture() [1/2]

QQuickTextureFactory * QQuickImageProviderWithOptions::requestTexture	(	const QString &	id,
		QSize *	size,
		const QSize &	requestedSize
	)

overridevirtual

Implement this method to return the texture with id.

The default implementation returns \nullptr.

The id is the requested image source, with the "image:" scheme and provider identifier removed. For example, if the image \l{Image::}{source} was "image://myprovider/icons/home", the given id would be "icons/home".

The requestedSize corresponds to the \l {Image::sourceSize} requested by an Image item. If requestedSize is a valid size, the image returned should be of that size.

In all cases, size must be set to the original size of the image. This is used to set the \l {Item::}{width} and \l {Item::}{height} of the relevant \l Image if these values have not been set explicitly.

Note: this method may be called by multiple threads, so ensure the implementation of this method is reentrant.

Reimplemented from QQuickImageProvider.

Definition at line 603 of file qquickimageprovider.cpp.

References requestTexture().

Referenced by requestTexture().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requestTexture() [2/2]

QQuickTextureFactory * QQuickImageProviderWithOptions::requestTexture	(	const QString &	id,
		QSize *	size,
		const QSize &	requestedSize,
		const QQuickImageProviderOptions &	options
	)

virtual

Definition at line 620 of file qquickimageprovider.cpp.

References Q_UNUSED, and QQuickImageProvider::requestTexture().

Here is the call graph for this function:

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

qtdeclarative/src/quick/util/qquickpixmapcache_p.h
qtdeclarative/src/quick/util/qquickimageprovider.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickImageProviderWithOptions()

Member Function Documentation

◆ checkedCast()

◆ loadSize()

◆ requestImage() [1/2]

◆ requestImage() [2/2]

◆ requestImageResponse() [1/2]

◆ requestImageResponse() [2/2]

◆ requestPixmap() [1/2]

◆ requestPixmap() [2/2]

◆ requestTexture() [1/2]

◆ requestTexture() [2/2]