Method ModifyItem

source/script_menu.cpp:633–678

ResultType UserMenu::ModifyItem(UserMenuItem *aMenuItem, IObject *aCallback, UserMenu *aSubmenu, LPTSTR aOptions)
// Modify the callback, submenu, or options of a menu item (exactly one of these should be NULL and the
// other not except when updating only the options).
// If a menu item becomes a submenu, we don't relinquish its ID in case it's ever made a normal item
// again (avoids the need to re-lookup a unique ID).
{
	if (*aOptions && UpdateOptions(aMenuItem, aOptions) != OK)
		return FAIL; // UpdateOptions displays an error message if aOptions contains invalid options.
	if (!aCallback && !aSubmenu) // We were called only to update this item's options.
		return OK;

	if (aMenuItem->mMenuID >= ID_TRAY_FIRST && aCallback)
	{
		// For a custom label to work for this item, it must have a different ID.
		MENUITEMINFO mii;
		mii.cbSize = sizeof(mii);
		mii.fMask = MIIM_ID;
		mii.wID = g_script.GetFreeMenuItemID();
		if (mMenu)
			SetMenuItemInfo(mMenu, aMenuItem->mMenuID, FALSE, &mii);
		aMenuItem->mMenuID = mii.wID;
	}

	aMenuItem->mCallback = aCallback;  // This will be NULL if this menu item is a separator or submenu.
	if (aMenuItem->mSubmenu == aSubmenu) // Below relies on this check.
		return OK;

	if (aSubmenu)
		aSubmenu->AddRef();
	if (aMenuItem->mSubmenu)
		aMenuItem->mSubmenu->Release();
	aMenuItem->mSubmenu = aSubmenu;

	if (!mMenu)
		return OK;
	// Otherwise, since the OS menu exists, one of these is to be done to aMenuItem in it:
	// 1) Change a submenu to point to a different menu.
	// 2) Change a submenu so that it becomes a normal menu item.
	// 3) Change a normal menu item into a submenu.
	// Replacing or removing a submenu is known to destroy the old submenu as a side-effect,
	// so instead of changing the submenu directly, remove the item and add it back with the
	// correct properties.
	RemoveMenu(mMenu, aMenuItem->mMenuID, MF_BYCOMMAND);
	InternalAppendMenu(aMenuItem, aMenuItem->mNextMenuItem);
	return OK;
}