Professional User Interface Suite, Copyright FOSS Software Inc. Help Published with Permission.

Properties

g_nMsgTreeItemDelayedFocus Registered message which notifies about a delayed focus change event.
m_bmpTreeBoxCollapsed Skin for a collapse/expand button when it is collapsed.
m_bmpTreeBoxCollapsedHover Skin for a collapse/expand button when it is collapsed and hovered.
m_bmpTreeBoxExpanded Skin for a collapse/expand button when it is expanded.
m_bmpTreeBoxExpandedHover Skin for a collapse/expand button when it is expanded and hovered.

Classes

~CExtTreeCtrl Destructor.
AutoDisableChildrenItemsGet Returns true if all child items of a tree item become disabled when this item becomes disabled or false when this change of state of the tree item does not affect state of its child items.
AutoDisableChildrenItemsSet Specifies if all child items of a tree item become disabled when this item becomes disabled or false when this change of state of the tree item does not affect state of its child items.
CExtTreeCtrl Constructor.
EnableItem Enables or disables a tree item.
ExpandCollapseButtonFillColorGet Returns the background color of the expand/collapse button. The COLORREF(-1L) value means the default color, which is white.
ExpandCollapseButtonFillColorSet Specifies the background color of the expand/collapse button.
ExpandCollapseButtonSignColorGet Returns the foreground color of the expand/collapse button. The COLORREF(-1L) value means the default color, which is black.
ExpandCollapseButtonSignColorSet Specifies the foreground color of an expand/collapse button.
ExpandCollapseButtonStyleGet Returns the style of the expand/collapse button.
ExpandCollapseButtonStyleSet Sets the style of the expand/collapse button.
FindItemByText Searches for a tree item by label text and returns the handle of the found tree item if succeded or NULL otherwise.
FocusDisabledItemsGet Returns true if a disabled tree item can become focused or false otherwise.
FocusDisabledItemsSet Specifies if a disabled tree item can become focused.
FocusItem Sets focus on a tree item and optionally selects it and/or deselects all other items.
FullRowSelectionGet Returns true if full row selection is enabled; false otherwise.
FullRowSelectionSet Specifies if full row selection is enabled.
GetFocusedItem Returns a handle of the focused tree item or NULL if no item is focused.
GetInPlaceEditedItem Returns a handle of the currently edited item or NULL if no item is being edited.
GetSelectedItemsList Returns a list of selected tree items.
HasAncestor Returns true if a tree item has some other tree item as its ancestor or false otherwise.
HasButtonsGet Returns true if expand/collapse buttons are visible or false if they are hidden.
HasButtonsSet Specifies if expand/collapse buttons are visible or hidden.
HasItem Returns true if the tree view contains the specified tree item; false otherwise.
HasLinesGet Returns true if tree lines are visible or false if they are hidden.
HasLinesSet Specifies if tree lines are visible or hidden.
HoverCheckBoxesGet Returns true if the check box in a tree item is highlighted when hovered or false otherwise.
HoverCheckBoxesSet Specifies if the check box in a tree item is highlighted when hovered.
HoverDisabledItemsGet Returns true if a disabled tree item is highlighted when hovered or false otherwise.
HoverDisabledItemsSet Specifies if a disabled tree item is highlighted when hovered.
HoverRadioBoxesGet Returns true if the radio button in a tree item is highlighted when hovered or false otherwise.
HoverRadioBoxesSet Specifies if the radio button in a tree item is highlighted when hovered.
HoverTreeBoxesGet Returns true if an expand/collapse button is highlighted when hovered or false otherwise.
HoverTreeBoxesSet Specifies if an expand/collapse button is highlighted when hovered.
IsItemEnabled Returns true if the tree item is enabled or false otherwise.
IsItemSelected Returns true if the tree item is selected or false otherwise.
LinearItemFromItem Returns the tree item that is above or below the specified tree item by the given number of items in the vertical list of items.
LinearItemGetNext Returns the next tree item that is below the specified tree item in the vertical list of items.
LinearItemGetPrev Returns the previous tree item that is above the specified tree item in the vertical list of items.
LinearItemIsAfter Returns true if the htiAfter item is below the htiFrom item in the vertical list of items.
LinearItemIsBefore Returns true if the htiAfter item is above the htiFrom item in the vertical list of items.
LineColorGet Returns the color of hierarchy tree lines. The COLORREF(-1L) value means the default color, which is black.
LineColorSet Sets the color of hierarchy tree lines.
LinesAtRootGet Returns Indicates if tree lines at root tree level should be displayed.
LinesAtRootSet Specifies if the tree lines at root level should be visible or hidden.
LineStyleGet Returns the style of hierarchy tree lines.
LineStyleSet Sets the style of hierarchy tree lines.
LoadWinVistaTreeBox Loads Windows Vista skin images for expand/collapsed buttons.
LoadWinXPTreeBox Loads Windows XP skin images for expand/collapsed buttons.
MultipleSelectionGet Returns true if the user can select more than one tree item at a time; only one tree item otherwise.
MultipleSelectionSet Specifies if the user can select more than one tree item at a time.
MarginCheckBoxLeftGet Returns the left margin of the check box that comes next to the label on the left in a tree item.
MarginCheckBoxLeftSet Sets the left margin of the check box that comes next to the label on the left in a tree item.
MarginCheckBoxRightGet Returns the right margin of the check box that comes next to the label on the left in a tree item.
MarginCheckBoxRightSet Sets the right margin of the check box that comes next to the label on the left in a tree item.
MarginControlLabelLeftGet Returns the left margin of the control that comes next to the label on the right in a tree item.
MarginControlLabelLeftSet Sets the left margin of the control that comes next to the label on the right in a tree item.
MarginControlLabelRightGet Returns the right margin of the control that comes next to the label on the right in a tree item.
MarginControlLabelRightSet Sets the right margin of the control that comes next to the label on the right in a tree item.
MarginIconLeftGet Returns the left margin of the icon in a tree item.
MarginIconLeftSet Sets the left margin of the icon in a tree item.
MarginIconRightGet Returns the right margin of the icon in a tree item.
MarginIconRightSet Sets the right margin of the icon in a tree item.
MarginLabelLeftGet Returns the left margin of the label in a tree item.
MarginLabelLeftSet Sets the left margin of the label in a tree item.
MarginLabelRightGet Returns the right margin of the label in a tree item.
MarginLabelRightSet Sets the right margin of the label in a tree item.
PaddingLabelLeftGet Returns the left padding of the label.
PaddingLabelLeftSet Sets the left padding of the label.
PaddingLabelRightGet Returns the right padding of the label.
PaddingLabelRightSet Sets the right padding of the label.
ProgressBackgroundColorGet Returns the background color of the progress control next to the label on the right in a tree item. The COLORREF(-1L) value means the default color, which is COLOR_HIGHLIGHTTEXT.
ProgressBackgroundColorSet Sets the background color of the progress control next to the label on the right in a tree item.
ProgressBorderColorGet Returns the border color of the progress control next to the label on the right in a tree item. The COLORREF(-1L) value means the default color, which is COLOR_3DDKSHADOW.
ProgressBorderColorSet Sets the border color of the progress control next to the label on the right in a tree item.
ProgressForegroundColorGet Returns the foreground color of the progress control next to the label on the right in a tree item. The COLORREF(-1L) value means the default color, which is COLOR_HIGHLIGHT.
ProgressForegroundColorSet Sets the foreground color of the progress control next to the label on the right in a tree item.
ReadOnlyLabelsGet Returns true if the label in a tree item is read-only; editable otherwise.
ReadOnlyLabelsSet Specifies if the label in a tree item is read-only or editable.
SelectCollapsedItemsGet Returns true if when an item becomes selected, its child items become selected too; otherwise, the child items do not change their selection states.
SelectCollapsedItemsSet Specifies whether when an item becomes selected, its child items become selected too or the child items do not change their selection states.
SelectDisabledItemsGet Returns true if a disabled item can be selected or false if it cannot be selected.
SelectDisabledItemsSet Specifies if a disabled item can be selected or not.
SelectItem Selects or deselects the tree item.
SelectItemRange Selects or deselects the continuous range of tree items.
ShowSelectionAlwaysGet Returns true if a selected item remains highlighted when the tree view loses focus; the item restores its normal visual state otherwise.
ShowSelectionAlwaysSet Specifies if a selected item remains highlighted when the tree view loses focus.
SingleExpandGet Returns true if a tree item that receives focus becomes automatically expanded and the previously focused item becomes collapsed. The method returns false if the expanded/collapsed state of the items do not change.
SingleExpandSet Specifies whether a tree item that receives focus becomes automatically expanded and the previously focused item becomes collapsed.
SubtractSelectionGet Returns true if a subtractive selection is turned on or false otherwise.
SubtractSelectionSet Turns on or off a subtractive selection.
TrackSelectionGet Returns true if the label of a hovered tree item changes its font color and becomes underlined or false if the label does not change its style.
TrackSelectionSet Specifies if the label of a hovered tree item changes its font color and becomes underlined.
TreeBkColorGet Returns the background color of the tree view. The COLORREF(-1L) value means the default color (COLOR_WINDOW).
TreeBkColorSet Sets the background color of the tree view.
TreeGetDisplayedItemCount Returns the number of tree items displayed in the client area of the tree view.
TreeGetStyle
TreeGetStyleEx Returns the extended styles applied to the tree view.
TreeIconAdd Adds an icon object to the internal collection of icon objects.
TreeIconGetAt Returns the icon object by its zero-based index.
TreeIconGetCount Returns the number of icon objects in the internal collection of icons.
TreeIconInsert Inserts an icon object into the internal collection of icons.
TreeIconRemove Removes the specified number of icon objects from the internal collection of icons.
TreeIconRemoveAll Removes all icons from the internal collection of icons.
TreeItemCalcLabelWidth Returns the width of the label of the tree item in pixels.
TreeItemHitTest Performs hit testing and returns a handle of the tree item and a set of __EXT_TVHT_*** flags, which describes the result of the hit-testing. The method returns NULL if ptClient does not point to any tree item.
TreeItemInfoGet Returns a reference to the tree item information object by tree item handle.
TreeItemInfoGetPtr Returns a pointer to the tree item information object by tree item handle.
TreeItemIsExpanded Returns true if the tree item is expanded or false if it is collapsed.
TreeItemRectGet Returns a rectangle of the tree item or its part in client coordinates of the tree view. The method also returns true if succeeded or false otherwise.
TreeItemRectsGet Returns the rectangle of the entire tree item and the rectangles of its parts in client coordinates of the tree view. The method returns true if succeeded or false otherwise.
TreeModifyStyle Modifies the basic styles of the tree view.
TreeModifyStyleEx �Modifies the extended styles of the tree view.

