$root.$iwindows.WINDOW.$objs.Tab Strip

Parent: $root.$iwindows.WINDOW.$objs
 
Children 

Class notation

Properties Methods Events 

Tab Strip fields contain a number of tabs, only one of which can be selected at any time.

Properties

Object specific 
$currenttabThe current tab.For window objects,assigning a different value to $currenttab at runtime generates an evTabSelected event
$expandedgroupsIf true, and the tabstrip is in vertical mode, all tab groups will be expanded, all tabs & groups shown and tab groups will be non-selectable.
$extraspacingThe extra spacing in pixels added to entries
$fieldstylefocusedThe style in system class #STYLES assigned to this field in addition to $fieldstyle when the control has focus
$gridsectionThe type of the complex grid section containing the object. One of the kGrid... constants
$selectedtabcolorThe color of the currently selected tab
$selectedtabtextcolorThe color of the text on the currently selected tab
$selectedtabtextstyleThe font style for the currently selected tab
$showedgeIf true, the tab strip shows an edge on the top of the control
$showtabcloseboxIf true, the control will show a close box on each tab. Not available in vertical mode or on non-animated tab styles
$squaremodeIf true,the tab control draws tabs in square mode
kTabStripAnimDot kTabStripAnimLine kTabStripAnimRndSquare kTabStripAnimSquare kTabStripOriginal kTabStripSquare
$tabcaptionThe caption for the current selected tab
$tabcolorThe color of tabs which are not selected
$tabgroupcolorColor for the tab groups. Groups are supported when tabmode is kTabStripAnimSquare,kTabStripAnimLine,kTabStripAnimDot or kTabStripAnimRndSquare and in vertical mode only
$tabgroupfontThe font for the tab groups
$tabgroupfontsizeThe font size for tab group titles. Defaults to 0, and uses $fontsize of the control
$tabgroupfontstyleThe font style for the tab groups
$tabgroupnameThe group for the current tab.
$tabgrouptextcolorThe color of the text for the tab groups. By default this is kColorDefault and will draw as white
$tabiconidThe icon id for the current tab
$tableftmarginThe width in pixels of the margin to the left of the tabs
$tabsA comma separated list of the text displayed on the tabs
$tabtextcolorThe color of the text on tabs which are not selected
$tooltipposA kTooltipPos... constant that specifies where $tooltip appears relative to the control
kTooltipPosBottom kTooltipPosLeft kTooltipPosMouse kTooltipPosRight kTooltipPosTop
$verticaltabsIf true,the tab strip uses a vertical layout for its tabs
Standard$active $alpha $backcolor $backgroundtheme $bordercolor $candropcursor $componentinfo $container $contextmenu $cursor $disablefocus $disablesystemfocus $dragborder $dragiconid $dragmode $dragrange $dropmode $edgefloat $effect $enabled $fieldstyle $font $fontsize $fontstyle $framehwnd $gridcolumn $hasfocus $height $helpfile $hwnd $ident $keyevents $left $mouseevents $name $nodropcursor $objtype $order $osdropflags $rmouseevents $selected $sidepanel $sidepanelmode $statusevents $tooltip $top $userinfo $visible $width

Methods

Object specific 
$addtab$addtab(cTabName[,cTabIcon,cTabGroupName,bDoNotChangeTab=kFalse]) adds a new tab to the tabstrip with optional tab icon and tab group. evTabSelected not sent if bDoNotChangeTab is kTrue. Returns new tab number
$sendevent$sendevent(iEvent[,eventParameters...]) Sends event iEvent (an ev... constant value) to the object with eventParameters passed as name,value pairs, for example $sendevent(evClick,'pLineNumber',2).Returns kFalse if the event is discarded
$settabinfo$settabinfo(iTabNumber[,cTabCaption,cTabIcon]) sets a tabstrip or tabpane tab caption and or tab icon
$showpanel$showpanel(iAction[,iMode=kSidePanelModeAuto]) executes kSidePanelAction... on a side panel object. iMode only applies to kSidePanelActionShow,and must be kSidePanelModeCover/Push/Auto. For JS client,$showpanel must be executed on the client
Standard$redraw

Events

Object specific 
evTreeCollapseSent to a tree list when a node collapses
Parameters
pEventCodeThe event code
pNodeItemA reference to the tree node
evTreeExpandSent to a tree list when a node expands
Parameters
pEventCodeThe event code
pNodeItemA reference to the tree node
evTreeExpandCollapseFinishedSent to a tree list after expanding or collapsing is finished
Parameters
pEventCodeThe event code
pVisibleNodeCountThe count of visible tree nodes after an expand or collapse has occurred
evTreeListEditFinishedSent to a Tree list when the edit field has been closed
Parameters
pEventCodeThe event code
pNodeItemA reference to the tree node
pColumnNumberThe list column number
evTreeListEditFinishingSent to a Tree list when new text is ready to be stored in the list
Parameters
pEventCodeThe event code
pNodeItemA reference to the tree node
pColumnNumberThe list column number
pNewTextThe new text entered by the user
evTreeListEditStartingSent to a Tree list when the column text is about to be edited
Parameters
pEventCodeThe event code
pNodeItemA reference to the tree node
pColumnNumberThe list column number
evTreeNodeIconClickedSent to a tree list when the node icon has been clicked
Parameters
pEventCodeThe event code
pNodeItemA reference to the tree node
evTreeNodeNameFinishedSent to a tree list when the node name has been changed
Parameters
pEventCodeThe event code
pNodeItemA reference to the tree node
pNewTextThe new text entered by the user
evTreeNodeNameFinishingSent to a tree list when a node name is about to be changed
Parameters
pEventCodeThe event code
pNodeItemA reference to the tree node
pNewTextThe new text entered by the user
evWillHideSent to a field before it is hidden. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
evWillShowSent to a field before it becomes visible. Currently only used when the field is set as a side panel
Parameters
pEventCodeThe event code
pSidePanelIf true,this object is being hidden or shown as a side panel
StandardevAfter evBefore evCanDrop evClick evClipChangedData evDisabled evDoubleClick evDrag evDragBorder evDragFinished evDrop evEnabled evHidden evHScrolled evKey evMouseDouble evMouseDown evMouseEnter evMouseLeave evMouseUp evOpenContextMenu evRMouseDouble evRMouseDown evRMouseUp evSent evShiftTab evShown evTab evVScrolled evWillDrop

Children

Top 

$methods