Skip to content

Commit cbde70c

Browse files
committed
Update Docs
1 parent c0342c2 commit cbde70c

File tree

11 files changed

+41
-12
lines changed

11 files changed

+41
-12
lines changed

API-Reference/Flow.Launcher.Plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
| class [FlowLauncherKeyDownEventArgs](./Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs.md) | |
1313
| delegate [FlowLauncherKeyDownEventHandler](./Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md) | |
1414
| class [FlowLauncherQueryEventArgs](./Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md) | |
15-
| record [GlyphInfo](./Flow.Launcher.Plugin/GlyphInfo.md) | |
15+
| record [GlyphInfo](./Flow.Launcher.Plugin/GlyphInfo.md) | Text with FontFamily specified |
1616
| interface [IAsyncPlugin](./Flow.Launcher.Plugin/IAsyncPlugin.md) | Asynchronous Plugin Model for Flow Launcher |
1717
| interface [IAsyncReloadable](./Flow.Launcher.Plugin/IAsyncReloadable.md) | This interface is to indicate and allow plugins to asyncronously reload their in memory data cache or other mediums when user makes a new change that is not immediately captured. For example, for BrowserBookmark and Program plugin does not automatically detect when a user added a new bookmark or program, so this interface's function is exposed to allow user manually do the reloading after those new additions. The command that allows user to manual reload is exposed via Plugin.Sys, and it will call the plugins that have implemented this interface. |
1818
| interface [IContextMenu](./Flow.Launcher.Plugin/IContextMenu.md) | |

API-Reference/Flow.Launcher.Plugin/GlyphInfo.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# GlyphInfo record
22

3+
Text with FontFamily specified
4+
35
```csharp
46
public record GlyphInfo
57
```
@@ -8,7 +10,7 @@ public record GlyphInfo
810

911
| name | description |
1012
| --- | --- |
11-
| [GlyphInfo](GlyphInfo/GlyphInfo.md)(…) | |
13+
| [GlyphInfo](GlyphInfo/GlyphInfo.md)(…) | Text with FontFamily specified |
1214
| [FontFamily](GlyphInfo/FontFamily.md) { get; set; } | |
1315
| [Glyph](GlyphInfo/Glyph.md) { getset; } | |
1416

API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# GlyphInfo constructor
22

3+
Text with FontFamily specified
4+
35
```csharp
46
public GlyphInfo(string FontFamily, string Glyph)
57
```
68

9+
| parameter | description |
10+
| --- | --- |
11+
| FontFamily | Font Family of this Glyph |
12+
| Glyph | Text/Unicode of the Glyph |
13+
714
## See Also
815

916
* record [GlyphInfo](../GlyphInfo.md)

API-Reference/Flow.Launcher.Plugin/Result/Action.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Result.Action property
22

3-
return true to hide flowlauncher after select result
3+
Delegate activated when result is been selected true to hide flowlauncher after select result
44

55
```csharp
66
public Func<ActionContext, bool> Action { get; set; }

API-Reference/Flow.Launcher.Plugin/Result/ContextData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Result.ContextData property
22

3-
Additional data associate with this result
3+
Additional data associate with this result As external information for ContextMenu
44

55
```csharp
66
public object ContextData { get; set; }

API-Reference/Flow.Launcher.Plugin/Result/Glyph.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Result.Glyph property
22

3-
Information for Glyph Icon
3+
Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons)
44

55
```csharp
66
public GlyphInfo Glyph { get; set; }

API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Result.IcoPath property
22

3+
Image Displayed on the result
4+
35
```csharp
46
public string IcoPath { get; set; }
57
```
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Result.OriginQuery property
2+
3+
Query information associated with the result
4+
5+
```csharp
6+
public Query OriginQuery { get; set; }
7+
```
8+
9+
## See Also
10+
11+
* class [Query](../Query.md)
12+
* class [Result](../Result.md)
13+
* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md)
14+
15+
<!-- DO NOT EDIT: generated by xmldocmd for flow.launcher.plugin.dll -->

API-Reference/Flow.Launcher.Plugin/Result/Score.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Result.Score property
22

3+
Priority of the current result
4+
35
```csharp
46
public int Score { get; set; }
57
```

API-Reference/Flow.Launcher.Plugin/Result/Title.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Result.Title property
22

3-
Provides the title of the result. This is always required.
3+
The title of the result. This is always required.
44

55
```csharp
66
public string Title { get; set; }

0 commit comments

Comments
 (0)