@@ -10,11 +10,11 @@ public class Result
10
10
{
11
11
12
12
private string _pluginDirectory ;
13
-
13
+
14
14
private string _icoPath ;
15
15
16
16
/// <summary>
17
- /// Provides the title of the result. This is always required.
17
+ /// The title of the result. This is always required.
18
18
/// </summary>
19
19
public string Title { get ; set ; }
20
20
@@ -36,6 +36,11 @@ public class Result
36
36
/// </summary>
37
37
public string AutoCompleteText { get ; set ; }
38
38
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>
39
44
public string IcoPath
40
45
{
41
46
get { return _icoPath ; }
@@ -60,16 +65,23 @@ public string IcoPath
60
65
public IconDelegate Icon ;
61
66
62
67
/// <summary>
63
- /// Information for Glyph Icon
68
+ /// Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons)
64
69
/// </summary>
65
- public GlyphInfo Glyph { get ; init ; }
70
+ public GlyphInfo Glyph { get ; init ; }
66
71
67
72
68
73
/// <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>
70
78
/// </summary>
71
79
public Func < ActionContext , bool > Action { get ; set ; }
72
80
81
+ /// <summary>
82
+ /// Priority of the current result
83
+ /// <value>default: 0</value>
84
+ /// </summary>
73
85
public int Score { get ; set ; }
74
86
75
87
/// <summary>
@@ -81,7 +93,7 @@ public string IcoPath
81
93
public IList < int > SubTitleHighlightData { get ; set ; }
82
94
83
95
/// <summary>
84
- /// Only results that originQuery match with current query will be displayed in the panel
96
+ /// Query information associated with the result
85
97
/// </summary>
86
98
internal Query OriginQuery { get ; set ; }
87
99
@@ -101,6 +113,7 @@ public string PluginDirectory
101
113
}
102
114
}
103
115
116
+ /// <inheritdoc />
104
117
public override bool Equals ( object obj )
105
118
{
106
119
var r = obj as Result ;
@@ -113,22 +126,25 @@ public override bool Equals(object obj)
113
126
return equality ;
114
127
}
115
128
129
+ /// <inheritdoc />
116
130
public override int GetHashCode ( )
117
131
{
118
132
var hashcode = ( Title ? . GetHashCode ( ) ?? 0 ) ^
119
133
( SubTitle ? . GetHashCode ( ) ?? 0 ) ;
120
134
return hashcode ;
121
135
}
122
136
137
+ /// <inheritdoc />
123
138
public override string ToString ( )
124
139
{
125
140
return Title + SubTitle ;
126
141
}
127
142
128
- public Result ( ) { }
129
-
130
143
/// <summary>
131
- /// Additional data associate with this result
144
+ /// Additional data associated with this result
145
+ /// <example>
146
+ /// As external information for ContextMenu
147
+ /// </example>
132
148
/// </summary>
133
149
public object ContextData { get ; set ; }
134
150
0 commit comments