Overridables

OnInplaceControlCancel Invoked when in-place editing of the label or the control next to the label on the right was cancelled.
OnInplaceControlComplete Invoked when the user finished editing the label or the control next to the label on the right.
OnInplaceControlCreate Invoked when the control next to the label on the right is attached to the tree item and returns the handle of the created control if succeeded or NULL otherwise.
OnPaintEntireTree Invoked to paint the entire content of the tree view.
OnPaintTreeItem Invoked to paint the tree item.
OnPaintTreeItemBackground Invoked to paint the background of the tree item.
OnPaintTreeItemCheckBox Invoked to paint the check box in the tree item.
OnPaintTreeItemControl Invoked to paint the control next to the label on the right.
OnPaintTreeItemIcon Invoked to paint the icon in the tree item.
OnPaintTreeItemLines Invoked to paint the hierarchy lines of the item.
OnPaintTreeItemRadioBox Invoked to paint the check box when it is to be painted as a radio button.
OnPaintTreeItemText Invoked to paint the text of the label in the tree item.
OnPaintTreeItemExpandCollapseButton Invoked to paint the expand/collapse button in the tree item.
OnQueryItemEnabledState Invoked to determine the enabled state of the tree item and returns true is the item is enabled or false if disabled.
OnQueryItemFont Returns the font used for drawing text in the label and in the control next to the label on the right.
OnQueryWindowFocusedState Returns true if the tree view is focused or false otherwise.
OnTreeItemCalcCheckBoxAreaWidth Returns the width of check box in a tree item in pixels.
OnTreeItemContextMenu Invoked to display the context menu over a tree item.
OnTreeItemDelayedFocus Invoked when the tree item is about to become focused in a delay or it has become focused.
OnTreeItemDoDragDetect Invoked when a mouse button is pressed and hold down for drag-n-drop starting detection and returns true if the event has been processed and drag-n-drop detected or false otherwise. Default implementation returns false if the tree control has no the TVS_DISABLEDRAGDROP window style or mouse was pressed not on the tree item�s icon or label. Otherwise performs drag-n-drop starting detection and sends the TVN_BEGINDRAG notification to the parent window of the tree control.
OnTreeItemHoverChanged Invoked when the tree item becomes hovered.
OnTreeItemQueryIcon Returns the icon in the tree item.
OnTreeItemSetCursor Invoked to set the mouse pointer on the tree item.
OnTreeItemUnRegisterData Invoked when the tree item is removed from the tree view.
OnTreeMouseClick Invoked to handle a mouse click event over the tree view and returns true if the event has been processed or false otherwise.
OnTreeMouseMove Invoked to handle mouse movement over the tree view.

See Also

CExtTreeCtrl Overview | Hierarchy Chart