Reference   Language | Libraries | Comparison | Changes

USBHost : MouseController class

getButton()

Description

Reports the status of the requested mouse button.

Syntax

mouse.getButton(button)

Parameters

button : which mouse button is being requested. Can be one of the following :

  • LEFT_BUTTON
  • RIGHT_BUTTON
  • MIDDLE_BUTTON

Returns

boolean : true if the requested button is pressed, false if it is not pressed.

Example

#include <MouseController.h>

// Initialize USB Controller
USBHost usb;

// Attach mouse controller to USB
MouseController mouse(usb);

// This function intercepts mouse button press
void mousePressed() {
  Serial.print("Pressed: ");
  if (mouse.getButton(LEFT_BUTTON))
    Serial.print("L");
  if (mouse.getButton(MIDDLE_BUTTON))
    Serial.print("M");
  if (mouse.getButton(RIGHT_BUTTON))
    Serial.print("R");
  Serial.println();
}

void setup(){
  Serial.begin(9600);
}

void loop(){
  usb.Task();
}

See Also

Corrections, suggestions, and new documentation should be posted to the Forum.

The text of the Arduino reference is licensed under a Creative Commons Attribution-ShareAlike 3.0 License. Code samples in the reference are released into the public domain.