CBCGPHotSpotImageCtrl

Detailed Description

The CBCGPHotSpotImageCtrl implements the functionality of a control with background image containing click able points (hot spots). When the user clicks a hot spot the CBCGPHotSpotImageCtrl controls sends the WM_COMMAND message with BN_CLICKED code to the parent.

Perform the following steps to add this control to your application:

• Embed a CBCGPHotSpotImageCtrl member into a class to receive notifications:CBCGPHotSpotImageCtrl m_Image;
• Call CBCGPHotSpotImageCtrl::Create in order to initialize the hot spot control. Here you'll need to specify the control's bounding rectangle, a pointer to parent and hot spot control ID. For example, m_Image.Create (rectClient, this, IDC_START_IMAGE);
• Add hot spots using CBCGPHotSpotImageCtrl::AddHotSpot
• Provide the hot spot image control with the regular and hot images using CBCGPHotSpotImageCtrl::SetImage. If you want to use advanced highlighting algorithms without specifying a hot image, call CBCGPHotSpotImageCtrl::SetHighlightHotArea.
• Add to the parent's message map a BN_CLICKED entry: ON_BN_CLICKED(IDC_START_IMAGE, OnClickHotSpot)
• Add to the source BN_CLICKED handler OnClickHotSpot. Use CBCGPHotSpotImageCtrl::GetHotSpot to determine the ID of a hot spot that has been clicked.
• If you need to display a custom cursor when the mouse is hovering over a hot spot, derive a class from CBCGPHotSpotImageCtrl and process WM_SETCURSOR message. Use CBCGPHotSpotImageCtrl::HitTest to detect hot spots. By default, the library uses BCGPGLOBAL_DATA::m_hcurHand cursor (loaded from IDC_BCGBARRES_HAND resource).

Inheritance diagram for CBCGPHotSpotImageCtrl:

Public Member Functions
	CBCGPHotSpotImageCtrl	Constructor.
	AddHotSpot	Adds a new hot spot to the hot spot image control.
	AddHotSpot	Adds a new hot spot to SVG-based hot spot image control.
	Create	Initializes a hot spot image control.
	DrawItem	Called by the framework when it needs to draw a hot spot image control.
	EnableAutoHideScrollBars	Scpecifies whether control's scroll bars should be hidden when scroll bars are inactive (mouse cursor is located outside of scrollbar).
	EnableScrollBars	Enables or disables scroll bars.
	EnsureVisible	Makes a hot spot fully visible.
	GetBackgroundColor	Retrieves the background color of a hot spot image control.
	GetHotSpot	Retrieves the ID of current (clicked) hot spot.
	GetImageSize	Retrieves the size of control background image.
	GetScrollBarsStyle	Returns the current scroll bar style.
	HitTest	Returns a pointer to hot spot containing the specified point.
	IsScrollBarAutoHideEnabled	Tells whether control's scroll bars are auto-hidden.
	IsSVGBased	Tells whether a control is SVG-based (loaded from SVG image).
	OnClickHotSpot	Called by the framework when user clicks hot spot.
	SetBackgroundColor	Sets background color.
	SetBuffer	Loads image from the memory buffer.
	SetHighlightHotArea	Defines an area to highlight.
	SetHotSpotToolTip	Sets hot spot tool tip.
	SetImage	Sets regular and hot images to the hot spot image control.
	SetImage	Sets regular and hot images to the hot spot image control.
	SetScrollBarsStyle	Sets style of scroll bars.

Additional Inherited Members
Protected Member Functions inherited from CBCGPGestureBase
	OnGestureEventBegin	Called by the framework to handle BCGP_GID_BEGIN notification.
	OnGestureEventEnd	Called by the framework to handle BCGP_GID_END notification.
	OnGestureEventPressAndTap	Called by the framework to handle BCGP_GID_PRESSANDTAP notification.
	OnGestureEventRotate	Called by the framework to handle BCGP_GID_ROTATE notification.
	OnGestureEventTwoFingerTap	Called by the framework to handle BCGP_GID_TWOFINGERTAP notification.
	OnGestureEventZoom	Called by the framework to handle BCGP_GID_ZOOM notification.
	ProcessGestureEvent	This method should be called from WM_GESTURE message handler.