BCGControlBar Pro for MFC
CBCGPDiagramConnector

Detailed Description

The CBCGPDiagramConnector implements a connector. Connector is an object that displays the connection line between two diagram items.

The connector is linked with diagram items. The point of a diagram item that can be used for connection is called connection port. Connection port is specified by numeric value. Predefined connection ports are listed in CBCGPDiagramVisualObject::ConnectionPorts enum.

Call CBCGPDiagramVisualObject::UseConnectionPort and Connect() to create a connection with a diagram item. After setting ending points by Connect() you can call InsertPoint() to specify the exact path of the connection line.

The connector's ending points are specified by CBCGPDiagramAnchorPoint. Call GetPoints() to retrieve a list of points. The position of connector's ending point can be specified by X,Y coordinates. If a connector is linked with a diagram item then the position of connector's ending point is calculated automatically. Call CBCGPDiagramVisualContainer::CalculatePoint to retrieve actual X,Y coordinates of connector's ending point.

See also
CBCGPDiagramVisualObject::ConnectionPorts, CBCGPDiagramAnchorPoint, CBCGPDiagramVisualObject
+ Inheritance diagram for CBCGPDiagramConnector:

Public Types

enum  BCGP_ARROW_SHAPE
 
enum  BCGP_CURVE_TYPE
 
- Public Types inherited from CBCGPDiagramVisualObject
enum  ConnectionPorts
 
enum  Parts
 

Public Member Functions

 CBCGPDiagramConnectorDefault constructor.
 
 CBCGPDiagramConnectorCopy constructor.
 
 CBCGPDiagramConnectorTwo-point constructor.
 
 CBCGPDiagramConnectorThree-point constructor.
 
 CBCGPDiagramConnectorFour-point constructor.
 
 AnchorPointRetrieves an anchor point by index.
 
 ConnectConnects two diagram items.
 
 ConnectConnects a directly positioned connector.
 
 ConnectConnects two diagram anchors.
 
 FindAnchorPointIndexSearches for the specified anchor point index.
 
 GetBeginArrowGets begin arrow parameters.
 
 GetBeginArrowFillBrushGets begin arrow fill brush.
 
 GetBeginArrowOutlineBrushGets begin arrow outline brush.
 
 GetBoundsRectGets bounding rectangle of the diagram connector.
 
 GetCurveTypeGets connector curve type.
 
 GetEndArrowGets end arrow parameters.
 
 GetEndArrowFillBrushGets end arrow fill brush.
 
 GetEndArrowOutlineBrushGets end arrow outline brush.
 
 GetPointCountGets number of connector points.
 
 GetPointsGets the array of connector points.
 
 InsertPointSpecifies the exact path of the connection line.
 
 IsConnectedTells whether this connector is linked to any diagram items.
 
 IsConnectedToSelectionTells whether this connector is linked to the currently selected diagram item(s).
 
 SetBeginArrowSets begin arrow style.
 
 SetBeginArrowSets begin arrow style and dimensions.
 
 SetBeginArrowFillBrushSets begin arrow fill brush.
 
 SetBeginArrowOutlineBrushSets begin arrow outline brush.
 
 SetCurveTypeSets connector curve type.
 
 SetEndArrowSets end arrow style.
 
 SetEndArrowSets end arrow style and dimensions.
 
 SetEndArrowFillBrushGets end arrow fill brush.
 
 SetEndArrowOutlineBrushSets end arrow outline brush.
 
- Public Member Functions inherited from CBCGPDiagramVisualObject
 CBCGPDiagramVisualObjectConstructor.
 
 CBCGPDiagramVisualObjectCopy constructor.
 
 AddTextDataAdds a text data to the diagram item.
 
 DrawConnectionPortsCalled by the framework to draw a connection ports.
 
 GetAllConnectorsGets the list of all item connectors.
 
 GetConnectionPortGets coordinates of the specific connection port.
 
 GetConnectorsGets the list of connectors connected to specified port.
 
 GetFillBrushGets object fill brush.
 
 GetFillColorGets object fill color.
 
 GetItemIDGets item identifier.
 
 GetOutlineBrushGets object outline brush.
 
 GetOutlineColorGets object outline color.
 
 GetParentDiagramGets the parent diagram.
 
 GetPartTextDataRetrieves the text data object of the diagram item.
 
 GetStrokeStyleGets the object stroke style.
 
 GetTextDataGets text data by index.
 
 GetThicknessGets the border thickness.
 
 HasConnectorsTells whether the diagram item has a specific connector(s).
 
 RemoveTextDataRemoves the text data from the diagram item.
 
 SetAutoDestroySpecifies whether the diagram object should be destroyed automatically.
 
 SetFillBrushSets object fill brush.
 
 SetFillColorSets object fill color.
 
 SetItemIDSets an item identifier.
 
 SetOutlineBrushSets object outline brush.
 
 SetOutlineColorSets object outline color.
 
 SetStrokeStyleSets the object border stroke style.
 
 SetTextDataSets text data in the diagram item.
 
 SetThicknessSets the object border thickness.
 
 UseConnectionPortCreates a new anchor point.
 
- Public Member Functions inherited from CBCGPBaseVisualObject
 CBCGPBaseVisualObjectConstructor.
 
 CBCGPBaseVisualObjectCopy constructor.
 
 CopyToClipboardCopies visual object to the Clipboard.
 
 EnableImageCacheEnables or disables visual object image cache.
 
 ExportToBitmapExports the visual object to bitmap.
 
 ExportToFileExports the visual object to a file (BMP or PNG).
 
 ExportToImageExports the visual object to an image.
 
 GetDataGets an internal data object.
 
 GetDataAnimationTypeGets data animation type.
 
 GetDataCountReturns a number of data objects.
 
 GetEditFlagsGets editing flags.
 
 GetIDGets the object identifier.
 
 GetNameGets the object name.
 
 GetParentContainerGets the parent visual container.
 
 GetRectGets the object bounding rectangle.
 
 GetSelectedThemeObtain a currently selected visual theme.
 
 GetUserDataGets user-defined data associated with this object.
 
 GetValueGets the object value.
 
 IsAutoDestroyTells whether this object will be destroyed automatically.
 
 IsEditModeTells whether this object has the edit mode.
 
 IsEnabledTells whether the visual object is enabled.
 
 IsImageCacheTells whether image cache is enabled for this object.
 
 IsSelectedTells whether this object is selected in the parent container.
 
 IsVisibleTells whether the visual object is visible.
 
 RedrawRedraws this object.
 
 RedrawRectRedraws a specified rectangle.
 
 SelectVisualThemeSelect a visual theme created in Visual Designer.
 
 SetAutoDestroySpecifies whether the object should be destroyed automatically.
 
 SetDataAnimationTypeSets data animation type.
 
 SetDirtyInvalidates and redraws a visual object.
 
 SetEditFlagsSets editing flags.
 
 SetIDSets the object identifier.
 
 SetNameSets an object name.
 
 SetUserDataSets user-defined data associated with this object.
 
 SetValueSets the object value.
 
 SetVisibleShows or hides the visual object.