snestracker icon indicating copy to clipboard operation
snestracker copied to clipboard

Comments in the Pattern Editor

Open bazz1tv opened this issue 4 years ago • 0 comments

Let's face it, pattern data can become a mundane mess. To make this easier to manage and understand, allow the user to add comments. Requested by @RowanDDR.

What follows is a brain storm on impl'ing the feature.

The comments will go become metadata, perhaps easiestly impl'd in the PatternMeta class or by creating a TrackRowMeta class.

Somehow (right clicking over a row and getting a context menu including the option to add a comment), the user can add a comment to a row on the active pattern in the pattern editor. When this is activated, a variation on a TextEditRect should appear, take focus, and allow the user to write in their comment.

In order not to compete with the tracker arrangement, comments could behave like tooltips, in that they are simply an icon that you must click on to reveal the comment.

The comment, when revealed, needs a button to edit it or remove it. (right clicking on the comment should produce a context menu allowing the same).

I want a comment icon, small enough to fit in a row, cool enough to attract some.attention.

Comments should be expandable. When expanded, they take up a row of space. The pattern editor logic will need to use that for its calculations of the layout.

We can decide to save the state of comments when the project is saved. Eg. Which comments are expanded (when that gets impl'd).

Comments could be allowed per track, but since that increases initial complexity, let's first implement per row.

The user may want to permanently display their comment in the patterneditor. Consider how this might be implemented after getting the initial impl done.

bazz1tv avatar Jun 11 '20 12:06 bazz1tv