HaikuArchives / StreamRadio

Haiku-native application to search for and listen to internet radio stations.
8 stars 11 forks source link

Add help menu item #16

Closed Vidrep closed 4 years ago

Vidrep commented 4 years ago

Add a help menu item with links to usage instructions and the project website

Begasus commented 4 years ago

A help item in the menu pointing to the doc recently merged here would be enough I think (https://github.com/HaikuArchives/Haiku-Radio/blob/master/docs/userguide.md)

jsteinaker commented 4 years ago

Done on jsteinaker/Haiku-Radio@6b18e764c6ef2ac048de1c29272ee16802d42a36 (I'll merge the features branch to my master if everything's working)

Side note: I've tried to make the F1 key to open the help, with no success. I've seen B_F1_KEY on the documentation, tried to use it. Code compiled but nothing happened when I pressed the key, with or without modificators. Is there any reason for this? Is F1 the key commonly used for help in Haiku?

In the end, I just used Command + H, but I'm all ears.

humdingerb commented 4 years ago

The F1 key isn't used as a 'help' key in Haiku. Good thing, with Windows at work I keep hitting F1 accidentally and have to wait a felt eternity for the doc viewer to pop up so I can close it again...

Shortcuts should only be used for commands that are used regularly. So, I'd just add a 'Help' item with no shortcut.

WRT your help-branch: I propose renaming 'File' to 'App' and put Help, About, Separator, Quit items there.

jsteinaker commented 4 years ago

I followed your advice, it makes a lot of sense. I've updated the pull request with this already in place.

pulkomandy commented 4 years ago

The F keys are a bit special, you have to check for the key string to be B_FUNCTION_KEY and then check the keycode to be B_F1_KEY. This is documented in the Be Book: https://www.haiku-os.org/legacy-docs/bebook/TheKeyboard_CharacterConstants.html

Vidrep commented 4 years ago

Can we close this now?

humdingerb commented 4 years ago

Yes, we can! :)