Add option to favorite items in the file browser

[AW1534]

Added the ability to favorite items. This gets added to its own tab named "My Favorites". note that this required a minor config change. I'm unsure whether this counts as a new config version.

<favoriteitems>
  <item path="C:\Program Files\Steinberg\VSTPlugins"/>
  <item path="E:\Documents\lmms\samples\Boi-1da Soundkit 2\Bill Gates Hat.wav"/>
</favoriteitems>

Video Demonstration (slightly outdated):

• https://imgur.com/a/VH0KACw
• Untitled - LMMS 1.3.0-alpha - [Song-Editor] 2025-03-03 21-29-07.mp4.zip

(recovered from #7419)

[sakertooth]

I think the phrasing "Favorites" is better than "Starred Items".

[sakertooth]

Just my initial thoughts and concerns. I think overall, a new class should be made that inherits FileBrowser and then has its own functions and logic for favoriting items. Putting that functionality directly into FileBrowser feels wrong because it seems like there's a layer of abstraction missing (that class shouldn't have to worry about that stuff).

Actually nevermind, not sure yet.

[sakertooth]

We should probably be consistent with either using "favorite" or "favourite" to avoid complications. For the actual GUI, translations can be added as necessary.

I am probably going to be submitting the review in batches since I need to review multiple times.

[sakertooth]

I was thinking of a solution like this:

1. FileBrowser should contain new context menu actions to add or remove favorite items.
2. The context menu actions should update the config as necessary. If the browser is the "Favorite" browser (can make a new class or pass in a bool parameter in the constructor, I prefer a new class), then a Directory or FileItem should be added or removed to/from the main FileBrowserTreeWidget. Otherwise, do nothing (maybe add a star to the right if possible).
3. On construction of the "Favorite" browser, it should be fine to load in the favorite items the same way as the other browsers without much refactoring.

Unless I am mistaken, that should be it (if not, the bulk of the work). No need to maintain a separate list of items or add coupling you don't need.

[AW1534]

2. The context menu actions should update the config as necessary. If the browser is the "Favorite" browser (can make a new class or pass in a bool parameter in the constructor, I prefer a new class), then a Directory or FileItem should be added or removed to/from the main FileBrowserTreeWidget. Otherwise, do nothing (maybe add a star to the right if possible).

This seems like a good solution.
The star on the right is something I wanted to add too, but I realised it would require checking if each item is favourited as it is added, which would end up running std::find_if on each element. in something like the samples or preset browser this would be fine, but in the home or computer browsers this would compound and slow down the loading of the items drastically

[AW1534]

We should probably be consistent with either using "favorite" or "favourite" to avoid complications. For the actual GUI, translations can be added as necessary.

I am probably going to be submitting the review in batches since I need to review multiple times.

I believe I was consistent with "favorite", but as I'm British I may have slipped up. I'll take a look later.

[sakertooth]

I believe I was consistent with "favorite", but as I'm British I may have slipped up. I'll take a look later.

Feel free to choose whatever you are comfortable with. But I would recommend being consistent with one in the code 👍

[AW1534]

I think that's it (for the most part, we have to deal with the icon situation now).

Great, thank you. I'll do that now

[sakertooth]

We didn't have to change the star for the classic theme?

[AW1534]

We didn't have to change the star for the classic theme?

I left the original one in and I think it looks fine for now (discord message)

It's just slightly smaller than the rest.

[sakertooth]

Looks good, thanks. I was also wondering if we wanted to move the star? 🤔
Doesn't matter as much though.

[AW1534]

Looks good, thanks. I was also wondering if we wanted to move the star? 🤔 Doesn't matter as much though.

oh yeah I moved it up in 4848a41. Should I move it back down? I like the position its at now because its quite an important tab

[sakertooth]

oh yeah I moved it up in 4848a41. Should I move it back down? I like the position its at now because its quite an important tab

I was thinking move it above instrument plugins, but its up to you. Don't feel compelled to though. I don't mind where it is too much. Not that big of a deal.

[AW1534]

oh yeah I moved it up in 4848a41. Should I move it back down? I like the position its at now because its quite an important tab

I was thinking move it above instrument plugins, but its up to you. Don't feel compelled to though. I don't mind where it is too much. Not that big of a deal.

I think its better below, because the way I see it, the plugin browser is separate to all the other file browsers (its not even really a file browser, as such)

[regulus79]

I briefly tested this and it seems to work as expected. I'm able to add/remove files/folders from favorites. If I delete a file which has been favorited, that file will disappear from the favorites tab (you have to restart for it to update though). If you add that file back it will appear again in the favorites (I'm not sure if that is intended behavior but it seems fine).

While using it, I felt like it would be useful if you could drag to rearrange the order of the favorite files. Also I kind of expected a star to appear beside the files which are favorited in the other file browsers.

[regulus79]

Is hq_mode used anywhere else in the codebase? I can't seem to find any occurrences, but I'm not sure.

[regulus79]

Also why does the diff show the classic theme icon being renamed, but the default theme icon is being deleted and replaced by a different file (which looks the same?)

[AW1534]

Is hq_mode used anywhere else in the codebase? I can't seem to find any occurrences, but I'm not sure.

not that i'm aware of. @sakertooth probably knows more

[AW1534]

Also why does the diff show the classic theme icon being renamed, but the default theme icon is being deleted and replaced by a different file (which looks the same?)

I had to resize the default icon because it looked bad shown at #7753 (comment)

And this explains why I didn't change the classic theme: #7753 (comment)

[AW1534]

I felt like it would be useful if you could drag to rearrange the order of the favorite files.

I thought about this, but I think that might be to0 complex for me at the moment (I'm new to both Qt and LMMS).

Also I kind of expected a star to appear beside the files which are favorited in the other file browsers.

I also thought about this, and I think it might cause performance issues, as checking if an item is starred requires a loop to be run, and it would be taxing to run this for each item- especially in the My Computer or My Home tabs. (explained here: #7753 (comment))