com.esri.arcgis.controls
Interface IToolbarBuddy

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobeBean, GlobeControl, IToolbarBuddyProxy, MapBean, MapControl, PageLayoutBean, PageLayoutControl, SceneBean, SceneControl

public interface IToolbarBuddy
extends Serializable

Provides access to members that control the ToolbarControl buddy.

Description

Objects that implement the IToolbarBuddy interface can be passed to the IToolbarControl::SetBuddyControl method. The ToolbarControl will set properties on this interface in repsonse to the CurrentTool being set.

Product Availability

Available with ArcGIS Engine.

Method Summary

ITool	getCurrentTool() Current active tool for the buddy.
void	setCurrentToolByRef(ITool pTool) Current active tool for the buddy.

Method Detail

getCurrentTool

ITool getCurrentTool()
                     throws IOException,
                            AutomationException

Current active tool for the buddy.

Description

The CurrentTool is the tool used to interact with the display area of the IToolbarControl::Buddy. The IToolbarBuddy references this tool so that it can:

• Call ITool::Refresh after a Windows paint event.
• Set the windows cursor to the ITool::Cursor property.
• Respond to mouse events with the ITool::OnMouseUp, ITool::OnMouseDown and ITool::OnMouseMove events.
• Respond to keyboard events with the ITool::OnKeyDown and ITool::OnKeyUp events.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.systemUI.ITool

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentToolByRef

void setCurrentToolByRef(ITool pTool)
                         throws IOException,
                                AutomationException

Current active tool for the buddy.

Product Availability

Available with ArcGIS Engine.

Parameters:

pTool - A reference to a com.esri.arcgis.systemUI.ITool (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.