GalleryRollTemplate Class Reference

Inheritance diagram for GalleryRollTemplate:

Properties
bool	cache
var	cb
int	fillMode
int	imageHeight
var	images
int	imageWidth
alias	interactive
alias	orientation
alias	running

Detailed Description

A template control to display images in a carousel form.

This element is use with the GalleryRollItem to display the images, so consider using that control instead of this one.

This control inherits all properties from the MauiKit ShadowedRectangle control. Thus, the corners radius can be modified individually, and a drop shadow can be added, using the corners and shadow properties respectively.

The transition of the images can be set as vertical or horizontal using the orientation property, and the transition time is picked randomly.

See also

orientation

Note

If not images are set, then the area is filled with a solid color block. This color can be changed using the color property.

Definition at line 16 of file GalleryRollTemplate.qml.

Property Documentation

cache

bool GalleryRollTemplate::cache

read

Whether the images should be saved in cache memory to save loading time.

By default this is set to true.

Definition at line 37 of file GalleryRollTemplate.qml.

cb

var GalleryRollTemplate::cb

read

A callback function to manage what image is positioned.

This callback function is called for each image source set in the model images, so the final source can be modified. This function should return a - new or modified - image source URL.

As an example, if the images model looks like: ["page1", "page2", "page3"] - which are not file URLs, this callback function can be use to map each individual source to an actual file URL.

images: ["page1", "page2", "page3"]
cb : (source) => 
{
  return mapSourceToImageFile(source) //here the "page1" could be mapped to "file:///some/path/to/image1.jpg" and return this new source to be use.
}    

Definition at line 50 of file GalleryRollTemplate.qml.

fillMode

int GalleryRollTemplate::fillMode

read

The fill mode of the images.

To see possible values refer to the QQC2 Image documentation form Qt. By default this is set to Image.PreserveAspectCrop.

Definition at line 66 of file GalleryRollTemplate.qml.

imageHeight

int GalleryRollTemplate::imageHeight

read

Sets the painted height size of the image.

Note

If the image has a big resolution it will take longer to load, so make it faster set this property to a lower value.

By default this is set to -1, which means that the image will be painted using the full image resolution. This is the same as setting the QQC2 Image sourceSize.height property.

Definition at line 87 of file GalleryRollTemplate.qml.

images

var GalleryRollTemplate::images

read

A list of images to be used.

This will be use as the model.

Definition at line 54 of file GalleryRollTemplate.qml.

imageWidth

int GalleryRollTemplate::imageWidth

read

Sets the painted width size of the image.

Note

If the image has a big resolution it will take longer to load, so make it faster set this property to a lower value.

By default this is set to -1, which means that the image will be painted using the full image resolution. This is the same as setting the QQC2 Image sourceSize.width property.

Definition at line 79 of file GalleryRollTemplate.qml.

interactive

alias GalleryRollTemplate::interactive

read

Whether the images in the carousel can be flicked with touch gestures.

Definition at line 23 of file GalleryRollTemplate.qml.

orientation

alias GalleryRollTemplate::orientation

read

The orientation of the transition of the images.

By default this is set to ListView.Horizontal. The possible values are:

• ListView.Horizontal
• ListView.Vertical

Definition at line 32 of file GalleryRollTemplate.qml.

running

alias GalleryRollTemplate::running

read

Checks and sets whether the transition animation is running or not.

Definition at line 71 of file GalleryRollTemplate.qml.

---

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

• GalleryRollTemplate.qml