diff --git a/Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj b/Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj index 7ce2fc8fde9..8bdb861f263 100644 --- a/Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj +++ b/Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj @@ -1,4 +1,4 @@ - + net5.0-windows @@ -42,6 +42,7 @@ 4 AnyCPU false + ..\Output\Debug\Flow.Launcher.Plugin.xml diff --git a/Flow.Launcher.Plugin/GlyphInfo.cs b/Flow.Launcher.Plugin/GlyphInfo.cs index d24624d8f50..730046e1d48 100644 --- a/Flow.Launcher.Plugin/GlyphInfo.cs +++ b/Flow.Launcher.Plugin/GlyphInfo.cs @@ -7,5 +7,10 @@ namespace Flow.Launcher.Plugin { + /// + /// Text with FontFamily specified + /// + /// Font Family of this Glyph + /// Text/Unicode of the Glyph public record GlyphInfo(string FontFamily, string Glyph); } diff --git a/Flow.Launcher.Plugin/Result.cs b/Flow.Launcher.Plugin/Result.cs index 29f8198ab44..0cc0a681185 100644 --- a/Flow.Launcher.Plugin/Result.cs +++ b/Flow.Launcher.Plugin/Result.cs @@ -10,11 +10,11 @@ public class Result { private string _pluginDirectory; - + private string _icoPath; /// - /// Provides the title of the result. This is always required. + /// The title of the result. This is always required. /// public string Title { get; set; } @@ -36,6 +36,11 @@ public class Result /// public string AutoCompleteText { get; set; } + /// + /// Image Displayed on the result + /// Relative Path to the Image File + /// GlyphInfo is prioritized if not null + /// public string IcoPath { get { return _icoPath; } @@ -60,16 +65,23 @@ public string IcoPath public IconDelegate Icon; /// - /// Information for Glyph Icon + /// Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons) /// - public GlyphInfo Glyph { get; init; } + public GlyphInfo Glyph { get; init; } /// - /// return true to hide flowlauncher after select result + /// Delegate. An action to take in the form of a function call when the result has been selected + /// + /// true to hide flowlauncher after select result + /// /// public Func Action { get; set; } + /// + /// Priority of the current result + /// default: 0 + /// public int Score { get; set; } /// @@ -83,7 +95,7 @@ public string IcoPath public IList SubTitleHighlightData { get; set; } /// - /// Only results that originQuery match with current query will be displayed in the panel + /// Query information associated with the result /// internal Query OriginQuery { get; set; } @@ -103,6 +115,7 @@ public string PluginDirectory } } + /// public override bool Equals(object obj) { var r = obj as Result; @@ -116,6 +129,7 @@ public override bool Equals(object obj) return equality; } + /// public override int GetHashCode() { var hashcode = (Title?.GetHashCode() ?? 0) ^ @@ -123,15 +137,17 @@ public override int GetHashCode() return hashcode; } + /// public override string ToString() { return Title + SubTitle; } - public Result() { } - /// - /// Additional data associate with this result + /// Additional data associated with this result + /// + /// As external information for ContextMenu + /// /// public object ContextData { get; set; }