CBCGPDiagramVisualObject

Detailed Description

CBCGPDiagramVisualObject is a base class for a diagram item. Derived classes are used for specific types of diagram items.

Special case is a connector CBCGPDiagramConnector.

Diagram items are stored in a diagram by CBCGPDiagramVisualContainer class. Call CBCGPDiagramVisualContainer::AddItem to add a new diagram item. Call CBCGPDiagramVisualContainer::AddConnector to add a new connector. After adding to container each diagram item has unique identifier that is used for reference and connections between diagram items. Call GetItemID() to retrieve item's ID.

CBCGPDiagramVisualObject class allows to display one text label that's stored in the embedded CBCGPDiagramTextDataObject object. Call AddTextData() to add a text label.

See also

CBCGPBaseVisualObject, CBCGPDiagramShape, CBCGPDiagramTableShape, CBCGPDiagramConnector, CBCGPDiagramImageObject, CBCGPDiagramVisualContainer

Inheritance diagram for CBCGPDiagramVisualObject:

Public Types
enum	ConnectionPorts
enum	Parts

Public Member Functions
	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).
	HitTestConnectionPort	Hits test connection port.
	RemoveTextData	Removes the text data from the diagram item.
	SetAutoDestroy	Specifies whether the diagram object should be destroyed automatically.
	SetConnectionPorts	Called by the framework when connection port positions are calculated.
	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.
	SetSelected	Selects or unselects the object in the parent container.
	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.