IRsToolEx Interface Reference

Inherits IRsTool.

List of all members.

Public Member Functions
HRESULT	GetToolPriority ([in] RtMouseEvent *pMouseEvent,[in] IRsNode *pViewNode,[out] RtUlong *pPriority)
HRESULT	OnToolRemove ()
HRESULT	OnFocusLost ()
HRESULT	OnFocus ()
HRESULT	IsToolLocked (RtBool *pbLocked)
HRESULT	ProcessMouseEvent ([in] RtMouseEvent *pMouseEvent,[in] IRsNode *pViewNode)

---

Detailed Description

Interface to Rosetta tool manager, extended version.

With IRsToolEx you can also use IRsTool message handlers.
In this case, return S_OK from OnRelease will cause tool deactivation.
To prevent tool from deactivating, return E_NOTIMPL from OnRelease andS_OK from ProcessMouseEvent.
If you don't want to use OnXXX handlers, return E_NOTIMPL.

---

Member Function Documentation

HRESULT IRsToolEx::GetToolPriority	(	[in] RtMouseEvent *	pMouseEvent,
		[in] IRsNode *	pViewNode,
		[out] RtUlong *	pPriority
	)

Tool priority for automatic override management. Widgets subsystem uses priority 1000.
Setting priority above this value will not activate widget when clicking on it's control surface.

Parameters:

	pMouseEvent	[in] .
	pViewNode	[in] .
	pPriority	[out] .

HRESULT IRsToolEx::OnToolRemove

(

)

Notify tool, that it will be removed from tool manager, so it can perform some cleanups.

HRESULT IRsToolEx::OnFocusLost

(

)

Notify tool, that it will not receive mouse messages.

HRESULT IRsToolEx::OnFocus

(

)

Notify tool, that it becomes active again.

HRESULT IRsToolEx::IsToolLocked

(

RtBool *

pbLocked

)

Test tool, if it is in locked state.
This method is used to perform synchronization with IRsTool interface and is used to evaluate tool manager state.
When returing S_OK, pbLocked defines whether tool is in Drag state (true) or Click state (false).
When in drag state, tool manager does not try to terminate the tool.

Return E_NOTIMPL to use internal tool manager mechanism.

HRESULT IRsToolEx::ProcessMouseEvent	(	[in] RtMouseEvent *	pMouseEvent,
		[in] IRsNode *	pViewNode
	)

Process mouse event. Return value that differs from S_OK will cause tool deactivation.

Parameters:

	pMouseEvent	[in] .
	pViewNode	[in] .