CBCGPVisualContainer

Detailed Description

The CBCGPVisualContainer class implements functionality of the visual container.

The visual container is a windowless object that hosts CBCGPBaseVisualObject - derived objects. You can initialize this object either using CBCGPVisualContainerCtrl window (simplest way) or directly:

• Create a new CBCGPVisualContainer object as member of any CWnd-derived window.
• Create a new CBCGPGraphicsManager - derived object.
• Specify container location by calling SetRect() method.
• Add WM_PAINT message handler to the window class, bind CBCGPGraphicsManager object to the device content and call CBCGPVisualContainer::OnDraw (see CBCGPGraphicsManager description for more information).

You can add CBCGPBaseVisualObject - derived objects using Add() method or prepare the container context in our WYSWYG Visual Designer application (see https://bcgsoft.com/Support/DevArea/VisualDesigner), and call LoadFromXML() or LoadFromFile() methods to load the container objects saved by Designer.

Please take a look at the following examples to study how to use the Visual Container:

• BCGPChartExample: CChartAdvancedLegendView, CChartContainerView and CChartThumbnailsView classes.
• BCGPDigitalDashboard: each view hosts CBCGPVisualContainer - derived class
• BCGPGaugesDemo: CDesignerDataView demonstrates how to load and use container prepared by Visual Designer application (see https://bcgsoft.com/Support/DevArea/VisualDesigner); other classes such as CBCGPColorIndicatorView, CBCGPImageIndicatorView, CBCGPNumericIndicatorView or CBCGPTextIndicatorView show how to create the container programmatically.

Inheritance diagram for CBCGPVisualContainer:

Public Types
enum	BCGP_VISUAL_CONTAINER_GRID_STYLE

Public Member Functions
	CBCGPVisualContainer	Constructor.
	Add	Adds a new child visual object to the container.
	AreVisualEffectsEnabled	Tells whether the visual effects are enabled.
	ClearSelection	Unselect all previously selected objects.
	CopyToClipboard	Copies visual container to the Clipboard.
	EnableAutoHideScrollBars	Scpecifies whether container's scroll bars should be hidden when scroll bars are inactive (mouse cursor is located outside of scrollbar).
	EnableEditMode	Enables or disables the container edit mode.
	EnableImageCache	Enables or disables visual container image cache.
	EnableLayout	Enables or disables layout manager for a visual container
	EnableScrollBars	Enables or disables visual container scroll bars.
	EnableVisualEffects	Call this method to temporarily enable/disable visual effects for all objects.
	EnableVisualManagerTheme	Enables the visual manager style.
	ExportToBitmap	Exports the visual container to bitmap.
	ExportToFile	Exports the visual container to an image file (BMP or PNG).
	ExportToImage	Exports the visual container to an image.
	FindIndex	Gets a specified object index.
	GetAt	Gets a child object by index.
	GetBoundsRect	Gets a rectangle which includes all child visual objects.
	GetByID	Gets a child object by identifier.
	GetCount	Gets the number of the child visual objects.
	GetFillBrush	Gets container fill brush.
	GetFromPoint	Gets a visual object located at specified coordinates.
	GetGridBrush	Gets container grid brush.
	GetGridSize	Gets container grid cell size.
	GetGridStyle	Gets container grid style.
	GetLayout	Returns a pointer to layout manager.
	GetOutlineBrush	Gets container outline brush.
	GetOwner	Gets the visual container owner.
	GetRect	Gets the container bounding rectangle.
	GetScrollOffset	Gets container scroll offset.
	GetSel	Gets a selected object by index.
	GetSelCount	Gets number of the selected objects.
	GetSelectedTheme	Obtain a currently selected visual theme.
	GetVisualThemesCount	Gets visual themes count.
	HasScrollBars	Tells whether this container has scroll bars.
	InsertAt	Adds a new child visual object to the container at the specific position.
	IsDPIAwareGrid	Tells whether the grid cell size be automatically scaled according to current DPI.
	IsEditMode	Tells whether the container is in the edit mode.
	IsImageCache	Tells whether image cache is enabled for this container.
	IsLayoutEnabled	Tells whether layout management is enabled for a visual container.
	IsScrollBarAutoHideEnabled	Tells whether control's scroll bars are auto-hidden.
	IsSingleSel	Tells whether a single selection mode is activated.
	IsVisualManagerTheme	Tells whether a window uses visual manager style.
	LoadFromBuffer	Loads container data from buffer.
	LoadFromFile	Loads container data from external file.
	LoadFromXML	Loads container data from XML resource.
	LoadFromXML	Loads container data from XML resource.
	OnAfterCreateWnd	Called by the framework after custom control creating.
	OnBeforeDestroyWnd	Called by the framework before custom window destroying.
	OnCreateCustomControl	Called by the framework to create a Visual Container custom control.
	OnDraw	Called by the framework to draw a visual container
	Remove	Removes the child visual object by specified index.
	Remove	Removes the child visual object.
	RemoveAll	Removes all child visual objects from the container.
	RemoveSelected	Removes all currenly selected child visual objects from the container.
	SaveToXML	Saves container data to external file.
	Select	Selects an object.
	SelectAll	Selects all visual objects.
	SelectVisualTheme	Select a visual theme (by index) created in Visual Designer.
	SelectVisualThemeByName	Select a visual theme (by name) created in Visual Designer.
	SetFillBrush	Sets container fill brush.
	SetGridBrush	Sets container grid brush.
	SetGridSize	Sets container grid size.
	SetGridStyle	Sets container grid style.
	SetOutlineBrush	Sets container outline brush.
	SetOwner	Sets the visual container owner window.
	SetRect	Sets a new bounding rectangle.
	SetScrollOffset	Sets container scroll offset.