TabControl

tab header - tab labels, with optional More button

class TabControl : WidgetGroupDefaultDrawing {

TabItemList _items;

ImageButton _moreButton;

bool _enableCloseButton;

TabItemWidget[] _sortedItems;

int _buttonOverlap;

string _tabStyle;

string _tabButtonStyle;

string _tabButtonTextStyle;

Signal!TabHandler tabChanged;

Signal!TabCloseHandler tabClose;

Align _tabAlignment;

Align tabAlignment [@property getter];

Align tabAlignment [@property setter];

this(string ID, Align tabAlignment);

void setStyles(string tabStyle, string tabButtonStyle, string tabButtonTextStyle);

bool enableCloseButton [@property getter];

bool enableCloseButton [@property setter];

int tabCount [@property getter];

TabItem tab(int index);

TabItem tab(string id);

const(TabItem) tab(string id);

int tabIndex(string id);

void updateTabs();

static bool accessTimeComparator(TabItemWidget a, TabItemWidget b);

TabItemWidget[] sortedItems();

int getNextItemIndex(int direction);

TabControl removeTab(string id);

void renameTab(string ID, dstring name);

void renameTab(int index, dstring name);

void onTabClose(string tabId);

TabControl addTab(TabItem item, int index, bool enableCloseButton);

TabControl addTab(string id, dstring label, string iconId, bool enableCloseButton);

TabControl addTab(string id, string labelResourceId, string iconId, bool enableCloseButton);

bool onMouse(Widget source, MouseEvent event);

void measure(int parentWidth, int parentHeight);

void layout(Rect rc);

void onDraw(DrawBuf buf);

string _selectedTabId;

string selectedTabId [@property getter];

void updateAccessTs();

void selectTab(int index, bool updateAccess);

}

Constructors

this this(): empty parameter list constructor - for usage by factory
this this(string ID, Align tabAlignment): create with ID parameter

Members

Functions

addTab TabControl addTab(TabItem item, int index, bool enableCloseButton): add new tab
addTab TabControl addTab(string id, dstring label, string iconId, bool enableCloseButton): add new tab by id and label string
addTab TabControl addTab(string id, string labelResourceId, string iconId, bool enableCloseButton): add new tab by id and label string resource id
getNextItemIndex int getNextItemIndex(int direction): find next or previous tab index, based on access time
layout void layout(Rect rc): Set widget rectangle to specified value and layout widget contents. (Step 2 of two phase layout).
measure void measure(int parentWidth, int parentHeight): Measure widget according to desired width and height constraints. (Step 1 of two phase layout).
onDraw void onDraw(DrawBuf buf): Draw widget at its position to buffer
onMouse bool onMouse(Widget source, MouseEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
onTabClose void onTabClose(string tabId): Undocumented in source. Be warned that the author may not have intended to support it.
removeTab TabControl removeTab(string id): remove tab
renameTab void renameTab(string ID, dstring name): change name of tab
renameTab void renameTab(int index, dstring name): change name of tab
selectTab void selectTab(int index, bool updateAccess): Undocumented in source. Be warned that the author may not have intended to support it.
setStyles void setStyles(string tabStyle, string tabButtonStyle, string tabButtonTextStyle): Undocumented in source. Be warned that the author may not have intended to support it.
sortedItems TabItemWidget[] sortedItems(): Undocumented in source. Be warned that the author may not have intended to support it.
tab TabItem tab(int index): returns tab item by id (null if index out of range)
tab TabItem tab(string id): returns tab item by id (null if not found)
tab const(TabItem) tab(string id): returns tab item by id (null if not found)
tabIndex int tabIndex(string id): get tab index by tab id (-1 if not found)
updateAccessTs void updateAccessTs(): Undocumented in source. Be warned that the author may not have intended to support it.
updateTabs void updateTabs(): Undocumented in source. Be warned that the author may not have intended to support it.

Properties

enableCloseButton bool enableCloseButton [@property getter]
bool enableCloseButton [@property setter]: when true, shows close buttons in tabs
selectedTabId string selectedTabId [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
tabAlignment Align tabAlignment [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
tabAlignment Align tabAlignment [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
tabCount int tabCount [@property getter]: returns tab count

Static functions

accessTimeComparator bool accessTimeComparator(TabItemWidget a, TabItemWidget b): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

_buttonOverlap int _buttonOverlap;: Undocumented in source.
_enableCloseButton bool _enableCloseButton;: Undocumented in source.
_items TabItemList _items;: Undocumented in source.
_moreButton ImageButton _moreButton;: Undocumented in source.
_selectedTabId string _selectedTabId;: Undocumented in source.
_sortedItems TabItemWidget[] _sortedItems;: Undocumented in source.
_tabAlignment Align _tabAlignment;: Undocumented in source.
_tabButtonStyle string _tabButtonStyle;: Undocumented in source.
_tabButtonTextStyle string _tabButtonTextStyle;: Undocumented in source.
_tabStyle string _tabStyle;: Undocumented in source.
tabChanged Signal!TabHandler tabChanged;: signal of tab change (e.g. by clicking on tab header)
tabClose Signal!TabCloseHandler tabClose;: signal on tab close button

Inherited Members

onDraw void onDraw(DrawBuf buf): Draw widget at its position to buffer

Meta

Source

See Implementation

dlangui widgets tabs classes

interfaces