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
	CBCGPDiagramConnector	Default constructor.
	CBCGPDiagramConnector	Copy constructor.
	CBCGPDiagramConnector	Two-point constructor.
	CBCGPDiagramConnector	Three-point constructor.
	CBCGPDiagramConnector	Four-point constructor.
	AnchorPoint	Retrieves an anchor point by index.
	Connect	Connects two diagram items.
	Connect	Connects a directly positioned connector.
	Connect	Connects two diagram anchors.
	Disconnect	Disconnects connector from the diagram.
	FindAnchorPointIndex	Searches for the specified anchor point index.
	GetBeginArrow	Gets begin arrow parameters.
	GetBeginArrowFillBrush	Gets begin arrow fill brush.
	GetBeginArrowOutlineBrush	Gets begin arrow outline brush.
	GetBoundsRect	Gets bounding rectangle of the diagram connector.
	GetCurveType	Gets connector curve type.
	GetEndArrow	Gets end arrow parameters.
	GetEndArrowFillBrush	Gets end arrow fill brush.
	GetEndArrowOutlineBrush	Gets end arrow outline brush.
	GetPointCount	Gets number of connector points.
	GetPoints	Gets the array of connector points.
	InsertPoint	Specifies the exact path of the connection line.
	IsConnected	Tells whether this connector is linked to any diagram items.
	IsConnectedToSelection	Tells whether this connector is linked to the currently selected diagram item(s).
	SetBeginArrow	Sets begin arrow style.
	SetBeginArrow	Sets begin arrow style and dimensions.
	SetBeginArrowFillBrush	Sets begin arrow fill brush.
	SetBeginArrowOutlineBrush	Sets begin arrow outline brush.
	SetCurveType	Sets connector curve type.
	SetEndArrow	Sets end arrow style.
	SetEndArrow	Sets end arrow style and dimensions.
	SetEndArrowFillBrush	Gets end arrow fill brush.
	SetEndArrowOutlineBrush	Sets end arrow outline brush.
Public Member Functions inherited from CBCGPDiagramVisualObject
	CBCGPDiagramVisualObject	Constructor.
	CBCGPDiagramVisualObject	Copy constructor.
	AddTextData	Adds a text data to the diagram item.
	DrawConnectionPorts	Called by the framework to draw a connection ports.
	GetAllConnectors	Gets the list of all item connectors.
	GetConnectionPort	Gets coordinates of the specific connection port.
	GetConnectors	Gets the list of connectors connected to specified port.
	GetFillBrush	Gets object fill brush.
	GetFillColor	Gets object fill color.
	GetItemID	Gets item identifier.
	GetOutlineBrush	Gets object outline brush.
	GetOutlineColor	Gets object outline color.
	GetParentDiagram	Gets the parent diagram.
	GetPartTextData	Retrieves the text data object of the diagram item.
	GetStrokeStyle	Gets the object stroke style.
	GetTextData	Gets text data by index.
	GetThickness	Gets the border thickness.
	HasConnectors	Tells whether the diagram item has a specific connector(s).
	RemoveTextData	Removes the text data from the diagram item.
	SetAutoDestroy	Specifies whether the diagram object should be destroyed automatically.
	SetFillBrush	Sets object fill brush.
	SetFillColor	Sets object fill color.
	SetItemID	Sets an item identifier.
	SetOutlineBrush	Sets object outline brush.
	SetOutlineColor	Sets object outline color.
	SetStrokeStyle	Sets the object border stroke style.
	SetTextData	Sets text data in the diagram item.
	SetThickness	Sets the object border thickness.
	UseConnectionPort	Creates a new anchor point.
Public Member Functions inherited from CBCGPBaseVisualObject
	CBCGPBaseVisualObject	Constructor.
	CBCGPBaseVisualObject	Copy constructor.
	CopyToClipboard	Copies visual object to the Clipboard.
	EnableImageCache	Enables or disables visual object image cache.
	ExportToBitmap	Exports the visual object to bitmap.
	ExportToFile	Exports the visual object to a file (BMP or PNG).
	ExportToImage	Exports the visual object to an image.
	GetData	Gets an internal data object.
	GetDataAnimationType	Gets data animation type.
	GetDataCount	Returns a number of data objects.
	GetEditFlags	Gets editing flags.
	GetFillBrush	Retrieves a visual object's background brush
	GetID	Gets the object identifier.
	GetName	Gets the object name.
	GetParentContainer	Gets the parent visual container.
	GetRect	Gets the object bounding rectangle.
	GetSelectedTheme	Obtain a currently selected visual theme.
	GetUserData	Gets user-defined data associated with this object.
	GetValue	Gets the object value.
	GetVisualEffect	Retrieves a visual effect
	IsAutoDestroy	Tells whether this object will be destroyed automatically.
	IsEditMode	Tells whether this object has the edit mode.
	IsEnabled	Tells whether the visual object is enabled.
	IsImageCache	Tells whether image cache is enabled for this object.
	IsSelected	Tells whether this object is selected in the parent container.
	IsVisible	Tells whether the visual object is visible.
	Redraw	Redraws this object.
	RedrawRect	Redraws a specified rectangle.
	SelectVisualTheme	Select a visual theme created in Visual Designer.
	SetAutoDestroy	Specifies whether the object should be destroyed automatically.
	SetDataAnimationType	Sets data animation type.
	SetDirty	Invalidates and redraws a visual object.
	SetEditFlags	Sets editing flags.
	SetFillBrush	Sets a new fill brush.
	SetID	Sets the object identifier.
	SetName	Sets an object name.
	SetUserData	Sets user-defined data associated with this object.
	SetValue	Sets the object value.
	SetVisible	Shows or hides the visual object.
	SetVisualEffect	Sets a visual effect.