Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
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 506 of file qquickimageprovider.cpp.

◆ ~QQuickImageProviderOptions()

QQuickImageProviderOptions::~QQuickImageProviderOptions ( )

Definition at line 511 of file qquickimageprovider.cpp.

◆ QQuickImageProviderOptions() [2/2]

QQuickImageProviderOptions::QQuickImageProviderOptions ( const QQuickImageProviderOptions & other)

Definition at line 515 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 537 of file qquickimageprovider.cpp.

◆ operator=()

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

Definition at line 520 of file qquickimageprovider.cpp.

◆ operator==()

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

Definition at line 526 of file qquickimageprovider.cpp.

◆ 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 551 of file qquickimageprovider.cpp.

◆ 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 565 of file qquickimageprovider.cpp.

◆ setAutoTransform()

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

Definition at line 542 of file qquickimageprovider.cpp.

◆ setPreserveAspectRatioCrop()

void QQuickImageProviderOptions::setPreserveAspectRatioCrop ( bool preserveAspectRatioCrop)

Definition at line 556 of file qquickimageprovider.cpp.

◆ setPreserveAspectRatioFit()

void QQuickImageProviderOptions::setPreserveAspectRatioFit ( bool preserveAspectRatioFit)

Definition at line 570 of file qquickimageprovider.cpp.

◆ setSourceClipRect()

void QQuickImageProviderOptions::setSourceClipRect ( const QRectF & rect)

Definition at line 596 of file qquickimageprovider.cpp.

◆ setTargetColorSpace()

void QQuickImageProviderOptions::setTargetColorSpace ( const QColorSpace & colorSpace)

Definition at line 583 of file qquickimageprovider.cpp.

◆ sourceClipRect()

QRectF QQuickImageProviderOptions::sourceClipRect ( ) const

Returns the requested source clip rect.

Definition at line 591 of file qquickimageprovider.cpp.

◆ targetColorSpace()

QColorSpace QQuickImageProviderOptions::targetColorSpace ( ) const

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

Definition at line 578 of file qquickimageprovider.cpp.


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