LT-21491: Move DeleteRecord to Pub/Sub

Cherry-pick from the PubSub branch to the main branch using
the following commands:
git cherry-pick --no-commit 934ebfd
git cherry-pick --no-commit ad97751

After the cherry-pick additional edits were made to:
1. resolve conflicts
2. standardize on the use of:
using static SIL.FieldWorks.Common.FwUtils.FwUtils;

Author: mark-sil

Src/Common/Controls/XMLViews/XmlBrowseRDEView.cs

@@ -12,6 +12,7 @@
 using SIL.LCModel.Core.Text;
 using SIL.LCModel.Core.KernelInterfaces;
 using SIL.FieldWorks.Common.FwUtils;
+using static SIL.FieldWorks.Common.FwUtils.FwUtils;
 using SIL.LCModel;
 using SIL.FieldWorks.Common.RootSites;
 using SIL.LCModel.Application;
@@ -74,6 +75,8 @@ protected override void Dispose( bool disposing )
 
 			if( disposing )
 			{
+				Subscriber.Unsubscribe(EventConstants.DeleteRecord, DeleteRecord);
+
 				if (components != null)
 				{
 					components.Dispose();
@@ -99,6 +102,8 @@ public override void Init(XmlNode nodeSpec, int hvoRoot, int fakeFlid,
 
 			// Use the ones in fakeFlid, and any we create.
 			base.Init(nodeSpec, hvoRoot, fakeFlid, cache, mediator, bv);
+
+			Subscriber.Subscribe(EventConstants.DeleteRecord, DeleteRecord);
 		}
 
 		#endregion Construction, initialization, and disposal.
@@ -1059,12 +1064,22 @@ public bool OnDeleteRecordToolTip(object holder)
 
 		/// ------------------------------------------------------------------------------------
 		/// <summary>
-		/// Called when [delete record].
+		/// Method that handles the menu handling for deleting records.
+		/// Triggered from (DistFiles\Language Explorer\Configuration\Main.xml)
 		/// </summary>
 		/// <param name="commandObject">The command object.</param>
 		/// <returns></returns>
 		/// ------------------------------------------------------------------------------------
-		public override bool OnDeleteRecord(object commandObject)
+		public bool OnDeleteRecord(object commandObject)
+		{
+			DeleteRecord(commandObject);
+			return true;
+		}
+
+		/// <summary>
+		/// Method to handle published messages for DeleteRecord
+		/// </summary>
+		private void DeleteRecord(object _)
 		{
 			CheckDisposed();
 
@@ -1073,11 +1088,11 @@ public override bool OnDeleteRecord(object commandObject)
 
 			IVwSelection vwsel = m_rootb.Selection;
 			if (vwsel == null)
-				return false;
+				return;
 			ISilDataAccess sda = m_bv.SpecialCache;
 			List<XmlNode> columns = m_xbvvc.ColumnSpecs;
 			if (columns == null || columns.Count == 0)
-				return false;		// Something is broken!
+				return;		// Something is broken!
 
 			TextSelInfo tsi = new TextSelInfo(m_rootb.Selection);
 			if (tsi.ContainingObject(0) == XmlRDEBrowseViewVc.khvoNewItem)
@@ -1087,55 +1102,9 @@ public override bool OnDeleteRecord(object commandObject)
 			else
 			{
 				// 1. Remove the domain from the sense shown in the second column.
-				// 2. Delete the sense iff it is now empty except for the definition shown.
-				// 3. Delete the entry iff the entry now has no senses.
-#if false // JohnT: don't understand the following code at all. In particular it makes no sense
-				// to use ihvoRoot to index rgvsli; ihvoRoot is always zero in this view, it has only one root.
-				// Possibly this was an unsuccessful attempt to adapt some generic code I wrote to this
-				// particular application involving senses and entries?
-				// I'm leaving it in existence for now in case the original author turns up and
-				// can explain what he was getting at.
-				int cLevels = vwsel.get_BoxDepth(true);
-				int iLevel;
-				int cBoxes = -1;
-				int iBox = -1;
-				VwBoxType[] rgvbt = new VwBoxType[cLevels];
-				VwBoxType vbt = VwBoxType.kvbtUnknown;
-				for (iLevel = 0; iLevel < cLevels; ++iLevel)
-				{
-					vbt = vwsel.get_BoxType(false, iLevel);
-					if (vbt == VwBoxType.kvbtTableCell)
-					{
-						cBoxes = vwsel.get_BoxCount(true, iLevel);
-						iBox = vwsel.get_BoxIndex(true, iLevel);
-						break;
-					}
-				}
-				Debug.Assert(cBoxes == 2);
-				Debug.Assert(iBox != -1);
-				int hvoEntry;
-				int hvoSense;
-				if (iBox == 0)
-				{
-					hvoEntry = rgvsli[ihvoRoot].hvo;
-					IVwSelection vwsel2 = m_rootb.MakeSelInBox(vwsel, false, iLevel, 1,
-						true, false, false);
-					SelLevInfo[] rgvsli2 = SelLevInfo.AllTextSelInfo(vwsel, vwsel2.CLevels(false) - 1,
-						out ihvoRoot, out tag, out cpropPrevious, out ichAnchor, out ichEnd,
-						out ws, out fAssocPrev, out ihvoEnd, out ttp);
-					hvoSense = rgvsli2[ihvoRoot].hvo;
-				}
-				else
-				{
-					hvoSense = rgvsli[ihvoRoot].hvo;
-					IVwSelection vwsel2 = m_rootb.MakeSelInBox(vwsel, false, iLevel, 0,
-						true, false, false);
-					SelLevInfo[] rgvsli2 = SelLevInfo.AllTextSelInfo(vwsel, vwsel2.CLevels(false) - 1,
-						out ihvoRoot, out tag, out cpropPrevious, out ichAnchor, out ichEnd,
-						out ws, out fAssocPrev, out ihvoEnd, out ttp);
-					hvoEntry = rgvsli2[ihvoRoot].hvo;
-				}
-#else
+				// 2. Delete the sense if it is now empty except for the definition shown.
+				// 3. Delete the entry if the entry now has no senses.
+
 				int cvsli = tsi.Levels(false) - 1;
 				int tag = tsi.ContainingObjectTag(cvsli - 1);
 				Debug.Assert(cvsli >= 1); // there should be at least one level (each row is a sense)
@@ -1144,7 +1113,7 @@ public override bool OnDeleteRecord(object commandObject)
 				// want to process.
 				int hvoSense = tsi.ContainingObject(cvsli - 1);
 				int hvoEntry = m_cache.ServiceLocator.GetInstance<ICmObjectRepository>().GetObject(hvoSense).Owner.Hvo;
-#endif
+
 				// If this was an editable object, it no longer is, because it's about to no longer exist.
 				RDEVc.EditableObjectsRemove(hvoSense);
 
@@ -1227,7 +1196,6 @@ public override bool OnDeleteRecord(object commandObject)
 					}
 				});
 			}
