AnimatedImageViewer Class Reference

Properties
alias	asynchronous
alias	cache
alias	fillMode
alias	image
alias	imageHeight
alias	imageWidth
alias	source
alias	sourceSize

Signals
void	pressAndHold ()
void	rightClicked ()

Public Member Functions
void	fill ()
void	fit ()
void	rotateLeft ()
void	rotateRight ()

Detailed Description

A view for displaying animated images, such as GIF documents.

This controls inherits from QQC2 Flickable, to checkout its inherited properties refer to the Qt Docs.

This control along with the ImageViewer are meant to display images and support to zoom in and out with touch and mouse gestures and keyboard shortcuts.

Definition at line 19 of file AnimatedImageViewer.qml.

Property Documentation

asynchronous

alias AnimatedImageViewer::asynchronous

read

Whether the image should be loaded asynchronously.

By default this is set to true.

Definition at line 53 of file AnimatedImageViewer.qml.

cache

alias AnimatedImageViewer::cache

read

If the image should be cached in memory.

The default value is set to true

Definition at line 59 of file AnimatedImageViewer.qml.

fillMode

alias AnimatedImageViewer::fillMode

read

The fill mode of the image.

The possible values can be found on the Image control documentation from Qt. By default this is set to Image.PreserveAspectFit.

Definition at line 47 of file AnimatedImageViewer.qml.

image

alias AnimatedImageViewer::image

read

This an alias to the actual control painting the image.

This control is handled by a QQC2 AnimatedImage.

Definition at line 34 of file AnimatedImageViewer.qml.

imageHeight

alias AnimatedImageViewer::imageHeight

read

The painted height of the image.

This the same as using the image sourceSize property to set the height.

Definition at line 69 of file AnimatedImageViewer.qml.

imageWidth

alias AnimatedImageViewer::imageWidth

read

The painted width of the image.

This the same as using the image sourceSize property to set the width.

Definition at line 64 of file AnimatedImageViewer.qml.

source

alias AnimatedImageViewer::source

read

The source of the image.

Can be a remote or local file URL.

Definition at line 74 of file AnimatedImageViewer.qml.

sourceSize

alias AnimatedImageViewer::sourceSize

read

The painted size of the image.

As taken from Qt documentation: This property holds the scaled width and height of the full-frame image. Unlike the width and 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.

Definition at line 41 of file AnimatedImageViewer.qml.

Member Function Documentation

fill()

void AnimatedImageViewer::fill

(

)

Forces the image to fill-in the viewport, this is done horizontally, so the image might be out of view vertically.

fit()

void AnimatedImageViewer::fit

(

)

Forces the image to fit in the viewport.

pressAndHold

void AnimatedImageViewer::pressAndHold ( )

signal

Emitted when the image area has been pressed for a few seconds.

rightClicked

void AnimatedImageViewer::rightClicked ( )

signal

Emitted when the image area has been right clicked with a mouse event.

rotateLeft()

void AnimatedImageViewer::rotateLeft

(

)

Forces the image to be rotated 90 degrees to the left.

rotateRight()

void AnimatedImageViewer::rotateRight

(

)

Forces the image to be rotated 90 degrees to the right.

---

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

• AnimatedImageViewer.qml