CTreeOptionsCtrl v1.74

Welcome to CTreeOptionsCtrl, a control which implements a tree options control similar to the advanced tab as seen on the "Internet Options" dialog in Internet Explorer 4 and later. In addition to Boolean values, it also allows edit boxes, combo boxes, file browser, folder browsers, color browsers, font browsers, font name combo boxes, general opaque objects, date controls, time controls and IP address controls to be included in the tree control, similar to the new printer property dialogs which were introduced in Windows 2000. Included below is a snapshot showing the demo application and what the control looks like.

Features

• Derived from the MFC class CTreeCtrl so if you have used this class before, then you should get up to speed using the CTreeOptionsCtrl pretty easily.
• Items supported included check boxes, radio buttons, semi check boxes, edit boxes, combo boxes (drop list and editable), Edit boxes with spin control, File browser, Folder browser, Color selector, Font selector, Font Name selector and Boolean selector <g>!.
• Code is UNICODE enabled and build configurations are provided.
• All widget classes (e.g. Combo boxes and edit boxes) that are created can be customized without affected the base code.
• All code compiles cleanly at level 4.
• Small footprint, total size amounts to just c. 2400 lines of code, for such a large amount of functionality.

Copyright

• You are allowed to include the source code in any product (commercial, shareware, freeware or otherwise) when your product is released in binary form.
• You are allowed to modify the source code in any way you want except you cannot modify the copyright details at the top of each module.
• If you want to distribute source code with your application, then you are only allowed to distribute versions released by the author. This is to maintain a single distribution point for the source code.

Usage

