# $mouse(5)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

$mouse - Mouse configuration variable

## SYNOPSIS

$mouse bitmask; Default is system dependent

## DESCRIPTION

The $mouse is used to define and configure the MicroEmacs mouse support, it is a bit based flag where:-

0x00f

Defines the number of button the mouse has, only values 1, 2 & 3 are useful. By default MicroEmacs uses the system information to determine the number of buttons on the mouse, this is not fool proof so the user can set these bits to the appropriate number if the initial value is incorrect.

0x010

If set the mouse is enabled, if clear the mouse will not function. On systems which do not support mice (such as UNIX Termcap) this bit will be clear and can not be altered.

0x020

If set the buttons are reversed, i.e. the left button becomes the right and vice versa. By default this bit is clear.

0xf0000

Defines the current mouse icon to used, valid values are as follows:

0x00000 - Set mouse to default icon.
0x10000 - Set mouse to arrow icon.
0x20000 - Set mouse to text I-beam icon.
0x30000 - Set mouse to crosshair icon.
0x40000 - Set mouse to the grab icon.
0x50000 - Set mouse to the wait icon.
0x60000 - Set mouse to the stop icon.

This feature is not supported on some systems and on others some icons are not obvious due to platform limitations.

## EXAMPLE

The following example checks that the mouse is currently available, if not, it aborts.

    !if &not &band $mouse 0x10
        ml-write "[Mouse support is not currently available]"
        !abort
    !endif

## NOTES

The mouse can be easily configured using user-setup(3).

## SEE ALSO

user-setup(3), $system(5), $platform(5).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12

</HMTL>