1- using System ;
1+ using System ;
22using System . Collections . Generic ;
33using System . IO ;
44using System . Windows . Media ;
@@ -10,11 +10,11 @@ public class Result
1010 {
1111
1212 private string _pluginDirectory ;
13-
13+
1414 private string _icoPath ;
1515
1616 /// <summary>
17- /// Provides the title of the result. This is always required.
17+ /// The title of the result. This is always required.
1818 /// </summary>
1919 public string Title { get ; set ; }
2020
@@ -36,6 +36,11 @@ public class Result
3636 /// </summary>
3737 public string AutoCompleteText { get ; set ; }
3838
39+ /// <summary>
40+ /// Image Displayed on the result
41+ /// <value>Relative Path to the Image File</value>
42+ /// <remarks>GlyphInfo is prioritized if not null</remarks>
43+ /// </summary>
3944 public string IcoPath
4045 {
4146 get { return _icoPath ; }
@@ -60,30 +65,35 @@ public string IcoPath
6065 public IconDelegate Icon ;
6166
6267 /// <summary>
63- /// Information for Glyph Icon
68+ /// Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons)
6469 /// </summary>
65- public GlyphInfo Glyph { get ; init ; }
70+ public GlyphInfo Glyph { get ; init ; }
6671
6772
6873 /// <summary>
69- /// return true to hide flowlauncher after select result
74+ /// Delegate. An action to take in the form of a function call when the result has been selected
75+ /// <returns>
76+ /// true to hide flowlauncher after select result
77+ /// </returns>
7078 /// </summary>
7179 public Func < ActionContext , bool > Action { get ; set ; }
7280
81+ /// <summary>
82+ /// Priority of the current result
83+ /// <value>default: 0</value>
84+ /// </summary>
7385 public int Score { get ; set ; }
7486
7587 /// <summary>
7688 /// A list of indexes for the characters to be highlighted in Title
7789 /// </summary>
7890 public IList < int > TitleHighlightData { get ; set ; }
7991
80- /// <summary>
81- /// A list of indexes for the characters to be highlighted in SubTitle
82- /// </summary>
92+ [ Obsolete ( "Deprecated as of Flow Launcher v1.9.1. Subtitle highlighting is no longer offered" ) ]
8393 public IList < int > SubTitleHighlightData { get ; set ; }
8494
8595 /// <summary>
86- /// Only results that originQuery match with current query will be displayed in the panel
96+ /// Query information associated with the result
8797 /// </summary>
8898 internal Query OriginQuery { get ; set ; }
8999
@@ -103,35 +113,38 @@ public string PluginDirectory
103113 }
104114 }
105115
116+ /// <inheritdoc />
106117 public override bool Equals ( object obj )
107118 {
108119 var r = obj as Result ;
109120
110121 var equality = string . Equals ( r ? . Title , Title ) &&
111122 string . Equals ( r ? . SubTitle , SubTitle ) &&
112123 string . Equals ( r ? . IcoPath , IcoPath ) &&
113- TitleHighlightData == r . TitleHighlightData &&
114- SubTitleHighlightData == r . SubTitleHighlightData ;
124+ TitleHighlightData == r . TitleHighlightData ;
115125
116126 return equality ;
117127 }
118128
129+ /// <inheritdoc />
119130 public override int GetHashCode ( )
120131 {
121132 var hashcode = ( Title ? . GetHashCode ( ) ?? 0 ) ^
122133 ( SubTitle ? . GetHashCode ( ) ?? 0 ) ;
123134 return hashcode ;
124135 }
125136
137+ /// <inheritdoc />
126138 public override string ToString ( )
127139 {
128140 return Title + SubTitle ;
129141 }
130142
131- public Result ( ) { }
132-
133143 /// <summary>
134- /// Additional data associate with this result
144+ /// Additional data associated with this result
145+ /// <example>
146+ /// As external information for ContextMenu
147+ /// </example>
135148 /// </summary>
136149 public object ContextData { get ; set ; }
137150
0 commit comments