TabControl

tab header - tab labels, with optional More button

class TabControl : WidgetGroupDefaultDrawing {}

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, dstring tooltipText)

add new tab by id and label string

addTab
TabControl addTab(string id, string labelResourceId, string iconId, bool enableCloseButton, dstring tooltipText)

add new tab by id and label string resource id

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

add new tab by id and label UIString

getMoreButtonPopupMenu
MenuItem getMoreButtonPopupMenu()
Undocumented in source. Be warned that the author may not have intended to support it.
getNextItemIndex
int getNextItemIndex(int direction)

find next or previous tab index, based on access time

handleAction
bool handleAction(Action a)

override to handle specific actions

handleMorePopupMenu
bool handleMorePopupMenu()

try to invoke popup menu, return true if popup menu is shown

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

renameTab
void renameTab(int index, string id, dstring name)

change name and id 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

autoMoreButtonMenu
bool autoMoreButtonMenu [@property getter]
bool autoMoreButtonMenu [@property setter]

when true, automatically generate popup menu for more button - allowing to select tab from list

enableCloseButton
bool enableCloseButton [@property getter]
bool enableCloseButton [@property setter]

when true, shows close buttons in tabs

enableMoreButton
bool enableMoreButton [@property getter]
bool enableMoreButton [@property setter]

when true, more button is visible

moreButtonIcon
string moreButtonIcon [@property getter]
string moreButtonIcon [@property setter]

more button custom icon

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

_autoMoreButtonMenu
bool _autoMoreButtonMenu;
Undocumented in source.
_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.
moreButtonClick
Signal!OnClickHandler moreButtonClick;

on more button click (bool delegate(Widget))

moreButtonPopupMenu
Signal!PopupMenuHandler moreButtonPopupMenu;

handler for more button popup menu

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

From WidgetGroupDefaultDrawing

onDraw
void onDraw(DrawBuf buf)

Draw widget at its position to buffer

Meta