org::kde::kirigami::Hero

Search for usage in LXR

org::kde::kirigami::Hero Class Reference

Inherits Item.

Properties

Item destination
 
alias duration
 
QtObject easing
 
QtObject mask
 
bool restore
 
Item source
 

Public Member Functions

void close ()
 
void open ()
 

Detailed Description

An element that implements a shared element transition, otherwise known as a "hero animation".

Definition at line 14 of file Hero.qml.

Property Documentation

◆ destination

Item org::kde::kirigami::Hero::destination
read

This property holds the item to animate to in the Hero animation.

Definition at line 24 of file Hero.qml.

◆ easing

QtObject org::kde::kirigami::Hero::easing
read
Remarks
This property is read-only

Definition at line 54 of file Hero.qml.

◆ mask

QtObject org::kde::kirigami::Hero::mask
read

Group of properties related to the mask of the object when performing a hero animation.

This contains the default mask as well as the properties required to create a custom mask.

The default mask of the Hero will transition from a circle to a rectangle on open(), and from a rectangle to a circle on close().

  • sourceProgress: real the progress of the animation, where 0 is the start and 1 is the end.
  • destinationProgress: real the progress of the animation, where 1 is the start and 0 is the end.
  • mask.sourceHeight: real the height of the source item.
  • mask.sourceWidth: real the width of the source item.
  • mask.destinationWidth: real the width of the destination item.
  • mask.destinationHeight: real the height of the destination item.
  • item: Rectangle the item used to mask the Hero during animation. This should bind to the sourceProgress and destinationProgress to change as the animation progresses.
    Remarks
    This property is read-only

Definition at line 49 of file Hero.qml.

◆ restore

bool org::kde::kirigami::Hero::restore
read

This property sets whether the source item will reappear in the original position when the Hero animation completes.

default: true

Definition at line 31 of file Hero.qml.

◆ source

Item org::kde::kirigami::Hero::source
read

This property holds the item to animate from in the Hero animation.

Definition at line 20 of file Hero.qml.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 6 2023 04:13:18 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.