BCGControlBar Pro for MFC
CBCGPEditListBaseabstract

Detailed Description

The CBCGPEditListBase class provides the basic functionality that allows to create various controls with editable items and manages an extensible list of buttons to control these items.

To take advantage of the CBCGPEditListBase class features you must inherit your own class from it, because CBCGPEditListBase class is abstract class, and you have to implement the actual editing methods.

The CBCGPEditListBase class supports four standard buttons for Add, Delete, Move Up and Move Down operations on the item list. You need to call SetStandardButtons() method with the desired combination to enable them. The button images are loaded from the BCGControlBar Library resource file. You may add your own buttons and images by the AddButton() method. You may want to override some notification methods to take a specific actions when a user is editing the item list.

See also
CBCGPButton, CBCGPEditListBox
+ Inheritance diagram for CBCGPEditListBase:

Public Member Functions

 AddButtonAdds a new button to the list control
 
 AddItemAdds a new item to the CBCGPEditListBase - derived object. Implementation required.
 
 EditItemAllows to edit an item in-place. Implementation required
 
 EnableBrowseButtonEnables or disables browse button for each item of a list box.
 
 EnableButtonAllows to enable or disable a button that manages list control items
 
 GetButtonIDGiven a button's index returns the button's ID.
 
 GetButtonNumGiven a button ID returns the button's index
 
 GetButtonsCountReturns the number of buttons.
 
 GetCountReturns the number of items in a list control. Implementation required.
 
 GetItemDataReturns the data value associated with the list item. Implementation required.
 
 GetItemTextReturns the text associated with the list item. Implementation required.
 
 GetSelItemReturns the zero-based index of the currently selected item in a list control.
 
 IsBrowseButtonSpecifies whether browse button is enabled or not.
 
 IsGrayDisabledButtonsTells whether the disabled button will be drawn grayed.
 
 OnAfterAddItemCalled when a new item has been added by in-place editing.
 
 OnAfterMoveItemDownCalled when a list box item has been moved down
 
 OnAfterMoveItemUpCalled when a list control item has been moved up
 
 OnAfterRenameItemCalled when a list box item has been renamed
 
 OnBeforeRemoveItemCalled when a list box item is about to be deleted.
 
 OnBrowseCalled by the framework when the user release the left mouse button over a browse button.
 
 OnClickButtonCalled when the use clicks the button
 
 OnEndEditLabelCalled when in-place editing of the list control item's text has been finished
 
 OnGetImageCalled when an edit list control needs to display an item.
 
 OnKeyCalled when the user pressed the keyboard key.
 
 OnSelectionChangedCalled when the selection in the list control has been changed
 
 RemoveAllButtonsRemoves all standard and custom buttons.
 
 RemoveAllItemsRemoves all list control items.
 
 RemoveItemDeletes an item from a list control. Implementation required.
 
 SelectItemSelects a list control item. Implementation required.
 
 SetGrayDisabledButtonsAllows to draw disabled button grayed. By default, the disabled button will be drawn with the regular look.
 
 SetItemDataSets the data value associated with the list control item. Implementation required.
 
 SetItemTextChanges the text of a list control item. Implementation required.
 
 SetStandardButtonsAllows to specify which standard buttons should be created at the top of control.
 

Protected Member Functions

 CreateNewItemCreates a new list control item in-place
 
 GetListHwndReturns the handle to the list control window. Implementation required.
 
 OnCreateListCalled by the framework as a part of initialization process. Implementation required.
 
 OnSizeListCalled when the layout of CBCGPEdiListBoxBase - derived control has changed. Implementation required.