C/C++ API


	C/C++ API	Softel vdm, Inc.

Direct calls to the SftTree DLLs are used to communicate with the tree control for maximum efficiency.

The class CSftTree defines all necessary functions to communicate with the tree control. The class CSftTreeSplit defines a split tree control.

The API Reference section lists C and C++ macros and functions. They are sorted alphabetically, but leading SftTree_, SftTree_Get and SftTree_Set text is not considered. E.g., when looking up the function SftTree_GetCurSel, look for topic CurSel, the leading SftTree_Get is dropped.

Definitions and Structures

Name	Description
LPFNSFTTREE_OWNERDRAWPROC	Defines the type of an application-supplied owner-draw function, which is called whenever an object needs to be rendered.
LPFNSFTTREE_VGETITEM	Defines the type of the virtual data source callback used by SftTree/DLL to retrieve information about one item as it is needed by the tree control.
LPFNSFTTREE_VRELEASEITEM	Defines the type of the virtual data source callback called by SftTree/DLL to release information previously returned by the SFTTREE_VGETITEM callback.
SFT_PICTURE	Used to describe a picture component (a bitmap, icon or ImageList image, etc.).
SFTTREE_CELL	Used with GetCellInfo/SetCellInfo to retrieve and set cell attributes and as part of the SFTTREE_ITEM structure (for a virtual data source).
SFTTREE_CELLINFOPARM	Used as parameter for GetCellInfo and SetCellInfo to retrieve and set cell attributes.
SFTTREE_CLASS	Defines the window class name of a tree control without splitter bar.
SFTTREE_COLORS	Used with GetCtlColors and SetCtlColors to retrieve and set a tree control's color attributes.
SFTTREE_COLUMN_EX	Used with GetColumns and SetColumns to retrieve and set column attributes.
SFTTREE_CONTROL	Used with GetControlInfo and SetControlInfo to retrieve and set tree control attributes.
SFTTREE_DELETEPARM	Used to define an application-specific deletion callback routine, which is called whenever an item is removed from the tree control.
SFTTREE_DELETEPROC	Defines the type of a user-supplied callback routine, called by SftTree/DLL whenever an item is removed from the tree control.
SFTTREE_DRAGINFO	Used during drag & drop operations and can be retrieved using GetDragInfo.
SFTTREE_DWORD_PTR	Defines a type large enough to hold a DWORD or pointer value.
SFTTREE_ID	Defines the type of an item ID.
SFTTREE_ITEM	Used by the callback function SFTTREE_VGETITEM to return the requested item information to SftTree/DLL when a virtual data source is used.
SFTTREE_MAXLEVELS	Defines the maximum number of levels supported.
SFTTREE_NOCOLOR	Used to indicate that the default color should be used.
SFTTREE_OBSOLETE_4	Used to indicate compatibility with SftTree/DLL 4.0 (and older).
SFTTREE_OWNERDRAW	Used as parameter for an application-supplied owner-draw function of type LPFNSFTTREE_OWNERDRAWPROC.
SFTTREE_OWNERDRAWPARM	Used to define an application-specific owner-draw callback routine, which is called whenever an object needs to be rendered.
SFTTREE_ROW	Used with GetRowInfo and SetRowInfo and as part of the SFTTREE_ITEM structure (for a virtual data source).
SFTTREE_ROWINFOPARM	Used as parameter for GetRowInfo and SetRowInfo to retrieve and set row header attributes.
SFTTREE_SELENTRY	Used by GetSelItemsArray to return an array of structures describing groups of selected items.
SFTTREE_SORTPROC_CELLDATA	Defines the type of a user-supplied callback routine, called by SftTree/DLL to allow an application to sort items using SortDependents.
SFTTREE_SORTPROC_ITEM	Defines the type of a user-supplied callback routine, called by SftTree/DLL to allow an application to sort items using SortDependents.
SFTTREE_SORTPROCEX	Defines the type of a user-supplied callback routine, called by SftTree/DLL to allow an application to sort items using SortDependents.
SFTTREE_STATIC	Defines static linking of SftTree/DLL to an application.
SFTTREE_TOOLTIPSPARM	Used as parameter for SetToolTipsCallback, to define an application-specific ToolTips callback routine, which can define the ToolTip text when a ToolTip or ScrollTip is to be displayed.
SFTTREE_TOOLTIPSPROC	Defines the type of a user-supplied callback routine, called by SftTree/DLL to allow an application to define the ToolTip text when a ToolTip or ScrollTip is to be displayed.
SFTTREE_VIRTUALDEF	Used by VirtualInitialize to use the tree control in virtual mode and to define the virtual data source.
SFTTREESPLIT_CLASS	Defines the window class name of a tree control with splitter bar.

