[Overview][Constants][Types][Procedures and functions][Variables][Index] | Reference for unit 'Mouse' (#rtl)

# DetectMouse

Detect the presence of a mouse.

## Declaration

Source position: mouseh.inc line 70

`function DetectMouse: Byte;`

## Description

DetectMouse detects whether a mouse is attached to the system or not. If there is no mouse, then zero is returned. If a mouse is attached, then the number of mouse buttons is returned.

This function should be called after the mouse driver was initialized.

## Errors

None.

## See also

InitMouse |  | Initialize the FPC mouse driver.
DoneMouse |  | Deinitialize mouse driver.

## Example

    Program Example1;

    { Program to demonstrate the DetectMouse function. }

    Uses mouse;

    Var
      Buttons : Byte;

    begin
      InitMouse;
      Buttons:=DetectMouse;
      If Buttons=0 then
        Writeln('No mouse present.')
      else
        Writeln('Found mouse with ',Buttons,' buttons.');
      DoneMouse;
    end.

Documentation generated on: May 14 2021