processing-website icon indicating copy to clipboard operation
processing-website copied to clipboard

Fix #631: Add MouseEvent and KeyEvent reference documentation

Open yashodipmore opened this issue 7 months ago • 2 comments

Fixes Issue #631

This PR completely resolves the missing MouseEvent and KeyEvent reference documentation issue by adding comprehensive class references, updating all related function documentation, and providing practical examples.

Problem Summary

The Processing website was missing reference pages for MouseEvent and KeyEvent classes. Users could see methods like mousePressed(event) and keyPressed(event) in function signatures but had no documentation about:

  • What these event objects contained
  • How to use their methods (getX(), getY(), getButton(), getCount(), etc.)
  • When to use event objects vs global variables
  • How to detect modifier keys (Shift, Ctrl, Alt, Meta)

Solution Implemented

New Class References Created

  • MouseEvent class - Complete reference with 8 documented methods
  • KeyEvent class - Complete reference with 8 documented methods
  • Spanish translations - Full internationalization support for both classes

Enhanced Function Documentation

Updated 8 core functions to include event parameter documentation:

  • mousePressed(), mouseReleased(), mouseClicked()
  • mouseMoved(), mouseDragged(), mouseWheel()
  • keyPressed(), keyReleased(), keyTyped()

Comprehensive Examples Added

Created 6 new example files demonstrating:

  • Basic MouseEvent usage with button detection and coordinates
  • Advanced mouse wheel interactions with modifier keys
  • KeyEvent usage with modifier key combinations
  • Keyboard event logging and auto-repeat detection
  • Real-world scenarios like interactive drawing and text input

Files Added/Modified

New Files (10):

Screenshot 2025-06-19 110418 Screenshot 2025-06-19 110336

yashodipmore avatar Jun 19 '25 05:06 yashodipmore