@@ -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,9 @@ public class Result
36
36
/// </summary>
37
37
public string AutoCompleteText { get ; set ; }
38
38
39
+ /// <summary>
40
+ /// Image Displayed on the result
41
+ /// </summary>
39
42
public string IcoPath
40
43
{
41
44
get { return _icoPath ; }
@@ -60,16 +63,22 @@ public string IcoPath
60
63
public IconDelegate Icon ;
61
64
62
65
/// <summary>
63
- /// Information for Glyph Icon
66
+ /// Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons)
64
67
/// </summary>
65
- public GlyphInfo Glyph { get ; init ; }
68
+ public GlyphInfo Glyph { get ; init ; }
66
69
67
70
68
71
/// <summary>
69
- /// return true to hide flowlauncher after select result
72
+ /// Delegate activated when result is been selected
73
+ /// <returns>
74
+ /// true to hide flowlauncher after select result
75
+ /// </returns>
70
76
/// </summary>
71
77
public Func < ActionContext , bool > Action { get ; set ; }
72
78
79
+ /// <summary>
80
+ /// Priority of the current result
81
+ /// </summary>
73
82
public int Score { get ; set ; }
74
83
75
84
/// <summary>
@@ -83,9 +92,9 @@ public string IcoPath
83
92
public IList < int > SubTitleHighlightData { get ; set ; }
84
93
85
94
/// <summary>
86
- /// Only results that originQuery match with current query will be displayed in the panel
95
+ /// Query information associated with the result
87
96
/// </summary>
88
- internal Query OriginQuery { get ; set ; }
97
+ public Query OriginQuery { get ; set ; }
89
98
90
99
/// <summary>
91
100
/// Plugin directory
@@ -103,6 +112,7 @@ public string PluginDirectory
103
112
}
104
113
}
105
114
115
+ /// <inheritdoc />
106
116
public override bool Equals ( object obj )
107
117
{
108
118
var r = obj as Result ;
@@ -116,22 +126,25 @@ public override bool Equals(object obj)
116
126
return equality ;
117
127
}
118
128
129
+ /// <inheritdoc />
119
130
public override int GetHashCode ( )
120
131
{
121
132
var hashcode = ( Title ? . GetHashCode ( ) ?? 0 ) ^
122
133
( SubTitle ? . GetHashCode ( ) ?? 0 ) ;
123
134
return hashcode ;
124
135
}
125
136
137
+ /// <inheritdoc />
126
138
public override string ToString ( )
127
139
{
128
140
return Title + SubTitle ;
129
141
}
130
142
131
- public Result ( ) { }
132
-
133
143
/// <summary>
134
144
/// Additional data associate with this result
145
+ /// <example>
146
+ /// As external information for ContextMenu
147
+ /// </example>
135
148
/// </summary>
136
149
public object ContextData { get ; set ; }
137
150
0 commit comments