Skip to content

Commit

Permalink
docs: document ActionFromKey
Browse files Browse the repository at this point in the history
  • Loading branch information
DanySK committed Sep 12, 2024
1 parent 905943b commit 343b995
Showing 1 changed file with 43 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,59 @@ package it.unibo.alchemist.boundary.fxui.interaction.keyboard
* Actions which can be bound to a key on the keyboard.
*/
enum class ActionFromKey(private val description: String) {
/**
* Control modifier.
*/
MODIFIER_CONTROL("Control modifier"),

/**
* Shift modifier.
*/
MODIFIER_SHIFT("Shift modifier"),

/**
* Pan north.
*/
PAN_NORTH("Pan north"),

/**
* Pan south.
*/
PAN_SOUTH("Pan south"),

/**
* Pan east.
*/
PAN_EAST("Pan east"),

/**
* Pan west.
*/
PAN_WEST("Pan west"),

/**
* Deletion.
*/
DELETE("Delete"),

/**
* Move.
*/
MOVE("Move"),

/**
* Edit.
*/
EDIT("Edit"),

/**
* Play and Pause.
*/
PLAY_AND_PAUSE("Play and Pause"),

/**
* Forward one step.
*/
ONE_STEP("Forward one step"),
;

Expand Down

0 comments on commit 343b995

Please sign in to comment.