VCOM:VectorWorks:Extension:IProviderCursorHandles

From Vectorworks Developer
Jump to navigation Jump to search

Description

namespace VectorWorks::Extension

..put some descriptoin in here...

Interface

// ----------------------------------------------------------------------------------------------------
// {88311AB9-9F69-4093-9AB1-6D9F00DAD543}
static const TSinkIID IID_ProviderCursorHandles = { 0x88311ab9, 0x9f69, 0x4093, { 0x9a, 0xb1, 0x6d, 0x9f, 0x0, 0xda, 0xd5, 0x43 } };

// ----------------------------------------------------------------------------------------------------
class DYNAMIC_ATTRIBUTE IProviderCursorHandles : public IEventSink
{
public:
	virtual VCOMError VCOM_CALLTYPE			GetHandleType(ICursorHandleGetContext* context) = 0;
	virtual VCOMError VCOM_CALLTYPE			GetHandleCueText(ICursorHandleGetContext* context) = 0;
	virtual VCOMError VCOM_CALLTYPE			GetHandleCursorSpec(ICursorHandleGetContext* context) = 0;
	virtual VCOMError VCOM_CALLTYPE			GetHandleImageSpec(ICursorHandleGetContext* context, ViewPt& outImageOffset) = 0;
	virtual VCOMError VCOM_CALLTYPE			GetHandleIsVisible(ICursorHandleGetContext* context) = 0;

	virtual VCOMError VCOM_CALLTYPE			OnCursorAction_MouseDown(ICursorHandleActionContext* context) = 0;
	virtual VCOMError VCOM_CALLTYPE			OnCursorAction_Complete(ICursorHandleActionContext* context) = 0;
	virtual VCOMError VCOM_CALLTYPE			OnCursorAction_MouseMove(ICursorHandleActionContext* context) = 0;
	virtual VCOMError VCOM_CALLTYPE			OnCursorAction_Draw(ICursorHandleActionContext* context) = 0;
	virtual VCOMError VCOM_CALLTYPE			OnCursorAction_Cancel(ICursorHandleActionContext* context) = 0;
};

Members

GetHandleType
GetHandleCueText
GetHandleCursorSpec
GetHandleImageSpec
GetHandleIsVisible
OnCursorAction_MouseDown
OnCursorAction_Complete
OnCursorAction_MouseMove
OnCursorAction_Draw
OnCursorAction_Cancel

Remarks

There is predefined type for smart VCOM pointer VCOMPtr to IProviderCursorHandles interface:

typedef VCOMPtr<IProviderCursorHandles>  IProviderCursorHandlesPtr;

Version

Available from: Vectorworks 2015

See Also

VCOM:VCOMPtr

[[VCOM:VCOMPtr]]