CBCGPPropList

Detailed Description

The CBCGPPropList object implements the functionality of a list control that displays the hierarchical list of editable properties. Each property can represent various types and contain sub-items. It's possible to enable a resizable description area at the bottom of a property list control to display a description for selected properties.

Property List control supports "commands" - an additional area at the bottom of Property List with "links". The list of commands can be content dependent - just call SetCommands() and ClearCommands() to display the commands or remove them.

Below are two pictures of the property list control working in hierarchical and alphabetic modes:

To use a property list control in the application just construct a CBCGPPropList object and call CBCGPPropList::Create. Then, you can begin adding items using CBCGPPropList::AddProperty. All properties have the same base class CBCGPProp.

The library has several "predefined" property types:

• CBCGPProp - generic property object that handles strings, booleans, dates and so on.
• CBCGPColorProp - for the color property, with the ability to select a new color
• CBCGPFileProp - allows selection of a file
• CBCGPFontProp - allows selection of a font
• CBCGPBrushProp - allows selection of CBCGPBrush object
• CBCGPTextFormatProp - allows selection of CBCGPTextFormat object
• CBCGPLineStyleProp - allows selection of line style based on CBCGPStrokeStyle.
• CBCGPBitwiseProp - for the "bitwise" property (used in the flags combination editing)
• CBCGPDateTimeProp - the date/time property

In addition, the Property List control supports context menu, built-in toolbar with predefined buttons and built-in search box.

You need to process BCGM_PROPERTY_MENU_ITEM_SELECTED registered message to handle custom context menu commands.

Inherits CBCGPWnd, and CBCGPCtrlPlaceHolderHelper.

