Use interface for monitors & Add clean clipboard support

Author: Jack251970

src/Flow.Launcher.Plugin.ClipboardPlus.Core/Data/Models/Clipboard/ClipboardChangedEventArgs.cs

@@ -0,0 +1,47 @@
+// Copyright (c) 2024 Jack251970
+// Licensed under the Apache License. See the LICENSE.
+
+namespace Flow.Launcher.Plugin.ClipboardPlus.Core.Data.Models;
+
+/// <summary>
+/// Provides data for the <see cref="ClipboardChanged"/> event.
+/// </summary>
+public class ClipboardChangedEventArgs : EventArgs
+{
+    public ClipboardChangedEventArgs(
+        object? content,
+        DataType dataType,
+        SourceApplication source
+    )
+    {
+        Content = content;
+        DataType = dataType;
+
+        SourceApplication = new SourceApplication(
+            source.Handle,
+            source.Name,
+            source.Title,
+            source.Path
+        );
+    }
+
+    #region Properties
+
+    /// <summary>
+    /// Gets the currently copied clipboard content.
+    /// </summary>
+    public object? Content { get; }
+
+    /// <summary>
+    /// Gets the currently copied clipboard content-type.
+    /// </summary>
+    public DataType DataType { get; }
+
+    /// <summary>
+    /// Gets the application from where the
+    /// clipboard's content were copied.
+    /// </summary>
+    public SourceApplication SourceApplication { get; }
+
+    #endregion
+}

src/Flow.Launcher.Plugin.ClipboardPlus.Core/Data/Models/Clipboard/ClipboardMonitorW.cs

@@ -11,7 +11,7 @@ namespace Flow.Launcher.Plugin.ClipboardPlus.Core.Data.Models;
 /// ClipboardMonitorW is a class that monitors the clipboard
 /// </summary>
 [SupportedOSPlatform("windows6.0.6000")]
-public class ClipboardMonitorW : IDisposable
+public class ClipboardMonitorW : IClipboardMonitor
 {
     #region Fields
 
@@ -143,6 +143,19 @@ public void StopMonitoring()
         }
     }
 
+    /// <summary>
+    /// Clears the clipboard of all data.
+    /// </summary>
+    public void CleanClipboard()
+    {
+        ClipboardText = string.Empty;
+        ClipboardRtfText = string.Empty;
+        ClipboardObject = null;
+        ClipboardImage = null;
+        ClipboardFile = string.Empty;
+        ClipboardFiles.Clear();
+    }
+
     #endregion
 
     #region Private
@@ -177,53 +190,6 @@ internal void Invoke(object? content, DataType type, SourceApplication source)
 
     #endregion
 
-    #region Event Arguments
-
-    /// <summary>
-    /// Provides data for the <see cref="ClipboardChanged"/> event.
-    /// </summary>
-    public class ClipboardChangedEventArgs : EventArgs
-    {
-        public ClipboardChangedEventArgs(
-            object? content,
-            DataType dataType,
-            SourceApplication source
-        )
-        {
-            Content = content;
-            DataType = dataType;
-
-            SourceApplication = new SourceApplication(
-                source.Handle,
-                source.Name,
-                source.Title,
-                source.Path
-            );
-        }
-
-        #region Properties
-
-        /// <summary>
-        /// Gets the currently copied clipboard content.
-        /// </summary>
-        public object? Content { get; }
-
-        /// <summary>
-        /// Gets the currently copied clipboard content-type.
-        /// </summary>
-        public DataType DataType { get; }
-
-        /// <summary>
-        /// Gets the application from where the
-        /// clipboard's content were copied.
-        /// </summary>
-        public SourceApplication SourceApplication { get; }
-
-        #endregion
-    }
-
-    #endregion
-
     #endregion
 
     #region Private
@@ -284,8 +250,7 @@ protected virtual void Dispose(bool disposing)
             _timer = null!;
             _clipboardHandle = null!;
             _observableFormats = null!;
-            ClipboardFiles = null!;
-            ClipboardImage = null!;
+            CleanClipboard();
             _disposed = true;
         }
     }

