Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

mouse [-enableScrollWheel boolean] [-mouseButtonTracking int] [-mouseButtonTrackingStatus] [-scrollWheelStatus]

mouse is undoable, NOT queryable, and NOT editable.

This command allows to configure mouse.

Return value

int When -scrollWheelStatus flag is used, will return 1 if scroll wheel support enabled, otherwise 0.
When -mouseButtonTrackingStatus flag is used, will return the number of mouse buttons being tracked.

Flags

enableScrollWheel, mouseButtonTracking, mouseButtonTrackingStatus, scrollWheelStatus
Long name (short name) Argument types Properties
-enableScrollWheel(-esw) boolean create
Enable or disable scroll wheel support.
-scrollWheelStatus(-sws) create
returns the current status of scroll wheel support.
-mouseButtonTracking(-mbt) int create
Set the number (1, 2 or 3) of mouse buttons to track.
Note: this is only supported on Macintosh
-mouseButtonTrackingStatus( -mbs) create
returns the current number of mouse buttons being tracked.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

mouse -enableScrollWheel false;

int $mouseEnabled = `mouse -scrollWheelStatus`;

mouse -mouseButtonTracking 1;

int $numberOfMouseButtons = `mouse -mouseButtonTrackingStatus`;