• To use the class in your code simply include TreeOptionsCtrl.cpp in your project and #include "TreeOptionsCtrl.h" in which ever of your modules needs to make calls to the class.
• You also need to copy over the strings from the sample apps string table (IDS_TREEOPTIONS_...)
• Your code will need to include MFC either statically or dynamically.
• As of v1.70, the classes are now designed for VC 2005 or later. They will not compile on earlier releases of VC.
• To see the class in action, have a look at the usage of the code in the module "appDlg.cpp".
• Please note that the functions SetItemData and GetItemData which the class inherits from CTreeCtrl can no longer be used safely since CTreeOptionsCtrl use the item data for internally allocated data. All usage of GetItemData should be replaced by usage of GetUserItemData and SetUserItemData instead.
• Please note that by default the descriptive text you display for an item should not include the text ": ". This is because this text is used as the divider between the descriptive text and the actual data to be edited. You can change this using the "SetTextSeparator" method.
• You should ensure that you hook up an image list to the control via SetImageList (even if you don't intend for your items to have icons). This is because the classes uses the space allocated for the image list icon as the place to put the custom draw bitmaps.

History

V1.0 (2 April 1999)

• Initial public release.

V1.01 (20 April 1999)

• Minor Update to the bitmap which is used as the image list for the tree control.

V1.1 (21 April 1999)

• Added full support for enabling / disabling of group, check box and radio button items.

V1.11 (5 October 1999)

• Made class more self contained by internally managing the image list.

V1.2 (8 October 1999)

• Added support for including combo boxes as well as edit boxes into the edit control.
• Added support for customizing the image list to use

V1.21 (29 February 2000)

• Removed a VC 6 level 4 warning

V1.22 (3 April 2000)

• Added support for navigation into and out of the combo boxes and edit controls inside the control.

V1.23 (10 May 2000)

• Fixed a bug where the text was not being transferred to the control when the in place combo or edit box is active and the tree control gets destroyed.
• Added support for having check box items as children of other check box items
• Setting the check box state of a parent now also sets the check box state for all child box children.
• Setting the check box state affects the check box state of the parent if that parent is also a check box.

V1.24 (30 May 2000)

• Code now uses ON_NOTIFY_REFLECT_EX instead of ON_NOTIFY_REFLECT. This allows derived classes to handle the reflected messages also.

V1.25 (3 July 2000)

• Now includes support for edit boxes with accompanying spin controls.

V1.26 (25 April 2001)

• Creation of the image list is now virtual. This allows customisation such as being able to use high color bitmaps
• Added an option which determines if check box state should be changed when you click anywhere on an item or just over the checkbox icon
• Updated copyright message

V1.30 (12 August 2001)

• Fixed an issue in GetComboText and GetEditText where the code was modifying the contents of the combo/edit box when it was being read. This was because that function is doing double duty as it is called when the child control is about to be created in place, and you want to remove the text from the tree control and put it in the child control. Thanks to "Jef" for spotting this.
• Made the code in SetComboText more robust. Thanks to "Jef" for this also.
• Added a DDX method for integers in a edit box. Thanks to Colin Urquhart for this.
• Added a extra member to _TreeOptionsItemData to be used as an item data. This allows you to avoid having to implement multiple derived classes and instead use the item data to stash away pointers etc.

V1.31 (27 August 2001)

• Provided a "GetUserItemData" member to provide access to the item data provided by the class. Thanks to Colin Urquhart for this.
• Fixed a redraw problem which occurred when you scrolled using an wheel enabled mouse. Thanks to "Jef" for spotting this.
• Provided an AutoSelect option which automatically sets focus to child control in the tree control. Thanks to "Jef" for this suggestion.
• Added full support for CBS_DROPDOWN and CBS_SIMPLE style combo boxes. Thanks to "Jef" for this suggestion.

V1.4 (17 October 2001)

• Provided support for specify a color via CColorDialog.
• Controls are now created to fill the full width of the tree control.
• Provided support for specifying a font via CFontDialog.
• Provided support for specifying a font name from a combo box.
• Provided support for specifying a Boolean value from a combo box.

V1.41 (27 November 2001)

• Fixed a bug where the message map for OnMouseWheel was setup incorrectly. It should have been ON_WM_MOUSEWHEEL instead of ON_MESSAGE!!!.
• Allowed passing in the hAfter item for the InsertItem calls. All params are defaulted as to not affect any current code.
• Made possible the use of radio button groups followed by other items (in which case the group is considered complete).
• Added a couple of utility functions at the bottom of the cpp file. Thanks to Mike Funduc for all these updates.

V1.42 (5 December 2001)

• Minor code tidy up following development of the author's CListOptionsCtrl class

V1.43 (13 December 2001)

• Fixed an assertion in OnClick. Thanks to "flipposwitch" for spotting the problem.

V1.44 (14 February 2002)

• Now allows item data to be associated with any item added to the control.
• Fixed issue with return value from GetUserItemData.

V1.45 (2 June 2002)

• Moved sample app to VC 6 to facilitate support for IP Address control and date and time controls.
• Fixed a bug where the child controls can get orphaned when a node in the tree control is expanded or contracted. Thanks to Lauri Ott for spotting this problem.
• Now fully supports the CDateTimeCtrl for editing of dates and times
• Now fully supports the CIPAddressCtrl for editing of IP addresses
• Custom draw support for color browser items is now configurable via an additional parameter of the AddColorBrowser method

V1.46 (24 September 2002)

• Updated documentation which incorrectly stated that the parent of a check box item must be a group item as inserted with InsertGroup. Thanks to Kögl Christoph for spotting this.
• Fixed an issue with "IMPLEMENT_DYNAMIC(CDateTimeCtrl..." not being declared properly. Some users reported that it worked ok, while others said that my fix was causing link problems. The problem should be sorted out for good now. Thanks to Kögl Christoph for reporting this.
• Renamed the SetImageListToUse function to "SetImageListResourceIDToUse".
• Provided a GetImageListResourceIDToUse function to match up with the Set function.
• Provided a method to allow the user item data to be changed after an item has been created.
• Provided some documentation info on how to safely use item data in the control. Thanks to Kögl Christoph for reporting this.
• Fixed a potential memory leak in AddComboBox if the function is invoked twice without an explicit delete of the item first. Thanks to Kögl Christoph for reporting this.
• Fixed some typos in the documentation. It incorrectly stated that the return type of member functions InsertGroup, InsertCheckBox, and InsertRadioButton is BOOL when in fact it is HTREEITEM.  Thanks to Kögl Christoph for reporting this.
• Improved the look of the disabled checked check button. Thanks to Kögl Christoph for reporting this.
• Improved the look of the disabled radio button which is selected. Thanks to Kögl Christoph for reporting this.

V1.47 (17 October 2002)

• Added a method to add an "Opaque Browser" to the Tree options control. An Opaque Browser is where the tree options control allows a end user specified structure to be edited by the tree options control without it explicitly knowing what it is editing.

V1.48 (25 October 2002)

• Updated the download to include the missing files OpaqueShow.cpp/h. Thanks to Kögl Christoph for reporting this.
• Made the class more const-correct. e.g. the Get... member functions are now const. Thanks to Kögl Christoph for reporting this. Also updated the documentation for this.
• Updated the documentation to refer to the "Opaque Browser" support.

V1.49 (28 October 2002)

• Fixed a bug where upon a combo losing focus it will also result in the associated button control would also be destroyed. Thanks to Kögl Christoph for reporting this problem. Fixed this bug should also fix an intermittent release bug which was occurring in this area.

V1.50 (30 October 2002)

• Made a number of other methods const. Thanks to Kögl Christoph for reporting this.

V1.51 (15 November 2002)

• Now allows the Field Data separator i.e. ": " to be configured. Please note that the characters you pick should be avoided in the descriptive text you display for an item as it is used as the divider between the descriptive text and the actual data to be edited. Thanks to Kögl Christoph for this update.
• Fixed an access violation in CTreeOptionsCtrl::OnSelchanged when there is no selected item in the control. Thanks to Kögl Christoph for this update.

V1.52 (6 February 2003)

• Fixed a memory leak which can occur when the control is used in a property sheet. Thanks to David Rainey for reporting this problem.
• Fixed another memory leak in the destructor of the CTreeOptionsCtrl class when the test app is closed.
• Did a spell check on the documentation <g>

V1.53 (14 May 2003)

• Fixed a bug where the OnSelChanged function was getting in the way when the control was being cleared down, leading to an ASSERT. Thanks to Chen Fu for reporting this problem.

V1.54 (7 June 2003)

• Fixed a bug where the date time control was not reflecting the changes when the child control was displayed. Thanks to Tom Serface for reporting this problem.

V1.55 (17 July 2003)

• Made SetRadioButton methods in CTreeOptionsCtrl virtual to allow further client customisation.

V1.56 (26 July 2003)

• Fix an issue where the child controls get drawn in the wrong place, if the item is just on the vertical (either top or bottom) edge of the client area. Thanks to Kögl Christoph for reporting this problem and providing the fix.

V1.6 (31 July 2003)

• Now class does not require the use of the built in image list. This means that now the class behaves like its parent class CTreeCtrl in that management of the image list is entirely outside of the class and client code calls SetImageList as per normal.
• Class now draws the radio and check box icons using custom draw.
• Class now takes advantage of XP Visual Themes when available.
• Made a number of additional functions virtual to allow more types of client customisation

V1.61 (2 August 2003)

• Now supports multi-line edit controls as a child control.

V1.62 (18 September 2003)

• Fixed a bug when the control draws the custom draw icons when the control does not have an image list attached. Thanks to Benoit Lariviere for reporting this problem.
• Fixed a bug where the control draws the custom draw icons in the wrong position when the control has horizontal scroll bars. Thanks to Benoit Lariviere for reporting this problem.

20 September 2003

• Updated documentation to better explain how to use the class.

V1.63 (11 December 2003)

• Implemented the function SetUseThemes which was missing. Thanks to Marcel Scherpenisse for reporting this problem. Also updated the sample app to enable toggling of this setting.
• Improved the default look of radio buttons and check boxes when the control is not XP themed. This is achieved using the virtual function GetItemIconPosition. Thanks to Marcel Scherpenisse for reporting this issue. This update also means that by default radio buttons and check boxes are by default draw as 16*16 icons centred in the icon position for each item. This can of course by overridden by derived classes.

V1.64 (5 February 2004)

• Made HandleChildControlLosingFocus public so that it can be called from outside the class. This is useful in the following scenario reported by RnySmile: I noticed a bug happened only if it is used in a Property Page. I added an Edit item, and when user leaves that item with a child control active while tabbing away to another tab, the data of that item will lost. The solution is to ensure HandleChildControlLosingFocus is called before a DDX_Tree... function is called if a child control is active.

V1.65 (5 May 2004)

• Fixed some compiler warnings when the code is compiled using VC 7.x. Please note that to implement these fixes, the code will now require the Platform SDK to be installed if you compile the code on VC 6.

V1.66 (26 January 2005)

• Both of the sample apps shipped with the class now include XP manifest files, meaning that the full look and feel of XP Themes are shown. Thanks to Piotr Zagawa for reporting this issue.

V1.67 (16 March 2005)

• Fix for crash when you have one of the edit controls in a IP address control selected and you then select another item in the tree options control. Hard to know if this is a bug in the control on in Windows itself. Either way, the workaround fix is to ensure that the child windows of an IP Address control are destroyed before we destroy the IP address control itself. Thanks to Steve Hayes for reporting this problem.

V1.68 (11 July 2006)

• Updated copyright details
• Removed unused constructor and destructor methods from some of the classes in the sample app.
• Replaced calls to ZeroMemory with memset
• Addition of CTREEOPTIONSCTRL_EXT_CLASS macro to allow the code to be easily added to an extension dll.
• Class now uses private messages based at WM_USER instead of WM_APP
• Optimized CTreeOptionsCtrl constructor code.
• Optimized CTreeOptionsCombo constructor code.
• Optimized CTreeOptionsDateCtrl constructor code
• Reworked CTreeOptionsDateCtrl::GetDisplayText logic
• Reworked CTreeOptionsTimeCtrl::GetDisplayText logic
• Optimized CTreeOptionsIPAddressCtrl constructor code
• Optimized CTreeOptionsEdit constructor code
• Optimized CTreeOptionsSpinCtrl constructor code
• Optimized CTreeOptionsBrowseButton constructor code
• Replaced calls to CopyMemory with memcpy
• Optimized CMultiLineEditFrameWnd constructor code
• Removed common control 6 manifest as this conflicts with VC 2005 compilation.
• Updated the code to clean compile on VC 2005.
• Updated documentation to use the same style as the web site.

V1.69 (23 December 2007)

• Updated copyright details.
• Removed VC 6 style AppWizard comments from the code.
• Optimized CTreeOptionsItemData constructor code
• Boolean member variables of CTreeOptionsItemData have now been made "bool" instead of "BOOL".
• Fixed an issue where if you create a combo box with a style of CBS_DROPDOWN instead of CBS_DROPDOWNLIST, then the combo box would not be properly deactivated when it loses focus to a control outside of the TreeOptionsCtrl while the cursor is in the combo box edit field. Thanks to Tobias Wolf for reporting this issue.
• Fixed a crash where you select a combo box item, select something in it and then hit tab.
• Focus is now correctly transferred to a tree options button if you hit tab on a tree options combo box.
• GetBrowseForFolderCaption, GetBrowseForFileCaption and GetFileExtensionFilter all now by default use a string resource.

V1.70 (21 June 2008)

• Updated copyright details
• Code now compiles cleanly using Code Analysis (/analyze)
• Updated code to compile correctly using _ATL_CSTRING_EXPLICIT_CONSTRUCTORS define
• The code now only supports VC 2005 or later.
• Replaced all calls to CopyMemory with memcpy
• Fixed a bug in the CTreeOptionsCtrl constructor when checking the validity of the function pointers for XP Theming.
• Fixed a bug in the sample app's COpaqueShoeButton2::BrowseForOpaque function

V1.71 (20 July 2008)

• Added two missing files to the download zip file specifically the correct sln and vcproj files. Thanks to Ingmar Koecher for reporting this issue.
• Radio buttons and check boxes now by default use a more 3d style of drawing when XP theming is not active. You can revert back to a more flat style of drawing these items by SetFlatStyleRadioButtons(TRUE) and SetFlatStyleCheckBoxes(TRUE) respectively. Thanks to Ingmar Koecher for reporting this issue.

V1.72 (29 April 2012)

• Updated copyright details.
• Updated sample project settings to more modern defaults
• Code now compiles cleanly using Code Analysis (/analyze)
• When the parent node of a group of checkboxes is also a checkbox (e.g. the Node "Security" in the test app) the parent is checked / unchecked depending on the status of its children whenever a child is modified in the GUI. This previously worked ok when you changed the checkmark of a child in the GUI by mouse or keyboard, but it doesn't work if the change is made programmatically (via SetCheckBox or by means of the referenced boolean variable). The code has now been updated to handle this anomaly. Thanks to Michael Oerder for providing this nice update.

V1.73 (21 May 2012)

• Updated the code to draw disabled items in gray text. Thanks to Damir Valiulin for this nice addition.

V1.74 (16 March 2015)

• Updated copright details.
• Updated the code to clean compile on VC 2013
• Code no longer uses LoadLibrary without an absolute path when loading XP Theming DLL. This avoids DLL planting security issues.

API Reference

The API consists of the following class members and global functions

CTreeOptionsCtrl::InsertGroup
CTreeOptionsCtrl::InsertCheckBox
CTreeOptionsCtrl::InsertRadioButton
CTreeOptionsCtrl::IsGroup
CTreeOptionsCtrl::IsCheckBox
CTreeOptionsCtrl::IsEditBox
CTreeOptionsCtrl::IsFileItem
CTreeOptionsCtrl::IsFolderItem
CTreeOptionsCtrl::IsColorItem
CTreeOptionsCtrl::IsFontItem
CTreeOptionsCtrl::IsRadioButton
CTreeOptionsCtrl::SetCheckBox
CTreeOptionsCtrl::GetCheckBox
CTreeOptionsCtrl::GetRadioButton
CTreeOptionsCtrl::SetRadioButton
CTreeOptionsCtrl::SetGroupEnable
CTreeOptionsCtrl::SetCheckBoxEnable
CTreeOptionsCtrl::SetRadioButtonEnable
CTreeOptionsCtrl::GetRadioButtonEnable
CTreeOptionsCtrl::GetCheckBoxEnable
CTreeOptionsCtrl::AddComboBox
CTreeOptionsCtrl::AddEditBox
CTreeOptionsCtrl::AddFileEditBox
CTreeOptionsCtrl::AddFolderEditBox
CTreeOptionsCtrl::GetComboText
CTreeOptionsCtrl::GetEditText
CTreeOptionsCtrl::GetFileEditText
CTreeOptionsCtrl::GetFolderEditText
CTreeOptionsCtrl::SetComboText
CTreeOptionsCtrl::SetEditText
CTreeOptionsCtrl::SetFileEditText
CTreeOptionsCtrl::SetFolderEditText
CTreeOptionsCtrl::AddColorSelector
CTreeOptionsCtrl::GetColor
CTreeOptionsCtrl::SetColor
CTreeOptionsCtrl::AddFontSelector
CTreeOptionsCtrl::GetFontItem
CTreeOptionsCtrl::SetFontItem
CTreeOptionsCtrl::AddOpaque
CTreeOptionsCtrl::SetOpaque
CTreeOptionsCtrl::IsOpaque
DDX_TreeCheck
DDX_TreeRadio
DDX_TreeEdit
DDX_TreeCombo
DDX_TreeFileEdit
DDX_TreeFolderEdit
DDX_TreeColor
DDX_TreeFont
DDX_TreeBoolean

HTREEITEM InsertGroup(LPCTSTR lpszItem, int nImage, HTREEITEM hParent = TVI_ROOT,  HTREEITEM hAfter = TVI_LAST, DWORD_PTR dwItemData = 0);

The group item's tree identifier.

lpszItem The text of the item to add.

nImage The zero based index of the icon in the tree controls image list to use for this group item.

hParent Handle of the parent where the item should be inserted.

hAfter The item to insert this item after.

dwItemData The custom item data you want to use with this tree item. This can be used for whatever you want e.g. to maintain a pointer to a custom structure.

Remarks

Adds a group item to the tree control. A group item is the parent of either a collection of radio items or check items. In the sample app, the two items which are group items are "Accessibility (Example of check options)" and "When Searching (Example of radio options)". The first 8 icons of the image list associated with the tree options control are reserved and you should specify a "nImage" value greater than 7 when adding a group item. By default the function will add items at the root level of the tree control but you can add them at any depth using the "hParent" parameter. You can see this in the "Internet options" dialog which the control emulates.

HTREEITEM InsertCheckBox(LPCTSTR lpszItem, HTREEITEM hParent, BOOL bCheck = TRUE, HTREEITEM hAfter = TVI_LAST, DWORD_PTR dwItemData = 0);

The check box item identifier.

lpszItem The text of the item to add.

hParent Handle of the parent where the item should be inserted.

bCheck The initial checked state of the check box. TRUE if the item is to be checked, FALSE to leave it unchecked.

hAfter The item to insert this item after.

dwItemData The custom item data you want to use with this tree item. This can be used for what ever you want e.g. to maintain a pointer to a custom structure.

Remarks

Adds a check box item to the tree control. A check box item behaves the same as a normal check box. Using the space bar or left mouse button will toggle its state.

HTREEITEM InsertRadioButton(LPCTSTR lpszItem, HTREEITEM hParent, BOOL bCheck = TRUE, HTREEITEM hAfter = TVI_LAST, DWORD_PTR dwItemData = 0);

The radio button item identifier.

lpszItem The text of the item to add.

hParent Handle of the parent where the item should be inserted.

bCheck The initial checked state of the check box. TRUE if the item is to be checked, FALSE to leave it unchecked.

hAfter The item to insert this item after.

dwItemData The custom item data you want to use with this tree item. This can be used for whathever you want e.g. to maintain a pointer to a custom structure.

Remarks

Adds a radio button item to the tree control. A radio button item behaves the same as a normal radio button i.e. when a radio button is checked all the other items in the same group are unchecked. Using the space bar or left mouse button will toggle its state. The parent of the radio button item must be a group item as added with InsertGroup

BOOL IsGroup(HTREEITEM hItem) const;

TRUE if the specified item is a group item otherwise FALSE.

hItem Handle of the item to check the type of.

Checks to see if the specified item is a group item i.e. an item which is the parent of a collection of radio button or check box items.

BOOL IsCheckBox(HTREEITEM hItem) const;

TRUE if the specified item is a check box item otherwise FALSE.

hItem Handle of the item to check the type of.

Checks to see if the specified item is a check box item.

BOOL IsEditBox(HTREEITEM hItem) const;

TRUE if the specified item is a edit box item otherwise FALSE.

hItem Handle of the item to check the type of.

Checks to see if the specified item is a edit box item.

BOOL IsFileItem(HTREEITEM hItem) const;

TRUE if the specified item is a file browser item otherwise FALSE.

hItem Handle of the item to check the type of.

Checks to see if the specified item is a file browser item.

BOOL IsFolderItem(HTREEITEM hItem) const;

TRUE if the specified item is a folder browser item otherwise FALSE.

hItem Handle of the item to check the type of.

Checks to see if the specified item is a folder browser item.

BOOL IsColorItem(HTREEITEM hItem) const;

TRUE if the specified item is a color browser item otherwise FALSE.

hItem Handle of the item to check the type of.

Checks to see if the specified item is a color browser item.

BOOL IsFontItem(HTREEITEM hItem) const;

TRUE if the specified item is a font browser item otherwise FALSE.

hItem Handle of the item to check the type of.

Checks to see if the specified item is a font browser item.

BOOL IsRadioButton(HTREEITEM hItem) const;

TRUE if the specified item is a radio button item otherwise FALSE.

hItem Handle of the item to check the type of.

Checks to see if the specified item is a radio button item.

BOOL IsOpaque(HTREEITEM hItem) const;

TRUE if the specified item is an "Opaque Browser" item otherwise FALSE.

hItem Handle of the item to check the type of.

Checks to see if the specified item is an "Opaque Browser" item.

BOOL SetCheckBox(HTREEITEM hItem, BOOL bCheck);

TRUE if the check state of the item was successfully changed otherwise FALSE.

hItem Handle of the item to change the checked state of.

bCheck The state of the check box to be set. TRUE if the item is to be checked, FALSE to uncheck the item.

Changes the checked state of a check box item.

BOOL GetCheckBox(HTREEITEM hItem, BOOL& bCheck) const;

Return Value

TRUE if the check state of the item was successfully retrieved otherwise FALSE.

hItem Handle of the item to retrieve the checked state of.

bCheck Upon successful return, this will contain the state of the check box. TRUE if the item is checked, FALSE if unchecked.

Retrieves the checked state of a check box item.

BOOL SetRadioButton(HTREEITEM hParent, int nIndex);

BOOL SetRadioButton(HTREEITEM hItem);

TRUE if the check state of the specified radio button in the specified group was successfully set otherwise FALSE.

hParent Handle of the parent group item which contains the radio button items.

nIndex The index of the radio button in the group to select.

hItem The item in the radio button group to check.

Changes the checked state of the specified item in the specified radio button group. The item specified by the value "nIndex" or "hItem" is checked and all the other items in the group are unchecked.

BOOL GetRadioButton(HTREEITEM hParent, int& nIndex, HTREEITEM& hCheckItem) const;

BOOL GetRadioButton(HTREEITEM hItem, BOOL& bCheck) const;

TRUE if the check state was successfully retrieved otherwise FALSE.

hParent Handle of the parent group item which contains the radio button items.

nIndex Upon successful return, this will contain the index of the radio button in the group which is checked.

hCheckItem Upon successful return, this will contain the handle of the radio button item which is checked.

hItem Handle of the radio button item to check the state of.

bCheck Upon successful return, this will contain the state of the radio button. TRUE if the item is checked, FALSE if unchecked.

Retrieves the checked state of a radio button item.

BOOL SetGroupEnable(HTREEITEM hItem, BOOL bEnable);

TRUE if the check state of the items in the group were successfully enabled / disabled.

hItem Handle of the group item to enable or disable.

bEnable TRUE if the items should be enabled, FALSE to disable the items.

Enables or disables all the items under a group item.

BOOL SetCheckBoxEnable(HTREEITEM hItem, BOOL bEnable);

TRUE if the check state of the check box item was successfully enabled / disabled.

hItem Handle of the check box item to enable or disable.

bEnable TRUE if the item should be enabled, FALSE to disable the item.

Enables or disables the specified check box item.

BOOL SetRadioButtonEnable(HTREEITEM hItem, BOOL bEnable);

TRUE if the check state of the radio button item was successfully enabled / disabled.

hItem Handle of the radio button item to enable or disable.

bEnable TRUE if the item should be enabled, FALSE to disable the item.

Enables or disables the specified radio button item.

BOOL GetRadioButtonEnable(HTREEITEM hItem, BOOL& bEnable) const;

TRUE if the enabled state of the item was successfully retrieved otherwise FALSE.

hItem Handle of the item to retrieve the enabled state of.

bCheck Upon successful return, this will contain the enabled state of the radio button. TRUE if the item is enabled, FALSE if disabled.

Retrieves the enabled state of a radio button item.

BOOL GetCheckBoxEnable(HTREEITEM hItem, BOOL& bEnable) const;

TRUE if the enabled state of the item was successfully retrieved otherwise FALSE.

hItem Handle of the item to retrieve the enabled state of.

bCheck Upon successful return, this will contain the enabled state of the check box. TRUE if the item is enabled, FALSE if disabled.

Retrieves the enabled state of a check box item.

BOOL AddComboBox(HTREEITEM hItem, CRuntimeClass* pRuntimeClass, DWORD_PTR dwItemData = 0);

TRUE if the combo box item was successfully added otherwise FALSE.

hItem Handle of the item to add the combo box at.

pRuntimeClass The runtime class pointer on a class derived from "CTreeOptionsCombo" which is to be added to the tree options control.

dwItemData The custom item data you want to use with this tree item. This can be used for whatever you want e.g. to maintain a pointer to a custom structure.

Adds a combo box item to the tree control. The combo box by default provides a choice of multiple strings from which to pick. You are free to derive your own class from "CTreeOptionsCombo" to implement customized behavior

BOOL AddEditBox(HTREEITEM hItem, CRuntimeClass* pRuntimeClassEditCtrl, DWORD_PTR dwItemData = 0);

BOOL AddEditBox(HTREEITEM hItem, CRuntimeClass* pRuntimeClassEditCtrl, CRuntimeClass* pRuntimeClassSpinCtrl, DWORD_PTR dwItemData = 0);

TRUE if the edit box item was successfully added otherwise FALSE.

hItem Handle of the item to add the edit box at.

pRuntimeClassEditCtrl The runtime class pointer on a class derived from "CTreeOptionsEdit" which is to be added to the tree options control.

pRuntimeClassSpinCtrl The runtime class pointer on a class derived from "CTreeOptionsSpinCtrl" which is to be attached to the edit box to allow the edit box value to be changed using a standard spin control.

dwItemData The custom item data you want to use with this tree item. This can be used for whathever you want e.g. to maintain a pointer to a custom structure.

Adds a edit box item to the tree control. The edit box by default allows any text to be set. You are free to derive your own class from "CTreeOptionsEdit" to implement customized behavior. You can use the second version of the function to add an edit box along with a standard spin control with it.

BOOL AddFileEditBox(HTREEITEM hItem, CRuntimeClass* pRuntimeClassEditCtrl, CRuntimeClass* pRuntimeClassBrowseButton, DWORD_PTR dwItemData = 0);

TRUE if the edit box item was successfully added otherwise FALSE.

hItem Handle of the item to add the File Browser edit box at.

pRuntimeClassEditCtrl The runtime class pointer on a class derived from "CTreeOptionsEdit" which is to be added to the tree options control.

pRuntimeClassBrowseButton The runtime class pointer on a class derived from "CTreeOptionsBrowseButton" which is to be attached to the edit box to allow the edit box value to be changed using a standard file dialog control.

dwItemData The custom item data you want to use with this tree item. This can be used for whathever you want e.g. to maintain a pointer to a custom structure.

Adds a File Browser edit box item to the tree control. The edit box by default allows any text to be set. You are free to derive your own class from "CTreeOptionsEdit" to implement customized behavior.

BOOL AddFolderEditBox(HTREEITEM hItem, CRuntimeClass* pRuntimeClassEditCtrl, CRuntimeClass* pRuntimeClassBrowseButton, DWORD_PTR dwItemData = 0);

TRUE if the edit box item was successfully added otherwise FALSE.

hItem Handle of the item to add the Folder Browser edit box at.

pRuntimeClassEditCtrl The runtime class pointer on a class derived from "CTreeOptionsEdit" which is to be added to the tree options control.

pRuntimeClassBrowseButton The runtime class pointer on a class derived from "CTreeOptionsBrowseButton" which is to be attached to the edit box to allow the edit box value to be changed using a standard folder selection dialog control.

dwItemData The custom item data you want to use with this tree item. This can be used for whathever you want e.g. to maintain a pointer to a custom structure.

Adds a Folder Browser edit box item to the tree control. The edit box by default allows any text to be set. You are free to derive your own class from "CTreeOptionsEdit" to implement customized behavior.

CString GetComboText(HTREEITEM hItem) const;

The text associated with this combo box item.

hItem Handle of the item to retrieve the combo box text of.

Retrieves the combo text of a combo box item.

CString GetEditText(HTREEITEM hItem) const;

The text associated with this edit box item.

hItem Handle of the item to retrieve the edit box text of.

Retrieves the edit box text of a edit box item.

CString GetEditText(HTREEITEM hItem) const;

The text associated with this edit box item.

hItem Handle of the item to retrieve the edit box text of.

Retrieves the edit box text of a File Browser edit box item.

CString GetEditText(HTREEITEM hItem) const;

The text associated with this edit box item.

hItem Handle of the item to retrieve the edit box text of.

Retrieves the edit box text of a Folder Browser edit box item.

void SetComboText(HTREEITEM hItem, const CString& sComboText);

hItem Handle of the item to change the combo box text of.

sComboText The text to set in the combo box.

Changes the combo box text of a combo box item.

void SetEditText(HTREEITEM hItem, const CString& sEditText);

hItem Handle of the item to change the edit box text of.

sEditText The text to set in the edit box.

Changes the edit box text of a edit box item.

void SetFileText(HTREEITEM hItem, const CString& sEditText);

hItem Handle of the item to change the edit box text of.

sEditText The text to set in the edit box.

Changes the edit box text of a File Browser edit box item.

void SetFolderText(HTREEITEM hItem, const CString& sEditText);

hItem Handle of the item to change the edit box text of.

sEditText The text to set in the edit box.

Changes the edit box text of a Folder Browser edit box item.

BOOL AddColorSelector(HTREEITEM hItem, CRuntimeClass* pRuntimeClassButton, DWORD_PTR dwItemData = 0);

TRUE if the color browser item was successfully added otherwise FALSE.

hItem Handle of the item to add the color browser at.

pRuntimeClassButton The runtime class pointer on a class derived from "CTreeOptionsBrowseButton" which is to be added to the tree options control.

dwItemData The custom item data you want to use with this tree item. This can be used for whathever you want e.g. to maintain a pointer to a custom structure.

Adds a Color Browser item to the tree control. The color browser displays a standard CColorDialog when you hit the browse button. You are free to derive your own class from "CTreeOptionsBrowseButton" to implement customized behavior.

COLORREF GetColor(HTREEITEM hItem) const;

The COLORREF value associated with this color browser item.

hItem Handle of the item to retrieve the COLORREF of.

Retrieves the color of a color browser item.

void SetColor(HTREEITEM hItem, COLORREF color);

hItem Handle of the item to change the color of.

color The color to set in the color browser item.

Changes the edit box text of a edit box item.

BOOL AddFontSelector(HTREEITEM hItem, CRuntimeClass* pRuntimeClassButton, DWORD_PTR dwItemData = 0);

TRUE if the font browser item was successfully added otherwise FALSE.

hItem Handle of the item to add the color browser at.

pRuntimeClassButton The runtime class pointer on a class derived from "CTreeOptionsBrowseButton" which is to be added to the tree options control.

dwItemData The custom item data you want to use with this tree item. This can be used for whathever you want e.g. to maintain a pointer to a custom structure.

Adds a font browser item to the tree control. The font browser displays a standard CFontDialog when you hit the browse button. You are free to derive your own class from "CTreeOptionsBrowseButton" to implement customized behavior.

void GetFontItem(HTREEITEM hItem, LOGFONT* pLogFont) const;

hItem Handle of the item to retrieve the COLORREF of.

pLogFont Upon return this will contain the update LOGFONT structure.

Retrieves the font characteristics of a font browser item.

void SetFontItem(HTREEITEM hItem, const LOGFONT* pLogFont);

hItem Handle of the item to change the color of.

pLogFont pointer to the LOGFONT structure to set in the font browser item.

Changes the edit font characteristics of a font browser item.

BOOL AddOpaque(HTREEITEM hItem, CRuntimeClass* pRuntimeClass1, CRuntimeClass* pRuntimeClass2, DWORD_PTR dwItemData = 0);

TRUE if the opaque browser was successfully added otherwise FALSE.

hItem Handle of the item to add the File Browser edit box at.

pRuntimeClass1 The runtime class pointer on a first class control for this item.

pRuntimeClass2 The runtime class pointer on the second class control for this item.

dwItemData The custom item data you want to use with this tree item. This can be used for whathever you want e.g. to maintain a pointer to a custom structure.

Adds an "Opaque Browser" to the tree control. An Opaque Browser is where the tree options control allows a end user specified structure to be edited by the tree options control without it explicitly knowing what it is editing. 

hItem Handle of the item to change the color of.

dwItemData The item data to set in the "Opaque Browser" item.

Changes the item data of an "Opaque Browser" item.

void DDX_TreeCheck(CDataExchange* pDX, int nIDC, HTREEITEM hItem, BOOL& bCheck);

pDX A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC The resource ID of the tree control associated with the control property.

hItem Handle of the check box item to get/set the state of.

bCheck A reference to a member variable of the dialog box, form view, or control view object with which data is exchanged.

The DDX_TreeCheck function manages the transfer of BOOL data between a check box item in the CTreeOptionsCtrl in a dialog box, form view, or control view object and a BOOL data member of the dialog box, form view, or control view object.

void DDX_TreeRadio(CDataExchange* pDX, int nIDC, HTREEITEM hParent, int& nIndex);

pDX A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC The resource ID of the tree control associated with the control property.

hParent Handle of the parent group item which contains the radio button items.

nIndex A reference to a member variable of the dialog box, form view, or control view object with which data is exchanged.

The DDX_TreeRadio function manages the transfer of int data between a radio button group in the CTreeOptionsCtrl in a dialog box, form view, or control view object and an int data member of the dialog box, form view, or control view object.

void DDX_TreeEdit(CDataExchange* pDX, int nIDC, HTREEITEM hItem, CString& sText);

void DDX_TreeEdit(CDataExchange* pDX, int nIDC, HTREEITEM hItem, int& nValue);

pDX A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC The resource ID of the tree control associated with the control property.

hParent Handle of the parent group item which contains the radio button items.

sText A reference to a CString which is the text to display or retrieve from the tree options control.

The DDX_TreeEdit function manages the transfer of CString or integer data between a edit box in the CTreeOptionsCtrl in a dialog box, form view, or control view object and a CString or integer value.

void DDX_TreeCombo(CDataExchange* pDX, int nIDC, HTREEITEM hItem, CString& sText);

pDX A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC The resource ID of the tree control associated with the control property.

hParent Handle of the parent group item which contains the radio button items.

sText A reference to a CString which is the text to display or retrieve from the tree options control.

The DDX_TreeCombo function manages the transfer of CString data between a combo box in the CTreeOptionsCtrl in a dialog box, form view, or control view object and a CString data member.

void DDX_TreeFileEdit(CDataExchange* pDX, int nIDC, HTREEITEM hItem, CString& sText);

pDX A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC The resource ID of the tree control associated with the control property.

hParent Handle of the parent group item which contains the radio button items.

sText A reference to a CString which is the text to display or retrieve from the tree options control.

The DDX_TreeFileEdit function manages the transfer of CString data between a File Browser edit box in the CTreeOptionsCtrl in a dialog box, form view, or control view object and a CString value.

void DDX_TreeFolderEdit(CDataExchange* pDX, int nIDC, HTREEITEM hItem, CString& sText);

pDX A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC The resource ID of the tree control associated with the control property.

hParent Handle of the parent group item which contains the radio button items.

sText A reference to a CString which is the text to display or retrieve from the tree options control.

The DDX_TreeFolderEdit function manages the transfer of CString data between a Folder Browser edit box in the CTreeOptionsCtrl in a dialog box, form view, or control view object and a CString value.

void DDX_TreeColor(CDataExchange* pDX, int nIDC, HTREEITEM hItem, COLORREF& color);

pDX A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC The resource ID of the tree control associated with the control property.

hParent Handle of the parent group item which contains the radio button items.

color A reference to a COLORREF which is the color to display or retrieve from the tree options control.

The DDX_TreeColor function manages the transfer of COLORREF data between a color browser item in the CTreeOptionsCtrl in a dialog box, form view, or control view object and a COLORREF value.

void DDX_TreeFont(CDataExchange* pDX, int nIDC, HTREEITEM hItem, LOGFONT* pLogFont);

pDX A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC The resource ID of the tree control associated with the control property.

hParent Handle of the parent group item which contains the radio button items.

color A pointer to a LOGFONT structure which is the font to display or retrieve from the tree options control.

The DDX_TreeFont function manages the transfer of LOGFONT structure data between a font browser item in the CTreeOptionsCtrl in a dialog box, form view, or control view object and a LOGFONT structure value.

void DDX_TreeBoolean(CDataExchange* pDX, int nIDC, HTREEITEM hItem, BOOL& bValue);

pDX A pointer to a CDataExchange object. The framework supplies this object to establish the context of the data exchange, including its direction.

nIDC The resource ID of the tree control associated with the control property.

hParent Handle of the parent group item which contains the radio button items.

color A reference to a BOOL which is the Boolean value to display or retrieve from the tree options control.

The DDX_TreeBoolean function manages the transfer of a BOOL value between a Boolean combo box item in the CTreeOptionsCtrl in a dialog box, form view, or control view object and a BOOL value.

Planned Enhancements

• If you have any other suggested improvements, please let me know so that I can incorporate them into the next release.

Contacting the Author

PJ Naughter
Email: pjna@naughter.com
Web: http://www.naughter.com
16 March 2015