Learn what Felgo offers to help your business succeed. Start your free evaluation today! Felgo for Your Business

TabControl

A tabbed navigation control. More...

Import Statement: import Felgo 4.0
Inherits:

Item

Properties

Signals

Detailed Description

This control can be used for a navigation based on tabs. It is based on the Qt Quick TabBar and StackLayout. It has a default a platform-specific look. You can use the properties tabBar.background, NavigationItem::contentItem and others to customize the tabs' appearances.

Children of TabControl should be NavigationItem objects.

To implement a platform dependent navigation, Navigation can be used instead of TabControl.

TabControl internally uses a TabBar to display the navigation items. It shows the navigation item content in a StackLayout.

Note: TabControl uses a lazy-loading mechanism for the contents of each tab. This means, that the tab contents within each NavigationItem element are created when the tab is opened for the first time. You can disable the lazy-loading manually. To do so, set NavigationItem::lazyLoadContent to false.

Example Code

To use tabbed control in your application, the following code can be used:

 AppPage {
   TabControl {
     NavigationItem {
       title: "Tab #1"
       iconType: IconType.arrowleft

       FirstPage { }
     }
     NavigationItem {
       title: "Tab #2"
       iconType: IconType.arrowright

       SecondPage { }
     }
   }
 }

Property Documentation

[since Felgo 3.7.0] backgroundColor : color

The background color each tab. The default value matches Theme.tabBar.backgroundColor

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] barHeight : real

The height of the tab bar in pixel. The default value matches Theme.tabBar.height

This property was introduced in Felgo 3.7.0.


[read-only, since Felgo 4.0.0] count : int

The number of tabs the control contains. This includes invisible tabs.

Contains the tabBar's Container::count.

This property was introduced in Felgo 4.0.0.

See also tabBar and countVisible.


[read-only, since Felgo 4.0.0] countVisible : int

The number of tabs that are visible in the control.

This property was introduced in Felgo 4.0.0.

See also tabBar and count.


[since Felgo 4.0.0] currentIndex : alias

The current tab's index. You can also change this property to change the currently active tab.

This property sets the internal tabBar's currentIndex property.

This property was introduced in Felgo 4.0.0.

See also tabBar, stackLayout, and tabWidth.


[read-only] currentTab : NavigationItem

Access to the currently visible NavigationItem.


[since Felgo 3.7.0] dividerColor : color

The color of the upper divider. The default value matches Theme.tabBar.dividerColor

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] fontBold : bool

Whether the tab text label is displayed in bold. The default value matches Theme.tabBar.fontBold

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] fontCapitalization : real

The font capitalization of the tab text label. The default value matches Theme.tabBar.fontCapitalization

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] iconSize : real

The size of the tab icon in pixel. The default value matches Theme.tabBar.iconSize

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] markerColor : color

The color of the bottom marker which shows the selected tab.

The default value matches Theme.tabBar.markerColor

This property was introduced in Felgo 3.7.0.


[since Felgo 2.7.0] showIcon : bool

Whether the set NavigationItem::iconType should be displayed for the tabs. The default value matches Theme.tabBar.showIcon.

This property was introduced in Felgo 2.7.0.


[since Felgo 3.7.0] showOnlySelectedLabel : bool

The color of icon and text for the pressed item. The default value is false.

This property was introduced in Felgo 3.7.0.


[since Felgo 4.0.0] stackHeight : alias

The stackLayout's height.

This property was introduced in Felgo 4.0.0.

See also tabBar, stackLayout, and tabHeight.


[since Felgo 4.0.0] stackLayout : alias

The internally used StackLayout for layouting the tab content.

This property was introduced in Felgo 4.0.0.

See also tabBar.


[since Felgo 4.0.0] stackWidth : alias

The stackLayout's width.

This property was introduced in Felgo 4.0.0.

See also tabBar, stackLayout, and tabWidth.


[since Felgo 4.0.0] tabBar : alias

The internally used TabBar for showing the tab buttons.

This property was introduced in Felgo 4.0.0.

See also stackLayout.


[since Felgo 4.0.0] tabHeight : alias

The tabBar's Container::contentHeight.

This property was introduced in Felgo 4.0.0.

See also tabBar, stackLayout, and stackHeight.


[since Felgo 4.0.0] tabPosition : enum

Sets the vertical tab position. Tabs can appear on top or bottom of the user interface.

The corresponding values for this are TabBar.Header and TabBar.Footer. This property sets the internal TabBar::position proeprty.

This property was introduced in Felgo 4.0.0.


[since Felgo 4.0.0] tabWidth : alias

The tabBar's Container::contentWidth.

This property was introduced in Felgo 4.0.0.

See also tabBar, stackLayout, and stackWidth.


[since Felgo 4.0.0] tabsVisible : alias

Sets whether the tab bar is visible.

This property sets the internal tabBar's visible property.

This property was introduced in Felgo 4.0.0.


[since Felgo 2.12.0] textFont : font

This property gives full access to all font settings of the title text within the tabs.

This property was introduced in Felgo 2.12.0.


[since Felgo 3.7.0] textMaximumLineCount : int

The Maximum line count for the title text of each tab. The default value matches Theme.tabBar.textMaximumLineCount

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] textSize : real

The font size of the tab text label. The default value matches Theme.tabBar.textSize

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] titleColor : color

The default color of icon and text for each tab. The default value matches Theme.tabBar.titleColor

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] titleDisabledColor : color

The color of icon and text for disabled tabs. The default value matches Theme.tabBar.titleDisabledColor

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] titleOffColor : color

The color of icon and text for not selected tabs. The default value matches Theme.tabBar.titleOffColor

This property was introduced in Felgo 3.7.0.


[since Felgo 3.7.0] titlePressedColor : color

The color of icon and text for the pressed item. The default value matches Theme.tabBar.titlePressedColor

This property was introduced in Felgo 3.7.0.


Signal Documentation

tabClicked(NavigationItem tab, int index)

Called when a tab has been clicked, and its content page will be displayed.

Note: The corresponding handler is onTabClicked.


Qt_Technology_Partner_RGB_475 Qt_Service_Partner_RGB_475_padded