QML InfoBanner Element

InfoBanner component is used to display information to the user More...

Inherited by SystemBanner.

This element was introduced in qt-components 4.7.

Properties

Methods

Detailed Description

The InfoBanner component is used to display information to the user. The number of lines of text is limited to 3

 // Create an info banner with no icon
 InfoBanner {
     id: sb
     text: "This is an info banner with no icon"
 }

 // Create an info banner with icon
 InfoBanner {
     text: "This is an info banner with icon"
     iconSource: "system_banner_thumbnail.png"
 }

 function showBanner1() {
         // set display time to 5000 ms, default is 3000 ms
         sb.timerShowTime = 5000;
         // display info banner
     sb.show();
 }

 function showBanner2() {
     // disable "self-dismissing" timer, banner has to be dismissed manually
     sb.timerEnabled = false;
     // display info banner
     sb.show();
 }

 function hideBanner() {
     // hide info banner manually
     sb.hide();
 }

Property Documentation

iconSource : url

Property default is ""

The path to the icon image


leftMargin : real

Property default is 8

Allows user to customize left margin if needed


text : string

Text to be displayed in Info Banner


timerEnabled : bool

Property default is true

Enable/disable timer that dismisses Info Banner


timerShowTime : int

Property default is 3000

For setting how long Info Banner stays visible to user before being dismissed


topMargin : real

Property default is 8

Allows user to customize top margin if needed


Method Documentation

InfoBanner::hide ()

Hides Info Banner


InfoBanner::show ()

Displays Info Banner