Skip to content

Commit

Permalink
docs: document ActionOnMouse
Browse files Browse the repository at this point in the history
  • Loading branch information
DanySK committed Sep 12, 2024
1 parent e009be4 commit 246a271
Showing 1 changed file with 29 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,42 @@ package it.unibo.alchemist.boundary.fxui.interaction.mouse

/**
* Actions that can happen on a mouse and a certain mouse button.
* The enum's values are based on JavaFX's mouse events, such as onMouseClicked
* The enum's values are based on JavaFX's mouse events, such as onMouseClicked:
* [CLICKED], [DRAGGED], [ENTERED], [EXITED], [MOVED], [PRESSED], [RELEASED].
*/
enum class ActionOnMouse {
/**
* The mouse button was clicked.
*/
CLICKED,

/**
* The mouse button was dragged.
*/
DRAGGED,

/**
* The mouse entered the area.
*/
ENTERED,

/**
* The mouse exited the area.
*/
EXITED,

/**
* The mouse was moved.
*/
MOVED,

/**
* The mouse button was pressed.
*/
PRESSED,

/**
* The mouse button was released.
*/
RELEASED,
}

0 comments on commit 246a271

Please sign in to comment.