Method ScriptDeleteMenu

source/script_menu.cpp:288–332

ResultType Script::ScriptDeleteMenu(UserMenu *aMenu)
// Deletes a UserMenu object and all the UserMenuItem objects that belong to it.
// Any UserMenuItem object that has a submenu attached to it does not result in
// that submenu being deleted, even if no other menus are using that submenu
// (i.e. the user must delete all menus individually).  Any menus which have
// aMenu as one of their submenus will have that menu item deleted from their
// menus to avoid any chance of problems due to non-existent or NULL submenus.
{
	// Delete any other menu's menu item that has aMenu as its attached submenu:
	// This is not done because reference counting ensures that submenus are not
	// deleted before the parent menu, except when the script is exiting.
	//UserMenuItem *mi, *mi_prev, *mi_to_delete;
	//for (UserMenu *m = mFirstMenu; m; m = m->mNextMenu)
	//	if (m != aMenu) // Don't bother with this menu even if it's submenu of itself, since it will be destroyed anyway.
	//		for (mi = m->mFirstMenuItem, mi_prev = NULL; mi;)
	//		{
	//			mi_to_delete = mi;
	//			mi = mi->mNextMenuItem;
	//			if (mi_to_delete->mSubmenu == aMenu)
	//				m->DeleteItem(mi_to_delete, mi_prev);
	//			else
	//				mi_prev = mi_to_delete;
	//		}
	// Remove aMenu from the linked list.
	UserMenu *aMenu_prev;
	if (aMenu == mFirstMenu) // Checked first since it's always true when called by ~Script().
	{
		mFirstMenu = aMenu->mNextMenu; // Can be NULL if the list will now be empty.
		aMenu_prev = NULL;
	}
	else // Find the item that occurs prior to aMenu in the list:
		for (aMenu_prev = mFirstMenu; aMenu_prev; aMenu_prev = aMenu_prev->mNextMenu)
			if (aMenu_prev->mNextMenu == aMenu)
			{
				aMenu_prev->mNextMenu = aMenu->mNextMenu; // Can be NULL if aMenu was the last one.
				break;
			}
	if (aMenu == mLastMenu)
		mLastMenu = aMenu_prev; // Can be NULL if the list will now be empty.
	--mMenuCount;
	// Do this last when its contents are no longer needed.  It will delete all
	// the items in the menu and destroy the OS menu itself:
	aMenu->Dispose();
	return OK;
}