LT-21519: Implement ConsideringClosing in Pub/Sub system

mark-sil · web-flow · commit fceeb8536974 · 2026-04-15T18:56:39.000-04:00
Note: Currently there are no code paths that will block the close.
diff --git a/Src/Common/Controls/XMLViews/XmlBrowseRDEView.cs b/Src/Common/Controls/XMLViews/XmlBrowseRDEView.cs
@@ -76,6 +76,7 @@ protected override void Dispose( bool disposing )
 			if( disposing )
 			{
 				Subscriber.Unsubscribe(EventConstants.DeleteRecord, DeleteRecord);
+				Subscriber.Unsubscribe(EventConstants.ConsideringClosing, ConsideringClosing);
 
 				if (components != null)
 				{
@@ -104,6 +105,7 @@ public override void Init(XmlNode nodeSpec, int hvoRoot, int fakeFlid,
 			base.Init(nodeSpec, hvoRoot, fakeFlid, cache, mediator, bv);
 
 			Subscriber.Subscribe(EventConstants.DeleteRecord, DeleteRecord);
+			Subscriber.Subscribe(EventConstants.ConsideringClosing, ConsideringClosing);
 		}
 
 		#endregion Construction, initialization, and disposal.
@@ -167,17 +169,22 @@ public override void SetSelectedRowHighlighting()
 		#region XCore message handlers
 
 		/// <summary>
-		/// This name is magic for an xCoreColleague that is active at the time when an xWindow is being closed.
-		/// If some active colleague implements this method, it gets a chance to do something special as the
-		/// xWindow closes (and can veto the close, though we aren't really using that here).
+		/// Cleanup any pending edits before a potential xWindow close.
 		/// </summary>
-		/// <returns></returns>
-		public bool OnConsideringClosing(object sender, CancelEventArgs arg)
+		private void ConsideringClosing(object obj)
 		{
 			CheckDisposed();
-
-			arg.Cancel = CleanupPendingEdits();
-			return arg.Cancel; // if we want to cancel, others don't need to be asked.
+			if (!(obj is CancelEventArgs arg))
+			{
+				Debug.Assert(false, "Received unexpected object type.");
+				return;
+			}
+			// Return if the close has already been canceled by another Subscriber.
+			if (arg.Cancel)
+			{
+				return;
+			}
+			CleanupPendingEdits();
 		}
 
 		/// <summary>
@@ -288,10 +295,8 @@ private void SetSelection()
 		/// <summary>
 		/// Cleanup any pending edits.
 		/// </summary>
-		/// <returns>True to cancel the window closing, otherwise false.</returns>
-		private bool CleanupPendingEdits()
+		private void CleanupPendingEdits()
 		{
-			bool cancelClose = false;
 			ITsString[] rgtss;
 			if (CanGotoNextRow(out rgtss))
 			{
@@ -308,8 +313,6 @@ private bool CleanupPendingEdits()
 				CreateObjectFromEntryRow(rgtss, false);
 			}
 			DoMerges();
-
-			return cancelClose;
 		}
 		/// <summary>
 		/// Check whether we have enough data entered in this row to go on to create another row.
diff --git a/Src/Common/FwUtils/EventConstants.cs b/Src/Common/FwUtils/EventConstants.cs
@@ -11,6 +11,7 @@ public static class EventConstants
 		public const string ClerkOwningObjChanged = "ClerkOwningObjChanged";
 		public const string ConfigureCustomFields = "ConfigureCustomFields";
 		public const string ConfigureHeadwordNumbers = "ConfigureHeadwordNumbers";
+		public const string ConsideringClosing = "ConsideringClosing";
 		public const string CreateFirstRecord = "CreateFirstRecord";
 		public const string DataTreeDelete = "DataTreeDelete";
 		public const string DeleteRecord = "DeleteRecord";
diff --git a/Src/LexText/Interlinear/ConcordanceControl.cs b/Src/LexText/Interlinear/ConcordanceControl.cs
@@ -21,6 +21,7 @@
 using SIL.LCModel.Infrastructure;
 using SIL.FieldWorks.LexText.Controls;
 using SIL.FieldWorks.Common.FwUtils;
+using static SIL.FieldWorks.Common.FwUtils.FwUtils;
 using SIL.LCModel;
 using SIL.FieldWorks.Filters;
 using SIL.FieldWorks.FwCoreDlgs;
@@ -97,6 +98,8 @@ public override void Init(Mediator mediator, PropertyTable propertyTable, XmlNod
 			}
 			// Load any saved settings.
 			LoadSettings();
+
+			Subscriber.Subscribe(EventConstants.ConsideringClosing, ConsideringClosing);
 		}
 
 		/// <summary>
@@ -108,6 +111,8 @@ protected override void Dispose(bool disposing)
 			Debug.WriteLineIf(!disposing, "****************** Missing Dispose() call for " + GetType().Name + ". ******************");
 			if (disposing)
 			{
+				Subscriber.Unsubscribe(EventConstants.ConsideringClosing, ConsideringClosing);
+
 				if (components != null)
 					components.Dispose();
 				if (m_clerk != null)
@@ -264,13 +269,19 @@ public override string AccName
 		/// <summary>
 		/// This is called when the main window is closing.
 		/// </summary>
-		/// <param name="sender"></param>
-		/// <param name="arg"></param>
-		/// <returns></returns>
-		public bool OnConsideringClosing(object sender, CancelEventArgs arg)
+		private void ConsideringClosing(object obj)
 		{
+			if (!(obj is CancelEventArgs arg))
+			{
+				Debug.Assert(false, "Received unexpected object type.");
+				return;
+			}
+			// Return if the close has already been canceled by another Subscriber.
+			if (arg.Cancel)
+			{
+				return;
+			}
 			arg.Cancel = !PrepareToGoAway();
-			return arg.Cancel;
 		}
 
 		#endregion
diff --git a/Src/XCore/xCoreInterfaces/Mediator.cs b/Src/XCore/xCoreInterfaces/Mediator.cs
@@ -1108,25 +1108,6 @@ public bool HasReceiver(string messageName)
 				true);		//we are just checking, don't invoke anything
 		}
 
