AppActivityIndicator

An intermediate spinning progress indicator More...

Import Statement: import VPlayApps 1.0
Inherits:

Item

Properties

Methods

Detailed Description

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.

Property Documentation

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.


icon : alias

The icon to be displayed. Uses IconType::refresh by default.

This QML property was introduced in V-Play 2.9.2.


iconFont : string

Allows to specify a different icon font to be used. The item uses the Theme::iconFont by default.

This QML property was introduced in V-Play 2.9.2.


iconSize : alias

The size of the indicator icon within the AppActivityIndicator.

This QML property was introduced in V-Play 2.9.2.


Method Documentation

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().


Videos

Voted #1 for:

  • Easiest to learn
  • Most time saving
  • Best support

Develop Cross-Platform Apps and Games 50% Faster!

  • Voted the best supported, most time-saving and easiest to learn cross-platform development tool
  • Based on the Qt framework, with native performance and appearance on all platforms including iOS and Android
  • Offers a variety of plugins to monetize, analyze and engage users
FREE!
create apps
create games
cross platform
native performance
3rd party services
game network
multiplayer
level editor
easiest to learn
biggest time saving
best support