BCGControlBar Pro for MFC

Detailed Description

The CBCGPProp object implements the functionality of a generic property object that can be added to a property list control (CBCGPPropList).

A property object can represent various types such as strings, dates, boolean values, integer values, may contain a Windows combo box control with a list of options, may contain a button and may have a number of child properties.

+ Inheritance diagram for CBCGPProp:

Public Member Functions

 CBCGPPropConstructs a property object.
 
 CBCGPPropConstructs a property object.
 
 CBCGPPropConstructs a property object.
 
 AddOptionAdds a new option to a property.
 
 AddSubItemAdds a child item to the specifies property
 
 AdjustButtonRectCalled by the parent property list control to tell a property to adjust a bounding rectangle for embedded button.
 
 AllowEditMakes a property editable or read-only.
 
 CleanStateClean up a property state.
 
 CreateInPlaceEditCalled by the framework when it needs to create an in-place edit control for a property.
 
 CreateSpinControlCalled by the framework when it needs to create in-place spin control.
 
 EnableEnables or disables a property.
 
 EnableSpinControlEnables or disables spin control used to increment/decrement property value.
 
 ExpandExpands or collapses a property containing any sub-properties.
 
 FormatPropertyFormats a property value to a string
 
 GetDataReturns a DWORD value associated with a property.
 
 GetDescriptionRetrieves the property description.
 
 GetExpandedSubItemsReturns the number of expanded sub-items.
 
 GetHierarchyLevelReturns the zero-based index of the property hierarchical level.
 
 GetIDReturns a property identifier.
 
 GetNameReturns property name.
 
 GetNameTooltipCalled by the framework when it needs to display a tooltip for the property name.
 
 GetOptionReturns an option located at the specified index.
 
 GetOptionCountReturns the number of options that belong to a property.
 
 GetOptionDataReturns a user-defined data associated with option located at the specified index.
 
 GetParentReturns a pointer to a parent property.
 
 GetRectReturns the bounding rectangle of a property.
 
 GetSelectedOptionGets selected option.
 
 GetStateColorReturns a state indicator color.
 
 GetStateIndicatorReturns a state indicator character.
 
 GetStateToolTipReturns a state tool tip text.
 
 GetSubItemReturns a specific sub-property identified by the zero-based index.
 
 GetSubItemsCountReturns the number of sub-items.
 
 GetValueRetrieves a property value.
 
 GetValueTooltipCalled by the framework to retrieve a text string representation of the property value used for the tooltip.
 
 HasStateTells whether the property has a specified state.
 
 HitTestReturns a pointer to a property object at the given point (in the client coordinates).
 
 IsAllowEditTells whether a property is editable.
 
 IsDrawStateColorBorderTells whether a colored border should be drawn around the property.
 
 IsEnabledTells whether a property is enabled or disabled.
 
 IsExpandedTells whether a property is expanded or collapsed.
 
 IsModifiedTells whether property is modified, or not.
 
 IsParentExpandedTells whether the parent property of this property is expanded.
 
 IsSelectedTells whether a property is selected or not.
 
 IsVisibleTells whether property is visible, or not.
 
 OnClickButtonCalled by the framework when the user clicks a button contained in a property.
 
 OnClickNameCalled by parent property list control when user clicks a property name field.
 
 OnClickValueCalled by parent property list control when a value field of property is clicked.
 
 OnCloseComboCalled by the framework when a combo box contained in a property is closed.
 
 OnDblClickCalled by the framework when the user double clicks the property.
 
 OnDrawButtonCalled by the framework to draw a button contained in the property.
 
 OnDrawDescriptionCalled by the framework when the property list control needs to display the property description
 
 OnDrawExpandBoxCalled by the framework to draw an expand box near a property containing sub-properties.
 
 OnDrawMenuButtonCalled by the framework to display the property menu button.
 
 OnDrawNameCalled by the framework to display the property name.
 
 OnDrawStateIndicatorCalled by the framework to display the property state indicator.
 
 OnDrawValueCalled by the framework to display the property value.
 
 OnEditCalled by the framework when the user is about to edit a property value.
 
 OnEndEditCalled by the framework to notify that the editing has finished.
 
 OnRClickNameCalled by the framework when the user clicks the right mouse button on the property name.
 
 OnRClickValueCalled by the framework when the user clicks the right mouse button on the property value.
 
 OnSelectComboCalled by the framework when the user selects an item from the in-place combo box.
 
 OnSetCursorCalled by the framework to notify that the property list is about to set cursor on the property.
 
 OnUpdateValueCalled by the framework to notify a property object that its value has been updated.
 
 PushCharCalled from the property list control when the property is selected and user enters a new character.
 
 RedrawRedraws the property.
 
 RedrawStateRedraws the property state indicator.
 
 RemoveAllOptionsRemoves all options from a property.
 
 RemoveAllSubItemsRemoves all sub-items.
 
 RemoveSubItemRemoves the specified sub-item.
 
 ResetOriginalValueRestores the original value.
 
 SelectOptionSelect a property option by index.
 
 SetDataSets a DWORD_PTR value to be associated with the property.
 
 SetDescriptionSets description for a property item.
 
 SetDropDownWidthSets width of drop down list of combo box property.
 
 SetIDSets a property identifier.
 
 SetNameSets property name.
 
 SetStateSets a property custom state.
 
 SetSwitchLabelsSets text labels for the switch-style Boolean property.
 
 SetValueSets the property value.
 
 ShowShows or hides property.
 

Static Public Attributes

 m_strFormatDoubleFormat string for the value of the type double.
 
 m_strFormatFloatFormat string for the value of the type float.
 
 m_strFormatLongFormat string for the value of the type long.
 
 m_strFormatShortFormat string for the value of the type short.
 

Protected Member Functions

 CreateComboCalled by the framework when it needs to create a combo box inside the property.
 
 HasButtonTells whether a property contains a button.
 
 HasListTells whether a property contains a list of options.
 
 HasSpinTells whether a property contains a spin (up-down) control.
 
 InitCalled by the framework to perform initialization.
 
 IsSubItemTells whether the specifies property is a sub-item of this property or not.
 
 IsValueChangedTells whether the value has changed.
 
 OnAddComboBoxItemCalled by the Property Grid to add a combo box item.
 
 OnCtlColorCalled by the framework when it needs to retrieve a brush to fill the background color of a property.
 
 OnDestroyWindowCalled when a property is destroyed or editing is finished (from OnEndEdit()).
 
 OnKillFocusCalled by the framework to notify that the property has lost the input focus.