-		/// <returns>true if the message was canceled, otherwise false.</returns>
-		[Obsolete("Use the the FwUtils Publisher and Subscriber classes instead.", false)]
-		[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
-		public bool SendCancellableMessage(string messageName, object parameter)
-		{
-			CheckDisposed();
-#if DEBUG
-			if(messageName.Substring(0,2) == "On")
-				Debug.Fail("The convention is to send messages without the 'On' prefix.  That is added by the message sending code.");
-#endif
-
-			System.ComponentModel.CancelEventArgs cancelArguments = new  System.ComponentModel.CancelEventArgs(false);
-			InvokeOnColleagues("On"+messageName,
-				null, // types see note above
-				new Object[] { parameter, cancelArguments },
-				true, false);
-			return cancelArguments.Cancel;
-		}
-
 		private bool InvokeOnColleagues(string methodName, Type[] parameterTypes,
 			object[] parameterList, bool stopWhenHandled, bool justCheckingForReceivers)
 		{
diff --git a/Src/XCore/xWindow.cs b/Src/XCore/xWindow.cs
@@ -2257,11 +2257,10 @@ protected virtual void XWindow_Closing(object sender, CancelEventArgs e)
 
 			m_widgetUpdateTimer.Enabled = false;
 
-#pragma warning disable 618 // suppress obsolete warning
-			if (m_mediator.SendCancellableMessage("ConsideringClosing", this))
-#pragma warning restore 618
+			e.Cancel = false;
+			Publisher.Publish(new PublisherParameterObject(EventConstants.ConsideringClosing, e));
+			if (e.Cancel)
 			{
-				e.Cancel = true;
 				m_widgetUpdateTimer.Enabled = true;
 				return;
 			}
diff --git a/Src/xWorks/RecordBrowseView.cs b/Src/xWorks/RecordBrowseView.cs
@@ -3,6 +3,7 @@
 // (http://www.gnu.org/licenses/lgpl-2.1.html)
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.Diagnostics;
 using System.Windows.Forms;
 using System.Xml;
@@ -67,6 +68,7 @@ protected override void Dispose(bool disposing)
 			if (disposing)
 			{
 				Subscriber.Unsubscribe(EventConstants.ClerkOwningObjChanged, ClerkOwningObjChanged);
+				Subscriber.Unsubscribe(EventConstants.ConsideringClosing, ConsideringClosing);
 
 				if (ExistingClerk != null) // ExistingClerk, *not* Clerk (see doc on ExistingClerk)
 				{
@@ -677,6 +679,7 @@ public override void Init(Mediator mediator, PropertyTable propertyTable, XmlNod
 			ShowRecord();
 
 			Subscriber.Subscribe(EventConstants.ClerkOwningObjChanged, ClerkOwningObjChanged);
+			Subscriber.Subscribe(EventConstants.ConsideringClosing, ConsideringClosing);
 		}
 
 		private void CheckExpectedListItemsClassInSync()
@@ -699,12 +702,21 @@ protected override void GetMessageAdditionalTargets(List<IxCoreColleague> collec
 
 		#endregion // IxCoreColleague implementation
 
-		public bool OnConsideringClosing(object argument, System.ComponentModel.CancelEventArgs args)
+		private void ConsideringClosing(object obj)
 		{
 			CheckDisposed();
 
+			if (!(obj is CancelEventArgs args))
+			{
+				Debug.Assert(false, "Received unexpected object type.");
+				return;
+			}
+			// Return if the close has already been canceled by another Subscriber.
+			if (args.Cancel)
+			{
+				return;
+			}
 			args.Cancel = !PrepareToGoAway();
-			return args.Cancel; // if we want to cancel, others don't need to be asked.
 		}
 
 		#region IxCoreContentControl implementation
diff --git a/Src/xWorks/RecordDocView.cs b/Src/xWorks/RecordDocView.cs
@@ -9,6 +9,7 @@
 // <remarks>
 // </remarks>
 using System;
+using System.ComponentModel;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Drawing;
@@ -18,6 +19,7 @@
 using SIL.FieldWorks.Common.Controls;
 using SIL.FieldWorks.Common.Framework;
 using SIL.FieldWorks.Common.FwUtils;
+using static SIL.FieldWorks.Common.FwUtils.FwUtils;
 using SIL.FieldWorks.Common.RootSites;
 using SIL.FieldWorks.Common.Widgets;
 using SIL.LCModel.Core.KernelInterfaces;
@@ -65,6 +67,8 @@ public override void Init(Mediator mediator, PropertyTable propertyTable, XmlNod
 
 			InitBase(mediator, propertyTable, configurationParameters);
 			m_fullyInitialized = true;
+
+			Subscriber.Subscribe(EventConstants.ConsideringClosing, ConsideringClosing);
 		}
 
 		protected override void GetMessageAdditionalTargets(System.Collections.Generic.List<IxCoreColleague> collector)
@@ -89,6 +93,8 @@ protected override void Dispose(bool disposing)
 
 			if (disposing)
 			{
+				Subscriber.Unsubscribe(EventConstants.ConsideringClosing, ConsideringClosing);
+
 				if (m_rootSite != null)
 					m_rootSite.Dispose();
 			}
@@ -102,12 +108,21 @@ protected override void Dispose(bool disposing)
 
 		#region Message Handlers
 
-		public bool OnConsideringClosing(object argument, System.ComponentModel.CancelEventArgs args)
+		private void ConsideringClosing(object obj)
 		{
 			CheckDisposed();
 
+			if (!(obj is CancelEventArgs args))
+			{
+				Debug.Assert(false, "Received unexpected object type.");
+				return;
+			}
+			// Return if the close has already been canceled by another Subscriber.
+			if (args.Cancel)
+			{
+				return;
+			}
 			args.Cancel = !PrepareToGoAway();
-			return args.Cancel; // if we want to cancel, others don't need to be asked.
 		}
 
 		#endregion // Message Handlers
diff --git a/Src/xWorks/RecordEditView.cs b/Src/xWorks/RecordEditView.cs
@@ -14,6 +14,7 @@
 using System.Collections.Generic;
 using SIL.FieldWorks.Common.Widgets;
 using SIL.FieldWorks.Common.FwUtils;
+using static SIL.FieldWorks.Common.FwUtils.FwUtils;
 using SIL.FieldWorks.Common.RootSites;
 using SIL.LCModel.Core.KernelInterfaces;
 using SIL.PlatformUtilities;
@@ -124,6 +125,8 @@ public override void Init(Mediator mediator, PropertyTable propertyTable, XmlNod
 			// If possible make it use the style sheet appropriate for its main window.
 			m_dataEntryForm.StyleSheet = FontHeightAdjuster.StyleSheetFromPropertyTable(m_propertyTable);
 			m_fullyInitialized = true;
+
+			Subscriber.Subscribe(EventConstants.ConsideringClosing, ConsideringClosing);
 		}
 
 		/// -----------------------------------------------------------------------------------
@@ -143,6 +146,8 @@ protected override void Dispose(bool disposing)
 
 			if (disposing)
 			{
+				Subscriber.Unsubscribe(EventConstants.ConsideringClosing, ConsideringClosing);
+
 				if (components != null)
 					components.Dispose();
 				if (m_dataEntryForm != null)
@@ -190,12 +195,21 @@ public override bool OnRecordNavigation(object argument)
 			return true;	//we handled this.
 		}
 
-		public bool OnConsideringClosing(object argument, CancelEventArgs args)
+		private void ConsideringClosing(object obj)
 		{
 			CheckDisposed();
 
+			if (!(obj is CancelEventArgs args))
+			{
+				Debug.Assert(false, "Received unexpected object type.");
+				return;
+			}
+			// Return if the close has already been canceled by another Subscriber.
+			if (args.Cancel)
+			{
+				return;
+			}
 			args.Cancel = !PrepareToGoAway();
-			return args.Cancel; // if we want to cancel, others don't need to be asked.
 		}
 
 		/// <summary>

Original file line number	Diff line number	Diff line change
`@@ -2257,11 +2257,10 @@ protected virtual void XWindow_Closing(object sender, CancelEventArgs e)`
`2257`	`2257`
`2258`	`2258`	`m_widgetUpdateTimer.Enabled = false;`
`2259`	`2259`
`2260`		`-#pragma warning disable 618 // suppress obsolete warning`
`2261`		`- if (m_mediator.SendCancellableMessage("ConsideringClosing", this))`
`2262`		`-#pragma warning restore 618`
	`2260`	`+ e.Cancel = false;`
	`2261`	`+ Publisher.Publish(new PublisherParameterObject(EventConstants.ConsideringClosing, e));`
	`2262`	`+ if (e.Cancel)`
`2263`	`2263`	`{`
`2264`		`- e.Cancel = true;`
`2265`	`2264`	`m_widgetUpdateTimer.Enabled = true;`
`2266`	`2265`	`return;`
`2267`	`2266`	`}`