BCGSuite for MFC
CBCGPListBox

Detailed Description

The CBCGPListBox class implements drawing of a list box control using Visual Manager. It's also designed to support drawing on DWM ("Glass") window area. In addition, this control supports the following features:

  • Group caption
  • Multi-line item description
  • Item icon
  • Custom colors
  • Pinned items
  • Enabled/disabled items
  • Item tooltip
  • Item color bar
  • Notification badge
  • Alternate row color
+ Inheritance diagram for CBCGPListBox:

Public Member Functions

 AddCaptionAdds a caption row.
 
 AddSeparatorAdds a separator.
 
 AreAutoToolTipsTells whether the control has automatically created tooltips (appear in item when not enough space to display the whole text).
 
 BCGPModifyStyleRecreates control with new styles.
 
 CleanUpClean up the control content.
 
 EnableEnables/disabled item.
 
 EnableItemDescriptionEnables the items description.
 
 EnableItemHighlightingEnables the items highlighting.
 
 EnablePinsEnables the list items pin button.
 
 GetColorBarWidthGets color bar width.
 
 GetDefaultItemGets default item.
 
 GetItemBarColorGets item's bar color.
 
 GetItemDescriptionGets item's description.
 
 GetItemExtraHeightGets item extra height.
 
 GetItemIconGets item icon.
 
 GetItemImageGets item image.
 
 GetItemImageSizeGets item image size.
 
 GetItemIndentGets item indentation.
 
 GetItemNotificationBadgeColorGets item notification badge background color.
 
 GetItemNotificationBadgeNumberGets item's notification badge numeric value.
 
 GetItemToolTipGets item tooltip text.
 
 GetItemToolTipDescriptionGets item tooltip description.
 
 GetNoContentLabelGets a text label appearing in the middle of control when the list is empty.
 
 HasItemDescriptionsChecks if this control has items description.
 
 HasPinsChecks if this control has items pin button.
 
 IsAlternateRowColorTells whether this control has alternate (even/odd) row colors.
 
 IsAutoRecreatedTells whether the control was automatically recreated ("owner draw" + "has strings" styles were added).
 
 IsCaptionItemTells whether a specified list box item is a caption item.
 
 IsCaptionItemsLargeFontTells whether caption items should be drawn using a large font.
 
 IsEnabledTells whether the item is enabled or not.
 
 IsItemHighlightingEnabledTells whether the item highlighting is enabled.
 
 IsItemPinnedTells whether the item is pinned or not.
 
 IsSeparatorItemTells whether a specified list box item is a separator.
 
 RemoveItemNotificationBadgeRemoves a notification badge associated with the item.
 
 ResetPinsResets all pins.
 
 SetAlternateRowColorSpecifies whether this control has alternate (even/odd) row colors.
 
 SetAutoToolTipsSpecifies whether the control has automatically created tooltips (appear in item when not enough space to display the whole text).
 
 SetCaptionItemsLargeFontSpecify whther caption items should be drawn using a large font.
 
 SetColorBarWidthSets color bar width.
 
 SetDefaultItemSets a default (bold) item.
 
 SetImageListSets image list.
 
 SetImageListSets image list.
 
 SetItemColorBarSets item's color bar.
 
 SetItemDescriptionSets item's description.
 
 SetItemExtraHeightSets list box item extra height.
 
 SetItemIconSets item icon.
 
 SetItemImageSets item image.
 
 SetItemIndentSets item indentation (in pixels).
 
 SetItemNotificationBadgeSets a numeric notification badge associated with the item.
 
 SetItemPinnedSets item pinned state.
 
 SetItemToolTipSets item's tool tip.
 
 SetNoContentLabelSpecify a text label appearing in the middle of control when the list is empty.
 

Public Attributes

 m_bOnGlassSpecifies whether a control is located on the "glass" (DWM) area of the parent window.
 
 m_bVisualManagerStyleSpecifies whether a control has a Visual Manager style look.
 

Protected Member Functions

 OnAfterRecreateCalled by the framework after control was recreated by calling BCGPModifyStyle() method.
 
 OnCopyItemDataCalled by the framework when control is recreated in BCGPModifyStyle() method.