CapeSoft.Com
Clarion Accessories
TabTree
Documentation
Class Reference
CapeSoft Logo

CapeSoft TabTree
Class Reference

Download Latest Version
Installed Version Latest Version

Methods and Properties

This document covers the TabTree class methods and properties.

Class Methods

The TabTree template will typically generate all the method calls you will need. The most useful method that the developer will call directly is AddTabIcon. Methods where the name begins with an underscore (_) are "internal" and are undocumented. However for your convenience these are not marked as Private, and can be called, or overwritten if desired.

Class Methods
AddTabIcon
BuildQueue
Construct
Destruct
Select
SetList
TakeEvent
Internal Methods
_AddControl
_AddToTree
_AnyNodes
_GetLegal
_Look
_RemoveHotkey
_SetIcon
_takeNewSelection
_TakePreAlert

AddTabIcon

AddTabIcon (Long p_Tab, String p_Icon, <String p_DisabledIcon>)

Description

Adds an icon to the list or tree for a particular tab.

Parameters
Name Description
p_tab The use equate of the tab to add the icon to.
p_Icon A string containing the name of the icon to use. If the icon is internal (as in the example below) then remember to add the icon to the Library, Object and resource files section of your Project.
Examples
Example
code
    myTabTree.AddTabIcon(?AdvancedTab, ' ~myIcon.ico ')

BuildQueue

BuildQueue ()

Description

Builds the queue for the control that represents the tree or list.
This method interrogates the Sheet control (the FEQ of the sheet should already be in the .SheetControl property) and builds the TabTree list accordingly. If you call this method directly, then you need to call the .Select method immediately after building the Queue. For your convenience, a routine is generated by the template which puts these two lines of code together. The routine is called
RebuildTabTreeQueue:1
where the :1 is the number of the TabTree instance on this window.

Construct

Construct ()

Description

Constructor. This method sets appropriate defaults for the class.

Destruct

Destruct ()

Description

Destructor. This method makes sure that any memory allocated by the class is disposed of before the class goes out of scope.

Select

Parameters
Name Description
(Long p_pos=0) If the p_pos parameter is omitted, then the currently selected tab is used. This method makes sure the currently selected tab, and the highlighted item in the list, are syncronised. The pos parameter is the entry in the list box that must be selected.

SetList

Parameters
Name Description
SetList (Long p_List) Set p_List to 1 for a list control, 0 for a tree control. This method primes the properties of the list control. The list control being set is the one who's FEQ is in the Control property. The properties for the list being set include prop:format, prop:iconlist, prop:tip and so on.

TakeEvent

TakeEvent ()

Description

This method detects any events (specifically NewSelection and PreAlert events) that are applicable to the TabTree controls.

Class Properties

The properties of the class are not typically accessed directly, the provided methods should be used to access or modify them in most cases.
NameDescription
branchDisabledIcon string(256)Name of the icon file to use for any disabled branches.
branchIcon string(256)Name of the icon file to use for the enabled branches.
columnHeader string(256)The column header (of the first column) of the TabTree list control.
control long The control equate (FEQ) of the TabTree list control.
debugOutput long Enable or disable debug output. If this property is set then debugging information will be written to DebugView (if it is running.)
disabledTip string(256)This tool tip is displayed when the user hovers the cursor over a disabled node.
header string(256) The root node of the tree.
headerDisabledIcon string(256)The icon to be used for the Root node in the tree, if the whole sheet control is disabled.
headerIcon string(256)The icon to be used for the Root node in the tree is the sheet control is enabled.
ignoreFieldSelect long .not used. 
ignoreTreeSelect long .internal property to avoid a recursive selection when an Event:NewSelection occurs.
lineHeight long The listbox line height, used to adjust the amount of space between rows in the list or tree.
noBoxes long Enable or disable the expand/contract boxes for nodes that contain children.
noLines long Enable or disable lines between nodes.
noTip string(256)The default text to use as the tip, when no tip is specified.
rememberTab long If set to 1 the selected entry is saved and restored on next open.
removeHotKey long If set hotkeys are disabled for the entries in the tree.
selected long The currently selected row in the TabTree list box.
selectedIcon long The name of the icon file to use to indicate a selected entry in the tree.
sheetControl long The field equate (FEQ) of the Sheet control used to build the tree.
tabIconsQueue &TabIconsQueueType A queue of the icons used for the tab controls.
tips long If this property is set to 1 then tooltips for each item in the TabTree list box will be set.
treeQ &TreeQueueType The queue containing all the rows for the TabTree list control.


Copyright© 2012 CapeSoft Software