This is a structure containing various extended parameters and options. If omitted, suitable defaults will be supplied, although that will severely limit the capabilities of the tree control. For those parameters which are essentially Boolean options, 0=false and 1=true. Most of the fields in XTRCTL are input-only, but a few, such as COLUMNACTIVE are updated as well, and some are output-only; these are indicated with "[in/out]" or "[out]" in the following table, which lists the structure members alphabetically for easy reference. To use the XTRCTL structure in your program, include the xtree.sdf and xtree.def files and then map an instance of the structure for each XTREE in the program, e.g.:
map1 xtr, XTRCTL ! define instance of XTRCTL structure named xtr
...
xtr.OPCODE = XTROP_CREATE
xtr.CTLNO = -1
etc.
Or include the xtree.map file which includes actual map statements for XTRCTL (rather than a structure definition); in that case, members would be assigned as follows:
XTR'OPCODE = XTROP_CREATE
XTR'CTLNO = -1
etc.
Note that the first method (declaring an instance of the defined structure XTRCTL and using the structure dot member notation) has the advantage of making it easy to define and maintain separate copies of the structure for multiple XTREEs.
|
Symbol |
Type |
I/O |
Description |
|
B,1 |
in |
Set size of last column to "open ended" or fixed. | |
|
XTR'COLORDER (31) |
B,1 |
in/out |
Provides rearranging of the display order of the first (up to) 31 columns |
|
XTR'COLUMNACTIVE |
B,1 |
in/out |
Col # with focus (for kbd search) |
|
XTR'COLUMNSORT (3) |
B,1 |
in/out |
First, second, third sort columns |
|
XTR'CTLID |
B,1 |
out |
Returns standard control ID of XTREE control (allowing access by AUI_CONTROL) |
|
B,1 |
in/out |
Specifies which XTREE control to use. | |
|
B,4 |
in |
Ctl to delete. | |
|
B,1 |
in |
0=collapse, #=expand through level # (9 max) | |
|
XTR'FLYBY |
B,1 |
in |
Fly-by highlighting? 0=no, 1 = first column, 2 = entire row. |
|
B,1 |
in |
| |
|
XTR'GRIDSTYLE |
B,1 |
in |
0=vert solid, 1=horz solid, 2=both, 3=vert dotted, 4=horz dotted, 5=both. See XTR'SHOWGRID. |
|
B,1 |
in |
Column header style flags | |
|
XTR'HIDEHEADER |
B,1 |
in |
Hide headers? (0=no) |
|
B,1 |
in |
Display lines per item. | |
|
S,10 |
in |
Click code. | |
|
B,1 |
|
Left-most visible column | |
|
B,1 |
in |
Number of columns in left pane. | |
|
B,1 |
in |
Width of left pane. | |
|
B,1 |
in |
Misc flags (overlays xtr’truncated, which is now deprecated) | |
|
B,1 |
in |
Determines how selected item(s) are highlighted, mostly when tree is inactive | |
|
B,1 |
in |
Opcode. | |
|
XTR'PARENTID |
B,2 |
in |
ID of parent of control (e.g. a dialog). To specify parent by its alphanumeric control name, set xtr'parentid to zero and add the ParentID=<name> clause to any column; see Advanced Coldef Options. |
|
XTR'ROWHDRSTYLE |
B,1 |
in |
Options related to row headers. See XTR’SHOWROWHDR. |
|
XTR'SCROLLTIPS |
B,1 |
in |
Show scroll tips (0=no) |
|
B,1 |
|
| |
|
B,1 |
in |
Clickable area and style. | |
|
XTR'SHOW3D |
B,1 |
in |
Use 3D style? (0=no). |
|
B,1 |
in |
Show expand/collapse buttons for level 0. These "buttons" are in addition to the standard clickable +/- indicators. | |
|
XTR'SHOWBUTTONS0 |
B,1 |
|
No longer used. See XTR'SHOWBUTTONS. |
|
XTR'SHOWFOOTER |
B,1 |
in |
See XTR'FOOTERSTYLE. |
|
XTR'SHOWGRID |
B,1 |
in |
Show grid lines (0=no, 1=yes). Sample image here. |
|
B,1 |
in |
Determines whether row headers are displayed. | |
|
S,10 |
in |
Search key. | |
|
XTR'SORTORDER (3) |
B,1 |
in/out |
0=ascending, 1=descending |
|
XTR'TARGETCOL |
B,1 |
in/out |
Column of "target" cell; see XTR'TARGET... |
|
XTR'TARGETROW |
B,4 |
in/out |
Row of "target" cell; see XTR'TARGET... |
|
B,4 |
in |
Timeout (ms) | |
|
B,4 |
in/out |
Force the initial display vertical scroll position. | |
|
XTR'TREELINESTYLE |
B,1 |
|
Style of lines linking child lines to parent: 0=none, 1=solid, 2=dotted |
|
XTR'TRUNCATED |
B,1 |
in |
Show dots if text truncated? (deprecated, replaced by XTR’MISCFLAGS) |
|
XTR'USECOLORDER |
B,1 |
in |
Use COLORDER() to reorder? |
|
XTR'USETHEMES |
B,1 |
in |
Use Windows themes? (0=no) |
|
XTR’USRCFG |
B,1 |
|
Used for Saving User Adjustments. |
|
XTR'XCOL |
B,1 |
in/out |
Column of last cell to have the focus. (see xtr'xrow and xtr'targetcol) |
|
XTR'XNAVCOD |
B,1 |
in/out |
Used in cell editing |
|
XTR'XNAVMASK |
B,1 |
in/out |
" " " " |
|
XTR'XROW |
B,4 |
in/out |
Row of last cell to have the focus. See XTR'TARGET... |
|
B,1 |
out |
|