src/Flow.Launcher.Plugin.ClipboardPlus.Core/Data/Models/Clipboard/ClipboardMonitorWin.cs

@@ -10,7 +10,7 @@ namespace Flow.Launcher.Plugin.ClipboardPlus.Core.Data.Models;
 /// ClipboardMonitorWin is a class that monitors the clipboard
 /// </summary>
 [SupportedOSPlatform("windows10.0.10240.0")]
-public class ClipboardMonitorWin : IDisposable
+public class ClipboardMonitorWin : IClipboardMonitor
 {
     #region Fields
 
@@ -134,6 +134,19 @@ public void StopMonitoring()
         }
     }
 
+    /// <summary>
+    /// Clears the clipboard of all data.
+    /// </summary>
+    public void CleanClipboard()
+    {
+        ClipboardText = string.Empty;
+        ClipboardRtfText = string.Empty;
+        ClipboardObject = null;
+        ClipboardImage = null;
+        ClipboardFile = string.Empty;
+        ClipboardFiles.Clear();
+    }
+
     #endregion
 
     #region Private
@@ -170,53 +183,6 @@ internal void Invoke(object? content, DataType type, SourceApplication source)
 
     #endregion
 
-    #region Event Arguments
-
-    /// <summary>
-    /// Provides data for the <see cref="ClipboardChanged"/> event.
-    /// </summary>
-    public class ClipboardChangedEventArgs : EventArgs
-    {
-        public ClipboardChangedEventArgs(
-            object? content,
-            DataType dataType,
-            SourceApplication source
-        )
-        {
-            Content = content;
-            DataType = dataType;
-
-            SourceApplication = new SourceApplication(
-                source.Handle,
-                source.Name,
-                source.Title,
-                source.Path
-            );
-        }
-
-        #region Properties
-
-        /// <summary>
-        /// Gets the currently copied clipboard content.
-        /// </summary>
-        public object? Content { get; }
-
-        /// <summary>
-        /// Gets the currently copied clipboard content-type.
-        /// </summary>
-        public DataType DataType { get; }
-
-        /// <summary>
-        /// Gets the application from where the
-        /// clipboard's content were copied.
-        /// </summary>
-        public SourceApplication SourceApplication { get; }
-
-        #endregion
-    }
-
-    #endregion
-
     #endregion
 
     #endregion
@@ -248,8 +214,7 @@ protected virtual void Dispose(bool disposing)
             _clipboardHandle.Dispose();
             _clipboardHandle = null!;
             _observableFormats = null!;
-            ClipboardFiles = null!;
-            ClipboardImage = null!;
+            CleanClipboard();
             _disposed = true;
         }
     }

src/Flow.Launcher.Plugin.ClipboardPlus.Core/Data/Models/Clipboard/IClipboardMonitor.cs

@@ -0,0 +1,41 @@
+// Copyright (c) 2024 Jack251970
+// Licensed under the Apache License. See the LICENSE.
+
+using System.Windows.Media.Imaging;
+
+namespace Flow.Launcher.Plugin.ClipboardPlus.Core.Data.Models;
+
+public interface IClipboardMonitor : IDisposable
+{
+    public bool MonitorClipboard { get; set; }
+
+    public bool ObserveLastEntry { get; set; }
+
+    public ObservableDataFormats ObservableFormats { get; set; }
+
+    public string ClipboardText { get; }
+
+    public string ClipboardRtfText { get; }
+
+    public object? ClipboardObject { get; }
+
+    public BitmapSource? ClipboardImage { get; }
+
+    public string ClipboardFile { get; }
+
+    public List<string> ClipboardFiles { get; }
+
+    public void SetContext(PluginInitContext context);
+
+    public void StartMonitoring();
+
+    public void PauseMonitoring();
+
+    public void ResumeMonitoring();
+
+    public void StopMonitoring();
+
+    public void CleanClipboard();
+
+    public event EventHandler<ClipboardChangedEventArgs>? ClipboardChanged;
+}