CBCGPEditListBox

Detailed Description

The CBCGPEditListBox class extends the functionality of a Windows list box by providing support for editing items in-place and ability to define a list of buttons to control edit operations. An editable list box displays a list of items, the user can view, select and edit them in-place or use buttons on the top of the list box to create a new items, delete the existing items, rename items, or move a single item up and down.

The following is a picture of the editable list box control. You can notice, that Item2 is selected for editing:

To use an editable list box in a dialog template, declare a CBCGPEditListBox variable in your dialog box class, then use DDX_Control in your dialog box class's DoDataExchange function to connect the member variable to the control. In the resource editor you should create a static control, because CBCGPEditLisBox class inherits from CStatic.

By default, the editable list box is created without buttons. You have to enable them by the CBCGPEditListBase::SetStandardButtons function.

See also

CBCGPEditListBase

Inheritance diagram for CBCGPEditListBox:

Public Member Functions
	CBCGPEditListBox	Constructs a CBCGPEditListBox object
	AddItem	Adds a string to a list control.
	EditItem	Begins in-place editing of an item's text.
	GetCount	Returns the number of strings in a list control.
	GetItemData	Returns the data value associated with the list control item.
	GetItemText	Returns a list control item's text.
	GetSelItem	Returns the zero-based index of the currently selected item in a list control.
	RemoveAllItems	Removes all list control items.
	RemoveItem	Removes an item from a list control.
	SelectItem	Selects a list control string.
	SetItemData	Sets the data value associated with the list control item.
Public Member Functions inherited from CBCGPEditListBase
	AddButton	Adds a new button to the list control
	EnableBrowseButton	Enables or disables browse button for each item of a list box.
	EnableButton	Allows to enable or disable a button that manages list control items
	GetButtonID	Given a button's index returns the button's ID.
	GetButtonNum	Given a button ID returns the button's index
	GetButtonsCount	Returns the number of buttons.
	IsBrowseButton	Specifies whether browse button is enabled or not.
	IsGrayDisabledButtons	Tells whether the disabled button will be drawn grayed.
	OnAfterAddItem	Called when a new item has been added by in-place editing.
	OnAfterMoveItemDown	Called when a list box item has been moved down
	OnAfterMoveItemUp	Called when a list control item has been moved up
	OnAfterRenameItem	Called when a list box item has been renamed
	OnBeforeRemoveItem	Called when a list box item is about to be deleted.
	OnBrowse	Called by the framework when the user release the left mouse button over a browse button.
	OnClickButton	Called when the use clicks the button
	OnEndEditLabel	Called when in-place editing of the list control item's text has been finished
	OnGetImage	Called when an edit list control needs to display an item.
	OnKey	Called when the user pressed the keyboard key.
	OnSelectionChanged	Called when the selection in the list control has been changed
	RemoveAllButtons	Removes all standard and custom buttons.
	SetGrayDisabledButtons	Allows to draw disabled button grayed. By default, the disabled button will be drawn with the regular look.
	SetStandardButtons	Allows to specify which standard buttons should be created at the top of control.

Protected Member Functions
	GetListHwnd	Returns the handle to the embedded list view control.
Protected Member Functions inherited from CBCGPEditListBase
	CreateNewItem	Creates a new list control item in-place