-			return true;
 		}
 
 		#endregion Other message handlers

Src/Common/Controls/XMLViews/XmlBrowseViewBase.cs

@@ -2063,21 +2063,6 @@ public virtual bool OnDisplayDeleteRecord(object commandObject,
 			return false;
 		}
 
-		/// ------------------------------------------------------------------------------------
-		/// <summary>
-		/// Called when [delete record].
-		/// </summary>
-		/// <param name="commandObject">The command object.</param>
-		/// <returns></returns>
-		/// ------------------------------------------------------------------------------------
-		public virtual bool OnDeleteRecord(object commandObject)
-		{
-			CheckDisposed();
-
-			return false;
-		}
-
-
 		/// <summary>
 		/// Allows xCore-specific initialization. We don't need any.
 		/// </summary>

Src/FdoUi/FdoUiCore.cs

@@ -1021,9 +1021,7 @@ public bool DeleteUnderlyingObject()
 				object command = this;
 				if (m_command != null)
 					command = m_command;
-#pragma warning disable 618 // suppress obsolete warning
-				m_mediator.SendMessage("DeleteRecord", command);
-#pragma warning restore 618
+				Publisher.Publish(new PublisherParameterObject(EventConstants.DeleteRecord, command));
 			}
 			else
 			{

Src/xWorks/RecordClerk.cs

@@ -421,7 +421,6 @@ public virtual void Init(Mediator mediator, PropertyTable propertyTable, XmlNode
 			StoreClerkInPropertyTable(clerkConfiguration);
 
 			SetupDataContext(false);
-
 		}
 
 		/// <summary>
@@ -1469,7 +1468,20 @@ private bool ShouldNotHandleDeletionMessage
 			get { return Id != "AllReversalEntries" && (!Editable || !IsPrimaryClerk || !m_shouldHandleDeletion); }
 		}
 
