com.esri.arcgis.systemUI
Interface ISystemMouseCursor

All Superinterfaces:

Serializable

All Known Implementing Classes:

SystemMouseCursor

public interface ISystemMouseCursor
extends Serializable

Provides access to members that load and get mouse cursor.

Description

The ISystemMouseCursor interface provides methods and properties for loading mouse cursors and accessing the OLE_HANDLE of a mouse cursor. It is primarily used when developing with the Java and C++ API.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

int	getCursor() Currently loaded mouse cursor.
void	load(int mouseCursorType) Loads system provided mouse cursor.
void	loadFromFile(String fileName) Loads mouse cursor from file.
void	setCursor(int mouseCursor) Currently loaded mouse cursor.

Method Detail

load

void load(int mouseCursorType)
          throws IOException,
                 AutomationException

Loads system provided mouse cursor.

Description

Loads a pre-defined mouse cursor into the SystemMouseCursor. Use the Cursor property to get the handle to the newly loaded cursor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

mouseCursorType - A com.esri.arcgis.systemUI.esriSystemMouseCursor constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromFile

void loadFromFile(String fileName)
                  throws IOException,
                         AutomationException

Loads mouse cursor from file. If file name uses relative path, the path must be relative to current application executable.

Description

The LoadFromFile method creates a SystemMouseCursor based upon the data in the specified file. Files containing cursor data may be in either cursor (.cur) or animated cursor (.ani) format. If file name uses relative path, the path must be relative to current application executable. Use the Cursor property to get the handle to the newly loaded cursor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

fileName - The fileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCursor

int getCursor()
              throws IOException,
                     AutomationException

Currently loaded mouse cursor.

Description

The handle of the mouse cursor that is currently loaded into the SystemMouseCursor using the Load or LoadFromFile methods.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The mouseCursor (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCursor

void setCursor(int mouseCursor)
               throws IOException,
                      AutomationException

Currently loaded mouse cursor.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

mouseCursor - The mouseCursor (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.