Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update SetRadioMode() method to descibe radio mode

Browse Source
This commit is contained in:
John Scipione 2013-11-11 19:27:13 -05:00
parent 104c0688da
commit 24be9ac7fd
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/user/interface/Menu.dox
View File

@ -578,7 +578,18 @@
\fn void BMenu::SetRadioMode(bool on)
\brief Turns radio mode on or off.
Turning radio mode off also turns label-from-marked mode off.
Turning radio mode off also turns off label-from-marked mode.
Radio mode means that only one menu item can be set as marked at a time.
Marking a menu item automatically unmarks all other menu items and draws
a check mark on the left side of the marked menu item. You don't have to
call BMenuItem::SetMarked() yourself for a menu in radio mode, this is done
for you automatically.
Radio mode does not work recursively, only the current menu is considered.
If you want to make a menu work in radio mode recursively you'll have to
turn radio mode off and iterate through each menu marking and unmarking
the items yourself.
\param on \c true to turn radio mode on, \c false to turn it off.
*/