Public Member Functions
	CBCGPPropList	Constructs a property list object.
	AddProperty	Adds a new property to a property list control.
	AdjustLayout	Adjusts layout of the list properties.
	AreCommandsVisible	Tells whether property list commands are visible, or hidden.
	ClearCommands	Clears the list of Property List commands.
	CloseColorPopup	Closes the color selection popup control.
	CommitModifiedValues	Makes the current values default.
	Create	Creates a window and attaches it to a property list object.
	DeleteProperty	Deletes the specified property from the property list.
	EditItem	Called by the framework when the user begins to edit a property list item (property).
	EnableAutoHideScrollBar	Scpecifies whether control's scroll bar should be hidden when scroll bar is inactive (mouse cursor is located outside of scrollbar).
	EnableContextMenu	Enables or disables context menu.
	EnableDescriptionArea	Enables the description area shown under the list of properties.
	EnableGridLines	Specifies whether grid lines should be drawn.
	EnableHeaderCtrl	Enables or disables the header control at the top of the property list control.
	EnableProperty	Enables or disables a property.
	EnableSearchBox	Shows or hides a search box.
	EnableToolBar	Shows or hides a toolbar displayed at the top of property list.
	EnableVerticalScrollBar	Enables or disables the vertical scroll bar.
	EndEditItem	Called by the framework when the user has finished to edit a property.
	EnsureVisible	Scrolls a property list to make the specified property visible.
	ExpandAll	Expands or collapses all property list nodes.
	ExportToXMLFile	Export properties to external XML file.
	FindItemByData	Returns a property according to the used-defined DWORD value associated with the property.
	FindItemByID	Finds a property by ID.
	GetBooleanPropertiesStyle	Gets a boolean properties style.
	GetButtonsAppearance	Returns property buttons appearance.
	GetCommandTextColor	Returns color of command text (text displayed in the "commands" area).
	GetCurSel	Returns the currently selected property.
	GetCustomColors	Retrieves custom colors defined for the property list elements.
	GetDescriptionHeight	Returns the height of the description area located at the bottom of the property list control.
	GetHeaderHeight	Returns the height of the property list control header.
	GetItemButtonColor	Returns background color of the item's button.
	GetItemMenuFlags	Returns context menu flags.
	GetListRect	Returns the bounding rectangle of the property list.
	GetProperty	Returns a property list control property according to the specified index.
	GetPropertyColumnWidth	Returns the current width of the column containing properties (right column).
	GetPropertyCount	Returns the number of properties in a property list control.
	GetRowHeight	Returns the height of a row in the property list control.
	GetRowPadding	Obtain row vertical padding.
	GetScrollBarCtrl	Returns a pointer to the scroll bar control.
	GetScrollBarsStyle	Returns the current scroll bar style.
	HasCommands	Tells whether the Property list displays commands in the "commands" area.
	HasHorizontalGridLines	Tells whether grid horizontal lines should be drawn.
	HasVerticalGridLines	Tells whether grid vertical lines should be drawn.
	HitTest	Given a point (in the client coordinates) returns a pointer to a property and the property area.
	IsAlphabeticMode	Tells whether a property list control is in alphabetic mode or not.
	IsAlternateRowColor	Tells whether alternate row colors are enabled.
	IsButtonsDefaultTheme	Tells whether the property button is displayed using Windows default theme.
	IsContextMenuEnabled	Tells whether property list context menu is enabled or not.
	IsDescriptionArea	Tells whether the description area is shown or not.
	IsHeaderCtrl	Tells whether the header control is present or not.
	IsMarkModifiedProperties	Tells how the property list displays modified properties.
	IsPropManagerNotifyChangesOnLoad	Tells whether CBCGPPropertyManager::OnPropertyChanged() method is called when value loaded from the registry is not default.
	IsScrollBarAutoHideEnabled	Tells whether control's scroll bars are auto-hidden.
	IsSearchBox	Tells whether property search box is displayed or not.
	IsToolBar	Tells whether property list toolbar is displayed, or not.
	IsVerticalScrollBarEnabled	Tells whether a vertical scroll bar is enabled.
	IsVSDotNetLook	Tells whether the property list control is displayed using VS.NET look & feel.
	MarkModifiedProperties	Tells the property list how to display modified properties.
	OnChangeSelection	Called by the framework when the current selection is being changed.
	OnClickButton	Called by the framework when a property button has been clicked.
	OnDrawPaletteColorBox	Called by the framework when the palette color box should be drawn.
	OnDrawProperty	Called by the framework to display a property.
	OnPropertyChanged	Called by the framework when the value of a property has changed.
	RedrawProperty	Redraw the specified property.
	RemoveAll	Removes all property objects from a property list control.
	ResetOriginalValues	Restores original values.
	SelectPropertyOption	Select the property option by index.
	SetAlphabeticMode	Sets or unsets the alphabetic mode.
	SetAlternateRowColor	Enables/disables drawing odd/even grid rows using different colors.
	SetBooleanPropertiesStyle	Sets a boolean properties style.
	SetBoolLabels	Specifies the textual representation of boolean labels.
	SetButtonsAppearance	Specifies property buttons appearance.
	SetButtonsDefaultTheme	Enables or disables property buttons default (Windows) theme.
	SetCommands	Specifies the list o commands (links) to display in the "commands" area.
	SetCommandsVisible	Shows or hides property list commands.
	SetCommandTextColor	Specifies color of command text (text displayed in the "commands" area).
	SetCurSel	Selects a property in a property list control.
	SetCustomColors	Allows to customize the property list appearance by setting custom colors for all property list elements.
	SetCustomMenuItems	Adds custom menu items to context menu.
	SetItemButtonColor	Specifies background color of the item's button.
	SetItemMenuFlags	Allows to show or hide predefined context menu items on the fly.
	SetListDelimiter	Defines a character to be used as a delimiter in the list of property values.
	SetRowPadding	Specifies row vertical padding.
	SetScrollBarsStyle	Sets scroll bar style
	SetVSDotNetLook	Enables or disables VS.NET look & feel.
	UpdateBrushProperty	Updates a brush property with a new value.
	UpdateColor	Updates the property color value.
	UpdateColorProperty	Updates a color property with a new value.
	UpdateDateTimeProperty	Updates a date time property with a new value.
	UpdateFontProperty	Updates font property.
	UpdateProperty	Updates a property value.
	UpdateTextFormatProperty	Updates the text format property with a new value.
	ValidateItemData	Called by the framework to validate a property data.

Protected Member Functions
	CompareProps	Called by the property list control when it needs to sort properties.
	Init	Called by the framework when a property list control is being initialized.
	OnDrawBorder	Called by the framework to draw a border around a property list control.
	OnDrawDescription	Called by the framework to draw the description area and display the description text.
	OnDrawList	Called by the framework to display the list of properties.
	OnSelectCombo	Called by the framework as a notification that a property containing a combo box has been selected.