+		/// <summary>
+		/// Handler for the 'Delete ...' menu item.
+		/// Triggered from (DistFiles\Language Explorer\Configuration\Main.xml)
+		/// </summary>
 		public bool OnDeleteRecord(object commandObject)
+		{
+			DeleteRecord(commandObject);
+			return true;
+		}
+
+		/// <summary>
+		/// Method to handle published messages for DeleteRecord
+		/// </summary>
+		private void DeleteRecord(object commandObject)
 		{
 			CheckDisposed();
 
@@ -1481,21 +1493,21 @@ public bool OnDeleteRecord(object commandObject)
 			// The m_shouldHandleDeletion member was also added, so the "AllReversalEntries" clerk's primary clerk
 			// would not handle the message, and delete an entire reversal index.
 			if (ShouldNotHandleDeletionMessage)
-				return false;
+				return;
 
 			// It may be null:
 			// 1. if the objects are bing deleted using the keys,
 			// 2. the last one has been deleted, and
 			// 3. the user keeps pressing the del key.
 			// It looks like the command is not being disabled at all or fast enough.
 			if (CurrentObjectHvo == 0)
-				return true;
+				return;
 
 			// Don't allow an object to be deleted if it shouldn't be deleted.
 			if (!CanDelete())
 			{
 				ReportCannotDelete();
-				return true;
+				return;
 			}
 
 			ICmObject thingToDelete = GetObjectToDelete(CurrentObject);
@@ -1542,7 +1554,6 @@ public bool OnDeleteRecord(object commandObject)
 #pragma warning restore 618
 				}
 			}
-			return true; //we handled this, no need to ask anyone else.
 		}
 
 		/// <summary>
@@ -1993,6 +2004,7 @@ public static RecordClerk FindClerk(PropertyTable propertyTable, string id)
 		protected virtual void RemoveNotification()
 		{
 			Subscriber.Unsubscribe(EventConstants.FilterListChanged, FilterListChanged);
+			Subscriber.Unsubscribe(EventConstants.DeleteRecord, DeleteRecord);
 
 			// We need the list to get the cache.
 			if (m_list == null || m_list.IsDisposed || Cache == null || Cache.IsDisposed || Cache.DomainDataByFlid == null)
@@ -2094,6 +2106,7 @@ virtual public void ActivateUI(bool useRecordTreeBar, bool updateStatusBar = tru
 		{
 			// RecordClerk only needs to handle changes if RecordClerk is being used in GUI
 			Subscriber.Subscribe(EventConstants.FilterListChanged, FilterListChanged);
+			Subscriber.Subscribe(EventConstants.DeleteRecord, DeleteRecord);
 
 			m_fIsActiveInGui = true;
 			CheckDisposed();

Src/xWorks/XmlDocView.cs

@@ -1367,27 +1367,6 @@ public virtual bool OnDisplayReplaceText(object commandObject, ref UIItemDisplay
 			return true; //we've handled this
 		}
 
-		/// <summary>
-		/// If this gets called (which it never should), just say we did it, unless we are in the context of reversal entries.
-		/// In the case of reversal entries, we say we did not do it, so the record clerk deals with it.
-		/// </summary>
-		/// <param name="commandObject"></param>
-		/// <returns></returns>
-		public bool OnDeleteRecord(object commandObject)
-		{
-			CheckDisposed();
-
-			if (Clerk.Id == "AllReversalEntries")
-			{
-				return false; // Let the clerk do it.
-			}
-			else
-			{
-				Debug.Assert(false);
-			}
-			return true;
-		}
-
 		public string FindTabHelpId
 		{
 			get { return XmlUtils.GetOptionalAttributeValue(m_configurationParameters, "findHelpId", null); }