Method Event

source/script_gui.cpp:9200–9461

void GuiType::Event(GuiIndexType aControlIndex, UINT aNotifyCode, USHORT aGuiEvent, UINT_PTR aEventInfo)
// Caller should pass GUI_EVENT_NONE (zero) for aGuiEvent if it wants us to determine aGuiEvent based on the
// type of control and the incoming aNotifyCode.
// This function handles events within a GUI window that caused one of its controls to change in a meaningful
// way, or that is an event that could trigger an external action, such as clicking a button or icon.
{
	if (aControlIndex >= mControlCount) // Caller probably already checked, but just to be safe.
		return;
	GuiControlType &control = *mControl[aControlIndex];
	if (!control.events.Count()) // But don't check IsMonitoring(aGuiEvent) yet, because aGuiEvent may be undetermined.
		return; // No event handlers associated with this control, so no action.
	if (control.attrib & GUI_CONTROL_ATTRIB_SUPPRESS_EVENTS)
		return;

	// Update: The below is now checked by MsgSleep() at the time the launch actually would occur because
	// g_nThreads will be more accurate/timely then:
	// If this control already has a thread running in its label, don't create a new thread to avoid
	// problems of buried threads, or a stack of suspended threads that might be resumed later
	// at an unexpected time. Users of timer subs that take a long time to run should be aware, as
	// documented in the help file, that long interruptions are then possible.
	//if (g_nThreads >= g_MaxThreadsTotal || (aControl->attrib & GUI_CONTROL_ATTRIB_HANDLER_IS_RUNNING))
	//	continue

	if (aGuiEvent == GUI_EVENT_WM_COMMAND) // Called by WM_COMMAND.
	{
		if (control.events.IsMonitoring(aNotifyCode, GUI_EVENTKIND_COMMAND))
		{
			POST_AHK_GUI_ACTION(mHwnd, aControlIndex, aGuiEvent, aNotifyCode);
			// Do the rest as well, just in case this command corresponds to an event.
		}
		aGuiEvent = GUI_EVENT_NONE; // Determine the actual event below.
	}

	if (aGuiEvent == GUI_EVENT_NONE) // Caller wants us to determine aGuiEvent based on control type and aNotifyCode.
	{
		switch(control.type)
		{
		case GUI_CONTROL_BUTTON:
		case GUI_CONTROL_CHECKBOX:
		case GUI_CONTROL_RADIO:
			switch (aNotifyCode)
			{
			case BN_CLICKED: // Must explicitly list this case since the default label below does a return.
				// Fix for v1.0.24: The below excludes from consideration messages from radios that are
				// being unchecked.  This prevents a radio group's g-label from being fired twice when the
				// user navigates to a new radio via the arrow keys.  It also filters out the BN_CLICKED that
				// occurs when the user tabs over to a radio group that lacks a selected button.  This new
				// behavior seems like it would be desirable most of the time.
				if (control.type == GUI_CONTROL_RADIO && SendMessage(control.hwnd, BM_GETCHECK, 0, 0) == BST_UNCHECKED)
					return;
				aGuiEvent = GUI_EVENT_CLICK;
				break;
			// All three of these require BS_NOTIFY:
			case BN_DBLCLK: aGuiEvent = GUI_EVENT_DBLCLK; break;
			case BN_SETFOCUS: aGuiEvent = GUI_EVENT_FOCUS; break;
			case BN_KILLFOCUS: aGuiEvent = GUI_EVENT_LOSEFOCUS; break;
			default:
				return;