Method RenameItem

source/script_menu.cpp:749–814

ResultType UserMenu::RenameItem(UserMenuItem *aMenuItem, LPTSTR aNewName)
// Caller should specify "" for aNewName to convert aMenuItem into a separator.
// Returns FAIL if the new name conflicts with an existing name.
{
	if (_tcslen(aNewName) > MAX_MENU_NAME_LENGTH)
		return FAIL; // Caller should display error if desired.

	// Preserve any additional type flags set by options, but exclude the main type bits.
	// Also clear MFT_OWNERDRAW (if set by the script), since it changes the meaning of dwTypeData.
	// MSDN: "The MFT_BITMAP, MFT_SEPARATOR, and MFT_STRING values cannot be combined with one another."
	UINT new_type = (aMenuItem->mMenuType & ~(MFT_BITMAP | MFT_SEPARATOR | MFT_STRING | MFT_OWNERDRAW))
		| (*aNewName ? MFT_STRING : MFT_SEPARATOR);

	if (!mMenu) // Just update the member variables for later use when the menu is created.
	{
		aMenuItem->mMenuType = (WORD)new_type;
		return UpdateName(aMenuItem, aNewName);
	}

	MENUITEMINFO mii;
	mii.cbSize = sizeof(mii);
	mii.fMask = 0;

	if (*aNewName)
	{
		if (aMenuItem->mMenuType & MFT_SEPARATOR)
		{
			// Since this item is currently a separator, the system will have disabled it.
			// Set the item's state to what it should be:
			mii.fMask |= MIIM_STATE;
			mii.fState = aMenuItem->mMenuState;
		}
	}
	else // converting into a separator
	{
		// Testing shows that if an item is converted into a separator and back into a
		// normal item, it retains its submenu.  So don't set the submenu to NULL, since
		// it's not necessary and would result in the OS destroying the submenu:
		//if (aMenuItem->mSubmenu)  // Converting submenu into a separator.
		//{
		//	mii.fMask |= MIIM_SUBMENU;
		//	mii.hSubMenu = NULL;
		//}
	}

	mii.fMask |= MIIM_TYPE;
	mii.fType = new_type;
	mii.dwTypeData = aNewName;

	// v1.1.04: If the new and old names both have accelerators, call UpdateAccelerators() if they
	// are different. Otherwise call it if only one is NULL (i.e. accelerator was added or removed).
	LPTSTR old_accel = _tcschr(aMenuItem->mName, '\t'), new_accel = _tcschr(aNewName, '\t');
	bool update_accel = old_accel && new_accel ? _tcsicmp(old_accel, new_accel) : old_accel != new_accel;

	// Failure is rare enough in the below that no attempt is made to undo the above:
	BOOL result = SetMenuItemInfo(mMenu, aMenuItem->mMenuID, FALSE, &mii);
	UPDATE_GUI_MENU_BARS(mMenuType, mMenu)  // Verified as being necessary.
	if (  !(result && UpdateName(aMenuItem, aNewName))  )