Method ControlSetPic

source/script_gui.cpp:1510–1586

ResultType GuiType::ControlSetPic(GuiControlType &aControl, LPTSTR aContents, ResultToken &aResultToken)
{
	// Update: The below doesn't work, so it will be documented that a picture control
	// should be always be referred to by its original filename even if the picture changes.
	// Set the text unconditionally even if the picture can't be loaded.  This text must
	// be set to allow GuiControl(Get) to be able to operate upon the picture without
	// needing to identify it via something like "Static14".
	//SetWindowText(control.hwnd, aContents);
	//SendMessage(control.hwnd, WM_SETTEXT, 0, (LPARAM)aContents);

	// Set default options, to be possibly overridden by any options actually present:
	// Fixed for v1.0.23: Below should use GetClientRect() vs. GetWindowRect(), otherwise
	// a size too large will be returned if the control has a border:
	RECT rect;
	GetClientRect(aControl.hwnd, &rect);
	int width = rect.right - rect.left;
	int height = rect.bottom - rect.top;
	int icon_number = 0; // Zero means "load icon or bitmap (doesn't matter)".
	// Note that setting the control's picture handle to NULL sometimes or always shrinks
	// the control down to zero dimensions, so must be done only after the above.

	// Parse any options that are present in front of the filename:
	LPTSTR next_option = omit_leading_whitespace(aContents);
	if (*next_option == '*') // Options are present.  Must check this here and in the for-loop to avoid omitting legitimate whitespace in a filename that starts with spaces.
	{
		LPTSTR option_end;
		TCHAR orig_char;
		for (; *next_option == '*'; next_option = omit_leading_whitespace(option_end))
		{
			// Find the end of this option item:
			if (   !(option_end = StrChrAny(next_option, _T(" \t")))   )  // Space or tab.
				option_end = next_option + _tcslen(next_option); // Set to position of zero terminator instead.
			// Permanently terminate in between options to help eliminate ambiguity for words contained
			// inside other words, and increase confidence in decimal and hexadecimal conversion.
			orig_char = *option_end;
			*option_end = '\0';
			++next_option; // Skip over the asterisk.  It might point to a zero terminator now.
			if (!_tcsnicmp(next_option, _T("Icon"), 4))
				icon_number = ATOI(next_option + 4); // LoadPicture() correctly handles any negative value.
			else
			{
				switch (ctoupper(*next_option))
				{
				case 'W':
					width = ATOI(next_option + 1);
					break;
				case 'H':
					height = ATOI(next_option + 1);
					break;
				// If not one of the above, such as zero terminator or a number, just ignore it.
				}
			}

			*option_end = orig_char; // Undo the temporary termination so that loop's omit_leading() will work.
		} // for() each item in option list

		// The below assigns option_end + 1 vs. next_option in case the filename is contained in a
		// variable ref and/ that filename contains leading spaces.  Example: