WinGui: A useful window utility class that might be useful later.

1 files changed, 127 insertions, 0 deletions

diff --git a/win/CS/HandBrakeWPF/AttachedProperties/WindowHelper.cs b/win/CS/HandBrakeWPF/AttachedProperties/WindowHelper.cs
new file mode 100644
index 000000000..0060658cf
--- /dev/null
+++ b/win/CS/HandBrakeWPF/AttachedProperties/WindowHelper.cs
@@ -0,0 +1,127 @@
+// --------------------------------------------------------------------------------------------------------------------
+// <copyright file="WindowHelper.cs" company="HandBrake Project (http://handbrake.fr)">
+//   This file is part of the HandBrake source code - It may be used under the terms of the GNU General Public License.
+// </copyright>
+// <summary>
+//   A helper to store a windows current state as part of the user settings service.
+// </summary>
+// --------------------------------------------------------------------------------------------------------------------
+
+namespace HandBrakeWPF.AttachedProperties
+{
+    using System;
+    using System.ComponentModel;
+    using System.Diagnostics.CodeAnalysis;
+    using System.Windows;
+
+    using Caliburn.Micro;
+
+    using HandBrakeWPF.Services.Interfaces;
+
+    using Newtonsoft.Json;
+
+    public class WindowHelper
+    {
+        public static readonly DependencyProperty SaveProperty = DependencyProperty.RegisterAttached("SaveState", typeof(bool), typeof(WindowHelper), new FrameworkPropertyMetadata(SaveState));
+
+        private readonly Window appWindow;
+        private readonly IUserSettingService userSettingService = IoC.Get<IUserSettingService>();
+
+        public WindowHelper(Window appWindow)
+        {
+            this.appWindow = appWindow;
+        }
+
+        public static void SetSaveState(DependencyObject sender, bool isEnabled)
+        {
+            sender.SetValue(SaveProperty, isEnabled);
+        }
+
+        private static void SaveState(DependencyObject sender, DependencyPropertyChangedEventArgs eventArgs)
+        {
+            if (sender is Window window)
+            {
+                if ((bool)eventArgs.NewValue)
+                {
+                    var settings = new WindowHelper(window);
+                    settings.Attach();
+                }
+            }
+        }
+
+        private void Attach()
+        {
+            if (this.appWindow != null)
+            {
+                this.appWindow.Closing += this.WindowClosing;
+                this.appWindow.Initialized += this.WindowInitialized;
+                this.appWindow.Loaded += this.WindowLoaded;
+            }
+        }
+
+        private void WindowClosing(object sender, CancelEventArgs cancelEventArgs)
+        {
+            string key = string.Format("{0}.Settings", this.appWindow.Name);
+            WindowInformation information = new WindowInformation(this.appWindow.Name, this.appWindow.WindowState, this.appWindow.RestoreBounds);
+
+            string json = JsonConvert.SerializeObject(information, Formatting.Indented);
+            if (!string.IsNullOrEmpty(json))
+            {
+                this.userSettingService.SetUserSetting(key, json);
+            }
+        }
+
+        private void WindowInitialized(object sender, EventArgs eventArgs)
+        {
+            string key = string.Format("{0}.Settings", this.appWindow.Name);
+            string json = this.userSettingService.GetUserSetting<string>(key);
+            if (!string.IsNullOrEmpty(json))
+            {
+                WindowInformation settings = JsonConvert.DeserializeObject<WindowInformation>(json);
+
+                if (settings.Location != Rect.Empty)
+                {
+                    // We might use these in the future
+                    this.appWindow.Left = settings.Location.Left;
+                    this.appWindow.Top = settings.Location.Top;
+                    this.appWindow.Width = settings.Location.Width;
+                    this.appWindow.Height = settings.Location.Height;
+                }
+
+                if (settings.WindowState != WindowState.Maximized)
+                {
+                    this.appWindow.WindowState = settings.WindowState;
+                }
+            }
+        }
+
+        private void WindowLoaded(object sender, RoutedEventArgs routedEventArgs)
+        {
+            string key = string.Format("{0}.Settings", this.appWindow.Name);
+            string json = this.userSettingService.GetUserSetting<string>(key);
+            if (!string.IsNullOrEmpty(json))
+            {
+                WindowInformation settings = JsonConvert.DeserializeObject<WindowInformation>(json);
+                this.appWindow.WindowState = settings.WindowState;
+            }
+        }
+    }
+
+    /// <summary>
+    /// An object we can store as JSON against a user setting key.
+    /// </summary>
+    [SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:FileMayOnlyContainASingleClass", Justification = "Reviewed. Suppression is OK here.")]
+    public class WindowInformation
+    {
+        public WindowInformation(string windowName, WindowState windowState, Rect location)
+        {
+            this.WindowName = windowName;
+            this.WindowState = windowState;
+            this.Location = location;
+        }
+
+        public string WindowName { get; set; }
+        public WindowState WindowState { get; set; }
+        public Rect Location { get; set; }
+    }
+}
\ No newline at end of file