Functions

Name	Description
~CSftTree	Standard destructor.
~CSftTreeSplit	Standard destructor.
AddString	Adds a new item to a tree control. The new item is added as the last item at level 0.
AdjustCellEditRect	Returns a cell's location in client area coordinates of the left or right pane of a split tree control.
AutoExpand	Defines whether items are automatically expanded when the mouse hovers over a collapsed parent item.
AutoExpandItem	Returns the zero-based index of the item to be expanded as a result of a call to StartAutoExpandTimer or SetAutoExpand.
BackgroundBitmap	Defines a background bitmap used as the background for the tree control.
Bitmaps	Registers the size and sets the default item pictures used for all items.
Buttons	Registers the size and sets the bitmaps used for expand/collapse buttons.
CalcCellFromPoint	Calculates the item index and column number given a point in tree control client area coordinates.
CalcColumnFromPoint	Calculates the column number given a point in tree control client area coordinates.
CalcIndexFromPoint	Calculates the item index number given a point in tree control client area coordinates.
CalcLimit	Defines the maximum number of items to consider for optimal column width and scrolling calculation.
CalcOptimalColumnWidth	Calculates a column's optimal width so text and pictures are not clipped.
CalcOptimalCellDimensions	Calculates a cell's optimal height and width so its contents aren't truncated.
CalcOptimalRowHeaderWidth	Calculates the optimal width for row headers so text and pictures are not clipped.
CalcVisibleOnly	Defines whether only visible items are considered for optimal column width and scrolling calculation.
CaretColumn	Returns the column where a mouse button was last clicked.
CaretIndex	Defines the current item (caret location).
CellEditWindow	Returns the window containing the specified cell in a split tree control.
CellInfo	Defines a cell's attributes.
CellRectInfo	Returns the location of a cell, the cell text and cell picture.
CellRectInfoEx	Returns the location of a cell, the cell text and cell picture.
CharSearchMode	Defines the method used to search for matching items in response to characters typed by the user.
ClickAgainPos	Returns the location of the item that was clicked again.
Collapse	Collapses a parent item.
Columns	Defines the number of columns and column attributes.
ControlData	Defines an application-defined value.
ControlInfo	Defines the tree control's attributes.
CopyItems	Copies a group of items to a new location.
Count	Returns the number of items in the tree control.
Create	Creates a tree control window and attaches it to the CSftTree or CSftTreeSplit object.
CrossColumnResize	Defines whether multiple columns can be resized during one column resizing operation.
CSftTree	Standard constructor.
CSftTreeSplit	Standard constructor.
CtlColors	Defines the tree control's color attributes.
CurSel	Defines the index of the selected item (single selection tree control).
CustomCode	Defines optional product customization.
DeleteCallback	Defines a deletion callback routine, called when items are deleted.
DeleteDependents	Deletes an item's dependent items.
DeleteString	Deletes an item.
Dependent	Returns dependent item information for a parent item.
DependentCount	Returns the number of dependents for a parent item.
DisableNoScroll	Defines the scroll bar handling status.
DisplayCellRect	Returns the location of a cell.
DisplayCellRectForItem	Returns the location of a cell.
DisplayColumn	Returns the display column number given a real column number.
DisplayHeaderRect	Returns the dimensions of the column header area.
DragBitmaps	Defines the drag & drop starting location attribute.
DragImage	Returns a drag image representing the currently selected items.
DragInfo	Returns drag & drop operation information in a SFTTREE_DRAGINFO structure.
DragType	Defines the drag & drop detection attribute.
DrawSelectionOutline	Draws a selection outline.
DropHighlight	Defines the current drag & drop target location.
DropHighlightStyle	Defines the display attribute of the current drag & drop target item.
EnterResizeMode	Allows the user to resize the panes of a split tree control using the keyboard.
Expand	Expands a parent item.
ExpandCollapseButtonRect	Returns the location of an item's expand/collapse button.
ExpandCollapseIndex	Returns the zero-based index of the item to expand/collapse.
FindItem	Searches item data.
FindString	Searches a string.
FindStringEx	Searches cells for a string.
FindStringExact	Searches a string.
FirstDisplayColumn	Returns the index of the first displayed column.
Flyby	Defines whether flyby highlighting is enabled.
ForwardChildMsgs	Defines the child window message handling status.
ForwardChildMsgs	Defines the child window message handling status.
FreeGDIPlusImageLoadedFromResource	Deletes a GDI+ image obtained using SftTree_LoadGDIPlusImageFromResource.
Header	Defines a column's header text.
HeaderButton	Defines the column number of the currently pressed header button.
HeaderFont	Defines the font used for header text display.
HeaderLength	Returns the length of a column's header text.
HeaderRect	Returns the dimensions of the header area.
HorizontalExtent	Defines the horizontal extent (in pixels) of the displayable area.
HorizontalOffset	Defines the current horizontal offset (in pixels) of the displayed area.
Indentation	Defines the indentation (in pixels) for item levels.
InheritBgColor	Defines whether the area to the left of the first cell inherits the cell's background color.
InsertString	Inserts a new item using a string.
ItemBitmap	Defines an item's item picture.
ItemBitmapAlign	Defines whether item pictures of items are aligned with the cells of the immediate parent level.
ItemData	Defines an item's application-specific value.
ItemEditIgnore	Defines whether an item is ignored for cell editing.
ItemExpand	Defines an item's expand status.
ItemExpandable	Defines whether an item is expandable.
ItemExpandCollapseButton	Defines whether an item's expand/collapse button is shown.
ItemHeight	Returns an item's height (in pixels).
ItemHeightMinMax	Defines an item's minimum and maximum height (in pixels).
ItemID	Defines an item's ID.
ItemIgnore	Defines whether the item is excluded from optimal column width and row header width calculation.
ItemIndex	Returns an item's index given an item ID.
ItemLabel	Defines an item's label picture information.
ItemLabelPicture	Defines an item's label picture information.
ItemLevel	Defines an item's level number.
ItemLines	Defines the number of text lines used for item height calculation.
ItemPicture	Defines an item's item picture.
ItemPictureAlign	Defines whether item pictures of items are aligned with the cells of the immediate parent level.
ItemRect	Returns an item's location in client area coordinates.
ItemShown	Defines an item's visibility status.
ItemsShown	Returns the number of items displayable in the tree control's client area, including partial items.
ItemsShownComplete	Returns the number of items displayable in the tree control's client area, not including partial items.
ItemStatus	Defines an item's enabled/disabled status.
KeyHandling	Defines keystrokes intercepted during cell editing.
LastCursorPos	Returns the last cursor position in tree control client area coordinates.
LastDisplayColumn	Returns the index of the last displayed column.
LeftWindow	Returns the window handle or object of the tree control in the left pane of a split tree control.
MakeCellVisible	Scrolls the specified cell into view horizontally and vertically so that it is displayed in the tree control's client area.
MakeCellVisible	Scrolls the specified cell into view horizontally and vertically so that it is displayed in the tree control's client area.
MakeContentWindow	Defines the specified window as a content window (virtual mode only).
LoadGDIPlusImageFromResource	Loads a GDI+ image from an application's or DLL's resources.
MakeColumnVisible	Scrolls the specified column into view horizontally so that it is displayed in the tree control's client area.
MakeIntegralHeight	Resizes the tree control vertically so visible items are displayed in their entirety.
MakeRowHeaderOptimal	Sets the optimal row header width so that the text and pictures of all row headers can be displayed.
MakeRowVisible	Scrolls the specified item into view vertically so that it is displayed in the tree control's client area.
MakeSplitterOptimal	Positions the splitter bar optimally, so the left pane can display as much data as possible without a horizontal scroll bar.
MoveItems	Moves a group of items to a new position in the tree control.
MultilineHeader	Defines whether column headers can display multiple lines of text.
NextShown	Returns the next visible item.
NoFocusStyle	Defines the display style of selected items when the tree control does not have the input focus.
OpenEnded	Defines whether the last column is open-ended.
OverheadWidth	Returns the width of the area added to the first column for hierarchical graphics components.
OwnerDrawCallback	Defines an application-supplied owner-draw function, which is called whenever an object needs to be rendered.
Parent	Returns an item's parent index.
Pictures	Registers the size and sets the default item pictures used for all items.
PlusMinus	Defines the plus/minus bitmaps used for all items.
PrevShown	Returns the previous visible item.
RealColumn	Returns the real column number given a display column number.
RecalcHorizontalExtent	Recalculates the optimal horizontal scrolling extent.
RegisterApp	Registers an application with SftTree/DLL.
ReorderColumns	Defines whether columns can be reordered using column drag & drop.
ResetContent	Removes all items from the tree control.
ResizeColumn	Returns the column number of the column being resized.
ResizeHeader	Defines whether columns are resizable by the user.
RightWindow	Returns the window handle or object of the tree control in the right pane of a split tree control.
RowColBitmap	Defines the picture displayed in the row/column header.
RowColBitmapStyle	Defines the position of the picture displayed in the row/column header.
RowColHeaderButton	Defines whether the row/column header button is currently down (pressed).
RowColHeaderRect	Returns the dimensions of the row/column header area.
RowColHeaderStyle	Defines the position of the text displayed in the row/column header.
RowColPicture	Defines the picture displayed in the row/column header.
RowColPictureStyle	Defines the position of the picture displayed in the row/column header.
RowColText	Defines the row/column header text.
RowColTextLength	Returns the row/column header text length.
RowHeaderFont	Defines the font used for row header text display.
RowHeaderLines	Defines the number of text lines used for row header height calculation.
RowHeaderRect	Returns the dimensions of the row header area.
RowHeaderStyle	Defines the position of text displayed in the row headers.
RowHeaderWidth	Defines the width of the row header area.
RowInfo	Defines an item's row header attributes.
RowText	Defines an item's row header text.
RowTextLength	Returns an item's row header text length.
RubberbandSelection	Defines whether click-drag selection of multiple items using a selection rectangle is supported.
ScrollTips	Defines whether ScrollTips are displayed during vertical scrolling.
Sel	Defines the selection status of an item (multiple selection tree only).
SelCount	Returns the number of currently selected items (multiple selection tree only).
SelectionArea	Defines the area where selection changes occur.
SelectionStyle	Defines the display style of selected items.
SelectString	Searches a string and selects the matching item.
SelectStringExact	Searches a string and selects the matching item.
SelItemRange	Selects or deselects a range of items (multiple selection tree only).
SelItems	Fills an array with the index numbers of currently selected items.
SelItemsArray	Returns an array of SFTTREE_SELENTRY structures describing groups of selected items.
Show3D	Defines the current display method used for items.
ShowBitmaps	Returns a value indicating the presence of item pictures.
ShowButton0	Defines the presence of level 0 expand/collapse buttons.
ShowButtons	Defines the presence of expand/collapse buttons (other than level 0).
ShowFocus	Defines whether a focus rectangle is drawn around the current item when the tree control has the input focus.
ShowGrid	Defines the presence of grid lines.
ShowHeader	Defines the presence of column headers.
ShowHeaderButtons	Defines the presence of column header buttons.
ShowLabels	Returns the presence of label pictures.
ShowPlusMinus	Returns the presence of plus/minus bitmaps.
ShowRowColHeaderButton	Defines the row/column header's display style.
ShowRowHeader	Defines the row header display style.
ShowTruncated	Defines whether text is clipped or truncated using trailing "...".
Sibling	Returns an item's sibling information.
SortDependents	Sorts items.
SplitColumn	Defines the number of columns displayed in the left pane of a split tree control.
SplitterOffset	Defines the offset of the splitter bar relative to the left edge of the tree control's client area.
SplitterRect	Returns the location of the splitter bar in client area coordinates.
SplitterWidth	Defines the width of the splitter bar in a split tree control.
StartAutoExpandTimer	Starts a timer for the specified item, so a SFTTREEN_AUTOEXPANDING notification will be sent.
StopAutoExpandTimer	Ends a started SFTTREEN_AUTOEXPANDING notification timer.
TabKeyIntercept	Defines the status of Tab key handling during cell editing.
Text	Defines an item's cell text.
TextLength	Returns the length of an item's cell text.
ToolTipAlways	Defines whether ToolTips are shown even if cell text is not truncated.
ToolTipsCallback	Defines an application supplied callback function, which can define the ToolTip text when a ToolTip or ScrollTip is to be displayed.
ToolTipsUseEntireCell	Defines whether ToolTips use the entire cell.
TopIndex	Defines the index number of the item shown at the top of the tree control.
TopParent	Returns the highest level parent index number for an item.
TreeLineStyle	Defines the display style of tree lines.
UnregisterApp	Unregisters an application from SftTree/DLL.
UpdateCaretExpandCollapse	Defines whether the current location (caret) is updated when the expand/collapse buttons are used.
UseSmoothScroll	Defines whether smooth scrolling is used.
UseThemes	Defines whether the control can use Windows themes.
VAlign	Defines the vertical alignment of tree lines, label pictures, plus/minus bitmap and item pictures.
VirtualCount	Defines the number of items when using a virtual data source.
VirtualInitialize	Initializes a tree control for virtual mode and for use with a virtual data source.
VirtualItemChanged	Notifies a tree control using a virtual data source that items have been changed.
VirtualUserData	Returns the application defined value last used in the SFTTREE_VIRTUALDEF structure when VirtualInitialize was called.