Unity 8
 All Classes Functions Properties
Carousel Class Reference

Inherits Item.

Signals

void clicked (int index, real itemY)
 
void pressAndHold (int index, real itemY)
 

Properties

Component itemComponent
 The component to be used as delegate. This component has to be derived from BaseCarouselDelegate.
 
alias model
 Model for the Carousel, which has to be a model usable by a ListView.
 
alias minimumTileWidth
 A minimal width of a tile can be set here. Per default a best fit will be calculated.
 
alias pathItemCount
 Sets the number of tiles that are visible.
 
alias tileAspectRatio
 Aspect ratio of the tiles width/height.
 
alias cacheBuffer
 Used to cache some delegates for performance reasons. See the ListView documentation for details.
 
int drawBuffer
 
real selectedItemScaleFactor
 The selected item can be shown in a different size controlled by selectedItemScaleFactor.
 
alias highlightIndex
 The index of the item that should be highlighted.
 
alias currentItem
 
alias verticalSpacing
 

Detailed Description

The Carousel component presents the items of a model in a carousel view. It's similar to a cover flow. But it stops at it's boundaries (therefore no PathView is used).

Definition at line 19 of file Carousel.qml.

Member Function Documentation

void Carousel::clicked ( int  index,
real  itemY 
)
signal

Emitted when the user clicked on an item

Parameters
indexis the index of the clicked item
itemYis y of the clicked delegate
void Carousel::pressAndHold ( int  index,
real  itemY 
)
signal

Emitted when the user pressed and held on an item

Parameters
indexis the index of the held item
itemYis y of the held delegate

Property Documentation

int Carousel::drawBuffer

Width of the "draw buffer" in pixel. The drawBuffer is an additional area at start/end where items drawn, even if it is not in the visible area. cacheBuffer controls only the to retain delegates outside the visible area (and is used on top of the drawBuffer) see https://bugreports.qt-project.org/browse/QTBUG-29173

Definition at line 38 of file Carousel.qml.


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