Skip to content

XUITabBarItem

Description

This class represents a tab in a XUITabBar.

Properties

Name Type Read-Only
Bounds Rect
Caption String
Closable Boolean
CloseIconBounds Rect
Enabled Boolean
Icon Picture
mOwner WeakRef
Owner XUITabBar
Tag Variant

Methods

Name Parameters Returns
Constructor owner As XUITabBar, caption As String, icon As Picture, tag As Variant, closable As Boolean, enabled As Boolean

Property Descriptions

Bounds As Rect

This tab's bounds. They are local to the renderer's buffer.


Caption As String

The tab's caption (visible text).


Closable As Boolean

If True then this tab can be closed by the user by clicking on the close icon.


CloseIconBounds As Rect

This tab's close icon bounds. They are local to the renderer's buffer. May be Nil.


Enabled As Boolean

True if this tab is enabled.


Icon As Picture

Optional icon.


mOwner As WeakRef

A weak reference to the tab bar that owns this tab.


Owner As XUITabBar

The tab bar that owns this tab.


Tag As Variant

Optional arbitrary data associated with this tab.


Method Descriptions

Constructor(owner As XUITabBar, caption As String, icon As Picture, tag As Variant, closable As Boolean, enabled As Boolean)

  • owner is the owing tab bar. A WeakRef will be created.
  • caption is the text displayed on the tab.
  • icon is an optional icon for the tab.
  • tag is optional arbitrary data to associate with the tab.
  • If closable is True (the default) then this tab will be closable by the user.
  • enabled determines if the tab is enable (default is True).