An intermediate spinning progress indicator. More...
| Import Statement: | import Felgo 4.0 |
| Inherits: |
The AppActivityIndicator type provides a convenient way of communicating that a task is in progress. The component by default appears as spinning gear item in a NavigationBar or somewhere else within your custom layouts.
Ongoing tasks for which you should display an activity indicator are downloads from the Internet, loading of data from a database or a long-running calculation within your app.
By default, the indicator has animating set to true.
|
animating : bool |
Set this property to true if the AppActivityIndicator should be spinning.
If set to false and hidesWhenStopped is set to true, the indicator gets hidden.
The default value is set to Item::visible.
See also startAnimating(), stopAnimating(), and toggleAnimating().
|
animationDuration : int |
Set this property to control the speed of the activity indicator (in milliseconds per single rotation). The default value is 1000ms (1Hz).
|
color : color |
The color of the activity indicator. If not overridden the color corresponds to Theme::textColor.
|
hidesWhenStopped : bool |
Set this property to true to automatically hide the AppActivityIndicator item as soon as the spinning is stopped (animating set to false or stopped when calling stopAnimating() or toggleAnimating()).
This property sets the Item::visible property on the item depending on the animation state.
|
[since Felgo 2.9.2] iconFont : string |
Allows to specify a custom icon font to be used.
This property was introduced in Felgo 2.9.2.
|
[since Felgo 2.9.2] iconSize : alias |
The size of the indicator icon within the AppActivityIndicator.
This property was introduced in Felgo 2.9.2.
|
[since Felgo 2.9.2] iconType : alias |
The icon that is displayed.
Note: This property was renamed from icon in Felgo 4.0.0. This is because many types already inherit a property AbstractButton::icon from Qt Quick Controls 2.
This property was introduced in Felgo 2.9.2.
|
startAnimating() |
Starts the animation of the AppActivityIndicator if not currently animating.
When the activity indicator is animated, the gear spins to indicate some ongoing progress. The indicator is animated until stopAnimating is called or
animating is set to false.
See also animating, stopAnimating(), and toggleAnimating().
|
stopAnimating() |
Stops the animation of the AppActivityIndicator if currently animating.
If animating is stopped and hidesWhenStopped is set to true, the indicator is hidden.
See also animating, startAnimating(), and toggleAnimating().
|
toggleAnimating() |
Starts or stops the animation of the AppActivityIndicator item depending on its current spinning state.
If animating is stopped and hidesWhenStopped is set to true, the indicator is hidden.
See also animating, startAnimating(), and stopAnimating().
