ssCore.Mouse.hide

Hide the system mouse cursor.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

None.


Output Parameters:

result - The new value of the display counter (see notes).


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Mouse.hide( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Mouse.hide( paramsObject );


Notes:

This function sets an internal display counter that determines whether the cursor should be displayed. The cursor is displayed only if the display count is greater than or equal to 0. If a mouse is installed, the initial display count is 0. If no mouse is installed, the display count is -1. Each call to this function returns the new display counter.

Examples:

ssCore.Mouse.hide();