Haiku/haiku
Haiku/haiku
1
0
Fork 0
mirror of https://review.haiku-os.org/haiku synced 2024-11-23 07:18:40 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

HaikuBook: Improve documentation of AddDynamicItem

Browse Source 
Change-Id: Id682c64f13eb103074bdbee34d531d3e2a91de0f
Reviewed-on: https://review.haiku-os.org/c/haiku/+/6955
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
This commit is contained in:
Zardshard 2023-09-25 19:27:11 -04:00 committed by waddlesplash
parent 493d3c69f3
commit c9afad2268
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -958,14 +958,20 @@
/*!
\fn bool BMenu::AddDynamicItem(add_state state)
\brief Implemented by subclasses to Add a dynamic item to the menu.
\brief Implemented by subclasses to add their own items to the menu.
This function is called when the menu is shown and will be continuously
called until it returns \c false. On the first call, \a state is
\c B_INITIAL_ADD. On subsequent calls \a state is \c B_PROCESSING. If the
function should stop adding items, such as if the user clicks off of it,
the function will be called with \a state set to \c B_ABORT.
\param state Possibilities include:
- \c B_INITIAL_ADD,
- \c B_PROCESSING,
- \c B_ABORT
\return \c true if the dynamic item was added, \c false otherwise.
\return \c true if there is more to do, \c false otherwise.
\since Haiku R1
*/