Key Mapping Edit Screen - cressie176/Load64 GitHub Wiki

Primary Purpose

Add or edit a keyboard remapping for a profile or launch configuration.

Main Screen Design

When adding a new mapping:

┌──────────────────────────────────────────────────────────────────────────────┐
│ TOP BAR                                                                      │
│  <Owner> > Key Mappings > Add                                                │
├──────────────────────────────────────────────────────────────────────────────┤
│                                                                              │
│  FORM                                                                        │
│  ┌────────────────────────────────────────────────────────────────────────┐  │
│  │                   ┌─────────────────────────────────────────────────┐  │  │
│  │  Host Key         │ —                                            \/ │  │  │
│  │                   └─────────────────────────────────────────────────┘  │  │
│  │                                                                        │  │
│  │                   ┌─────────────────────────────────────────────────┐  │  │
│  │  System Key       │ —                                            \/ │  │  │
│  │                   └─────────────────────────────────────────────────┘  │  │
│  │                                                                        │  │
│  │  [Save]   [Cancel]                                                     │  │
│  └────────────────────────────────────────────────────────────────────────┘  │
│                                                                              │
├──────────────────────────────────────────────────────────────────────────────┤
│ BOTTOM BAR                                                                   │
└──────────────────────────────────────────────────────────────────────────────┘

When editing an existing mapping:

┌──────────────────────────────────────────────────────────────────────────────┐
│ TOP BAR                                                                      │
│  <Owner> > Key Mappings > <Host Key>                                         │
├──────────────────────────────────────────────────────────────────────────────┤
│                                                                              │
│  FORM                                                                        │
│  ┌────────────────────────────────────────────────────────────────────────┐  │
│  │                   ┌─────────────────────────────────────────────────┐  │  │
│  │  Host Key         │ Esc                                          \/ │  │  │
│  │                   └─────────────────────────────────────────────────┘  │  │
│  │                                                                        │  │
│  │                   ┌─────────────────────────────────────────────────┐  │  │
│  │  System Key       │ RUN/STOP                                     \/ │  │  │
│  │                   └─────────────────────────────────────────────────┘  │  │
│  │                                                                        │  │
│  │  [Save]   [Cancel]                                                     │  │
│  └────────────────────────────────────────────────────────────────────────┘  │
│                                                                              │
├──────────────────────────────────────────────────────────────────────────────┤
│ BOTTOM BAR                                                                   │
└──────────────────────────────────────────────────────────────────────────────┘

TOP BAR

Focusable: No
Interactive: No
Purpose: Identify the owner and the key mapping being edited

<Owner> is the full breadcrumb path to the owner. i.e.

Owner	Owner Template	Add Example	Edit Example
Profile	Profiles >	Profiles > Multiplayer > Key Mappings > Add	Profiles > Multiplayer > Key Mappings > Esc
Launch Configuration		The Last Ninja > Key Mappings > Add	The Last Ninja > Key Mappings > Esc

FORM

Type: Form
Focusable: Yes (primary focus region)
Interactive: Yes
Purpose: Select the host key and the system key it maps to

Fields are pre-populated when editing an existing mapping, or unset when adding a new one.

Host Key

Dropdown of available host keys displayed using their human-readable labels (e.g. Esc, Left Arrow, Caps Lock). This is the physical key the user presses. Keys are listed in five groups: Special Keys, Function Keys, Letter Keys, Number Keys, Symbol Keys.

When adding a new mapping, host keys already mapped by the current owner are excluded from the dropdown. When editing an existing mapping, the current host key remains available.

System Key

Dropdown of all system keys displayed using their human-readable labels (e.g. RUN/STOP, CRSR LEFT, C=). This is the system key that VICE will register. Keys are listed in five groups: Special Keys, Function Keys, Letter Keys, Number Keys, Symbol Keys.

[Save] / [Cancel]

[Save] saves the mapping and returns to the Key Mapping List screen.
[Cancel] discards changes and returns to the Key Mapping List screen.

BOTTOM BAR

Focusable: No
Interactive: No
Purpose: Display validation errors

After a validation error:

├──────────────────────────────────────────────────────────────────────────────┤
│ BOTTOM BAR                                                                   │
│  <Error message>                                                             │
└──────────────────────────────────────────────────────────────────────────────┘

Behaviour

When adding: both dropdowns are unset. Host keys already mapped by the current owner are excluded from the Host Key dropdown.
When editing: both dropdowns are pre-populated. The current host key is not excluded from the Host Key dropdown.
If validation fails, the error is shown in the bottom bar and the form remains open.

Validation Rules

Name	Type	Required	Notes
Host Key	Dropdown	Yes	Must be selected.
System Key	Dropdown	Yes	Must be selected.