From 02e905d8f7e7c12e95ed0c4040ce8ac8a45770ec Mon Sep 17 00:00:00 2001
From: "Sergey V. Zhdanovskih" <serg.zhdanovskih@yandex.ru>
Date: Fri, 21 Jun 2024 22:22:36 +0300
Subject: [PATCH] Added remembering and the feature to select from a list of
 causes and agencies of events (fix #565)

---
 locales/help_enu/gkhHistory.html              |  1 +
 locales/help_rus/gkhHistory.html              |  1 +
 projects/GKCore/GKCore/BaseContext.cs         | 14 ++++++--
 .../Controllers/EventEditDlgController.cs     | 28 +++++++++------
 .../GKCore/Design/Views/IEventEditDlg.cs      |  4 +--
 projects/GKCore/GKCore/GKExtensions.cs        |  9 ++++-
 projects/GKCore/GKCore/ValuesCollection.cs    | 34 ++++++++-----------
 projects/GKTests/GKCore/ControllerTests.cs    |  4 +--
 .../GKTests/GKCore/ValuesCollectionTests.cs   |  4 +--
 .../GKUI/Forms/EventEditDlg.Designer.cs       |  8 ++---
 .../GEDKeeper2/GKUI/Forms/EventEditDlg.cs     |  8 ++---
 .../GEDKeeper3/GKUI/Forms/EventEditDlg.cs     | 12 +++----
 .../GEDKeeper3/GKUI/Forms/EventEditDlg.xeto   |  4 +--
 .../GEDKeeperX/GKUI/Forms/EventEditDlg.xaml   |  4 +--
 .../GKUI/Forms/EventEditDlg.xaml.cs           |  8 ++---
 15 files changed, 80 insertions(+), 63 deletions(-)

diff --git a/locales/help_enu/gkhHistory.html b/locales/help_enu/gkhHistory.html
index 7ae6edab3..f283dc961 100644
--- a/locales/help_enu/gkhHistory.html
+++ b/locales/help_enu/gkhHistory.html
@@ -12,6 +12,7 @@ <h1>Change log</h1>
 
     <p>
         <b>14.06.2024 [v2.30.1 &amp; v3.6.1]</b><ul>
+            <li>Added remembering and the feature to select from a list of causes and agencies of events.
             <li>Added an option to select list filtering methods (differences in speed).
             <li>Added an option to display the full name in one line in trees, for countries with a short form of the full name (hieroglyphs).
             <li>Added custom event types, the feature to turn off events and add custom ones.
diff --git a/locales/help_rus/gkhHistory.html b/locales/help_rus/gkhHistory.html
index f33c21cfa..6eb15d2dc 100644
--- a/locales/help_rus/gkhHistory.html
+++ b/locales/help_rus/gkhHistory.html
@@ -12,6 +12,7 @@ <h1>История версий</h1>
 
     <p>
         <b>14.06.2024 [v2.30.1 &amp; v3.6.1]</b><ul>
+            <li>Добавлено запоминание и возможность выбора из списка причин и удостоверяющих организаций событий.
             <li>Добавлена опция выбора методов фильтрации списков (различия по скорости).
             <li>Добавлена опция вывода в деревьях полного имени в одну строку, для стран с короткой формой полного имени (иероглифы).
             <li>Добавлены настраиваемые типы событий, возможность выключения событий и добавления пользовательских.
diff --git a/projects/GKCore/GKCore/BaseContext.cs b/projects/GKCore/GKCore/BaseContext.cs
index cd1408a30..d2a38c684 100644
--- a/projects/GKCore/GKCore/BaseContext.cs
+++ b/projects/GKCore/GKCore/BaseContext.cs
@@ -192,10 +192,18 @@ public void CollectEventValues(GDMCustomEvent evt)
         {
             if (evt == null) return;
 
-            string evName = evt.GetTagName();
+            string evKey = evt.GetEventKey();
             string evVal = evt.StringValue;
-            if (!string.IsNullOrEmpty(evName) && !string.IsNullOrEmpty(evVal)) {
-                fValuesCollection.Add(evName, evVal, true);
+            if (!string.IsNullOrEmpty(evKey) && !string.IsNullOrEmpty(evVal)) {
+                fValuesCollection.Add(evKey, evVal);
+            }
+
+            if (!string.IsNullOrEmpty(evt.Cause)) {
+                fValuesCollection.Add(GEDCOMTagName.CAUS, evt.Cause);
+            }
+
+            if (!string.IsNullOrEmpty(evt.Agency)) {
+                fValuesCollection.Add(GEDCOMTagName.AGNC, evt.Agency);
             }
         }
 
diff --git a/projects/GKCore/GKCore/Controllers/EventEditDlgController.cs b/projects/GKCore/GKCore/Controllers/EventEditDlgController.cs
index c2eed9175..b5678d4a4 100644
--- a/projects/GKCore/GKCore/Controllers/EventEditDlgController.cs
+++ b/projects/GKCore/GKCore/Controllers/EventEditDlgController.cs
@@ -160,8 +160,12 @@ public override void UpdateView()
             ChangeEventType();
 
             fView.Date.Date = fEvent.Date.Value;
-            fView.Cause.Text = fEvent.Cause;
-            fView.Agency.Text = fEvent.Agency;
+
+            var causVals = fBase.Context.ValuesCollection.GetValues(GEDCOMTagName.CAUS);
+            UpdateCombo(fView.Cause, true, false, causVals, fEvent.Cause);
+
+            var agncVals = fBase.Context.ValuesCollection.GetValues(GEDCOMTagName.AGNC);
+            UpdateCombo(fView.Agency, true, false, agncVals, fEvent.Agency);
 
             fTempLocation = fBase.Context.Tree.GetPtrValue<GDMLocationRecord>(fEvent.Place.Location);
             UpdatePlace(true);
@@ -238,27 +242,29 @@ public void ChangeEventType()
             bool isFact = (evDef.Kind == EventKind.ekFact);
             SetAttributeMode(isFact);
 
-            // TODO: It is necessary to provide the registrable list of values for different tag types.
             string[] vals;
             bool canbeSorted, fixedList;
-
             if (evTag == GEDCOMTagName._BGRO) {
                 vals = GKData.BloodGroups.Split('|');
                 canbeSorted = false;
                 fixedList = true;
             } else {
-                vals = fBase.Context.ValuesCollection.GetValues(evTag);
+                string evKey = evDef.Tag + ":" + evDef.Type;
+                vals = fBase.Context.ValuesCollection.GetValues(evKey);
                 canbeSorted = true;
                 fixedList = false;
             }
+            UpdateCombo(fView.Attribute, canbeSorted, fixedList, vals, fView.Attribute.Text);
+        }
 
-            if (vals != null) {
-                string tmp = fView.Attribute.Text;
-                fView.Attribute.Clear();
-                fView.Attribute.AddRange(vals, canbeSorted);
-                fView.Attribute.Text = tmp;
-                fView.Attribute.ReadOnly = fixedList;
+        private void UpdateCombo(IComboBox combo, bool canbeSorted, bool readOnly, string[] values, string current)
+        {
+            combo.Clear();
+            if (values != null) {
+                combo.AddRange(values, canbeSorted);
             }
+            combo.Text = current;
+            combo.ReadOnly = readOnly;
         }
 
         public void SendData(string signature, string data)
diff --git a/projects/GKCore/GKCore/Design/Views/IEventEditDlg.cs b/projects/GKCore/GKCore/Design/Views/IEventEditDlg.cs
index 4911c5d29..4578ac3e4 100644
--- a/projects/GKCore/GKCore/Design/Views/IEventEditDlg.cs
+++ b/projects/GKCore/GKCore/Design/Views/IEventEditDlg.cs
@@ -35,8 +35,8 @@ public interface IEventEditDlg : ICommonDialog, IBaseEditor, IDataReceiver
 
         IComboBox Attribute { get; }
         ITextBox Place { get; }
-        ITextBox Cause { get; }
-        ITextBox Agency { get; }
+        IComboBox Cause { get; }
+        IComboBox Agency { get; }
 
         ISheetList NotesList { get; }
         ISheetList MediaList { get; }
diff --git a/projects/GKCore/GKCore/GKExtensions.cs b/projects/GKCore/GKCore/GKExtensions.cs
index 5515dcba6..ba4e66dc8 100644
--- a/projects/GKCore/GKCore/GKExtensions.cs
+++ b/projects/GKCore/GKCore/GKExtensions.cs
@@ -1,6 +1,6 @@
 /*
  *  "GEDKeeper", the personal genealogical database editor.
- *  Copyright (C) 2009-2022 by Sergey V. Zhdanovskih.
+ *  Copyright (C) 2009-2024 by Sergey V. Zhdanovskih.
  *
  *  This file is part of "GEDKeeper".
  *
@@ -18,9 +18,16 @@
  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+using GDModel;
+using GDModel.Providers.GEDCOM;
+
 namespace GKCore
 {
     public static class GKExtensions
     {
+        public static string GetEventKey(this GDMCustomEvent customEvent)
+        {
+            return (customEvent == null) ? string.Empty : customEvent.GetTagName() + ":" + customEvent.Classification;
+        }
     }
 }
diff --git a/projects/GKCore/GKCore/ValuesCollection.cs b/projects/GKCore/GKCore/ValuesCollection.cs
index 35c77a99a..f7558941a 100644
--- a/projects/GKCore/GKCore/ValuesCollection.cs
+++ b/projects/GKCore/GKCore/ValuesCollection.cs
@@ -1,6 +1,6 @@
 /*
  *  "GEDKeeper", the personal genealogical database editor.
- *  Copyright (C) 2009-2017 by Sergey V. Zhdanovskih.
+ *  Copyright (C) 2009-2024 by Sergey V. Zhdanovskih.
  *
  *  This file is part of "GEDKeeper".
  *
@@ -24,7 +24,7 @@ namespace GKCore
 {
     public sealed class ValuesCollection
     {
-        private readonly Dictionary<string, List<string>> fValues;
+        private readonly Dictionary<string, SortedSet<string>> fValues;
 
         public int Count
         {
@@ -33,7 +33,7 @@ public int Count
 
         public ValuesCollection()
         {
-            fValues = new Dictionary<string, List<string>>();
+            fValues = new Dictionary<string, SortedSet<string>>();
         }
 
         public void Clear()
@@ -41,21 +41,16 @@ public void Clear()
             fValues.Clear();
         }
 
-        public void Add(string name, string value, bool excludeDuplicates = false)
+        public void Add(string name, string value)
         {
-            List<string> arrayList;
-            if (!fValues.TryGetValue(name, out arrayList)) {
-                arrayList = new List<string>(1);
-                fValues.Add(name, arrayList);
+            SortedSet<string> set;
+            if (!fValues.TryGetValue(name, out set)) {
+                set = new SortedSet<string>();
+                fValues.Add(name, set);
             }
 
-            if (value == null) return;
-
-            if (!excludeDuplicates) {
-                arrayList.Add(value);
-            } else {
-                if (!arrayList.Contains(value)) arrayList.Add(value);
-            }
+            if (!string.IsNullOrEmpty(value))
+                set.Add(value);
         }
 
         public void Remove(string name)
@@ -65,15 +60,14 @@ public void Remove(string name)
 
         public string[] GetValues(string name)
         {
-            List<string> list;
-            if (!fValues.TryGetValue(name, out list)) {
+            SortedSet<string> set;
+            if (!fValues.TryGetValue(name, out set)) {
                 return new string[0];
             }
 
-            int num = list.Count;
+            int num = set.Count;
             string[] array = new string[num];
-            list.CopyTo(0, array, 0, num);
-
+            set.CopyTo(array, 0, num);
             return array;
         }
     }
diff --git a/projects/GKTests/GKCore/ControllerTests.cs b/projects/GKTests/GKCore/ControllerTests.cs
index f93062891..3a91c4bd7 100644
--- a/projects/GKTests/GKCore/ControllerTests.cs
+++ b/projects/GKTests/GKCore/ControllerTests.cs
@@ -253,8 +253,8 @@ public void Test_EventEditDlgController()
             view.Date.Returns(Substitute.For<IDateControl>());
             view.Attribute.Returns(Substitute.For<IComboBox>());
             view.Place.Returns(Substitute.For<ITextBox>());
-            view.Cause.Returns(Substitute.For<ITextBox>());
-            view.Agency.Returns(Substitute.For<ITextBox>());
+            view.Cause.Returns(Substitute.For<IComboBox>());
+            view.Agency.Returns(Substitute.For<IComboBox>());
             view.NotesList.Returns(Substitute.For<ISheetList>());
             view.MediaList.Returns(Substitute.For<ISheetList>());
             view.SourcesList.Returns(Substitute.For<ISheetList>());
diff --git a/projects/GKTests/GKCore/ValuesCollectionTests.cs b/projects/GKTests/GKCore/ValuesCollectionTests.cs
index 4fd492191..96540ab98 100644
--- a/projects/GKTests/GKCore/ValuesCollectionTests.cs
+++ b/projects/GKTests/GKCore/ValuesCollectionTests.cs
@@ -32,10 +32,10 @@ public void Test_Common()
 
             valsCol.Add("red", "rojo");
             valsCol.Add("green", "verde");
-            valsCol.Add("blue", "azul", true);
+            valsCol.Add("blue", "azul");
             valsCol.Add("red", "rouge");
             valsCol.Add("red", null);
-            valsCol.Add("red", "rouge", true);
+            valsCol.Add("red", "rouge");
 
             Assert.AreEqual(3, valsCol.Count);
 
diff --git a/projects/GKv2/GEDKeeper2/GKUI/Forms/EventEditDlg.Designer.cs b/projects/GKv2/GEDKeeper2/GKUI/Forms/EventEditDlg.Designer.cs
index e5fed42a0..417d911ea 100644
--- a/projects/GKv2/GEDKeeper2/GKUI/Forms/EventEditDlg.Designer.cs
+++ b/projects/GKv2/GEDKeeper2/GKUI/Forms/EventEditDlg.Designer.cs
@@ -18,8 +18,8 @@ partial class EventEditDlg
 		private System.Windows.Forms.Label lblAttrValue;
 		private System.Windows.Forms.ComboBox cmbEventType;
 		private System.Windows.Forms.TextBox txtEventPlace;
-		private System.Windows.Forms.TextBox txtEventCause;
-		private System.Windows.Forms.TextBox txtEventOrg;
+		private System.Windows.Forms.ComboBox txtEventCause;
+		private System.Windows.Forms.ComboBox txtEventOrg;
 		private System.Windows.Forms.ComboBox txtAttribute;
 		private System.Windows.Forms.Button btnPlaceAdd;
 		private System.Windows.Forms.Button btnPlaceDelete;
@@ -42,8 +42,8 @@ private void InitializeComponent()
 		    this.btnPlaceDelete = new System.Windows.Forms.Button();
 		    this.cmbEventType = new System.Windows.Forms.ComboBox();
 		    this.txtEventPlace = new System.Windows.Forms.TextBox();
-		    this.txtEventCause = new System.Windows.Forms.TextBox();
-		    this.txtEventOrg = new System.Windows.Forms.TextBox();
+		    this.txtEventCause = new System.Windows.Forms.ComboBox();
+		    this.txtEventOrg = new System.Windows.Forms.ComboBox();
 		    this.txtAttribute = new System.Windows.Forms.ComboBox();
 		    this.pageNotes = new System.Windows.Forms.TabPage();
 		    this.pageMultimedia = new System.Windows.Forms.TabPage();
diff --git a/projects/GKv2/GEDKeeper2/GKUI/Forms/EventEditDlg.cs b/projects/GKv2/GEDKeeper2/GKUI/Forms/EventEditDlg.cs
index cbfb712d1..d15dc37e9 100644
--- a/projects/GKv2/GEDKeeper2/GKUI/Forms/EventEditDlg.cs
+++ b/projects/GKv2/GEDKeeper2/GKUI/Forms/EventEditDlg.cs
@@ -80,14 +80,14 @@ ITextBox IEventEditDlg.Place
             get { return GetControlHandler<ITextBox>(txtEventPlace); }
         }
 
-        ITextBox IEventEditDlg.Cause
+        IComboBox IEventEditDlg.Cause
         {
-            get { return  GetControlHandler<ITextBox>(txtEventCause); }
+            get { return  GetControlHandler<IComboBox>(txtEventCause); }
         }
 
-        ITextBox IEventEditDlg.Agency
+        IComboBox IEventEditDlg.Agency
         {
-            get { return  GetControlHandler<ITextBox>(txtEventOrg); }
+            get { return  GetControlHandler<IComboBox>(txtEventOrg); }
         }
 
         #endregion
diff --git a/projects/GKv3/GEDKeeper3/GKUI/Forms/EventEditDlg.cs b/projects/GKv3/GEDKeeper3/GKUI/Forms/EventEditDlg.cs
index 8be9c859d..e8f9876b2 100644
--- a/projects/GKv3/GEDKeeper3/GKUI/Forms/EventEditDlg.cs
+++ b/projects/GKv3/GEDKeeper3/GKUI/Forms/EventEditDlg.cs
@@ -53,8 +53,8 @@ public sealed partial class EventEditDlg : CommonDialog<IEventEditDlg, EventEdit
         private Label lblAttrValue;
         private ComboBox cmbEventType;
         private TextBox txtEventPlace;
-        private TextBox txtEventCause;
-        private TextBox txtEventOrg;
+        private ComboBox txtEventCause;
+        private ComboBox txtEventOrg;
         private ComboBox txtAttribute;
         private Button btnPlaceAdd;
         private Button btnPlaceDelete;
@@ -109,14 +109,14 @@ ITextBox IEventEditDlg.Place
             get { return GetControlHandler<ITextBox>(txtEventPlace); }
         }
 
-        ITextBox IEventEditDlg.Cause
+        IComboBox IEventEditDlg.Cause
         {
-            get { return  GetControlHandler<ITextBox>(txtEventCause); }
+            get { return  GetControlHandler<IComboBox>(txtEventCause); }
         }
 
-        ITextBox IEventEditDlg.Agency
+        IComboBox IEventEditDlg.Agency
         {
-            get { return  GetControlHandler<ITextBox>(txtEventOrg); }
+            get { return  GetControlHandler<IComboBox>(txtEventOrg); }
         }
 
         #endregion
diff --git a/projects/GKv3/GEDKeeper3/GKUI/Forms/EventEditDlg.xeto b/projects/GKv3/GEDKeeper3/GKUI/Forms/EventEditDlg.xeto
index d85544234..ba91dae93 100644
--- a/projects/GKv3/GEDKeeper3/GKUI/Forms/EventEditDlg.xeto
+++ b/projects/GKv3/GEDKeeper3/GKUI/Forms/EventEditDlg.xeto
@@ -40,12 +40,12 @@
 
             <TableRow>
               <Label x:Name="lblCause" />
-              <TextBox x:Name="txtEventCause" />
+              <ComboBox x:Name="txtEventCause" />
             </TableRow>
 
             <TableRow>
               <Label x:Name="lblOrg" />
-              <TextBox x:Name="txtEventOrg" />
+              <ComboBox x:Name="txtEventOrg" />
             </TableRow>
 
             <TableRow ScaleHeight="True" />
diff --git a/projects/GKvX/GEDKeeperX/GKUI/Forms/EventEditDlg.xaml b/projects/GKvX/GEDKeeperX/GKUI/Forms/EventEditDlg.xaml
index 10ad0ef8c..010a4f899 100644
--- a/projects/GKvX/GEDKeeperX/GKUI/Forms/EventEditDlg.xaml
+++ b/projects/GKvX/GEDKeeperX/GKUI/Forms/EventEditDlg.xaml
@@ -51,10 +51,10 @@
                             <comcom:GKDateControl x:Name="dateCtl" Grid.Column="1" Grid.Row="3" />
 
                             <Label x:Name="lblCause" Grid.Column="0" Grid.Row="4" />
-                            <Entry x:Name="txtEventCause" Grid.Column="1" Grid.Row="4" />
+                            <comcom:GKComboBox x:Name="txtEventCause" Grid.Column="1" Grid.Row="4" />
 
                             <Label x:Name="lblOrg" Grid.Column="0" Grid.Row="5" />
-                            <Entry x:Name="txtEventOrg" Grid.Column="1" Grid.Row="5" />
+                            <comcom:GKComboBox x:Name="txtEventOrg" Grid.Column="1" Grid.Row="5" />
                         </Grid>
 
                         <Label VerticalOptions="FillAndExpand" />
diff --git a/projects/GKvX/GEDKeeperX/GKUI/Forms/EventEditDlg.xaml.cs b/projects/GKvX/GEDKeeperX/GKUI/Forms/EventEditDlg.xaml.cs
index 5ed380af8..4d78cb171 100644
--- a/projects/GKvX/GEDKeeperX/GKUI/Forms/EventEditDlg.xaml.cs
+++ b/projects/GKvX/GEDKeeperX/GKUI/Forms/EventEditDlg.xaml.cs
@@ -74,14 +74,14 @@ ITextBox IEventEditDlg.Place
             get { return GetControlHandler<ITextBox>(txtEventPlace); }
         }
 
-        ITextBox IEventEditDlg.Cause
+        IComboBox IEventEditDlg.Cause
         {
-            get { return  GetControlHandler<ITextBox>(txtEventCause); }
+            get { return  GetControlHandler<IComboBox>(txtEventCause); }
         }
 
-        ITextBox IEventEditDlg.Agency
+        IComboBox IEventEditDlg.Agency
         {
-            get { return  GetControlHandler<ITextBox>(txtEventOrg); }
+            get { return  GetControlHandler<IComboBox>(txtEventOrg); }
         }
 
         #endregion