Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuickImageProviderOptions Class Reference

The QQuickImageProviderOptions class provides options for QQuickImageProviderWithOptions image requests. More...

#include <qquickpixmap_p.h>

+ Collaboration diagram for QQuickImageProviderOptions:

Public Types

enum  AutoTransform { UsePluginDefaultTransform = -1 , ApplyTransform = 0 , DoNotApplyTransform = 1 }
 Whether the image provider should apply transformation metadata on read(). More...
 

Public Member Functions

 QQuickImageProviderOptions ()
 
 ~QQuickImageProviderOptions ()
 
 QQuickImageProviderOptions (const QQuickImageProviderOptions &)
 
QQuickImageProviderOptionsoperator= (const QQuickImageProviderOptions &)
 
bool operator== (const QQuickImageProviderOptions &) const
 
AutoTransform autoTransform () const
 Returns whether the image provider should apply transformation metadata on read().
 
void setAutoTransform (AutoTransform autoTransform)
 
bool preserveAspectRatioCrop () const
 Returns whether the image request is for a PreserveAspectCrop Image.
 
void setPreserveAspectRatioCrop (bool preserveAspectRatioCrop)
 
bool preserveAspectRatioFit () const
 Returns whether the image request is for a PreserveAspectFit Image.
 
void setPreserveAspectRatioFit (bool preserveAspectRatioFit)
 
QColorSpace targetColorSpace () const
 Returns the color space the image provider should return the image in.
 
void setTargetColorSpace (const QColorSpace &colorSpace)
 
QRectF sourceClipRect () const
 Returns the requested source clip rect.
 
void setSourceClipRect (const QRectF &rect)
 

Detailed Description

The QQuickImageProviderOptions class provides options for QQuickImageProviderWithOptions image requests.

\inmodule QtQuick

See also
QQuickImageProviderWithOptions

Definition at line 57 of file qquickpixmap_p.h.

Member Enumeration Documentation

◆ AutoTransform

Whether the image provider should apply transformation metadata on read().

\value UsePluginDefaultTransform Image provider should do its default behavior on whether applying transformation metadata on read or not \value ApplyTransform Image provider should apply transformation metadata on read \value DoNotApplyTransform Image provider should not apply transformation metadata on read

Enumerator
UsePluginDefaultTransform 
ApplyTransform 
DoNotApplyTransform 

Definition at line 60 of file qquickpixmap_p.h.

Constructor & Destructor Documentation

◆ QQuickImageProviderOptions() [1/2]

QQuickImageProviderOptions::QQuickImageProviderOptions ( )

Definition at line 504 of file qquickimageprovider.cpp.

◆ ~QQuickImageProviderOptions()

QQuickImageProviderOptions::~QQuickImageProviderOptions ( )

Definition at line 509 of file qquickimageprovider.cpp.

◆ QQuickImageProviderOptions() [2/2]

QQuickImageProviderOptions::QQuickImageProviderOptions ( const QQuickImageProviderOptions & other)

Definition at line 513 of file qquickimageprovider.cpp.

Member Function Documentation

◆ autoTransform()

QQuickImageProviderOptions::AutoTransform QQuickImageProviderOptions::autoTransform ( ) const

Returns whether the image provider should apply transformation metadata on read().

Definition at line 535 of file qquickimageprovider.cpp.

References QQuickImageProviderOptionsPrivate::autoTransform.

Referenced by createPixmapDataSync(), readImage(), and setAutoTransform().

+ Here is the caller graph for this function:

◆ operator=()

QQuickImageProviderOptions & QQuickImageProviderOptions::operator= ( const QQuickImageProviderOptions & other)

Definition at line 518 of file qquickimageprovider.cpp.

References other().

+ Here is the call graph for this function:

◆ operator==()

bool QQuickImageProviderOptions::operator== ( const QQuickImageProviderOptions & other) const

Definition at line 524 of file qquickimageprovider.cpp.

References QQuickImageProviderOptionsPrivate::autoTransform, other(), QQuickImageProviderOptionsPrivate::preserveAspectRatioCrop, QQuickImageProviderOptionsPrivate::preserveAspectRatioFit, and QQuickImageProviderOptionsPrivate::targetColorSpace.

+ Here is the call graph for this function:

◆ preserveAspectRatioCrop()

bool QQuickImageProviderOptions::preserveAspectRatioCrop ( ) const

Returns whether the image request is for a PreserveAspectCrop Image.

This allows the provider to better optimize the size of the returned image.

Definition at line 549 of file qquickimageprovider.cpp.

References QQuickImageProviderOptionsPrivate::preserveAspectRatioCrop.

Referenced by QuickSharedImageLoader::key(), QQuickImageProviderWithOptions::loadSize(), and setPreserveAspectRatioCrop().

+ Here is the caller graph for this function:

◆ preserveAspectRatioFit()

bool QQuickImageProviderOptions::preserveAspectRatioFit ( ) const

Returns whether the image request is for a PreserveAspectFit Image.

This allows the provider to better optimize the size of the returned image.

Definition at line 563 of file qquickimageprovider.cpp.

References QQuickImageProviderOptionsPrivate::preserveAspectRatioFit.

Referenced by QuickSharedImageLoader::key(), QQuickImageProviderWithOptions::loadSize(), and setPreserveAspectRatioFit().

+ Here is the caller graph for this function:

◆ setAutoTransform()

void QQuickImageProviderOptions::setAutoTransform ( QQuickImageProviderOptions::AutoTransform autoTransform)

Definition at line 540 of file qquickimageprovider.cpp.

References QQuickImageProviderOptionsPrivate::autoTransform, and autoTransform().

+ Here is the call graph for this function:

◆ setPreserveAspectRatioCrop()

void QQuickImageProviderOptions::setPreserveAspectRatioCrop ( bool preserveAspectRatioCrop)

Definition at line 554 of file qquickimageprovider.cpp.

References QQuickImageProviderOptionsPrivate::preserveAspectRatioCrop, and preserveAspectRatioCrop().

+ Here is the call graph for this function:

◆ setPreserveAspectRatioFit()

void QQuickImageProviderOptions::setPreserveAspectRatioFit ( bool preserveAspectRatioFit)

Definition at line 568 of file qquickimageprovider.cpp.

References QQuickImageProviderOptionsPrivate::preserveAspectRatioFit, and preserveAspectRatioFit().

+ Here is the call graph for this function:

◆ setSourceClipRect()

void QQuickImageProviderOptions::setSourceClipRect ( const QRectF & rect)

◆ setTargetColorSpace()

void QQuickImageProviderOptions::setTargetColorSpace ( const QColorSpace & colorSpace)

◆ sourceClipRect()

QRectF QQuickImageProviderOptions::sourceClipRect ( ) const

Returns the requested source clip rect.

Definition at line 589 of file qquickimageprovider.cpp.

References QQuickImageProviderOptionsPrivate::sourceClipRect.

◆ targetColorSpace()

QColorSpace QQuickImageProviderOptions::targetColorSpace ( ) const

Returns the color space the image provider should return the image in.

Definition at line 576 of file qquickimageprovider.cpp.

References QQuickImageProviderOptionsPrivate::targetColorSpace.

Referenced by readImage().

+ Here is the caller graph for this function:

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