From 2bef0a89c7c2f6d7c011250ae77fbf0c01137b3d Mon Sep 17 00:00:00 2001 From: Kevin Zhang Date: Wed, 14 Jul 2021 14:30:51 +0800 Subject: [PATCH 1/8] add dispose docs --- develop-dotnet-plugins.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/develop-dotnet-plugins.md b/develop-dotnet-plugins.md index 06ebe71..f52622e 100644 --- a/develop-dotnet-plugins.md +++ b/develop-dotnet-plugins.md @@ -69,3 +69,6 @@ Implementing **IResultUpdated** provides a way to return part of the query resul To early return a result to Flow, you will need to invoke `ResultUpdated` event with an `ResultUpdatedEventArgs`, which includes the current `Query` object and the List of `Result` objects similar to the return value in `Query(Async)`. +### [IDisposable](https://docs.microsoft.com/en-us/dotnet/api/system.idisposable) *Flow 1.8.0 or higher* + +Implementing **IDisposable** to dispose unmanaged resource in the plugin. `Dispose()` will be called when Flow exit. \ No newline at end of file From c0342c247e4782d2ba18425733cdc24c3afe0f6c Mon Sep 17 00:00:00 2001 From: Hongtao Zhang Date: Wed, 29 Dec 2021 13:14:27 -0600 Subject: [PATCH 2/8] Update API Docs --- .../Flow.Launcher.Plugin.SharedCommands.md | 9 - .../FilesFolders/CopyAll.md | 19 + .../FilesFolders/FileExists.md | 12 + .../GetPreviousExistingDirectory.md | 14 + .../FilesFolders/IsLocationPathString.md | 14 + .../FilesFolders/LocationExists.md | 12 + .../FilesFolders/OpenContainingFolder.md | 12 + .../FilesFolders/OpenPath.md | 12 + .../FilesFolders/RemoveFolderIfExists.md | 12 + ...turnPreviousDirectoryIfIncompleteString.md | 14 + .../VerifyBothFolderFilesEqual.md | 12 + .../SearchWeb/OpenInBrowserTab.md | 15 + .../SearchWeb/OpenInBrowserWindow.md | 15 + .../ShellCommand.EnumThreadDelegate.md | 12 + .../ShellCommand/Execute.md | 47 ++ .../ShellCommand/RunAsDifferentUser.md | 12 + .../ShellCommand/SetProcessStartInfo.md | 14 + .../_sidebar.md | 5 - .../filesfolders.md | 177 +------ .../searchweb.md | 42 +- .../shellcommand.md | 53 +-- .../Flow.Launcher.Plugin.SharedModels.md | 9 - .../MatchResult/IsSearchPrecisionScoreMet.md | 12 + .../MatchResult/MatchData.md | 14 + .../MatchResult/MatchResult.md | 28 ++ .../MatchResult/RawScore.md | 12 + .../MatchResult/Score.md | 14 + .../MatchResult/SearchPrecision.md | 13 + .../MatchResult/Success.md | 12 + .../_sidebar.md | 5 - .../matchresult.md | 126 +---- .../searchprecisionscore.md | 26 +- API-Reference/Flow.Launcher.Plugin.md | 104 ++--- .../ActionContext/ActionContext.md | 14 + .../ActionContext/SpecialKeyState.md | 13 + .../AfterFlowLauncherQueryEventHandler.md | 12 + .../AllowedLanguage/CSharp.md | 12 + .../AllowedLanguage/Executable.md | 12 + .../AllowedLanguage/FSharp.md | 12 + .../AllowedLanguage/IsAllowed.md | 12 + .../AllowedLanguage/IsDotNet.md | 12 + .../AllowedLanguage/Python.md | 12 + .../BaseModel/BaseModel.md | 14 + .../BaseModel/OnPropertyChanged.md | 12 + .../BaseModel/PropertyChanged.md | 12 + .../FlowLauncherGlobalKeyboardEventHandler.md | 25 + .../FlowLauncherKeyDownEventArgs.md | 14 + .../FlowLauncherKeyDownEventArgs/Query.md | 12 + .../keyEventArgs.md | 12 + .../FlowLauncherKeyDownEventHandler.md | 12 + .../FlowLauncherQueryEventArgs.md | 14 + .../FlowLauncherQueryEventArgs/Query.md | 13 + .../Flow.Launcher.Plugin/GlyphInfo.md | 19 + .../GlyphInfo/FontFamily.md | 12 + .../Flow.Launcher.Plugin/GlyphInfo/Glyph.md | 12 + .../GlyphInfo/GlyphInfo.md | 12 + .../IAsyncPlugin/InitAsync.md | 19 + .../IAsyncPlugin/QueryAsync.md | 21 + .../IAsyncReloadable/ReloadDataAsync.md | 12 + .../IContextMenu/LoadContextMenus.md | 13 + .../Flow.Launcher.Plugin/IPlugin/Init.md | 19 + .../Flow.Launcher.Plugin/IPlugin/Query.md | 22 + .../GetTranslatedPluginDescription.md | 12 + .../IPluginI18n/GetTranslatedPluginTitle.md | 12 + .../IPluginI18n/OnCultureInfoChanged.md | 14 + .../IPublicAPI/AddActionKeyword.md | 19 + .../IPublicAPI/ChangeQuery.md | 19 + .../IPublicAPI/CheckForNewUpdate.md | 14 + .../IPublicAPI/CopyToClipboard.md | 18 + .../IPublicAPI/FuzzySearch.md | 24 + .../IPublicAPI/GetAllPlugins.md | 15 + .../IPublicAPI/GetTranslation.md | 18 + .../IPublicAPI/HttpDownloadAsync.md | 23 + .../IPublicAPI/HttpGetStreamAsync.md | 23 + .../IPublicAPI/HttpGetStringAsync.md | 23 + .../IPublicAPI/LoadSettingJsonStorage.md | 19 + .../IPublicAPI/LogDebug.md | 14 + .../IPublicAPI/LogException.md | 15 + .../IPublicAPI/LogInfo.md | 14 + .../IPublicAPI/LogWarn.md | 14 + .../IPublicAPI/OpenDirectory.md | 19 + .../IPublicAPI/OpenSettingDialog.md | 14 + .../IPublicAPI/OpenUrl.md | 14 + .../RegisterGlobalKeyboardCallback.md | 19 + .../IPublicAPI/ReloadAllPluginData.md | 14 + .../IPublicAPI/RemoveActionKeyword.md | 19 + .../RemoveGlobalKeyboardCallback.md | 19 + .../IPublicAPI/RestartApp.md | 14 + .../IPublicAPI/SaveAppAllSettings.md | 14 + .../IPublicAPI/SavePluginSettings.md | 14 + .../IPublicAPI/SaveSettingJsonStorage.md | 19 + .../IPublicAPI/ShellRun.md | 26 ++ .../IPublicAPI/ShowMainWindow.md | 14 + .../IPublicAPI/ShowMsg.md | 43 ++ .../IPublicAPI/ShowMsgError.md | 19 + .../IReloadable/ReloadData.md | 12 + .../IResultUpdated/ResultsUpdated.md | 13 + .../Flow.Launcher.Plugin/ISavable/Save.md | 12 + .../Flow.Launcher.Plugin/ISettingProvider.md | 17 + .../ISettingProvider/CreateSettingPanel.md | 12 + .../PluginInitContext/API.md | 15 + .../CurrentPluginMetadata.md | 13 + .../PluginInitContext/PluginInitContext.md | 29 ++ .../PluginMetadata/ActionKeyword.md | 12 + .../PluginMetadata/ActionKeywords.md | 12 + .../PluginMetadata/Author.md | 12 + .../PluginMetadata/AvgQueryTime.md | 12 + .../PluginMetadata/Description.md | 12 + .../PluginMetadata/Disabled.md | 12 + .../PluginMetadata/ExecuteFileName.md | 12 + .../PluginMetadata/ExecuteFilePath.md | 12 + .../Flow.Launcher.Plugin/PluginMetadata/ID.md | 12 + .../PluginMetadata/IcoPath.md | 12 + .../PluginMetadata/InitTime.md | 14 + .../PluginMetadata/Language.md | 12 + .../PluginMetadata/Name.md | 12 + .../PluginMetadata/PluginDirectory.md | 12 + .../PluginMetadata/PluginMetadata.md | 14 + .../PluginMetadata/Priority.md | 12 + .../PluginMetadata/QueryCount.md | 12 + .../PluginMetadata/ToString.md | 12 + .../PluginMetadata/Version.md | 12 + .../PluginMetadata/Website.md | 12 + .../Flow.Launcher.Plugin/PluginPair/Equals.md | 12 + .../PluginPair/GetHashCode.md | 12 + .../PluginPair/Metadata.md | 13 + .../Flow.Launcher.Plugin/PluginPair/Plugin.md | 13 + .../PluginPair/PluginPair.md | 14 + .../PluginPair/ToString.md | 12 + .../Query/ActionKeyword.md | 12 + .../Query/ActionKeywordSeparator.md | 14 + .../Flow.Launcher.Plugin/Query/FirstSearch.md | 14 + .../Query/GlobalPluginWildcardSign.md | 14 + .../Flow.Launcher.Plugin/Query/Query.md | 30 ++ .../Flow.Launcher.Plugin/Query/RawQuery.md | 14 + .../Flow.Launcher.Plugin/Query/Search.md | 14 + .../Flow.Launcher.Plugin/Query/SearchTerms.md | 14 + .../Query/SecondSearch.md | 14 + .../Query/SecondToEndSearch.md | 14 + .../Query/TermSeparator.md | 14 + .../Flow.Launcher.Plugin/Query/ThirdSearch.md | 14 + .../Flow.Launcher.Plugin/Query/ToString.md | 12 + .../Result.IconDelegate.md | 12 + .../Flow.Launcher.Plugin/Result/Action.md | 15 + .../Result/ActionKeywordAssigned.md | 14 + .../Result/AutoCompleteText.md | 14 + .../Result/ContextData.md | 14 + .../Flow.Launcher.Plugin/Result/Equals.md | 12 + .../Result/GetHashCode.md | 12 + .../Flow.Launcher.Plugin/Result/Glyph.md | 15 + .../Flow.Launcher.Plugin/Result/IcoPath.md | 12 + .../Flow.Launcher.Plugin/Result/Icon.md | 15 + .../Result/PluginDirectory.md | 14 + .../Flow.Launcher.Plugin/Result/PluginID.md | 14 + .../Flow.Launcher.Plugin/Result/Result.md | 14 + .../Flow.Launcher.Plugin/Result/Score.md | 12 + .../Flow.Launcher.Plugin/Result/SubTitle.md | 14 + .../Result/SubTitleHighlightData.md | 14 + .../Result/SubTitleToolTip.md | 14 + .../Flow.Launcher.Plugin/Result/Title.md | 14 + .../Result/TitleHighlightData.md | 14 + .../Result/TitleToolTip.md | 14 + .../Flow.Launcher.Plugin/Result/ToString.md | 12 + .../ResultItemDropEventHandler.md | 13 + .../ResultUpdatedEventArgs/Query.md | 13 + .../ResultUpdatedEventArgs.md | 14 + .../ResultUpdatedEventArgs/Results.md | 13 + .../ResultUpdatedEventArgs/Token.md | 12 + .../ResultUpdatedEventHandler.md | 13 + .../SpecialKeyState/AltPressed.md | 12 + .../SpecialKeyState/CtrlPressed.md | 12 + .../SpecialKeyState/ShiftPressed.md | 12 + .../SpecialKeyState/SpecialKeyState.md | 14 + .../SpecialKeyState/WinPressed.md | 12 + .../Flow.Launcher.Plugin/_sidebar.md | 26 -- .../Flow.Launcher.Plugin/actioncontext.md | 35 +- .../Flow.Launcher.Plugin/allowedlanguage.md | 99 +--- .../Flow.Launcher.Plugin/basemodel.md | 50 +- .../flowlauncherkeydowneventargs.md | 48 +- .../flowlauncherqueryeventargs.md | 35 +- .../Flow.Launcher.Plugin/iasyncplugin.md | 45 +- .../Flow.Launcher.Plugin/iasyncreloadable.md | 33 +- .../Flow.Launcher.Plugin/icontextmenu.md | 29 +- .../Flow.Launcher.Plugin/ifeatures.md | 12 +- API-Reference/Flow.Launcher.Plugin/iplugin.md | 49 +- .../Flow.Launcher.Plugin/iplugini18n.md | 37 +- .../Flow.Launcher.Plugin/ipublicapi.md | 433 ++---------------- .../Flow.Launcher.Plugin/ireloadable.md | 36 +- .../Flow.Launcher.Plugin/iresultupdated.md | 21 +- .../Flow.Launcher.Plugin/isavable.md | 23 +- .../Flow.Launcher.Plugin/plugininitcontext.md | 63 +-- .../Flow.Launcher.Plugin/pluginmetadata.md | 301 ++---------- .../Flow.Launcher.Plugin/pluginpair.md | 93 +--- API-Reference/Flow.Launcher.Plugin/query.md | 193 +------- API-Reference/Flow.Launcher.Plugin/result.md | 258 ++--------- .../resultupdatedeventargs.md | 43 +- .../Flow.Launcher.Plugin/specialkeystate.md | 74 +-- API-Reference/README.md | 8 +- API-Reference/_sidebar.md | 3 - 199 files changed, 2861 insertions(+), 2160 deletions(-) delete mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md delete mode 100644 API-Reference/Flow.Launcher.Plugin.SharedCommands/_sidebar.md delete mode 100644 API-Reference/Flow.Launcher.Plugin.SharedModels.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md create mode 100644 API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md delete mode 100644 API-Reference/Flow.Launcher.Plugin.SharedModels/_sidebar.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md create mode 100644 API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md create mode 100644 API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md create mode 100644 API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md create mode 100644 API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md create mode 100644 API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md create mode 100644 API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md create mode 100644 API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md create mode 100644 API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md create mode 100644 API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md create mode 100644 API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md create mode 100644 API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md create mode 100644 API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md create mode 100644 API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md create mode 100644 API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md create mode 100644 API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md create mode 100644 API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md create mode 100644 API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md create mode 100644 API-Reference/Flow.Launcher.Plugin/GlyphInfo.md create mode 100644 API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md create mode 100644 API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md create mode 100644 API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md create mode 100644 API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ISavable/Save.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ISettingProvider.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md create mode 100644 API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/Query.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/Search.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Query/ToString.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/Action.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/ContextData.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/Equals.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/Glyph.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/Icon.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/PluginID.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/Result.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/Score.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/SubTitleHighlightData.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/Title.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/ToString.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md create mode 100644 API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md create mode 100644 API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md create mode 100644 API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md create mode 100644 API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md create mode 100644 API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md create mode 100644 API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md delete mode 100644 API-Reference/Flow.Launcher.Plugin/_sidebar.md delete mode 100644 API-Reference/_sidebar.md diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands.md deleted file mode 100644 index 5351c40..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands.md +++ /dev/null @@ -1,9 +0,0 @@ -# Flow.Launcher.Plugin.SharedCommands Namesapce - -## Class - -- [FilesFolders](Flow.Launcher.Plugin.SharedCommands/filesfolders.md) - -- [SearchWeb](Flow.Launcher.Plugin.SharedCommands/searchweb.md) - -- [ShellCommand](Flow.Launcher.Plugin.SharedCommands/shellcommand.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md new file mode 100644 index 0000000..1b9ab19 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md @@ -0,0 +1,19 @@ +# FilesFolders.CopyAll method + +Copies the folder and all of its files and folders including subfolders to the target location + +```csharp +public static void CopyAll(this string sourcePath, string targetPath) +``` + +| parameter | description | +| --- | --- | +| sourcePath | | +| targetPath | | + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md new file mode 100644 index 0000000..9c43aa3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md @@ -0,0 +1,12 @@ +# FilesFolders.FileExists method + +```csharp +public static bool FileExists(this string filePath) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md new file mode 100644 index 0000000..f7a129b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md @@ -0,0 +1,14 @@ +# FilesFolders.GetPreviousExistingDirectory method + +Gets the previous level directory from a path string. Checks that previous level directory exists and returns it as a path string, or empty string if doesn't exist + +```csharp +public static string GetPreviousExistingDirectory(Func locationExists, string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md new file mode 100644 index 0000000..54cdee6 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md @@ -0,0 +1,14 @@ +# FilesFolders.IsLocationPathString method + +This checks whether a given string is a directory path or network location string. It does not check if location actually exists. + +```csharp +public static bool IsLocationPathString(this string querySearchString) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md new file mode 100644 index 0000000..40595d3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md @@ -0,0 +1,12 @@ +# FilesFolders.LocationExists method + +```csharp +public static bool LocationExists(this string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md new file mode 100644 index 0000000..4e24d9d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md @@ -0,0 +1,12 @@ +# FilesFolders.OpenContainingFolder method + +```csharp +public static void OpenContainingFolder(string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md new file mode 100644 index 0000000..c9889e9 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md @@ -0,0 +1,12 @@ +# FilesFolders.OpenPath method + +```csharp +public static void OpenPath(string fileOrFolderPath) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md new file mode 100644 index 0000000..997bc0f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md @@ -0,0 +1,12 @@ +# FilesFolders.RemoveFolderIfExists method + +```csharp +public static void RemoveFolderIfExists(this string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md new file mode 100644 index 0000000..66069bd --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md @@ -0,0 +1,14 @@ +# FilesFolders.ReturnPreviousDirectoryIfIncompleteString method + +Returns the previous level directory if path incomplete (does not end with '\'). Does not check if previous level directory exists. Returns passed in string if is complete path + +```csharp +public static string ReturnPreviousDirectoryIfIncompleteString(string path) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md new file mode 100644 index 0000000..b1a85b9 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md @@ -0,0 +1,12 @@ +# FilesFolders.VerifyBothFolderFilesEqual method + +```csharp +public static bool VerifyBothFolderFilesEqual(this string fromPath, string toPath) +``` + +## See Also + +* class [FilesFolders](../FilesFolders.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md new file mode 100644 index 0000000..92f19ab --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md @@ -0,0 +1,15 @@ +# SearchWeb.OpenInBrowserTab method + +Opens search as a tab in the default browser chosen in Windows settings. + +```csharp +public static void OpenInBrowserTab(this string url, string browserPath = "", + bool inPrivate = false, string privateArg = "") +``` + +## See Also + +* class [SearchWeb](../SearchWeb.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md new file mode 100644 index 0000000..de8d25f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md @@ -0,0 +1,15 @@ +# SearchWeb.OpenInBrowserWindow method + +Opens search in a new browser. If no browser path is passed in then Chrome is used. Leave browser path blank to use Chrome. + +```csharp +public static void OpenInBrowserWindow(this string url, string browserPath = "", + bool inPrivate = false, string privateArg = "") +``` + +## See Also + +* class [SearchWeb](../SearchWeb.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md new file mode 100644 index 0000000..0702b4a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md @@ -0,0 +1,12 @@ +# ShellCommand.EnumThreadDelegate delegate + +```csharp +public delegate bool EnumThreadDelegate(IntPtr hwnd, IntPtr lParam); +``` + +## See Also + +* class [ShellCommand](./ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md new file mode 100644 index 0000000..dcc0138 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md @@ -0,0 +1,47 @@ +# ShellCommand.Execute method (1 of 2) + +Runs a windows command using the provided ProcessStartInfo + +```csharp +public static void Execute(ProcessStartInfo info) +``` + +## Exceptions + +| exception | condition | +| --- | --- | +| !:FileNotFoundException | Thrown when unable to find the file specified in the command | +| !:Win32Exception | Thrown when error occurs during the execution of the command | + +## See Also + +* class [ShellCommand](../ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + +--- + +# ShellCommand.Execute method (2 of 2) + +Runs a windows command using the provided ProcessStartInfo using a custom execute command function + +```csharp +public static void Execute(Func startProcess, ProcessStartInfo info) +``` + +| parameter | description | +| --- | --- | +| Func startProcessstartProcess | allows you to pass in a custom command execution function | + +## Exceptions + +| exception | condition | +| --- | --- | +| !:FileNotFoundException | Thrown when unable to find the file specified in the command | +| !:Win32Exception | Thrown when error occurs during the execution of the command | + +## See Also + +* class [ShellCommand](../ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md new file mode 100644 index 0000000..121115e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md @@ -0,0 +1,12 @@ +# ShellCommand.RunAsDifferentUser method + +```csharp +public static Process RunAsDifferentUser(ProcessStartInfo processStartInfo) +``` + +## See Also + +* class [ShellCommand](../ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md new file mode 100644 index 0000000..5dab582 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md @@ -0,0 +1,14 @@ +# ShellCommand.SetProcessStartInfo method + +```csharp +public static ProcessStartInfo SetProcessStartInfo(this string fileName, + string workingDirectory = "", string arguments = "", string verb = "", + bool createNoWindow = false) +``` + +## See Also + +* class [ShellCommand](../ShellCommand.md) +* namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/_sidebar.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/_sidebar.md deleted file mode 100644 index 281168b..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/_sidebar.md +++ /dev/null @@ -1,5 +0,0 @@ -- [**Flow.Launcher.Plugin.SharedCommands**](../Flow.Launcher.Plugin.SharedCommands.md) - - **Class** - - [FilesFolders](filesfolders.md) - - [SearchWeb](searchweb.md) - - [ShellCommand](shellcommand.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md index b8ee22e..149e645 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md @@ -1,169 +1,26 @@ -# FilesFolders - -Namespace: Flow.Launcher.Plugin.SharedCommands - - +# FilesFolders class ```csharp public static class FilesFolders ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FilesFolders](filesfolders.md) - -## Methods - -### **CopyAll(String, String)** - -Copies the folder and all of its files and folders - including subfolders to the target location - -```csharp -public static void CopyAll(string sourcePath, string targetPath) -``` - -#### Parameters - -`sourcePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`targetPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **VerifyBothFolderFilesEqual(String, String)** - - - -```csharp -public static bool VerifyBothFolderFilesEqual(string fromPath, string toPath) -``` - -#### Parameters - -`fromPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`toPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **RemoveFolderIfExists(String)** - - - -```csharp -public static void RemoveFolderIfExists(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LocationExists(String)** - - - -```csharp -public static bool LocationExists(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **FileExists(String)** - - - -```csharp -public static bool FileExists(string filePath) -``` - -#### Parameters - -`filePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **OpenPath(String)** - - - -```csharp -public static void OpenPath(string fileOrFolderPath) -``` - -#### Parameters - -`fileOrFolderPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **OpenContainingFolder(String)** - - - -```csharp -public static void OpenContainingFolder(string path) -``` - -#### Parameters - -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **IsLocationPathString(String)** - -This checks whether a given string is a directory path or network location string. - It does not check if location actually exists. - -```csharp -public static bool IsLocationPathString(string querySearchString) -``` - -#### Parameters - -`querySearchString` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **GetPreviousExistingDirectory(Func<String, Boolean>, String)** - -Gets the previous level directory from a path string. - Checks that previous level directory exists and returns it - as a path string, or empty string if doesn't exist - -```csharp -public static string GetPreviousExistingDirectory(Func locationExists, string path) -``` - -#### Parameters - -`locationExists` [Func<String, Boolean>](https://docs.microsoft.com/en-us/dotnet/api/system.func-2)
- -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ReturnPreviousDirectoryIfIncompleteString(String)** - -Returns the previous level directory if path incomplete (does not end with '\'). - Does not check if previous level directory exists. - Returns passed in string if is complete path - -```csharp -public static string ReturnPreviousDirectoryIfIncompleteString(string path) -``` +## Public Members -#### Parameters +| name | description | +| --- | --- | +| static [CopyAll](FilesFolders/CopyAll.md)(…) | Copies the folder and all of its files and folders including subfolders to the target location | +| static [FileExists](FilesFolders/FileExists.md)(…) | | +| static [GetPreviousExistingDirectory](FilesFolders/GetPreviousExistingDirectory.md)(…) | Gets the previous level directory from a path string. Checks that previous level directory exists and returns it as a path string, or empty string if doesn't exist | +| static [IsLocationPathString](FilesFolders/IsLocationPathString.md)(…) | This checks whether a given string is a directory path or network location string. It does not check if location actually exists. | +| static [LocationExists](FilesFolders/LocationExists.md)(…) | | +| static [OpenContainingFolder](FilesFolders/OpenContainingFolder.md)(…) | | +| static [OpenPath](FilesFolders/OpenPath.md)(…) | | +| static [RemoveFolderIfExists](FilesFolders/RemoveFolderIfExists.md)(…) | | +| static [ReturnPreviousDirectoryIfIncompleteString](FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md)(…) | Returns the previous level directory if path incomplete (does not end with '\'). Does not check if previous level directory exists. Returns passed in string if is complete path | +| static [VerifyBothFolderFilesEqual](FilesFolders/VerifyBothFolderFilesEqual.md)(…) | | -`path` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+## See Also -#### Returns +* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md index 48dbc5c..ed35c05 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md @@ -1,42 +1,18 @@ -# SearchWeb - -Namespace: Flow.Launcher.Plugin.SharedCommands - - +# SearchWeb class ```csharp public static class SearchWeb ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SearchWeb](searchweb.md) - -## Methods - -### **NewBrowserWindow(String, String)** - -Opens search in a new browser. If no browser path is passed in then Chrome is used. - Leave browser path blank to use Chrome. - -```csharp -public static void NewBrowserWindow(string url, string browserPath) -``` - -#### Parameters - -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`browserPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+## Public Members -### **NewTabInBrowser(String, String)** - -Opens search as a tab in the default browser chosen in Windows settings. - -```csharp -public static void NewTabInBrowser(string url, string browserPath) -``` +| name | description | +| --- | --- | +| static [OpenInBrowserTab](SearchWeb/OpenInBrowserTab.md)(…) | Opens search as a tab in the default browser chosen in Windows settings. | +| static [OpenInBrowserWindow](SearchWeb/OpenInBrowserWindow.md)(…) | Opens search in a new browser. If no browser path is passed in then Chrome is used. Leave browser path blank to use Chrome. | -#### Parameters +## See Also -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) -`browserPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md index 9d97db5..8acc214 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md @@ -1,51 +1,20 @@ -# ShellCommand - -Namespace: Flow.Launcher.Plugin.SharedCommands - - +# ShellCommand class ```csharp public static class ShellCommand ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ShellCommand](shellcommand.md) - -## Methods - -### **RunAsDifferentUser(ProcessStartInfo)** - - - -```csharp -public static Process RunAsDifferentUser(ProcessStartInfo processStartInfo) -``` - -#### Parameters - -`processStartInfo` ProcessStartInfo
- -#### Returns - -Process
- -### **SetProcessStartInfo(String, String, String, String)** - - - -```csharp -public static ProcessStartInfo SetProcessStartInfo(string fileName, string workingDirectory, string arguments, string verb) -``` - -#### Parameters - -`fileName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`workingDirectory` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+## Public Members -`arguments` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+| name | description | +| --- | --- | +| static [Execute](ShellCommand/Execute.md)(…) | Runs a windows command using the provided ProcessStartInfo (2 methods) | +| static [RunAsDifferentUser](ShellCommand/RunAsDifferentUser.md)(…) | | +| static [SetProcessStartInfo](ShellCommand/SetProcessStartInfo.md)(…) | | +| delegate [EnumThreadDelegate](ShellCommand.EnumThreadDelegate.md) | | -`verb` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+## See Also -#### Returns +* namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) -ProcessStartInfo
+ diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels.md b/API-Reference/Flow.Launcher.Plugin.SharedModels.md deleted file mode 100644 index ddbf723..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels.md +++ /dev/null @@ -1,9 +0,0 @@ -# Flow.Launcher.Plugin.SharedModels Namespace - -## Class - -- [MatchResult](Flow.Launcher.Plugin.SharedModels/matchresult.md) - -## Enum - -- [SearchPrecisionScore](Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md new file mode 100644 index 0000000..6e8487b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md @@ -0,0 +1,12 @@ +# MatchResult.IsSearchPrecisionScoreMet method + +```csharp +public bool IsSearchPrecisionScoreMet() +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md new file mode 100644 index 0000000..7d3c469 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md @@ -0,0 +1,14 @@ +# MatchResult.MatchData property + +Matched data to highlight. + +```csharp +public List MatchData { get; set; } +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md new file mode 100644 index 0000000..c20b6a1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md @@ -0,0 +1,28 @@ +# MatchResult constructor (1 of 2) + +```csharp +public MatchResult(bool success, SearchPrecisionScore searchPrecision) +``` + +## See Also + +* enum [SearchPrecisionScore](../SearchPrecisionScore.md) +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + +--- + +# MatchResult constructor (2 of 2) + +```csharp +public MatchResult(bool success, SearchPrecisionScore searchPrecision, List matchData, + int rawScore) +``` + +## See Also + +* enum [SearchPrecisionScore](../SearchPrecisionScore.md) +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md new file mode 100644 index 0000000..07850e8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md @@ -0,0 +1,12 @@ +# MatchResult.RawScore property + +```csharp +public int RawScore { get; set; } +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md new file mode 100644 index 0000000..53f893b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md @@ -0,0 +1,14 @@ +# MatchResult.Score property + +The final score of the match result with search precision filters applied. + +```csharp +public int Score { get; } +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md new file mode 100644 index 0000000..e9da3cf --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md @@ -0,0 +1,13 @@ +# MatchResult.SearchPrecision property + +```csharp +public SearchPrecisionScore SearchPrecision { get; set; } +``` + +## See Also + +* enum [SearchPrecisionScore](../SearchPrecisionScore.md) +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md new file mode 100644 index 0000000..f25ed26 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md @@ -0,0 +1,12 @@ +# MatchResult.Success property + +```csharp +public bool Success { get; set; } +``` + +## See Also + +* class [MatchResult](../MatchResult.md) +* namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/_sidebar.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/_sidebar.md deleted file mode 100644 index 56d8b04..0000000 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/_sidebar.md +++ /dev/null @@ -1,5 +0,0 @@ -- [**Flow.Launcher.Plugin.SharedModels**](../Flow.Launcher.Plugin.SharedModels.md) - - **Class** - - [MatchResult](matchresult.md) - - **Enum** - - [SearchPrecisionScore](searchprecisionscore.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md index 10a2ea2..ede3d9d 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md @@ -1,121 +1,23 @@ -# MatchResult - -Namespace: Flow.Launcher.Plugin.SharedModels - - +# MatchResult class ```csharp public class MatchResult ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [MatchResult](matchresult.md) - -## Properties - -### **Success** - - - -```csharp -public bool Success { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **Score** - -The final score of the match result with search precision filters applied. - -```csharp -public int Score { get; private set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **RawScore** - - - -```csharp -public int RawScore { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **MatchData** - -Matched data to highlight. - -```csharp -public List MatchData { get; set; } -``` - -#### Property Value - -[List<Int32>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -### **SearchPrecision** - - - -```csharp -public SearchPrecisionScore SearchPrecision { get; set; } -``` - -#### Property Value - -[SearchPrecisionScore](sharedmodels.searchprecisionscore.md)
- -## Constructors - -### **MatchResult(Boolean, SearchPrecisionScore)** - - - -```csharp -public MatchResult(bool success, SearchPrecisionScore searchPrecision) -``` - -#### Parameters - -`success` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -`searchPrecision` [SearchPrecisionScore](sharedmodels.searchprecisionscore.md)
- -### **MatchResult(Boolean, SearchPrecisionScore, List<Int32>, Int32)** - - - -```csharp -public MatchResult(bool success, SearchPrecisionScore searchPrecision, List matchData, int rawScore) -``` - -#### Parameters - -`success` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+## Public Members -`searchPrecision` [SearchPrecisionScore](sharedmodels.searchprecisionscore.md)
+| name | description | +| --- | --- | +| [MatchResult](MatchResult/MatchResult.md)(…) | (2 constructors) | +| [MatchData](MatchResult/MatchData.md) { get; set; } | Matched data to highlight. | +| [RawScore](MatchResult/RawScore.md) { get; set; } | | +| [Score](MatchResult/Score.md) { get; } | The final score of the match result with search precision filters applied. | +| [SearchPrecision](MatchResult/SearchPrecision.md) { get; set; } | | +| [Success](MatchResult/Success.md) { get; set; } | | +| [IsSearchPrecisionScoreMet](MatchResult/IsSearchPrecisionScoreMet.md)() | | -`matchData` [List<Int32>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -`rawScore` [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Methods - -### **IsSearchPrecisionScoreMet()** - - - -```csharp -public bool IsSearchPrecisionScoreMet() -``` +## See Also -#### Returns +* namespace [Flow.Launcher.Plugin.SharedModels](../Flow.Launcher.Plugin.md) -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+ diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md index f9376e7..5d87373 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md @@ -1,23 +1,19 @@ -# SearchPrecisionScore +# SearchPrecisionScore enumeration -Namespace: Flow.Launcher.Plugin.SharedModels - -```c# +```csharp public enum SearchPrecisionScore ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ValueType](https://docs.microsoft.com/en-us/dotnet/api/system.valuetype) -> [Enum](https://docs.microsoft.com/en-us/dotnet/api/system.enum)-> [SearchPrecisionScore](searchprecisionscore.md) - -## Field - -### Regular - -Value: 50 +## Values -### Low +| name | value | description | +| --- | --- | --- | +| Regular | `50` | | +| Low | `20` | | +| None | `0` | | -Value: 20 +## See Also -### None +* namespace [Flow.Launcher.Plugin.SharedModels](../Flow.Launcher.Plugin.md) -Value: 0 \ No newline at end of file + diff --git a/API-Reference/Flow.Launcher.Plugin.md b/API-Reference/Flow.Launcher.Plugin.md index 59dce03..b114456 100644 --- a/API-Reference/Flow.Launcher.Plugin.md +++ b/API-Reference/Flow.Launcher.Plugin.md @@ -1,52 +1,52 @@ -# Flow.Launcher.Plugin Namespace - -## Class - -- [ActionContext](Flow.Launcher.Plugin/actioncontext.md) - -- [AllowedLanguage](Flow.Launcher.Plugin/allowedlanguage.md) - -- [BaseModel](Flow.Launcher.Plugin/basemodel.md) - -- [FlowLauncherKeyDownEventArgs](Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md) - -- [FlowLauncherQueryEventArgs](Flow.Launcher.Plugin/flowlauncherqueryeventargs.md) - -- [PluginInitContext](Flow.Launcher.Plugin/plugininitcontext.md) - -- [PluginMetadata](Flow.Launcher.Plugin/pluginmetadata.md) - -- [PluginPair](Flow.Launcher.Plugin/pluginpair.md) - -- [Query](Flow.Launcher.Plugin/query.md) - -- [Result](Flow.Launcher.Plugin/result.md) - -- [ResultUpdatedEventArgs](Flow.Launcher.Plugin/resultupdatedeventargs.md) - -- [SpecialKeyState](Flow.Launcher.Plugin/specialkeystate.md) - - -## Interface - -- [IAsyncPlugin](Flow.Launcher.Plugin/iasyncplugin.md) - -- [IAsyncReloadable](Flow.Launcher.Plugin/iasyncreloadable.md) - -- [IContextMenu](Flow.Launcher.Plugin/icontextmenu.md) - -- [IFeatures](Flow.Launcher.Plugin/ifeatures.md) - -- [IPlugin](Flow.Launcher.Plugin/iplugin.md) - -- [IPluginI18n](Flow.Launcher.Plugin/iplugini18n.md) - -- [IPublicAPI](Flow.Launcher.Plugin/ipublicapi.md) - -- [IReloadable](Flow.Launcher.Plugin/ireloadable.md) - -- [IResultUpdated](Flow.Launcher.Plugin/iresultupdated.md) - -- [ISavable](Flow.Launcher.Plugin/isavable.md) - -- [ISettingProvider](Flow.Launcher.Plugin/isettingprovider.md) \ No newline at end of file +# Flow.Launcher.Plugin assembly + +## Flow.Launcher.Plugin namespace + +| public type | description | +| --- | --- | +| class [ActionContext](./Flow.Launcher.Plugin/ActionContext.md) | | +| delegate [AfterFlowLauncherQueryEventHandler](./Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md) | | +| static class [AllowedLanguage](./Flow.Launcher.Plugin/AllowedLanguage.md) | | +| class [BaseModel](./Flow.Launcher.Plugin/BaseModel.md) | | +| delegate [FlowLauncherGlobalKeyboardEventHandler](./Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md) | Global keyboard events | +| class [FlowLauncherKeyDownEventArgs](./Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs.md) | | +| delegate [FlowLauncherKeyDownEventHandler](./Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md) | | +| class [FlowLauncherQueryEventArgs](./Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md) | | +| record [GlyphInfo](./Flow.Launcher.Plugin/GlyphInfo.md) | | +| interface [IAsyncPlugin](./Flow.Launcher.Plugin/IAsyncPlugin.md) | Asynchronous Plugin Model for Flow Launcher | +| 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. | +| interface [IContextMenu](./Flow.Launcher.Plugin/IContextMenu.md) | | +| interface [IFeatures](./Flow.Launcher.Plugin/IFeatures.md) | Base Interface for Flow's special plugin feature interface | +| interface [IPlugin](./Flow.Launcher.Plugin/IPlugin.md) | Synchronous Plugin Model for Flow Launcher | +| interface [IPluginI18n](./Flow.Launcher.Plugin/IPluginI18n.md) | Represent plugins that support internationalization | +| interface [IPublicAPI](./Flow.Launcher.Plugin/IPublicAPI.md) | Public APIs that plugin can use | +| interface [IReloadable](./Flow.Launcher.Plugin/IReloadable.md) | This interface is to indicate and allow plugins to synchronously 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. | +| interface [IResultUpdated](./Flow.Launcher.Plugin/IResultUpdated.md) | | +| interface [ISavable](./Flow.Launcher.Plugin/ISavable.md) | Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded, plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow | +| interface [ISettingProvider](./Flow.Launcher.Plugin/ISettingProvider.md) | | +| class [PluginInitContext](./Flow.Launcher.Plugin/PluginInitContext.md) | | +| class [PluginMetadata](./Flow.Launcher.Plugin/PluginMetadata.md) | | +| class [PluginPair](./Flow.Launcher.Plugin/PluginPair.md) | | +| class [Query](./Flow.Launcher.Plugin/Query.md) | | +| class [Result](./Flow.Launcher.Plugin/Result.md) | | +| delegate [ResultItemDropEventHandler](./Flow.Launcher.Plugin/ResultItemDropEventHandler.md) | | +| class [ResultUpdatedEventArgs](./Flow.Launcher.Plugin/ResultUpdatedEventArgs.md) | | +| delegate [ResultUpdatedEventHandler](./Flow.Launcher.Plugin/ResultUpdatedEventHandler.md) | | +| class [SpecialKeyState](./Flow.Launcher.Plugin/SpecialKeyState.md) | | + +## Flow.Launcher.Plugin.SharedCommands namespace + +| public type | description | +| --- | --- | +| static class [FilesFolders](./Flow.Launcher.Plugin.SharedCommands/FilesFolders.md) | | +| static class [SearchWeb](./Flow.Launcher.Plugin.SharedCommands/SearchWeb.md) | | +| static class [ShellCommand](./Flow.Launcher.Plugin.SharedCommands/ShellCommand.md) | | + +## Flow.Launcher.Plugin.SharedModels namespace + +| public type | description | +| --- | --- | +| class [MatchResult](./Flow.Launcher.Plugin.SharedModels/MatchResult.md) | | +| enum [SearchPrecisionScore](./Flow.Launcher.Plugin.SharedModels/SearchPrecisionScore.md) | | + + diff --git a/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md b/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md new file mode 100644 index 0000000..4bfc6ff --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md @@ -0,0 +1,14 @@ +# ActionContext constructor + +The default constructor. + +```csharp +public ActionContext() +``` + +## See Also + +* class [ActionContext](../ActionContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md b/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md new file mode 100644 index 0000000..26a5ef9 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md @@ -0,0 +1,13 @@ +# ActionContext.SpecialKeyState property + +```csharp +public SpecialKeyState SpecialKeyState { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* class [ActionContext](../ActionContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md b/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md new file mode 100644 index 0000000..cdf2831 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md @@ -0,0 +1,12 @@ +# AfterFlowLauncherQueryEventHandler delegate + +```csharp +public delegate void AfterFlowLauncherQueryEventHandler(FlowLauncherQueryEventArgs e); +``` + +## See Also + +* class [FlowLauncherQueryEventArgs](./FlowLauncherQueryEventArgs.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md new file mode 100644 index 0000000..15081a8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md @@ -0,0 +1,12 @@ +# AllowedLanguage.CSharp property + +```csharp +public static string CSharp { get; } +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md new file mode 100644 index 0000000..72e87ff --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md @@ -0,0 +1,12 @@ +# AllowedLanguage.Executable property + +```csharp +public static string Executable { get; } +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md new file mode 100644 index 0000000..ec4a9b5 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md @@ -0,0 +1,12 @@ +# AllowedLanguage.FSharp property + +```csharp +public static string FSharp { get; } +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md new file mode 100644 index 0000000..01093b1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md @@ -0,0 +1,12 @@ +# AllowedLanguage.IsAllowed method + +```csharp +public static bool IsAllowed(string language) +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md new file mode 100644 index 0000000..1889d10 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md @@ -0,0 +1,12 @@ +# AllowedLanguage.IsDotNet method + +```csharp +public static bool IsDotNet(string language) +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md new file mode 100644 index 0000000..4603c5b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md @@ -0,0 +1,12 @@ +# AllowedLanguage.Python property + +```csharp +public static string Python { get; } +``` + +## See Also + +* class [AllowedLanguage](../AllowedLanguage.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md b/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md new file mode 100644 index 0000000..e70a559 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md @@ -0,0 +1,14 @@ +# BaseModel constructor + +The default constructor. + +```csharp +public BaseModel() +``` + +## See Also + +* class [BaseModel](../BaseModel.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md b/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md new file mode 100644 index 0000000..bd78e5d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md @@ -0,0 +1,12 @@ +# BaseModel.OnPropertyChanged method + +```csharp +protected void OnPropertyChanged([CallerMemberName] string propertyName = null) +``` + +## See Also + +* class [BaseModel](../BaseModel.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md b/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md new file mode 100644 index 0000000..d746c35 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md @@ -0,0 +1,12 @@ +# BaseModel.PropertyChanged event + +```csharp +public event PropertyChangedEventHandler PropertyChanged; +``` + +## See Also + +* class [BaseModel](../BaseModel.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md new file mode 100644 index 0000000..230bc05 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md @@ -0,0 +1,25 @@ +# FlowLauncherGlobalKeyboardEventHandler delegate + +Global keyboard events + +```csharp +public delegate bool FlowLauncherGlobalKeyboardEventHandler(int keyevent, int vkcode, + SpecialKeyState state); +``` + +| parameter | description | +| --- | --- | +| keyevent | WM_KEYDOWN = 256,WM_KEYUP = 257,WM_SYSKEYUP = 261,WM_SYSKEYDOWN = 260 | +| vkcode | | +| state | | + +## Return Value + +return true to continue handling, return false to intercept system handling + +## See Also + +* class [SpecialKeyState](./SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md new file mode 100644 index 0000000..2ddc34f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md @@ -0,0 +1,14 @@ +# FlowLauncherKeyDownEventArgs constructor + +The default constructor. + +```csharp +public FlowLauncherKeyDownEventArgs() +``` + +## See Also + +* class [FlowLauncherKeyDownEventArgs](../FlowLauncherKeyDownEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md new file mode 100644 index 0000000..815251d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md @@ -0,0 +1,12 @@ +# FlowLauncherKeyDownEventArgs.Query property + +```csharp +public string Query { get; set; } +``` + +## See Also + +* class [FlowLauncherKeyDownEventArgs](../FlowLauncherKeyDownEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md new file mode 100644 index 0000000..86feded --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md @@ -0,0 +1,12 @@ +# FlowLauncherKeyDownEventArgs.keyEventArgs property + +```csharp +public KeyEventArgs keyEventArgs { get; set; } +``` + +## See Also + +* class [FlowLauncherKeyDownEventArgs](../FlowLauncherKeyDownEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md new file mode 100644 index 0000000..8c57d4e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md @@ -0,0 +1,12 @@ +# FlowLauncherKeyDownEventHandler delegate + +```csharp +public delegate void FlowLauncherKeyDownEventHandler(FlowLauncherKeyDownEventArgs e); +``` + +## See Also + +* class [FlowLauncherKeyDownEventArgs](./FlowLauncherKeyDownEventArgs.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md new file mode 100644 index 0000000..308899a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md @@ -0,0 +1,14 @@ +# FlowLauncherQueryEventArgs constructor + +The default constructor. + +```csharp +public FlowLauncherQueryEventArgs() +``` + +## See Also + +* class [FlowLauncherQueryEventArgs](../FlowLauncherQueryEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md new file mode 100644 index 0000000..7cd6198 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md @@ -0,0 +1,13 @@ +# FlowLauncherQueryEventArgs.Query property + +```csharp +public Query Query { get; set; } +``` + +## See Also + +* class [Query](../Query.md) +* class [FlowLauncherQueryEventArgs](../FlowLauncherQueryEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md new file mode 100644 index 0000000..f2c6427 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md @@ -0,0 +1,19 @@ +# GlyphInfo record + +```csharp +public record GlyphInfo +``` + +## Public Members + +| name | description | +| --- | --- | +| [GlyphInfo](GlyphInfo/GlyphInfo.md)(…) | | +| [FontFamily](GlyphInfo/FontFamily.md) { get; set; } | | +| [Glyph](GlyphInfo/Glyph.md) { get; set; } | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md new file mode 100644 index 0000000..578642d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md @@ -0,0 +1,12 @@ +# GlyphInfo.FontFamily property + +```csharp +public string FontFamily { get; set; } +``` + +## See Also + +* record [GlyphInfo](../GlyphInfo.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md new file mode 100644 index 0000000..3dd2286 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md @@ -0,0 +1,12 @@ +# GlyphInfo.Glyph property + +```csharp +public string Glyph { get; set; } +``` + +## See Also + +* record [GlyphInfo](../GlyphInfo.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md new file mode 100644 index 0000000..ae3d263 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md @@ -0,0 +1,12 @@ +# GlyphInfo constructor + +```csharp +public GlyphInfo(string FontFamily, string Glyph) +``` + +## See Also + +* record [GlyphInfo](../GlyphInfo.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md new file mode 100644 index 0000000..2c882f2 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md @@ -0,0 +1,19 @@ +# IAsyncPlugin.InitAsync method + +Initialize plugin asynchrously (will still wait finish to continue) + +```csharp +public Task InitAsync(PluginInitContext context) +``` + +| parameter | description | +| --- | --- | +| context | | + +## See Also + +* class [PluginInitContext](../PluginInitContext.md) +* interface [IAsyncPlugin](../IAsyncPlugin.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md new file mode 100644 index 0000000..a2f9297 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md @@ -0,0 +1,21 @@ +# IAsyncPlugin.QueryAsync method + +Asynchronous Querying + +```csharp +public Task> QueryAsync(Query query, CancellationToken token) +``` + +| parameter | description | +| --- | --- | +| query | Query to search | +| token | Cancel when querying job is obsolete | + +## See Also + +* class [Result](../Result.md) +* class [Query](../Query.md) +* interface [IAsyncPlugin](../IAsyncPlugin.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md b/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md new file mode 100644 index 0000000..ef32f2f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md @@ -0,0 +1,12 @@ +# IAsyncReloadable.ReloadDataAsync method + +```csharp +public Task ReloadDataAsync() +``` + +## See Also + +* interface [IAsyncReloadable](../IAsyncReloadable.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md b/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md new file mode 100644 index 0000000..054a5f4 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md @@ -0,0 +1,13 @@ +# IContextMenu.LoadContextMenus method + +```csharp +public List LoadContextMenus(Result selectedResult) +``` + +## See Also + +* class [Result](../Result.md) +* interface [IContextMenu](../IContextMenu.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md b/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md new file mode 100644 index 0000000..bb91d9e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md @@ -0,0 +1,19 @@ +# IPlugin.Init method + +Initialize plugin + +```csharp +public void Init(PluginInitContext context) +``` + +| parameter | description | +| --- | --- | +| context | | + +## See Also + +* class [PluginInitContext](../PluginInitContext.md) +* interface [IPlugin](../IPlugin.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md b/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md new file mode 100644 index 0000000..86d15c3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md @@ -0,0 +1,22 @@ +# IPlugin.Query method + +Querying when user's search changes + +This method will be called within a Task.Run, so please avoid synchrously wait for long. + +```csharp +public List Query(Query query) +``` + +| parameter | description | +| --- | --- | +| query | Query to search | + +## See Also + +* class [Result](../Result.md) +* class [Query](../Query.md) +* interface [IPlugin](../IPlugin.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md new file mode 100644 index 0000000..8fce8ed --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md @@ -0,0 +1,12 @@ +# IPluginI18n.GetTranslatedPluginDescription method + +```csharp +public string GetTranslatedPluginDescription() +``` + +## See Also + +* interface [IPluginI18n](../IPluginI18n.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md new file mode 100644 index 0000000..7182341 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md @@ -0,0 +1,12 @@ +# IPluginI18n.GetTranslatedPluginTitle method + +```csharp +public string GetTranslatedPluginTitle() +``` + +## See Also + +* interface [IPluginI18n](../IPluginI18n.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md new file mode 100644 index 0000000..08d6820 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md @@ -0,0 +1,14 @@ +# IPluginI18n.OnCultureInfoChanged method + +The method will be invoked when language of flow changed + +```csharp +public void OnCultureInfoChanged(CultureInfo newCulture) +``` + +## See Also + +* interface [IPluginI18n](../IPluginI18n.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md new file mode 100644 index 0000000..45a7c5a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md @@ -0,0 +1,19 @@ +# IPublicAPI.AddActionKeyword method + +Add ActionKeyword for specific plugin + +```csharp +public void AddActionKeyword(string pluginId, string newActionKeyword) +``` + +| parameter | description | +| --- | --- | +| pluginId | ID for plugin that needs to add action keyword | +| newActionKeyword | The actionkeyword that is supposed to be added | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md new file mode 100644 index 0000000..987700f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md @@ -0,0 +1,19 @@ +# IPublicAPI.ChangeQuery method + +Change Flow.Launcher query + +```csharp +public void ChangeQuery(string query, bool requery = false) +``` + +| parameter | description | +| --- | --- | +| query | query text | +| requery | force requery By default, Flow Launcher will not fire query if your query is same with existing one. Set this to true to force Flow Launcher requerying | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md new file mode 100644 index 0000000..8c3e59a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md @@ -0,0 +1,14 @@ +# IPublicAPI.CheckForNewUpdate method + +Check for new Flow Launcher update + +```csharp +public void CheckForNewUpdate() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md new file mode 100644 index 0000000..057d779 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md @@ -0,0 +1,18 @@ +# IPublicAPI.CopyToClipboard method + +Copy Text to clipboard + +```csharp +public void CopyToClipboard(string text) +``` + +| parameter | description | +| --- | --- | +| Text | Text to save on clipboard | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md new file mode 100644 index 0000000..f4dbab0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md @@ -0,0 +1,24 @@ +# IPublicAPI.FuzzySearch method + +Fuzzy Search the string with the given query. This is the core search mechanism Flow uses + +```csharp +public MatchResult FuzzySearch(string query, string stringToCompare) +``` + +| parameter | description | +| --- | --- | +| query | Query string | +| stringToCompare | The string that will be compared against the query | + +## Return Value + +Match results + +## See Also + +* class [MatchResult](../../Flow.Launcher.Plugin.SharedModels/MatchResult.md) +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md new file mode 100644 index 0000000..7a0d4d2 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md @@ -0,0 +1,15 @@ +# IPublicAPI.GetAllPlugins method + +Get all loaded plugins + +```csharp +public List GetAllPlugins() +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md new file mode 100644 index 0000000..b47e9ae --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md @@ -0,0 +1,18 @@ +# IPublicAPI.GetTranslation method + +Get translation of current language You need to implement IPluginI18n if you want to support multiple languages for your plugin + +```csharp +public string GetTranslation(string key) +``` + +| parameter | description | +| --- | --- | +| key | | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md new file mode 100644 index 0000000..72a3e04 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md @@ -0,0 +1,23 @@ +# IPublicAPI.HttpDownloadAsync method + +Download the specific url to a cretain file path + +```csharp +public Task HttpDownloadAsync(string url, string filePath, CancellationToken token = default) +``` + +| parameter | description | +| --- | --- | +| url | URL to download file | +| token | place to store file | + +## Return Value + +Task showing the progress + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md new file mode 100644 index 0000000..5129aeb --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md @@ -0,0 +1,23 @@ +# IPublicAPI.HttpGetStreamAsync method + +Http download the spefic url and return as stream + +```csharp +public Task HttpGetStreamAsync(string url, CancellationToken token = default) +``` + +| parameter | description | +| --- | --- | +| url | URL to call Http Get | +| token | Cancellation Token | + +## Return Value + +Task to get stream result + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md new file mode 100644 index 0000000..fc34bb3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md @@ -0,0 +1,23 @@ +# IPublicAPI.HttpGetStringAsync method + +Http download the spefic url and return as string + +```csharp +public Task HttpGetStringAsync(string url, CancellationToken token = default) +``` + +| parameter | description | +| --- | --- | +| url | URL to call Http Get | +| token | Cancellation Token | + +## Return Value + +Task to get string result + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md new file mode 100644 index 0000000..8ea141c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md @@ -0,0 +1,19 @@ +# IPublicAPI.LoadSettingJsonStorage<T> method + +Load JsonStorage for current plugin's setting. This is the method used to load settings from json in Flow. When the file is not exist, it will create a new instance for the specific type. + +```csharp +public T LoadSettingJsonStorage() + where T : new() +``` + +| parameter | description | +| --- | --- | +| T | Type for deserialization | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md new file mode 100644 index 0000000..4e5d849 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md @@ -0,0 +1,14 @@ +# IPublicAPI.LogDebug method + +Log debug message Message will only be logged in Debug mode + +```csharp +public void LogDebug(string className, string message, [CallerMemberName] string methodName = "") +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md new file mode 100644 index 0000000..bee4505 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md @@ -0,0 +1,15 @@ +# IPublicAPI.LogException method + +Log an Exception. Will throw if in debug mode so developer will be aware, otherwise logs the eror message. This is the primary logging method used for Flow + +```csharp +public void LogException(string className, string message, Exception e, + [CallerMemberName] string methodName = "") +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md new file mode 100644 index 0000000..f0fde65 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md @@ -0,0 +1,14 @@ +# IPublicAPI.LogInfo method + +Log info message + +```csharp +public void LogInfo(string className, string message, [CallerMemberName] string methodName = "") +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md new file mode 100644 index 0000000..f0e2edf --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md @@ -0,0 +1,14 @@ +# IPublicAPI.LogWarn method + +Log warning message + +```csharp +public void LogWarn(string className, string message, [CallerMemberName] string methodName = "") +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md new file mode 100644 index 0000000..d33f87d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md @@ -0,0 +1,19 @@ +# IPublicAPI.OpenDirectory method + +Open directory in an explorer configured by user via Flow's Settings. The default is Windows Explorer + +```csharp +public void OpenDirectory(string DirectoryPath, string FileName = null) +``` + +| parameter | description | +| --- | --- | +| DirectoryPath | Directory Path to open | +| FileName | Extra FileName Info | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md new file mode 100644 index 0000000..0fa4daf --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md @@ -0,0 +1,14 @@ +# IPublicAPI.OpenSettingDialog method + +Open setting dialog + +```csharp +public void OpenSettingDialog() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md new file mode 100644 index 0000000..2efd446 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md @@ -0,0 +1,14 @@ +# IPublicAPI.OpenUrl method + +Opens the url. The browser and mode used is based on what's configured in Flow's default browser settings. + +```csharp +public void OpenUrl(string url, bool? inPrivate = null) +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md new file mode 100644 index 0000000..88bff1c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md @@ -0,0 +1,19 @@ +# IPublicAPI.RegisterGlobalKeyboardCallback method + +Register a callback for Global Keyboard Event + +```csharp +public void RegisterGlobalKeyboardCallback(Func callback) +``` + +| parameter | description | +| --- | --- | +| callback | | + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md new file mode 100644 index 0000000..8bdd5c2 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md @@ -0,0 +1,14 @@ +# IPublicAPI.ReloadAllPluginData method + +Reloads any Plugins that have the IReloadable implemented. It refeshes Plugin's in memory data with new content added by user. + +```csharp +public Task ReloadAllPluginData() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md new file mode 100644 index 0000000..4494f04 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md @@ -0,0 +1,19 @@ +# IPublicAPI.RemoveActionKeyword method + +Remove ActionKeyword for specific plugin + +```csharp +public void RemoveActionKeyword(string pluginId, string oldActionKeyword) +``` + +| parameter | description | +| --- | --- | +| pluginId | ID for plugin that needs to remove action keyword | +| newActionKeyword | The actionkeyword that is supposed to be removed | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md new file mode 100644 index 0000000..a688ee4 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md @@ -0,0 +1,19 @@ +# IPublicAPI.RemoveGlobalKeyboardCallback method + +Remove a callback for Global Keyboard Event + +```csharp +public void RemoveGlobalKeyboardCallback(Func callback) +``` + +| parameter | description | +| --- | --- | +| callback | | + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md new file mode 100644 index 0000000..9172ffa --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md @@ -0,0 +1,14 @@ +# IPublicAPI.RestartApp method + +Restart Flow Launcher + +```csharp +public void RestartApp() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md new file mode 100644 index 0000000..f46db4d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md @@ -0,0 +1,14 @@ +# IPublicAPI.SaveAppAllSettings method + +Save everything, all of Flow Launcher and plugins' data and settings + +```csharp +public void SaveAppAllSettings() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md new file mode 100644 index 0000000..8889290 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md @@ -0,0 +1,14 @@ +# IPublicAPI.SavePluginSettings method + +Save all Flow's plugins settings + +```csharp +public void SavePluginSettings() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md new file mode 100644 index 0000000..c2c2d9a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md @@ -0,0 +1,19 @@ +# IPublicAPI.SaveSettingJsonStorage<T> method + +Save JsonStorage for current plugin's setting. This is the method used to save settings to json in Flow.Launcher This method will save the original instance loaded with LoadJsonStorage. This API call is for manually Save. Flow will automatically save all setting type that has called LoadSettingJsonStorage or SaveSettingJsonStorage previously. + +```csharp +public void SaveSettingJsonStorage() + where T : new() +``` + +| parameter | description | +| --- | --- | +| T | Type for Serialization | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md new file mode 100644 index 0000000..ef2b4b9 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md @@ -0,0 +1,26 @@ +# IPublicAPI.ShellRun method + +Run a shell command + +```csharp +public void ShellRun(string cmd, string filename = "cmd.exe") +``` + +| parameter | description | +| --- | --- | +| cmd | The command or program to run | +| filename | the shell type to run, e.g. powershell.exe | + +## Exceptions + +| exception | condition | +| --- | --- | +| FileNotFoundException | Thrown when unable to find the file specified in the command | +| !:Win32Exception | Thrown when error occurs during the execution of the command | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md new file mode 100644 index 0000000..1a02160 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md @@ -0,0 +1,14 @@ +# IPublicAPI.ShowMainWindow method + +Show the MainWindow when hiding + +```csharp +public void ShowMainWindow() +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md new file mode 100644 index 0000000..fe21722 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md @@ -0,0 +1,43 @@ +# IPublicAPI.ShowMsg method (1 of 2) + +Show message box + +```csharp +public void ShowMsg(string title, string subTitle = "", string iconPath = "") +``` + +| parameter | description | +| --- | --- | +| title | Message title | +| subTitle | Message subtitle | +| iconPath | Message icon path (relative path to your plugin folder) | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + +--- + +# IPublicAPI.ShowMsg method (2 of 2) + +Show message box + +```csharp +public void ShowMsg(string title, string subTitle, string iconPath, + bool useMainWindowAsOwner = true) +``` + +| parameter | description | +| --- | --- | +| title | Message title | +| subTitle | Message subtitle | +| iconPath | Message icon path (relative path to your plugin folder) | +| useMainWindowAsOwner | when true will use main windows as the owner | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md new file mode 100644 index 0000000..053fe32 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md @@ -0,0 +1,19 @@ +# IPublicAPI.ShowMsgError method + +Show the error message using Flow's standard error icon. + +```csharp +public void ShowMsgError(string title, string subTitle = "") +``` + +| parameter | description | +| --- | --- | +| title | Message title | +| subTitle | Optional message subtitle | + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md b/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md new file mode 100644 index 0000000..1dbee14 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md @@ -0,0 +1,12 @@ +# IReloadable.ReloadData method + +```csharp +public void ReloadData() +``` + +## See Also + +* interface [IReloadable](../IReloadable.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md b/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md new file mode 100644 index 0000000..cfc3480 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md @@ -0,0 +1,13 @@ +# IResultUpdated.ResultsUpdated event + +```csharp +public event ResultUpdatedEventHandler ResultsUpdated; +``` + +## See Also + +* delegate [ResultUpdatedEventHandler](../ResultUpdatedEventHandler.md) +* interface [IResultUpdated](../IResultUpdated.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md b/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md new file mode 100644 index 0000000..8b600e3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md @@ -0,0 +1,12 @@ +# ISavable.Save method + +```csharp +public void Save() +``` + +## See Also + +* interface [ISavable](../ISavable.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md b/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md new file mode 100644 index 0000000..26caeb2 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md @@ -0,0 +1,17 @@ +# ISettingProvider interface + +```csharp +public interface ISettingProvider +``` + +## Members + +| name | description | +| --- | --- | +| [CreateSettingPanel](ISettingProvider/CreateSettingPanel.md)() | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md b/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md new file mode 100644 index 0000000..cdd95b0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md @@ -0,0 +1,12 @@ +# ISettingProvider.CreateSettingPanel method + +```csharp +public Control CreateSettingPanel() +``` + +## See Also + +* interface [ISettingProvider](../ISettingProvider.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md new file mode 100644 index 0000000..6d943e5 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md @@ -0,0 +1,15 @@ +# PluginInitContext.API property + +Public APIs for plugin invocation + +```csharp +public IPublicAPI API { get; set; } +``` + +## See Also + +* interface [IPublicAPI](../IPublicAPI.md) +* class [PluginInitContext](../PluginInitContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md new file mode 100644 index 0000000..b1967dc --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md @@ -0,0 +1,13 @@ +# PluginInitContext.CurrentPluginMetadata property + +```csharp +public PluginMetadata CurrentPluginMetadata { get; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* class [PluginInitContext](../PluginInitContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md new file mode 100644 index 0000000..9aa32b7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md @@ -0,0 +1,29 @@ +# PluginInitContext constructor (1 of 2) + +The default constructor. + +```csharp +public PluginInitContext() +``` + +## See Also + +* class [PluginInitContext](../PluginInitContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + +--- + +# PluginInitContext constructor (2 of 2) + +```csharp +public PluginInitContext(PluginMetadata currentPluginMetadata, IPublicAPI api) +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* interface [IPublicAPI](../IPublicAPI.md) +* class [PluginInitContext](../PluginInitContext.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md new file mode 100644 index 0000000..e31a974 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md @@ -0,0 +1,12 @@ +# PluginMetadata.ActionKeyword property + +```csharp +public string ActionKeyword { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md new file mode 100644 index 0000000..0519681 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md @@ -0,0 +1,12 @@ +# PluginMetadata.ActionKeywords property + +```csharp +public List ActionKeywords { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md new file mode 100644 index 0000000..a62e8d2 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md @@ -0,0 +1,12 @@ +# PluginMetadata.Author property + +```csharp +public string Author { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md new file mode 100644 index 0000000..9f3cbbe --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md @@ -0,0 +1,12 @@ +# PluginMetadata.AvgQueryTime property + +```csharp +public long AvgQueryTime { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md new file mode 100644 index 0000000..edb2a52 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md @@ -0,0 +1,12 @@ +# PluginMetadata.Description property + +```csharp +public string Description { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md new file mode 100644 index 0000000..a1d136d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md @@ -0,0 +1,12 @@ +# PluginMetadata.Disabled property + +```csharp +public bool Disabled { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md new file mode 100644 index 0000000..912a0be --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md @@ -0,0 +1,12 @@ +# PluginMetadata.ExecuteFileName property + +```csharp +public string ExecuteFileName { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md new file mode 100644 index 0000000..9674c17 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md @@ -0,0 +1,12 @@ +# PluginMetadata.ExecuteFilePath property + +```csharp +public string ExecuteFilePath { get; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md new file mode 100644 index 0000000..b2a3555 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md @@ -0,0 +1,12 @@ +# PluginMetadata.ID property + +```csharp +public string ID { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md new file mode 100644 index 0000000..a83cf18 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md @@ -0,0 +1,12 @@ +# PluginMetadata.IcoPath property + +```csharp +public string IcoPath { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md new file mode 100644 index 0000000..ea1fe20 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md @@ -0,0 +1,14 @@ +# PluginMetadata.InitTime property + +Init time include both plugin load time and init time + +```csharp +public long InitTime { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md new file mode 100644 index 0000000..77556fc --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md @@ -0,0 +1,12 @@ +# PluginMetadata.Language property + +```csharp +public string Language { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md new file mode 100644 index 0000000..4ee00ee --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md @@ -0,0 +1,12 @@ +# PluginMetadata.Name property + +```csharp +public string Name { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md new file mode 100644 index 0000000..dac7625 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md @@ -0,0 +1,12 @@ +# PluginMetadata.PluginDirectory property + +```csharp +public string PluginDirectory { get; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md new file mode 100644 index 0000000..a3c7658 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md @@ -0,0 +1,14 @@ +# PluginMetadata constructor + +The default constructor. + +```csharp +public PluginMetadata() +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md new file mode 100644 index 0000000..fc6d370 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md @@ -0,0 +1,12 @@ +# PluginMetadata.Priority property + +```csharp +public int Priority { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md new file mode 100644 index 0000000..d7115bd --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md @@ -0,0 +1,12 @@ +# PluginMetadata.QueryCount property + +```csharp +public int QueryCount { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md new file mode 100644 index 0000000..72b2028 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md @@ -0,0 +1,12 @@ +# PluginMetadata.ToString method + +```csharp +public override string ToString() +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md new file mode 100644 index 0000000..1f0ba5f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md @@ -0,0 +1,12 @@ +# PluginMetadata.Version property + +```csharp +public string Version { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md new file mode 100644 index 0000000..5e9e1f3 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md @@ -0,0 +1,12 @@ +# PluginMetadata.Website property + +```csharp +public string Website { get; set; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md new file mode 100644 index 0000000..0550893 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md @@ -0,0 +1,12 @@ +# PluginPair.Equals method + +```csharp +public override bool Equals(object obj) +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md new file mode 100644 index 0000000..9043d85 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md @@ -0,0 +1,12 @@ +# PluginPair.GetHashCode method + +```csharp +public override int GetHashCode() +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md new file mode 100644 index 0000000..d589f5a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md @@ -0,0 +1,13 @@ +# PluginPair.Metadata property + +```csharp +public PluginMetadata Metadata { get; } +``` + +## See Also + +* class [PluginMetadata](../PluginMetadata.md) +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md new file mode 100644 index 0000000..78a3504 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md @@ -0,0 +1,13 @@ +# PluginPair.Plugin property + +```csharp +public IAsyncPlugin Plugin { get; } +``` + +## See Also + +* interface [IAsyncPlugin](../IAsyncPlugin.md) +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md new file mode 100644 index 0000000..27089e1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md @@ -0,0 +1,14 @@ +# PluginPair constructor + +The default constructor. + +```csharp +public PluginPair() +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md new file mode 100644 index 0000000..4dc90d6 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md @@ -0,0 +1,12 @@ +# PluginPair.ToString method + +```csharp +public override string ToString() +``` + +## See Also + +* class [PluginPair](../PluginPair.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md new file mode 100644 index 0000000..ee1ec44 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md @@ -0,0 +1,12 @@ +# Query.ActionKeyword property + +```csharp +public string ActionKeyword { get; set; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md new file mode 100644 index 0000000..74a0737 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md @@ -0,0 +1,14 @@ +# Query.ActionKeywordSeparator field + +User can set multiple action keywords seperated by ';' + +```csharp +public const string ActionKeywordSeparator; +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md new file mode 100644 index 0000000..faa311b --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md @@ -0,0 +1,14 @@ +# Query.FirstSearch property + +Return first search split by space if it has + +```csharp +public string FirstSearch { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md b/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md new file mode 100644 index 0000000..85afd7f --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md @@ -0,0 +1,14 @@ +# Query.GlobalPluginWildcardSign field + +'*' is used for System Plugin + +```csharp +public const string GlobalPluginWildcardSign; +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/Query.md b/API-Reference/Flow.Launcher.Plugin/Query/Query.md new file mode 100644 index 0000000..5610ee7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/Query.md @@ -0,0 +1,30 @@ +# Query constructor (1 of 2) + +The default constructor. + +```csharp +public Query() +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + +--- + +# Query constructor (2 of 2) + +to allow unit tests for plug ins + +```csharp +public Query(string rawQuery, string search, string[] terms, string[] searchTerms, + string actionKeyword = "") +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md b/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md new file mode 100644 index 0000000..448732c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md @@ -0,0 +1,14 @@ +# Query.RawQuery property + +Raw query, this includes action keyword if it has We didn't recommend use this property directly. You should always use Search property. + +```csharp +public string RawQuery { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/Search.md b/API-Reference/Flow.Launcher.Plugin/Query/Search.md new file mode 100644 index 0000000..6989ac0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/Search.md @@ -0,0 +1,14 @@ +# Query.Search property + +Search part of a query. This will not include action keyword if exclusive plugin gets it, otherwise it should be same as RawQuery. Since we allow user to switch a exclusive plugin to generic plugin, so this property will always give you the "real" query part of the query + +```csharp +public string Search { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md b/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md new file mode 100644 index 0000000..fe76627 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md @@ -0,0 +1,14 @@ +# Query.SearchTerms property + +The search string split into a string array. + +```csharp +public string[] SearchTerms { get; set; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md new file mode 100644 index 0000000..b44af74 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md @@ -0,0 +1,14 @@ +# Query.SecondSearch property + +Return second search split by space if it has + +```csharp +public string SecondSearch { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md new file mode 100644 index 0000000..c77e449 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md @@ -0,0 +1,14 @@ +# Query.SecondToEndSearch property + +strings from second search (including) to last search + +```csharp +public string SecondToEndSearch { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md b/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md new file mode 100644 index 0000000..b502fa4 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md @@ -0,0 +1,14 @@ +# Query.TermSeparator field + +Query can be splited into multiple terms by whitespace + +```csharp +public const string TermSeparator; +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md new file mode 100644 index 0000000..d3764d8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md @@ -0,0 +1,14 @@ +# Query.ThirdSearch property + +Return third search split by space if it has + +```csharp +public string ThirdSearch { get; } +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ToString.md b/API-Reference/Flow.Launcher.Plugin/Query/ToString.md new file mode 100644 index 0000000..2658416 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Query/ToString.md @@ -0,0 +1,12 @@ +# Query.ToString method + +```csharp +public override string ToString() +``` + +## See Also + +* class [Query](../Query.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md b/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md new file mode 100644 index 0000000..66fef90 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md @@ -0,0 +1,12 @@ +# Result.IconDelegate delegate + +```csharp +public delegate ImageSource IconDelegate(); +``` + +## See Also + +* class [Result](./Result.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Action.md b/API-Reference/Flow.Launcher.Plugin/Result/Action.md new file mode 100644 index 0000000..4013bac --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Action.md @@ -0,0 +1,15 @@ +# Result.Action property + +return true to hide flowlauncher after select result + +```csharp +public Func Action { get; set; } +``` + +## See Also + +* class [ActionContext](../ActionContext.md) +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md b/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md new file mode 100644 index 0000000..d813892 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md @@ -0,0 +1,14 @@ +# Result.ActionKeywordAssigned property + +This holds the action keyword that triggered the result. If result is triggered by global keyword: *, this should be empty. + +```csharp +public string ActionKeywordAssigned { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md b/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md new file mode 100644 index 0000000..658a1d6 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md @@ -0,0 +1,14 @@ +# Result.AutoCompleteText property + +This holds the text which can be provided by plugin to help Flow autocomplete text for user on the plugin result. If autocomplete action for example is tab, pressing tab will have the default constructed autocomplete text (result's Title), or the text provided here if not empty. + +```csharp +public string AutoCompleteText { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md b/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md new file mode 100644 index 0000000..226c6fc --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md @@ -0,0 +1,14 @@ +# Result.ContextData property + +Additional data associate with this result + +```csharp +public object ContextData { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Equals.md b/API-Reference/Flow.Launcher.Plugin/Result/Equals.md new file mode 100644 index 0000000..7ac31db --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Equals.md @@ -0,0 +1,12 @@ +# Result.Equals method + +```csharp +public override bool Equals(object obj) +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md b/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md new file mode 100644 index 0000000..2a327ab --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md @@ -0,0 +1,12 @@ +# Result.GetHashCode method + +```csharp +public override int GetHashCode() +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md b/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md new file mode 100644 index 0000000..bb94d2e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md @@ -0,0 +1,15 @@ +# Result.Glyph property + +Information for Glyph Icon + +```csharp +public GlyphInfo Glyph { get; set; } +``` + +## See Also + +* record [GlyphInfo](../GlyphInfo.md) +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md b/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md new file mode 100644 index 0000000..f162603 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md @@ -0,0 +1,12 @@ +# Result.IcoPath property + +```csharp +public string IcoPath { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Icon.md b/API-Reference/Flow.Launcher.Plugin/Result/Icon.md new file mode 100644 index 0000000..59a9052 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Icon.md @@ -0,0 +1,15 @@ +# Result.Icon field + +Delegate to Get Image Source + +```csharp +public IconDelegate Icon; +``` + +## See Also + +* delegate [IconDelegate](../Result.IconDelegate.md) +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md b/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md new file mode 100644 index 0000000..1635563 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md @@ -0,0 +1,14 @@ +# Result.PluginDirectory property + +Plugin directory + +```csharp +public string PluginDirectory { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md b/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md new file mode 100644 index 0000000..1ee56be --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md @@ -0,0 +1,14 @@ +# Result.PluginID property + +Plugin ID that generated this result + +```csharp +public string PluginID { get; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Result.md b/API-Reference/Flow.Launcher.Plugin/Result/Result.md new file mode 100644 index 0000000..d7550cd --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Result.md @@ -0,0 +1,14 @@ +# Result constructor + +The default constructor. + +```csharp +public Result() +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Score.md b/API-Reference/Flow.Launcher.Plugin/Result/Score.md new file mode 100644 index 0000000..545a9ae --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Score.md @@ -0,0 +1,12 @@ +# Result.Score property + +```csharp +public int Score { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md b/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md new file mode 100644 index 0000000..18e8d30 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md @@ -0,0 +1,14 @@ +# Result.SubTitle property + +Provides additional details for the result. This is optional + +```csharp +public string SubTitle { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/SubTitleHighlightData.md b/API-Reference/Flow.Launcher.Plugin/Result/SubTitleHighlightData.md new file mode 100644 index 0000000..c7e0ef8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/SubTitleHighlightData.md @@ -0,0 +1,14 @@ +# Result.SubTitleHighlightData property + +A list of indexes for the characters to be highlighted in SubTitle + +```csharp +public IList SubTitleHighlightData { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md b/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md new file mode 100644 index 0000000..78f9734 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md @@ -0,0 +1,14 @@ +# Result.SubTitleToolTip property + +Show message as ToolTip on result SubTitle hover over + +```csharp +public string SubTitleToolTip { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Title.md b/API-Reference/Flow.Launcher.Plugin/Result/Title.md new file mode 100644 index 0000000..bb929d0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/Title.md @@ -0,0 +1,14 @@ +# Result.Title property + +Provides the title of the result. This is always required. + +```csharp +public string Title { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md b/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md new file mode 100644 index 0000000..c8a2774 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md @@ -0,0 +1,14 @@ +# Result.TitleHighlightData property + +A list of indexes for the characters to be highlighted in Title + +```csharp +public IList TitleHighlightData { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md b/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md new file mode 100644 index 0000000..0d9f592 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md @@ -0,0 +1,14 @@ +# Result.TitleToolTip property + +Show message as ToolTip on result Title hover over + +```csharp +public string TitleToolTip { get; set; } +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ToString.md b/API-Reference/Flow.Launcher.Plugin/Result/ToString.md new file mode 100644 index 0000000..9c6da8a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/ToString.md @@ -0,0 +1,12 @@ +# Result.ToString method + +```csharp +public override string ToString() +``` + +## See Also + +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md b/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md new file mode 100644 index 0000000..5a6d384 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md @@ -0,0 +1,13 @@ +# ResultItemDropEventHandler delegate + +```csharp +public delegate void ResultItemDropEventHandler(Result result, IDataObject dropObject, + DragEventArgs e); +``` + +## See Also + +* class [Result](./Result.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md new file mode 100644 index 0000000..4c6b8d8 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md @@ -0,0 +1,13 @@ +# ResultUpdatedEventArgs.Query field + +```csharp +public Query Query; +``` + +## See Also + +* class [Query](../Query.md) +* class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md new file mode 100644 index 0000000..fa46b68 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md @@ -0,0 +1,14 @@ +# ResultUpdatedEventArgs constructor + +The default constructor. + +```csharp +public ResultUpdatedEventArgs() +``` + +## See Also + +* class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md new file mode 100644 index 0000000..9b45ae0 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md @@ -0,0 +1,13 @@ +# ResultUpdatedEventArgs.Results field + +```csharp +public List Results; +``` + +## See Also + +* class [Result](../Result.md) +* class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md new file mode 100644 index 0000000..50778e1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md @@ -0,0 +1,12 @@ +# ResultUpdatedEventArgs.Token property + +```csharp +public CancellationToken Token { get; set; } +``` + +## See Also + +* class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md new file mode 100644 index 0000000..53e02e1 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md @@ -0,0 +1,13 @@ +# ResultUpdatedEventHandler delegate + +```csharp +public delegate void ResultUpdatedEventHandler(IResultUpdated sender, ResultUpdatedEventArgs e); +``` + +## See Also + +* interface [IResultUpdated](./IResultUpdated.md) +* class [ResultUpdatedEventArgs](./ResultUpdatedEventArgs.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md new file mode 100644 index 0000000..9fe5c3d --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md @@ -0,0 +1,12 @@ +# SpecialKeyState.AltPressed property + +```csharp +public bool AltPressed { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md new file mode 100644 index 0000000..3daa1c7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md @@ -0,0 +1,12 @@ +# SpecialKeyState.CtrlPressed property + +```csharp +public bool CtrlPressed { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md new file mode 100644 index 0000000..7ec1b3e --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md @@ -0,0 +1,12 @@ +# SpecialKeyState.ShiftPressed property + +```csharp +public bool ShiftPressed { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md new file mode 100644 index 0000000..e0105c7 --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md @@ -0,0 +1,14 @@ +# SpecialKeyState constructor + +The default constructor. + +```csharp +public SpecialKeyState() +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md new file mode 100644 index 0000000..255018c --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md @@ -0,0 +1,12 @@ +# SpecialKeyState.WinPressed property + +```csharp +public bool WinPressed { get; set; } +``` + +## See Also + +* class [SpecialKeyState](../SpecialKeyState.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/_sidebar.md b/API-Reference/Flow.Launcher.Plugin/_sidebar.md deleted file mode 100644 index acb61c1..0000000 --- a/API-Reference/Flow.Launcher.Plugin/_sidebar.md +++ /dev/null @@ -1,26 +0,0 @@ -- [**Flow.Launcher.Plugin**](../Flow.Launcher.Plugin.md) - - **Class** - - [ActionContext](actioncontext.md) - - [AllowedLanguage](allowedlanguage.md) - - [BaseModel](basemodel.md) - - [FlowLauncherKeyDownEventArgs](flowlauncherkeydowneventargs.md) - - [FlowLauncherQueryEventArgs](flowlauncherqueryeventargs.md) - - [PluginInitContext](plugininitcontext.md) - - [PluginMetadata](pluginmetadata.md) - - [PluginPair](pluginpair.md) - - [Query](query.md) - - [Result](result.md) - - [ResultUpdatedEventArgs](resultupdatedeventargs.md) - - [SpecialKeyState](specialkeystate.md) - - **Interface** - - [IAsyncPlugin](iasyncplugin.md) - - [IAsyncReloadable](iasyncreloadable.md) - - [IContextMenu](icontextmenu.md) - - [IFeatures](ifeatures.md) - - [IPlugin](iplugin.md) - - [IPluginI18n](iplugini18n.md) - - [IPublicAPI](ipublicapi.md) - - [IReloadable](ireloadable.md) - - [IResultUpdated](iresultupdated.md) - - [ISavable](isavable.md) - - [ISettingProvider](isettingprovider.md) \ No newline at end of file diff --git a/API-Reference/Flow.Launcher.Plugin/actioncontext.md b/API-Reference/Flow.Launcher.Plugin/actioncontext.md index 6b88b5e..729ad2b 100644 --- a/API-Reference/Flow.Launcher.Plugin/actioncontext.md +++ b/API-Reference/Flow.Launcher.Plugin/actioncontext.md @@ -1,35 +1,18 @@ -# ActionContext - -Namespace: Flow.Launcher.Plugin - - +# ActionContext class ```csharp public class ActionContext ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [ActionContext](actioncontext.md) - -## Properties +## Public Members -### **SpecialKeyState** +| name | description | +| --- | --- | +| [ActionContext](ActionContext/ActionContext.md)() | The default constructor. | +| [SpecialKeyState](ActionContext/SpecialKeyState.md) { get; set; } | | +## See Also +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -```csharp -public SpecialKeyState SpecialKeyState { get; set; } -``` - -#### Property Value - -[SpecialKeyState](specialkeystate.md)
- -## Constructors - -### **ActionContext()** - - - -```csharp -public ActionContext() -``` + diff --git a/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md b/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md index 3251d46..6436add 100644 --- a/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md +++ b/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md @@ -1,95 +1,22 @@ -# AllowedLanguage - -Namespace: Flow.Launcher.Plugin - - +# AllowedLanguage class ```csharp public static class AllowedLanguage ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [AllowedLanguage](allowedlanguage.md) - -## Properties - -### **Python** - - - -```csharp -public static string Python { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **CSharp** - - - -```csharp -public static string CSharp { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **FSharp** - - - -```csharp -public static string FSharp { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Executable** - - - -```csharp -public static string Executable { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Methods - -### **IsDotNet(String)** - - - -```csharp -public static bool IsDotNet(string language) -``` - -#### Parameters - -`language` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **IsAllowed(String)** - - - -```csharp -public static bool IsAllowed(string language) -``` +## Public Members -#### Parameters +| name | description | +| --- | --- | +| static [CSharp](AllowedLanguage/CSharp.md) { get; } | | +| static [Executable](AllowedLanguage/Executable.md) { get; } | | +| static [FSharp](AllowedLanguage/FSharp.md) { get; } | | +| static [Python](AllowedLanguage/Python.md) { get; } | | +| static [IsAllowed](AllowedLanguage/IsAllowed.md)(…) | | +| static [IsDotNet](AllowedLanguage/IsDotNet.md)(…) | | -`language` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+## See Also -#### Returns +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+ diff --git a/API-Reference/Flow.Launcher.Plugin/basemodel.md b/API-Reference/Flow.Launcher.Plugin/basemodel.md index 29b4c68..a6fb79f 100644 --- a/API-Reference/Flow.Launcher.Plugin/basemodel.md +++ b/API-Reference/Flow.Launcher.Plugin/basemodel.md @@ -1,46 +1,24 @@ -# BaseModel - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class BaseModel : System.ComponentModel.INotifyPropertyChanged -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [BaseModel](basemodel.md)
-Implements INotifyPropertyChanged - -## Constructors - -### **BaseModel()** - - - -```csharp -public BaseModel() -``` - -## Methods - -### **OnPropertyChanged(String)** - - +# BaseModel class ```csharp -protected void OnPropertyChanged(string propertyName) +public class BaseModel : INotifyPropertyChanged ``` -#### Parameters +## Public Members -`propertyName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+| name | description | +| --- | --- | +| [BaseModel](BaseModel/BaseModel.md)() | The default constructor. | +| event [PropertyChanged](BaseModel/PropertyChanged.md) | | -## Events +## Protected Members -### **PropertyChanged** +| name | description | +| --- | --- | +| [OnPropertyChanged](BaseModel/OnPropertyChanged.md)(…) | | +## See Also +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -```csharp -public event PropertyChangedEventHandler PropertyChanged; -``` + diff --git a/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md b/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md index 9213142..f7f5c3e 100644 --- a/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md +++ b/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md @@ -1,47 +1,19 @@ -# FlowLauncherQueryEventArgs - -Namespace: Flow.Launcher.Plugin - - +# FlowLauncherKeyDownEventArgs class ```csharp public class FlowLauncherKeyDownEventArgs ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FlowLauncherQueryEventArgs](flowlauncherqueryeventargs.md) - -## Properties - -### **Query** - - - -```csharp -public Query Query { get; set; } -``` - -#### Property Value - -[Query](query.md)
- -```csharp -public Query Query { get; set; } -``` - -[KeyEventArgs](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.keyeventargs)
- - -```csharp -public KeyEventArgs keyEventArgs { get; set; } -``` - +## Public Members -## Constructors +| name | description | +| --- | --- | +| [FlowLauncherKeyDownEventArgs](FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md)() | The default constructor. | +| [keyEventArgs](FlowLauncherKeyDownEventArgs/keyEventArgs.md) { get; set; } | | +| [Query](FlowLauncherKeyDownEventArgs/Query.md) { get; set; } | | -### **FlowLauncherQueryEventArgs()** +## See Also +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - -```csharp -public FlowLauncherQueryEventArgs() -``` + diff --git a/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md b/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md index 60ed339..8b45a50 100644 --- a/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md +++ b/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md @@ -1,35 +1,18 @@ -# FlowLauncherQueryEventArgs - -Namespace: Flow.Launcher.Plugin - - +# FlowLauncherQueryEventArgs class ```csharp public class FlowLauncherQueryEventArgs ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [FlowLauncherQueryEventArgs](flowlauncherqueryeventargs.md) - -## Properties +## Public Members -### **Query** +| name | description | +| --- | --- | +| [FlowLauncherQueryEventArgs](FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md)() | The default constructor. | +| [Query](FlowLauncherQueryEventArgs/Query.md) { get; set; } | | +## See Also +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -```csharp -public Query Query { get; set; } -``` - -#### Property Value - -[Query](query.md)
- -## Constructors - -### **FlowLauncherQueryEventArgs()** - - - -```csharp -public FlowLauncherQueryEventArgs() -``` + diff --git a/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md b/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md index e5b1de5..31a612f 100644 --- a/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md +++ b/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md @@ -1,6 +1,4 @@ -# IAsyncPlugin - -Namespace: Flow.Launcher.Plugin +# IAsyncPlugin interface Asynchronous Plugin Model for Flow Launcher @@ -8,40 +6,15 @@ Asynchronous Plugin Model for Flow Launcher public interface IAsyncPlugin ``` -## Methods - -### **QueryAsync(Query, CancellationToken)** - -Asynchronous Querying - -```csharp -Task> QueryAsync(Query query, CancellationToken token) -``` - -#### Parameters - -`query` [Query](query.md)
-Query to search - -`token` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
-Cancel when querying job is obsolete - -#### Returns - -[Task<List<Result>>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
- -### **InitAsync(PluginInitContext)** - -Initialize plugin asynchrously (will still wait finish to continue) - -```csharp -Task InitAsync(PluginInitContext context) -``` +## Members -#### Parameters +| name | description | +| --- | --- | +| [InitAsync](IAsyncPlugin/InitAsync.md)(…) | Initialize plugin asynchrously (will still wait finish to continue) | +| [QueryAsync](IAsyncPlugin/QueryAsync.md)(…) | Asynchronous Querying | -`context` [PluginInitContext](plugininitcontext.md)
+## See Also -#### Returns +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ diff --git a/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md b/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md index 286a312..65c6320 100644 --- a/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md +++ b/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md @@ -1,31 +1,20 @@ -# IAsyncReloadable +# IAsyncReloadable interface -Namespace: Flow.Launcher.Plugin - -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. +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. ```csharp -public interface IAsyncReloadable +public interface IAsyncReloadable : IFeatures ``` -## Methods - -### **ReloadDataAsync()** - +## Members +| name | description | +| --- | --- | +| [ReloadDataAsync](IAsyncReloadable/ReloadDataAsync.md)() | | -```csharp -Task ReloadDataAsync() -``` +## See Also -#### Returns +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
+ diff --git a/API-Reference/Flow.Launcher.Plugin/icontextmenu.md b/API-Reference/Flow.Launcher.Plugin/icontextmenu.md index 7aab015..d62de37 100644 --- a/API-Reference/Flow.Launcher.Plugin/icontextmenu.md +++ b/API-Reference/Flow.Launcher.Plugin/icontextmenu.md @@ -1,29 +1,18 @@ -# IContextMenu - -Namespace: Flow.Launcher.Plugin - - +# IContextMenu interface ```csharp public interface IContextMenu : IFeatures ``` -Implements [IFeatures](ifeatures.md) - -## Methods - -### **LoadContextMenus(Result)** - - - -```csharp -List LoadContextMenus(Result selectedResult) -``` +## Members -#### Parameters +| name | description | +| --- | --- | +| [LoadContextMenus](IContextMenu/LoadContextMenus.md)(…) | | -`selectedResult` [Result](result.md)
+## See Also -#### Returns +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -[List<Result>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
+ diff --git a/API-Reference/Flow.Launcher.Plugin/ifeatures.md b/API-Reference/Flow.Launcher.Plugin/ifeatures.md index 570a11d..448c836 100644 --- a/API-Reference/Flow.Launcher.Plugin/ifeatures.md +++ b/API-Reference/Flow.Launcher.Plugin/ifeatures.md @@ -1,9 +1,13 @@ -# IFeatures - -Namespace: Flow.Launcher.Plugin - +# IFeatures interface +Base Interface for Flow's special plugin feature interface ```csharp public interface IFeatures ``` + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/iplugin.md b/API-Reference/Flow.Launcher.Plugin/iplugin.md index 90eec42..7779fa1 100644 --- a/API-Reference/Flow.Launcher.Plugin/iplugin.md +++ b/API-Reference/Flow.Launcher.Plugin/iplugin.md @@ -1,48 +1,23 @@ -# IPlugin - -Namespace: Flow.Launcher.Plugin +# IPlugin interface Synchronous Plugin Model for Flow Launcher - - If the Querying or Init method requires high IO transmission - or performaing CPU intense jobs (performing better with cancellation), please try the IAsyncPlugin interface - -```csharp -public interface IPlugin : IAsyncPlugin -``` - -Implements [IAsyncPlugin](iasyncplugin.md) - -## Methods - -### **Query(Query)** -Querying when user's search changes - - This method will be called within a Task.Run, - so please avoid synchrously wait for long. +If the Querying or Init method requires high IO transmission or performaing CPU intense jobs (performing better with cancellation), please try the IAsyncPlugin interface ```csharp -List Query(Query query) +public interface IPlugin : IAsyncPlugin ``` -#### Parameters - -`query` [Query](query.md)
-Query to search - -#### Returns - -[List<Result>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
+## Members -### **Init(PluginInitContext)** +| name | description | +| --- | --- | +| [Init](IPlugin/Init.md)(…) | Initialize plugin | +| [Query](IPlugin/Query.md)(…) | Querying when user's search changes | -Initialize plugin - -```csharp -void Init(PluginInitContext context) -``` +## See Also -#### Parameters +* interface [IAsyncPlugin](./IAsyncPlugin.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -`context` [PluginInitContext](plugininitcontext.md)
+ diff --git a/API-Reference/Flow.Launcher.Plugin/iplugini18n.md b/API-Reference/Flow.Launcher.Plugin/iplugini18n.md index a914191..fac1b1c 100644 --- a/API-Reference/Flow.Launcher.Plugin/iplugini18n.md +++ b/API-Reference/Flow.Launcher.Plugin/iplugini18n.md @@ -1,6 +1,4 @@ -# IPluginI18n - -Namespace: Flow.Launcher.Plugin +# IPluginI18n interface Represent plugins that support internationalization @@ -8,30 +6,17 @@ Represent plugins that support internationalization public interface IPluginI18n : IFeatures ``` -Implements [IFeatures](ifeatures.md) - -## Methods - -### **GetTranslatedPluginTitle()** - - - -```csharp -string GetTranslatedPluginTitle() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **GetTranslatedPluginDescription()** +## Members +| name | description | +| --- | --- | +| [GetTranslatedPluginDescription](IPluginI18n/GetTranslatedPluginDescription.md)() | | +| [GetTranslatedPluginTitle](IPluginI18n/GetTranslatedPluginTitle.md)() | | +| [OnCultureInfoChanged](IPluginI18n/OnCultureInfoChanged.md)(…) | The method will be invoked when language of flow changed | +## See Also -```csharp -string GetTranslatedPluginDescription() -``` - -#### Returns +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ diff --git a/API-Reference/Flow.Launcher.Plugin/ipublicapi.md b/API-Reference/Flow.Launcher.Plugin/ipublicapi.md index 3e1898a..67ecf9b 100644 --- a/API-Reference/Flow.Launcher.Plugin/ipublicapi.md +++ b/API-Reference/Flow.Launcher.Plugin/ipublicapi.md @@ -1,6 +1,4 @@ -# IPublicAPI - -Namespace: Flow.Launcher.Plugin +# IPublicAPI interface Public APIs that plugin can use @@ -8,392 +6,43 @@ Public APIs that plugin can use public interface IPublicAPI ``` -## Methods - -### **ChangeQuery(String, Boolean)** - -Change Flow.Launcher query - -```csharp -void ChangeQuery(string query, bool requery) -``` - -#### Parameters - -`query` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-query text - -`requery` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- - force requery By default, Flow Launcher will not fire query if your query is same with existing one. - Set this to true to force Flow Launcher requerying - -### **RestartApp()** - -Restart Flow Launcher - -```csharp -void RestartApp() -``` - -### **SaveAppAllSettings()** - -Save everything, all of Flow Launcher and plugins' data and settings - -```csharp -void SaveAppAllSettings() -``` - -### **SavePluginSettings()** - -Save all Flow's plugins settings - -```csharp -void SavePluginSettings() -``` - -### **ReloadAllPluginData()** - -Reloads any Plugins that have the - IReloadable implemented. It refeshes - Plugin's in memory data with new content - added by user. - -```csharp -Task ReloadAllPluginData() -``` - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
- -### **CheckForNewUpdate()** - -Check for new Flow Launcher update - -```csharp -void CheckForNewUpdate() -``` - -### **ShowMsgError(String, String)** - -Show the error message using Flow's standard error icon. - -```csharp -void ShowMsgError(string title, string subTitle) -``` - -#### Parameters - -`title` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message title - -`subTitle` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Optional message subtitle - -### **ShowMsg(String, String, String)** - -Show message box - -```csharp -void ShowMsg(string title, string subTitle, string iconPath) -``` - -#### Parameters - -`title` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message title - -`subTitle` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message subtitle - -`iconPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message icon path (relative path to your plugin folder) - -### **ShowMsg(String, String, String, Boolean)** - -Show message box - -```csharp -void ShowMsg(string title, string subTitle, string iconPath, bool useMainWindowAsOwner) -``` - -#### Parameters - -`title` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message title - -`subTitle` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message subtitle - -`iconPath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Message icon path (relative path to your plugin folder) - -`useMainWindowAsOwner` [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
-when true will use main windows as the owner - -### **OpenSettingDialog()** - -Open setting dialog - -```csharp -void OpenSettingDialog() -``` - -### **GetTranslation(String)** - -Get translation of current language - You need to implement IPluginI18n if you want to support multiple languages for your plugin - -```csharp -string GetTranslation(string key) -``` - -#### Parameters - -`key` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **GetAllPlugins()** - -Get all loaded plugins - -```csharp -List GetAllPlugins() -``` - -#### Returns - -[List<PluginPair>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -### **FuzzySearch(String, String)** - -Fuzzy Search the string with the given query. This is the core search mechanism Flow uses - -```csharp -MatchResult FuzzySearch(string query, string stringToCompare) -``` - -#### Parameters - -`query` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-Query string - -`stringToCompare` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The string that will be compared against the query - -#### Returns - -[MatchResult](sharedmodels.matchresult.md)
-Match results - -### **HttpGetStringAsync(String, CancellationToken)** - -Http download the spefic url and return as string - -```csharp -Task HttpGetStringAsync(string url, CancellationToken token) -``` - -#### Parameters - -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-URL to call Http Get - -`token` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
-Cancellation Token - -#### Returns - -[Task<String>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
-Task to get string result - -### **HttpGetStreamAsync(String, CancellationToken)** - -Http download the spefic url and return as stream - -```csharp -Task HttpGetStreamAsync(string url, CancellationToken token) -``` - -#### Parameters - -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-URL to call Http Get - -`token` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
-Cancellation Token - -#### Returns - -[Task<Stream>](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task-1)
-Task to get stream result - -### **HttpDownloadAsync(String, String, CancellationToken)** - -Download the specific url to a cretain file path - -```csharp -Task HttpDownloadAsync(string url, string filePath, CancellationToken token) -``` - -#### Parameters - -`url` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-URL to download file - -`filePath` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`token` [CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/system.threading.cancellationtoken)
-place to store file - -#### Returns - -[Task](https://docs.microsoft.com/en-us/dotnet/api/system.threading.tasks.task)
-Task showing the progress - -### **AddActionKeyword(String, String)** - -Add ActionKeyword for specific plugin - -```csharp -void AddActionKeyword(string pluginId, string newActionKeyword) -``` - -#### Parameters - -`pluginId` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-ID for plugin that needs to add action keyword - -`newActionKeyword` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-The actionkeyword that is supposed to be added - -### **RemoveActionKeyword(String, String)** - -Remove ActionKeyword for specific plugin - -```csharp -void RemoveActionKeyword(string pluginId, string oldActionKeyword) -``` - -#### Parameters - -`pluginId` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
-ID for plugin that needs to remove action keyword - -`oldActionKeyword` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LogDebug(String, String, String)** - -Log debug message - Message will only be logged in Debug mode - -```csharp -void LogDebug(string className, string message, string methodName) -``` - -#### Parameters - -`className` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`methodName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LogInfo(String, String, String)** - -Log info message - -```csharp -void LogInfo(string className, string message, string methodName) -``` - -#### Parameters - -`className` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`methodName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LogWarn(String, String, String)** - -Log warning message - -```csharp -void LogWarn(string className, string message, string methodName) -``` - -#### Parameters - -`className` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`methodName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LogException(String, String, Exception, String)** - -Log an Exception. Will throw if in debug mode so developer will be aware, - otherwise logs the eror message. This is the primary logging method used for Flow - -```csharp -void LogException(string className, string message, Exception e, string methodName) -``` - -#### Parameters - -`className` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`message` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`e` [Exception](https://docs.microsoft.com/en-us/dotnet/api/system.exception)
- -`methodName` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **LoadSettingJsonStorage<T>()** - -Load JsonStorage for current plugin's setting. This is the method used to load settings from json in Flow. - When the file is not exist, it will create a new instance for the specific type. - -```csharp -T LoadSettingJsonStorage() -``` - -#### Type Parameters - -`T`
-Type for deserialization - -#### Returns - -T
- -### **SaveSettingJsonStorage<T>()** - -Save JsonStorage for current plugin's setting. This is the method used to save settings to json in Flow.Launcher - This method will save the original instance loaded with LoadJsonStorage. - This API call is for manually Save. Flow will automatically save all setting type that has called LoadSettingJsonStorage or SaveSettingJsonStorage previously. - -```csharp -void SaveSettingJsonStorage() -``` - -#### Type Parameters - -`T`
-Type for Serialization - -## Events - -### **GlobalKeyboardEvent** - -Fired after global keyboard events - if you want to hook something like Ctrl+R, you should use this event - -```csharp -public abstract event FlowLauncherGlobalKeyboardEventHandler GlobalKeyboardEvent; -``` +## Members + +| name | description | +| --- | --- | +| [AddActionKeyword](IPublicAPI/AddActionKeyword.md)(…) | Add ActionKeyword for specific plugin | +| [ChangeQuery](IPublicAPI/ChangeQuery.md)(…) | Change Flow.Launcher query | +| [CheckForNewUpdate](IPublicAPI/CheckForNewUpdate.md)() | Check for new Flow Launcher update | +| [CopyToClipboard](IPublicAPI/CopyToClipboard.md)(…) | Copy Text to clipboard | +| [FuzzySearch](IPublicAPI/FuzzySearch.md)(…) | Fuzzy Search the string with the given query. This is the core search mechanism Flow uses | +| [GetAllPlugins](IPublicAPI/GetAllPlugins.md)() | Get all loaded plugins | +| [GetTranslation](IPublicAPI/GetTranslation.md)(…) | Get translation of current language You need to implement IPluginI18n if you want to support multiple languages for your plugin | +| [HttpDownloadAsync](IPublicAPI/HttpDownloadAsync.md)(…) | Download the specific url to a cretain file path | +| [HttpGetStreamAsync](IPublicAPI/HttpGetStreamAsync.md)(…) | Http download the spefic url and return as stream | +| [HttpGetStringAsync](IPublicAPI/HttpGetStringAsync.md)(…) | Http download the spefic url and return as string | +| [LoadSettingJsonStorage<T>](IPublicAPI/LoadSettingJsonStorage.md)() | Load JsonStorage for current plugin's setting. This is the method used to load settings from json in Flow. When the file is not exist, it will create a new instance for the specific type. | +| [LogDebug](IPublicAPI/LogDebug.md)(…) | Log debug message Message will only be logged in Debug mode | +| [LogException](IPublicAPI/LogException.md)(…) | Log an Exception. Will throw if in debug mode so developer will be aware, otherwise logs the eror message. This is the primary logging method used for Flow | +| [LogInfo](IPublicAPI/LogInfo.md)(…) | Log info message | +| [LogWarn](IPublicAPI/LogWarn.md)(…) | Log warning message | +| [OpenDirectory](IPublicAPI/OpenDirectory.md)(…) | Open directory in an explorer configured by user via Flow's Settings. The default is Windows Explorer | +| [OpenSettingDialog](IPublicAPI/OpenSettingDialog.md)() | Open setting dialog | +| [OpenUrl](IPublicAPI/OpenUrl.md)(…) | Opens the url. The browser and mode used is based on what's configured in Flow's default browser settings. | +| [RegisterGlobalKeyboardCallback](IPublicAPI/RegisterGlobalKeyboardCallback.md)(…) | Register a callback for Global Keyboard Event | +| [ReloadAllPluginData](IPublicAPI/ReloadAllPluginData.md)() | Reloads any Plugins that have the IReloadable implemented. It refeshes Plugin's in memory data with new content added by user. | +| [RemoveActionKeyword](IPublicAPI/RemoveActionKeyword.md)(…) | Remove ActionKeyword for specific plugin | +| [RemoveGlobalKeyboardCallback](IPublicAPI/RemoveGlobalKeyboardCallback.md)(…) | Remove a callback for Global Keyboard Event | +| [RestartApp](IPublicAPI/RestartApp.md)() | Restart Flow Launcher | +| [SaveAppAllSettings](IPublicAPI/SaveAppAllSettings.md)() | Save everything, all of Flow Launcher and plugins' data and settings | +| [SavePluginSettings](IPublicAPI/SavePluginSettings.md)() | Save all Flow's plugins settings | +| [SaveSettingJsonStorage<T>](IPublicAPI/SaveSettingJsonStorage.md)() | Save JsonStorage for current plugin's setting. This is the method used to save settings to json in Flow.Launcher This method will save the original instance loaded with LoadJsonStorage. This API call is for manually Save. Flow will automatically save all setting type that has called LoadSettingJsonStorage or SaveSettingJsonStorage previously. | +| [ShellRun](IPublicAPI/ShellRun.md)(…) | Run a shell command | +| [ShowMainWindow](IPublicAPI/ShowMainWindow.md)() | Show the MainWindow when hiding | +| [ShowMsg](IPublicAPI/ShowMsg.md)(…) | Show message box (2 methods) | +| [ShowMsgError](IPublicAPI/ShowMsgError.md)(…) | Show the error message using Flow's standard error icon. | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/ireloadable.md b/API-Reference/Flow.Launcher.Plugin/ireloadable.md index 2778090..3a37da3 100644 --- a/API-Reference/Flow.Launcher.Plugin/ireloadable.md +++ b/API-Reference/Flow.Launcher.Plugin/ireloadable.md @@ -1,30 +1,22 @@ -# IReloadable - -Namespace: Flow.Launcher.Plugin - -This interface is to indicate and allow plugins to synchronously 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. - - - If requiring reloading data asynchronously, please use the IAsyncReloadable interface +# IReloadable interface + +This interface is to indicate and allow plugins to synchronously 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. + +If requiring reloading data asynchronously, please use the IAsyncReloadable interface ```csharp -public interface IReloadable +public interface IReloadable : IFeatures ``` -## Methods +## Members -### **ReloadData()** +| name | description | +| --- | --- | +| [ReloadData](IReloadable/ReloadData.md)() | | +## See Also +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -```csharp -void ReloadData() -``` + diff --git a/API-Reference/Flow.Launcher.Plugin/iresultupdated.md b/API-Reference/Flow.Launcher.Plugin/iresultupdated.md index 5cf1110..a0a4e4b 100644 --- a/API-Reference/Flow.Launcher.Plugin/iresultupdated.md +++ b/API-Reference/Flow.Launcher.Plugin/iresultupdated.md @@ -1,21 +1,18 @@ -# IResultUpdated - -Namespace: Flow.Launcher.Plugin - - +# IResultUpdated interface ```csharp public interface IResultUpdated : IFeatures ``` -Implements [IFeatures](ifeatures.md) +## Members -## Events +| name | description | +| --- | --- | +| event [ResultsUpdated](IResultUpdated/ResultsUpdated.md) | | -### **ResultsUpdated** +## See Also +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - -```csharp -public abstract event ResultUpdatedEventHandler ResultsUpdated; -``` + diff --git a/API-Reference/Flow.Launcher.Plugin/isavable.md b/API-Reference/Flow.Launcher.Plugin/isavable.md index 67d3cd7..6815b2c 100644 --- a/API-Reference/Flow.Launcher.Plugin/isavable.md +++ b/API-Reference/Flow.Launcher.Plugin/isavable.md @@ -1,21 +1,20 @@ -# ISavable +# ISavable interface -Namespace: Flow.Launcher.Plugin - -Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, - Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded, - plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow +Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved, Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded, plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow ```csharp -public interface ISavable +public interface ISavable : IFeatures ``` -## Methods +## Members -### **Save()** +| name | description | +| --- | --- | +| [Save](ISavable/Save.md)() | | +## See Also +* interface [IFeatures](./IFeatures.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -```csharp -void Save() -``` + diff --git a/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md b/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md index cf9d282..e7f4d31 100644 --- a/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md +++ b/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md @@ -1,61 +1,20 @@ -# PluginInitContext - -Namespace: Flow.Launcher.Plugin - - +# PluginInitContext class ```csharp public class PluginInitContext ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PluginInitContext](plugininitcontext.md) - -## Properties - -### **CurrentPluginMetadata** - - - -```csharp -public PluginMetadata CurrentPluginMetadata { get; internal set; } -``` - -#### Property Value - -[PluginMetadata](pluginmetadata.md)
+## Public Members -### **API** - -Public APIs for plugin invocation - -```csharp -public IPublicAPI API { get; set; } -``` - -#### Property Value - -[IPublicAPI](ipublicapi.md)
- -## Constructors - -### **PluginInitContext()** - - - -```csharp -public PluginInitContext() -``` - -### **PluginInitContext(PluginMetadata, IPublicAPI)** - - - -```csharp -public PluginInitContext(PluginMetadata currentPluginMetadata, IPublicAPI api) -``` +| name | description | +| --- | --- | +| [PluginInitContext](PluginInitContext/PluginInitContext.md)() | The default constructor. | +| [PluginInitContext](PluginInitContext/PluginInitContext.md)(…) | | +| [API](PluginInitContext/API.md) { get; set; } | Public APIs for plugin invocation | +| [CurrentPluginMetadata](PluginInitContext/CurrentPluginMetadata.md) { get; } | | -#### Parameters +## See Also -`currentPluginMetadata` [PluginMetadata](pluginmetadata.md)
+* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -`api` [IPublicAPI](ipublicapi.md)
+ diff --git a/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md b/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md index bc7a06b..4966136 100644 --- a/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md +++ b/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md @@ -1,264 +1,37 @@ -# PluginMetadata - -Namespace: Flow.Launcher.Plugin - - - -```csharp -public class PluginMetadata : BaseModel, System.ComponentModel.INotifyPropertyChanged -``` - -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [BaseModel](basemodel.md) → [PluginMetadata](pluginmetadata.md)
-Implements INotifyPropertyChanged - -## Properties - -### **ID** - - - -```csharp -public string ID { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Name** - - - -```csharp -public string Name { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Author** - - - -```csharp -public string Author { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Version** - - - -```csharp -public string Version { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Language** - - - -```csharp -public string Language { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Description** - - - -```csharp -public string Description { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Website** - - - -```csharp -public string Website { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Disabled** - - - -```csharp -public bool Disabled { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **ExecuteFilePath** - - - -```csharp -public string ExecuteFilePath { get; private set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ExecuteFileName** - - - -```csharp -public string ExecuteFileName { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **PluginDirectory** - - - -```csharp -public string PluginDirectory { get; internal set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ActionKeyword** - - - -```csharp -public string ActionKeyword { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ActionKeywords** - - - -```csharp -public List ActionKeywords { get; set; } -``` - -#### Property Value - -[List<String>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.list-1)
- -### **IcoPath** - - - -```csharp -public string IcoPath { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Priority** - - - -```csharp -public int Priority { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **InitTime** - -Init time include both plugin load time and init time - -```csharp -public long InitTime { get; set; } -``` - -#### Property Value - -[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
- -### **AvgQueryTime** - - - -```csharp -public long AvgQueryTime { get; set; } -``` - -#### Property Value - -[Int64](https://docs.microsoft.com/en-us/dotnet/api/system.int64)
- -### **QueryCount** - - - -```csharp -public int QueryCount { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -## Constructors - -### **PluginMetadata()** - - - -```csharp -public PluginMetadata() -``` - -## Methods - -### **ToString()** - - - -```csharp -public string ToString() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Events - -### **PropertyChanged** - - - -```csharp -public event PropertyChangedEventHandler PropertyChanged; -``` +# PluginMetadata class + +```csharp +public class PluginMetadata : BaseModel +``` + +## Public Members + +| name | description | +| --- | --- | +| [PluginMetadata](PluginMetadata/PluginMetadata.md)() | The default constructor. | +| [ActionKeyword](PluginMetadata/ActionKeyword.md) { get; set; } | | +| [ActionKeywords](PluginMetadata/ActionKeywords.md) { get; set; } | | +| [Author](PluginMetadata/Author.md) { get; set; } | | +| [AvgQueryTime](PluginMetadata/AvgQueryTime.md) { get; set; } | | +| [Description](PluginMetadata/Description.md) { get; set; } | | +| [Disabled](PluginMetadata/Disabled.md) { get; set; } | | +| [ExecuteFileName](PluginMetadata/ExecuteFileName.md) { get; set; } | | +| [ExecuteFilePath](PluginMetadata/ExecuteFilePath.md) { get; } | | +| [IcoPath](PluginMetadata/IcoPath.md) { get; set; } | | +| [ID](PluginMetadata/ID.md) { get; set; } | | +| [InitTime](PluginMetadata/InitTime.md) { get; set; } | Init time include both plugin load time and init time | +| [Language](PluginMetadata/Language.md) { get; set; } | | +| [Name](PluginMetadata/Name.md) { get; set; } | | +| [PluginDirectory](PluginMetadata/PluginDirectory.md) { get; } | | +| [Priority](PluginMetadata/Priority.md) { get; set; } | | +| [QueryCount](PluginMetadata/QueryCount.md) { get; set; } | | +| [Version](PluginMetadata/Version.md) { get; set; } | | +| [Website](PluginMetadata/Website.md) { get; set; } | | +| override [ToString](PluginMetadata/ToString.md)() | | + +## See Also + +* class [BaseModel](./BaseModel.md) +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/pluginpair.md b/API-Reference/Flow.Launcher.Plugin/pluginpair.md index 77c4fdc..ccce457 100644 --- a/API-Reference/Flow.Launcher.Plugin/pluginpair.md +++ b/API-Reference/Flow.Launcher.Plugin/pluginpair.md @@ -1,89 +1,22 @@ -# PluginPair - -Namespace: Flow.Launcher.Plugin - - +# PluginPair class ```csharp public class PluginPair ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [PluginPair](pluginpair.md) - -## Properties - -### **Plugin** - - - -```csharp -public IAsyncPlugin Plugin { get; internal set; } -``` - -#### Property Value - -[IAsyncPlugin](iasyncplugin.md)
- -### **Metadata** - - - -```csharp -public PluginMetadata Metadata { get; internal set; } -``` - -#### Property Value - -[PluginMetadata](pluginmetadata.md)
- -## Constructors - -### **PluginPair()** - - - -```csharp -public PluginPair() -``` - -## Methods - -### **ToString()** - - - -```csharp -public string ToString() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Equals(Object)** - +## Public Members +| name | description | +| --- | --- | +| [PluginPair](PluginPair/PluginPair.md)() | The default constructor. | +| [Metadata](PluginPair/Metadata.md) { get; } | | +| [Plugin](PluginPair/Plugin.md) { get; } | | +| override [Equals](PluginPair/Equals.md)(…) | | +| override [GetHashCode](PluginPair/GetHashCode.md)() | | +| override [ToString](PluginPair/ToString.md)() | | -```csharp -public bool Equals(object obj) -``` - -#### Parameters - -`obj` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **GetHashCode()** - - - -```csharp -public int GetHashCode() -``` +## See Also -#### Returns +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
+ diff --git a/API-Reference/Flow.Launcher.Plugin/query.md b/API-Reference/Flow.Launcher.Plugin/query.md index 3ecd4e6..29a64d1 100644 --- a/API-Reference/Flow.Launcher.Plugin/query.md +++ b/API-Reference/Flow.Launcher.Plugin/query.md @@ -1,181 +1,30 @@ -# Query - -Namespace: Flow.Launcher.Plugin - - +# Query class ```csharp public class Query ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Query](query.md) - -## Fields - -### **TermSeperater** - -Query can be splited into multiple terms by whitespace - -```csharp -public static string TermSeperater; -``` - -### **ActionKeywordSeperater** - -User can set multiple action keywords seperated by ';' - -```csharp -public static string ActionKeywordSeperater; -``` - -### **GlobalPluginWildcardSign** - -'*' is used for System Plugin - -```csharp -public static string GlobalPluginWildcardSign; -``` - -## Properties - -### **RawQuery** - -Raw query, this includes action keyword if it has - We didn't recommend use this property directly. You should always use Search property. - -```csharp -public string RawQuery { get; internal set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Search** - -Search part of a query. - This will not include action keyword if exclusive plugin gets it, otherwise it should be same as RawQuery. - Since we allow user to switch a exclusive plugin to generic plugin, - so this property will always give you the "real" query part of the query - -```csharp -public string Search { get; internal set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Terms** - -The raw query splited into a string array. - -```csharp -public String[] Terms { get; set; } -``` - -#### Property Value - -[String[]](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ActionKeyword** - - - -```csharp -public string ActionKeyword { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **FirstSearch** +## Public Members -Return first search split by space if it has +| name | description | +| --- | --- | +| [Query](Query/Query.md)() | The default constructor. | +| [Query](Query/Query.md)(…) | to allow unit tests for plug ins | +| [ActionKeyword](Query/ActionKeyword.md) { get; set; } | | +| [FirstSearch](Query/FirstSearch.md) { get; } | Return first search split by space if it has | +| [RawQuery](Query/RawQuery.md) { get; } | Raw query, this includes action keyword if it has We didn't recommend use this property directly. You should always use Search property. | +| [Search](Query/Search.md) { get; } | Search part of a query. This will not include action keyword if exclusive plugin gets it, otherwise it should be same as RawQuery. Since we allow user to switch a exclusive plugin to generic plugin, so this property will always give you the "real" query part of the query | +| [SearchTerms](Query/SearchTerms.md) { get; set; } | The search string split into a string array. | +| [SecondSearch](Query/SecondSearch.md) { get; } | Return second search split by space if it has | +| [SecondToEndSearch](Query/SecondToEndSearch.md) { get; } | strings from second search (including) to last search | +| [ThirdSearch](Query/ThirdSearch.md) { get; } | Return third search split by space if it has | +| override [ToString](Query/ToString.md)() | | +| const [ActionKeywordSeparator](Query/ActionKeywordSeparator.md) | User can set multiple action keywords seperated by ';' | +| const [GlobalPluginWildcardSign](Query/GlobalPluginWildcardSign.md) | '*' is used for System Plugin | +| const [TermSeparator](Query/TermSeparator.md) | Query can be splited into multiple terms by whitespace | -```csharp -public string FirstSearch { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **SecondToEndSearch** - -strings from second search (including) to last search - -```csharp -public string SecondToEndSearch { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **SecondSearch** - -Return second search split by space if it has - -```csharp -public string SecondSearch { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ThirdSearch** - -Return third search split by space if it has - -```csharp -public string ThirdSearch { get; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **Query()** - - - -```csharp -public Query() -``` - -### **Query(String, String, String[], String)** - -to allow unit tests for plug ins - -```csharp -public Query(string rawQuery, string search, String[] terms, string actionKeyword) -``` - -#### Parameters - -`rawQuery` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`search` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`terms` [String[]](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -`actionKeyword` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Methods - -### **ToString()** - - - -```csharp -public string ToString() -``` +## See Also -#### Returns +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+ diff --git a/API-Reference/Flow.Launcher.Plugin/result.md b/API-Reference/Flow.Launcher.Plugin/result.md index d1e86b3..b34a19a 100644 --- a/API-Reference/Flow.Launcher.Plugin/result.md +++ b/API-Reference/Flow.Launcher.Plugin/result.md @@ -1,231 +1,37 @@ -# Result - -Namespace: Flow.Launcher.Plugin - - +# Result class ```csharp public class Result ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [Result](result.md) - -## Fields - -### **Icon** - -Delegate version of IcoPath. You can use either Icon or IcoPath to display image for the result. - -```csharp -public IconDelegate Icon; -``` - -## Properties - -### **Title** - -Provides the title of the result. This is always required. - -```csharp -public string Title { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **SubTitle** - -Provides additional details for the result. This is optional - -```csharp -public string SubTitle { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ActionKeywordAssigned** - -This holds the action keyword that triggered the result. - If result is triggered by global keyword: *, this should be empty. - -```csharp -public string ActionKeywordAssigned { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **IcoPath** - -Relative Path (plugin directory) to the Image displayed for the current Result. - -```csharp -public string IcoPath { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **Action** - -return true to hide flowlauncher after select result - -```csharp -public Func Action { get; set; } -``` - -#### Property Value - -[Func<ActionContext, Boolean>](https://docs.microsoft.com/en-us/dotnet/api/system.func-2)
- -### **Score** - -An int value showing the priority of the current result. It can be used to sort multiple results. - -```csharp -public int Score { get; set; } -``` - -#### Property Value - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **TitleHighlightData** - -A list of indexes for the characters to be highlighted in Title - -```csharp -public IList TitleHighlightData { get; set; } -``` - -#### Property Value - -[IList<Int32>](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ilist-1)
- -### **AutoCompleteText** -Full text display in the query window when autocomplete is triggered - -```csharp -public string AutoCompleteText { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **PluginDirectory** - -Plugin directory - -```csharp -public string PluginDirectory { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **ContextData** - -Additional data associate with this result - -```csharp -public object ContextData { get; set; } -``` - -#### Property Value - -[Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
- -### **PluginID** - -Plugin ID that generated this result - -```csharp -public string PluginID { get; internal set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **TitleToolTip** - -Show message as ToolTip on result Title hover over - -```csharp -public string TitleToolTip { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -### **SubTitleToolTip** - -Show message as ToolTip on result SubTitle hover over - -```csharp -public string SubTitleToolTip { get; set; } -``` - -#### Property Value - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
- -## Constructors - -### **Result()** - - - -```csharp -public Result() -``` - -## Methods - -### **Equals(Object)** - - - -```csharp -public bool Equals(object obj) -``` - -#### Parameters - -`obj` [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object)
- -#### Returns - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **GetHashCode()** - - - -```csharp -public int GetHashCode() -``` - -#### Returns - -[Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32)
- -### **ToString()** - - - -```csharp -public string ToString() -``` - -#### Returns - -[String](https://docs.microsoft.com/en-us/dotnet/api/system.string)
+## Public Members + +| name | description | +| --- | --- | +| [Result](Result/Result.md)() | The default constructor. | +| [Action](Result/Action.md) { get; set; } | return true to hide flowlauncher after select result | +| [ActionKeywordAssigned](Result/ActionKeywordAssigned.md) { get; set; } | This holds the action keyword that triggered the result. If result is triggered by global keyword: *, this should be empty. | +| [AutoCompleteText](Result/AutoCompleteText.md) { get; set; } | This holds the text which can be provided by plugin to help Flow autocomplete text for user on the plugin result. If autocomplete action for example is tab, pressing tab will have the default constructed autocomplete text (result's Title), or the text provided here if not empty. | +| [ContextData](Result/ContextData.md) { get; set; } | Additional data associate with this result | +| [Glyph](Result/Glyph.md) { get; set; } | Information for Glyph Icon | +| [IcoPath](Result/IcoPath.md) { get; set; } | | +| [PluginDirectory](Result/PluginDirectory.md) { get; set; } | Plugin directory | +| [PluginID](Result/PluginID.md) { get; } | Plugin ID that generated this result | +| [Score](Result/Score.md) { get; set; } | | +| [SubTitle](Result/SubTitle.md) { get; set; } | Provides additional details for the result. This is optional | +| [SubTitleHighlightData](Result/SubTitleHighlightData.md) { get; set; } | A list of indexes for the characters to be highlighted in SubTitle | +| [SubTitleToolTip](Result/SubTitleToolTip.md) { get; set; } | Show message as ToolTip on result SubTitle hover over | +| [Title](Result/Title.md) { get; set; } | Provides the title of the result. This is always required. | +| [TitleHighlightData](Result/TitleHighlightData.md) { get; set; } | A list of indexes for the characters to be highlighted in Title | +| [TitleToolTip](Result/TitleToolTip.md) { get; set; } | Show message as ToolTip on result Title hover over | +| [Icon](Result/Icon.md) | Delegate to Get Image Source | +| override [Equals](Result/Equals.md)(…) | | +| override [GetHashCode](Result/GetHashCode.md)() | | +| override [ToString](Result/ToString.md)() | | +| delegate [IconDelegate](Result.IconDelegate.md) | | + +## See Also + +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md b/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md index 746d957..573af73 100644 --- a/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md +++ b/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md @@ -1,39 +1,20 @@ -# ResultUpdatedEventArgs - -Namespace: Flow.Launcher.Plugin - - +# ResultUpdatedEventArgs class ```csharp -public class ResultUpdatedEventArgs : System.EventArgs +public class ResultUpdatedEventArgs : EventArgs ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [EventArgs](https://docs.microsoft.com/en-us/dotnet/api/system.eventargs) → [ResultUpdatedEventArgs](resultupdatedeventargs.md) - -## Fields - -### **Results** - - - -```csharp -public List Results; -``` +## Public Members -### **Query** +| name | description | +| --- | --- | +| [ResultUpdatedEventArgs](ResultUpdatedEventArgs/ResultUpdatedEventArgs.md)() | The default constructor. | +| [Token](ResultUpdatedEventArgs/Token.md) { get; set; } | | +| [Query](ResultUpdatedEventArgs/Query.md) | | +| [Results](ResultUpdatedEventArgs/Results.md) | | +## See Also +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -```csharp -public Query Query; -``` - -## Constructors - -### **ResultUpdatedEventArgs()** - - - -```csharp -public ResultUpdatedEventArgs() -``` + diff --git a/API-Reference/Flow.Launcher.Plugin/specialkeystate.md b/API-Reference/Flow.Launcher.Plugin/specialkeystate.md index 44620e7..9a0577e 100644 --- a/API-Reference/Flow.Launcher.Plugin/specialkeystate.md +++ b/API-Reference/Flow.Launcher.Plugin/specialkeystate.md @@ -1,71 +1,21 @@ -# SpecialKeyState - -Namespace: Flow.Launcher.Plugin - - +# SpecialKeyState class ```csharp public class SpecialKeyState ``` -Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [SpecialKeyState](specialkeystate.md) - -## Properties - -### **CtrlPressed** - - - -```csharp -public bool CtrlPressed { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **ShiftPressed** - - - -```csharp -public bool ShiftPressed { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
+## Public Members -### **AltPressed** +| name | description | +| --- | --- | +| [SpecialKeyState](SpecialKeyState/SpecialKeyState.md)() | The default constructor. | +| [AltPressed](SpecialKeyState/AltPressed.md) { get; set; } | | +| [CtrlPressed](SpecialKeyState/CtrlPressed.md) { get; set; } | | +| [ShiftPressed](SpecialKeyState/ShiftPressed.md) { get; set; } | | +| [WinPressed](SpecialKeyState/WinPressed.md) { get; set; } | | +## See Also +* namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) -```csharp -public bool AltPressed { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -### **WinPressed** - - - -```csharp -public bool WinPressed { get; set; } -``` - -#### Property Value - -[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)
- -## Constructors - -### **SpecialKeyState()** - - - -```csharp -public SpecialKeyState() -``` + diff --git a/API-Reference/README.md b/API-Reference/README.md index 17802de..c8cbe4b 100644 --- a/API-Reference/README.md +++ b/API-Reference/README.md @@ -1,9 +1,3 @@ ## API Reference -- [Flow.Launcher.Plugin](Flow.Launcher.Plugin.md) - - -- [Flow.Launcher.Plugin.SharedCommands](Flow.Launcher.Plugin.SharedCommands.md) - - -- [Flow.Launcher.Plugin.SharedModels](Flow.Launcher.Plugin.SharedModels.md) \ No newline at end of file +- [Flow.Launcher.Plugin](Flow.Launcher.Plugin.md) \ No newline at end of file diff --git a/API-Reference/_sidebar.md b/API-Reference/_sidebar.md deleted file mode 100644 index 1282571..0000000 --- a/API-Reference/_sidebar.md +++ /dev/null @@ -1,3 +0,0 @@ -- [Flow.Launcher.Plugin](Flow.Launcher.Plugin.md) -- [Flow.Launcher.Plugin.SharedCommands](Flow.Launcher.Plugin.SharedCommands.md) -- [Flow.Launcher.Plugin.SharedModels](Flow.Launcher.Plugin.SharedModels.md) \ No newline at end of file From cbde70c1c12a16ca5a123c62b8f30852029fb002 Mon Sep 17 00:00:00 2001 From: Hongtao Zhang Date: Wed, 29 Dec 2021 13:38:22 -0600 Subject: [PATCH 3/8] Update Docs --- API-Reference/Flow.Launcher.Plugin.md | 2 +- API-Reference/Flow.Launcher.Plugin/GlyphInfo.md | 4 +++- .../Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md | 7 +++++++ .../Flow.Launcher.Plugin/Result/Action.md | 2 +- .../Flow.Launcher.Plugin/Result/ContextData.md | 2 +- .../Flow.Launcher.Plugin/Result/Glyph.md | 2 +- .../Flow.Launcher.Plugin/Result/IcoPath.md | 2 ++ .../Flow.Launcher.Plugin/Result/OriginQuery.md | 15 +++++++++++++++ .../Flow.Launcher.Plugin/Result/Score.md | 2 ++ .../Flow.Launcher.Plugin/Result/Title.md | 2 +- API-Reference/Flow.Launcher.Plugin/result.md | 13 +++++++------ 11 files changed, 41 insertions(+), 12 deletions(-) create mode 100644 API-Reference/Flow.Launcher.Plugin/Result/OriginQuery.md diff --git a/API-Reference/Flow.Launcher.Plugin.md b/API-Reference/Flow.Launcher.Plugin.md index b114456..4c58ccb 100644 --- a/API-Reference/Flow.Launcher.Plugin.md +++ b/API-Reference/Flow.Launcher.Plugin.md @@ -12,7 +12,7 @@ | class [FlowLauncherKeyDownEventArgs](./Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs.md) | | | delegate [FlowLauncherKeyDownEventHandler](./Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md) | | | class [FlowLauncherQueryEventArgs](./Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md) | | -| record [GlyphInfo](./Flow.Launcher.Plugin/GlyphInfo.md) | | +| record [GlyphInfo](./Flow.Launcher.Plugin/GlyphInfo.md) | Text with FontFamily specified | | interface [IAsyncPlugin](./Flow.Launcher.Plugin/IAsyncPlugin.md) | Asynchronous Plugin Model for Flow Launcher | | 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. | | interface [IContextMenu](./Flow.Launcher.Plugin/IContextMenu.md) | | diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md index f2c6427..1b135ef 100644 --- a/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md @@ -1,5 +1,7 @@ # GlyphInfo record +Text with FontFamily specified + ```csharp public record GlyphInfo ``` @@ -8,7 +10,7 @@ public record GlyphInfo | name | description | | --- | --- | -| [GlyphInfo](GlyphInfo/GlyphInfo.md)(…) | | +| [GlyphInfo](GlyphInfo/GlyphInfo.md)(…) | Text with FontFamily specified | | [FontFamily](GlyphInfo/FontFamily.md) { get; set; } | | | [Glyph](GlyphInfo/Glyph.md) { get; set; } | | diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md index ae3d263..7508e75 100644 --- a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md @@ -1,9 +1,16 @@ # GlyphInfo constructor +Text with FontFamily specified + ```csharp public GlyphInfo(string FontFamily, string Glyph) ``` +| parameter | description | +| --- | --- | +| FontFamily | Font Family of this Glyph | +| Glyph | Text/Unicode of the Glyph | + ## See Also * record [GlyphInfo](../GlyphInfo.md) diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Action.md b/API-Reference/Flow.Launcher.Plugin/Result/Action.md index 4013bac..28c758f 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Action.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Action.md @@ -1,6 +1,6 @@ # Result.Action property -return true to hide flowlauncher after select result +Delegate activated when result is been selected true to hide flowlauncher after select result ```csharp public Func Action { get; set; } diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md b/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md index 226c6fc..f696366 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md @@ -1,6 +1,6 @@ # Result.ContextData property -Additional data associate with this result +Additional data associate with this result As external information for ContextMenu ```csharp public object ContextData { get; set; } diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md b/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md index bb94d2e..36738e8 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md @@ -1,6 +1,6 @@ # Result.Glyph property -Information for Glyph Icon +Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons) ```csharp public GlyphInfo Glyph { get; set; } diff --git a/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md b/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md index f162603..5b6ad17 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md @@ -1,5 +1,7 @@ # Result.IcoPath property +Image Displayed on the result + ```csharp public string IcoPath { get; set; } ``` diff --git a/API-Reference/Flow.Launcher.Plugin/Result/OriginQuery.md b/API-Reference/Flow.Launcher.Plugin/Result/OriginQuery.md new file mode 100644 index 0000000..905b96a --- /dev/null +++ b/API-Reference/Flow.Launcher.Plugin/Result/OriginQuery.md @@ -0,0 +1,15 @@ +# Result.OriginQuery property + +Query information associated with the result + +```csharp +public Query OriginQuery { get; set; } +``` + +## See Also + +* class [Query](../Query.md) +* class [Result](../Result.md) +* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) + + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Score.md b/API-Reference/Flow.Launcher.Plugin/Result/Score.md index 545a9ae..ca813ac 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Score.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Score.md @@ -1,5 +1,7 @@ # Result.Score property +Priority of the current result + ```csharp public int Score { get; set; } ``` diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Title.md b/API-Reference/Flow.Launcher.Plugin/Result/Title.md index bb929d0..2f338c5 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Title.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Title.md @@ -1,6 +1,6 @@ # Result.Title property -Provides the title of the result. This is always required. +The title of the result. This is always required. ```csharp public string Title { get; set; } diff --git a/API-Reference/Flow.Launcher.Plugin/result.md b/API-Reference/Flow.Launcher.Plugin/result.md index b34a19a..d880f0a 100644 --- a/API-Reference/Flow.Launcher.Plugin/result.md +++ b/API-Reference/Flow.Launcher.Plugin/result.md @@ -9,19 +9,20 @@ public class Result | name | description | | --- | --- | | [Result](Result/Result.md)() | The default constructor. | -| [Action](Result/Action.md) { get; set; } | return true to hide flowlauncher after select result | +| [Action](Result/Action.md) { get; set; } | Delegate activated when result is been selected true to hide flowlauncher after select result | | [ActionKeywordAssigned](Result/ActionKeywordAssigned.md) { get; set; } | This holds the action keyword that triggered the result. If result is triggered by global keyword: *, this should be empty. | | [AutoCompleteText](Result/AutoCompleteText.md) { get; set; } | This holds the text which can be provided by plugin to help Flow autocomplete text for user on the plugin result. If autocomplete action for example is tab, pressing tab will have the default constructed autocomplete text (result's Title), or the text provided here if not empty. | -| [ContextData](Result/ContextData.md) { get; set; } | Additional data associate with this result | -| [Glyph](Result/Glyph.md) { get; set; } | Information for Glyph Icon | -| [IcoPath](Result/IcoPath.md) { get; set; } | | +| [ContextData](Result/ContextData.md) { get; set; } | Additional data associate with this result As external information for ContextMenu | +| [Glyph](Result/Glyph.md) { get; set; } | Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons) | +| [IcoPath](Result/IcoPath.md) { get; set; } | Image Displayed on the result | +| [OriginQuery](Result/OriginQuery.md) { get; set; } | Query information associated with the result | | [PluginDirectory](Result/PluginDirectory.md) { get; set; } | Plugin directory | | [PluginID](Result/PluginID.md) { get; } | Plugin ID that generated this result | -| [Score](Result/Score.md) { get; set; } | | +| [Score](Result/Score.md) { get; set; } | Priority of the current result | | [SubTitle](Result/SubTitle.md) { get; set; } | Provides additional details for the result. This is optional | | [SubTitleHighlightData](Result/SubTitleHighlightData.md) { get; set; } | A list of indexes for the characters to be highlighted in SubTitle | | [SubTitleToolTip](Result/SubTitleToolTip.md) { get; set; } | Show message as ToolTip on result SubTitle hover over | -| [Title](Result/Title.md) { get; set; } | Provides the title of the result. This is always required. | +| [Title](Result/Title.md) { get; set; } | The title of the result. This is always required. | | [TitleHighlightData](Result/TitleHighlightData.md) { get; set; } | A list of indexes for the characters to be highlighted in Title | | [TitleToolTip](Result/TitleToolTip.md) { get; set; } | Show message as ToolTip on result Title hover over | | [Icon](Result/Icon.md) | Delegate to Get Image Source | From 8d1fce76320657bf207ebfc8a73b87f548d72096 Mon Sep 17 00:00:00 2001 From: Hongtao Zhang Date: Wed, 29 Dec 2021 13:47:10 -0600 Subject: [PATCH 4/8] add default value --- API-Reference/Flow.Launcher.Plugin/Result/Score.md | 2 +- API-Reference/Flow.Launcher.Plugin/result.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Score.md b/API-Reference/Flow.Launcher.Plugin/Result/Score.md index ca813ac..71b142f 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Score.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Score.md @@ -1,6 +1,6 @@ # Result.Score property -Priority of the current result +Priority of the current result default: 0 ```csharp public int Score { get; set; } diff --git a/API-Reference/Flow.Launcher.Plugin/result.md b/API-Reference/Flow.Launcher.Plugin/result.md index d880f0a..a951868 100644 --- a/API-Reference/Flow.Launcher.Plugin/result.md +++ b/API-Reference/Flow.Launcher.Plugin/result.md @@ -18,7 +18,7 @@ public class Result | [OriginQuery](Result/OriginQuery.md) { get; set; } | Query information associated with the result | | [PluginDirectory](Result/PluginDirectory.md) { get; set; } | Plugin directory | | [PluginID](Result/PluginID.md) { get; } | Plugin ID that generated this result | -| [Score](Result/Score.md) { get; set; } | Priority of the current result | +| [Score](Result/Score.md) { get; set; } | Priority of the current result default: 0 | | [SubTitle](Result/SubTitle.md) { get; set; } | Provides additional details for the result. This is optional | | [SubTitleHighlightData](Result/SubTitleHighlightData.md) { get; set; } | A list of indexes for the characters to be highlighted in SubTitle | | [SubTitleToolTip](Result/SubTitleToolTip.md) { get; set; } | Show message as ToolTip on result SubTitle hover over | From 915cbd44a482b8eef42be9804fb7a5fdf7f41011 Mon Sep 17 00:00:00 2001 From: Hongtao Zhang Date: Sat, 1 Jan 2022 13:21:37 -0600 Subject: [PATCH 5/8] Update Sidebar --- _sidebar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_sidebar.md b/_sidebar.md index 2f75965..dd4a91d 100644 --- a/_sidebar.md +++ b/_sidebar.md @@ -5,7 +5,7 @@ - [**plugin.json**](/plugin.json.md) - Dotnet Plugins - [**Development Guide**](/develop-dotnet-plugins.md) - - [**API Reference**](API-Reference/) + - [**API Reference**](/API-Reference/Flow.Launcher.Plugin.md) - Python Plugins - [**Before you start**](/py-develop-plugins.md) - [**Set up your project**](/py-setup-project.md) From 7cf65215d08b57f387b63daaa090d4259bcbcd01 Mon Sep 17 00:00:00 2001 From: Hongtao Zhang Date: Sat, 1 Jan 2022 13:39:46 -0600 Subject: [PATCH 6/8] Rename File --- .../FilesFolders/CopyAll.md | 2 +- .../FilesFolders/FileExists.md | 2 +- .../FilesFolders/GetPreviousExistingDirectory.md | 2 +- .../FilesFolders/IsLocationPathString.md | 2 +- .../FilesFolders/LocationExists.md | 2 +- .../FilesFolders/OpenContainingFolder.md | 2 +- .../FilesFolders/OpenPath.md | 2 +- .../FilesFolders/RemoveFolderIfExists.md | 2 +- .../ReturnPreviousDirectoryIfIncompleteString.md | 2 +- .../FilesFolders/VerifyBothFolderFilesEqual.md | 2 +- .../SearchWeb/OpenInBrowserTab.md | 2 +- .../SearchWeb/OpenInBrowserWindow.md | 2 +- .../ShellCommand.EnumThreadDelegate.md | 2 +- .../ShellCommand/Execute.md | 2 +- .../ShellCommand/RunAsDifferentUser.md | 2 +- .../ShellCommand/SetProcessStartInfo.md | 2 +- .../filesfolders.md | 2 +- .../searchweb.md | 2 +- .../shellcommand.md | 2 +- .../MatchResult/IsSearchPrecisionScoreMet.md | 2 +- .../MatchResult/MatchData.md | 2 +- .../MatchResult/MatchResult.md | 2 +- .../MatchResult/RawScore.md | 2 +- .../MatchResult/Score.md | 2 +- .../MatchResult/SearchPrecision.md | 2 +- .../MatchResult/Success.md | 2 +- .../matchresult.md | 2 +- .../searchprecisionscore.md | 2 +- API-Reference/Flow.Launcher.Plugin.md | 2 +- .../ActionContext/ActionContext.md | 2 +- .../ActionContext/SpecialKeyState.md | 2 +- .../AfterFlowLauncherQueryEventHandler.md | 2 +- .../AllowedLanguage/CSharp.md | 2 +- .../AllowedLanguage/Executable.md | 2 +- .../AllowedLanguage/FSharp.md | 2 +- .../AllowedLanguage/IsAllowed.md | 2 +- .../AllowedLanguage/IsDotNet.md | 2 +- .../AllowedLanguage/Python.md | 2 +- .../Flow.Launcher.Plugin/BaseModel/BaseModel.md | 2 +- .../BaseModel/OnPropertyChanged.md | 2 +- .../BaseModel/PropertyChanged.md | 2 +- .../FlowLauncherGlobalKeyboardEventHandler.md | 2 +- .../FlowLauncherKeyDownEventArgs.md | 2 +- .../FlowLauncherKeyDownEventArgs/Query.md | 2 +- .../FlowLauncherKeyDownEventArgs/keyEventArgs.md | 2 +- .../FlowLauncherKeyDownEventHandler.md | 2 +- .../FlowLauncherQueryEventArgs.md | 2 +- .../FlowLauncherQueryEventArgs/Query.md | 2 +- API-Reference/Flow.Launcher.Plugin/GlyphInfo.md | 2 +- .../Flow.Launcher.Plugin/GlyphInfo/FontFamily.md | 2 +- .../Flow.Launcher.Plugin/GlyphInfo/Glyph.md | 2 +- .../Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md | 2 +- .../IAsyncPlugin/InitAsync.md | 2 +- .../IAsyncPlugin/QueryAsync.md | 2 +- .../IAsyncReloadable/ReloadDataAsync.md | 2 +- .../IContextMenu/LoadContextMenus.md | 2 +- .../Flow.Launcher.Plugin/IPlugin/Init.md | 2 +- .../Flow.Launcher.Plugin/IPlugin/Query.md | 2 +- .../IPluginI18n/GetTranslatedPluginDescription.md | 2 +- .../IPluginI18n/GetTranslatedPluginTitle.md | 2 +- .../IPluginI18n/OnCultureInfoChanged.md | 2 +- .../IPublicAPI/AddActionKeyword.md | 2 +- .../IPublicAPI/ChangeQuery.md | 2 +- .../IPublicAPI/CheckForNewUpdate.md | 2 +- .../IPublicAPI/CopyToClipboard.md | 2 +- .../IPublicAPI/FuzzySearch.md | 2 +- .../IPublicAPI/GetAllPlugins.md | 2 +- .../IPublicAPI/GetTranslation.md | 2 +- .../IPublicAPI/HttpDownloadAsync.md | 2 +- .../IPublicAPI/HttpGetStreamAsync.md | 2 +- .../IPublicAPI/HttpGetStringAsync.md | 2 +- .../IPublicAPI/LoadSettingJsonStorage.md | 2 +- .../Flow.Launcher.Plugin/IPublicAPI/LogDebug.md | 2 +- .../IPublicAPI/LogException.md | 2 +- .../Flow.Launcher.Plugin/IPublicAPI/LogInfo.md | 2 +- .../Flow.Launcher.Plugin/IPublicAPI/LogWarn.md | 2 +- .../IPublicAPI/OpenDirectory.md | 2 +- .../IPublicAPI/OpenSettingDialog.md | 2 +- .../Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md | 2 +- .../IPublicAPI/RegisterGlobalKeyboardCallback.md | 2 +- .../IPublicAPI/ReloadAllPluginData.md | 2 +- .../IPublicAPI/RemoveActionKeyword.md | 2 +- .../IPublicAPI/RemoveGlobalKeyboardCallback.md | 2 +- .../Flow.Launcher.Plugin/IPublicAPI/RestartApp.md | 2 +- .../IPublicAPI/SaveAppAllSettings.md | 2 +- .../IPublicAPI/SavePluginSettings.md | 2 +- .../IPublicAPI/SaveSettingJsonStorage.md | 2 +- .../Flow.Launcher.Plugin/IPublicAPI/ShellRun.md | 2 +- .../IPublicAPI/ShowMainWindow.md | 2 +- .../Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md | 2 +- .../IPublicAPI/ShowMsgError.md | 2 +- .../IReloadable/ReloadData.md | 2 +- .../IResultUpdated/ResultsUpdated.md | 2 +- .../Flow.Launcher.Plugin/ISavable/Save.md | 2 +- .../Flow.Launcher.Plugin/ISettingProvider.md | 2 +- .../ISettingProvider/CreateSettingPanel.md | 2 +- .../Flow.Launcher.Plugin/PluginInitContext/API.md | 2 +- .../PluginInitContext/CurrentPluginMetadata.md | 2 +- .../PluginInitContext/PluginInitContext.md | 2 +- .../PluginMetadata/ActionKeyword.md | 2 +- .../PluginMetadata/ActionKeywords.md | 2 +- .../Flow.Launcher.Plugin/PluginMetadata/Author.md | 2 +- .../PluginMetadata/AvgQueryTime.md | 2 +- .../PluginMetadata/Description.md | 2 +- .../PluginMetadata/Disabled.md | 2 +- .../PluginMetadata/ExecuteFileName.md | 2 +- .../PluginMetadata/ExecuteFilePath.md | 2 +- .../Flow.Launcher.Plugin/PluginMetadata/ID.md | 2 +- .../PluginMetadata/IcoPath.md | 2 +- .../PluginMetadata/InitTime.md | 2 +- .../PluginMetadata/Language.md | 2 +- .../Flow.Launcher.Plugin/PluginMetadata/Name.md | 2 +- .../PluginMetadata/PluginDirectory.md | 2 +- .../PluginMetadata/PluginMetadata.md | 2 +- .../PluginMetadata/Priority.md | 2 +- .../PluginMetadata/QueryCount.md | 2 +- .../PluginMetadata/ToString.md | 2 +- .../PluginMetadata/Version.md | 2 +- .../PluginMetadata/Website.md | 2 +- .../Flow.Launcher.Plugin/PluginPair/Equals.md | 2 +- .../PluginPair/GetHashCode.md | 2 +- .../Flow.Launcher.Plugin/PluginPair/Metadata.md | 2 +- .../Flow.Launcher.Plugin/PluginPair/Plugin.md | 2 +- .../Flow.Launcher.Plugin/PluginPair/PluginPair.md | 2 +- .../Flow.Launcher.Plugin/PluginPair/ToString.md | 2 +- .../Flow.Launcher.Plugin/Query/ActionKeyword.md | 2 +- .../Query/ActionKeywordSeparator.md | 2 +- .../Flow.Launcher.Plugin/Query/FirstSearch.md | 2 +- .../Query/GlobalPluginWildcardSign.md | 2 +- API-Reference/Flow.Launcher.Plugin/Query/Query.md | 2 +- .../Flow.Launcher.Plugin/Query/RawQuery.md | 2 +- .../Flow.Launcher.Plugin/Query/Search.md | 2 +- .../Flow.Launcher.Plugin/Query/SearchTerms.md | 2 +- .../Flow.Launcher.Plugin/Query/SecondSearch.md | 2 +- .../Query/SecondToEndSearch.md | 2 +- .../Flow.Launcher.Plugin/Query/TermSeparator.md | 2 +- .../Flow.Launcher.Plugin/Query/ThirdSearch.md | 2 +- .../Flow.Launcher.Plugin/Query/ToString.md | 2 +- .../Flow.Launcher.Plugin/Result.IconDelegate.md | 2 +- .../Flow.Launcher.Plugin/Result/Action.md | 4 ++-- .../Result/ActionKeywordAssigned.md | 2 +- .../Result/AutoCompleteText.md | 2 +- .../Flow.Launcher.Plugin/Result/ContextData.md | 4 ++-- .../Flow.Launcher.Plugin/Result/Equals.md | 2 +- .../Flow.Launcher.Plugin/Result/GetHashCode.md | 2 +- .../Flow.Launcher.Plugin/Result/Glyph.md | 2 +- .../Flow.Launcher.Plugin/Result/IcoPath.md | 4 ++-- API-Reference/Flow.Launcher.Plugin/Result/Icon.md | 2 +- .../Flow.Launcher.Plugin/Result/OriginQuery.md | 15 --------------- .../Result/PluginDirectory.md | 2 +- .../Flow.Launcher.Plugin/Result/PluginID.md | 2 +- .../Flow.Launcher.Plugin/Result/Result.md | 2 +- .../Flow.Launcher.Plugin/Result/Score.md | 2 +- .../Flow.Launcher.Plugin/Result/SubTitle.md | 2 +- .../Result/SubTitleHighlightData.md | 14 -------------- .../Result/SubTitleToolTip.md | 2 +- .../Flow.Launcher.Plugin/Result/Title.md | 2 +- .../Result/TitleHighlightData.md | 2 +- .../Flow.Launcher.Plugin/Result/TitleToolTip.md | 2 +- .../Flow.Launcher.Plugin/Result/ToString.md | 2 +- .../ResultItemDropEventHandler.md | 2 +- .../ResultUpdatedEventArgs/Query.md | 2 +- .../ResultUpdatedEventArgs.md | 2 +- .../ResultUpdatedEventArgs/Results.md | 2 +- .../ResultUpdatedEventArgs/Token.md | 2 +- .../ResultUpdatedEventHandler.md | 2 +- .../SpecialKeyState/AltPressed.md | 2 +- .../SpecialKeyState/CtrlPressed.md | 2 +- .../SpecialKeyState/ShiftPressed.md | 2 +- .../SpecialKeyState/SpecialKeyState.md | 2 +- .../SpecialKeyState/WinPressed.md | 2 +- .../Flow.Launcher.Plugin/actioncontext.md | 2 +- .../Flow.Launcher.Plugin/allowedlanguage.md | 2 +- API-Reference/Flow.Launcher.Plugin/basemodel.md | 2 +- .../flowlauncherkeydowneventargs.md | 2 +- .../flowlauncherqueryeventargs.md | 2 +- .../Flow.Launcher.Plugin/iasyncplugin.md | 2 +- .../Flow.Launcher.Plugin/iasyncreloadable.md | 2 +- .../Flow.Launcher.Plugin/icontextmenu.md | 2 +- API-Reference/Flow.Launcher.Plugin/ifeatures.md | 2 +- API-Reference/Flow.Launcher.Plugin/iplugin.md | 2 +- API-Reference/Flow.Launcher.Plugin/iplugini18n.md | 2 +- API-Reference/Flow.Launcher.Plugin/ipublicapi.md | 2 +- API-Reference/Flow.Launcher.Plugin/ireloadable.md | 2 +- .../Flow.Launcher.Plugin/iresultupdated.md | 2 +- API-Reference/Flow.Launcher.Plugin/isavable.md | 2 +- .../Flow.Launcher.Plugin/plugininitcontext.md | 2 +- .../Flow.Launcher.Plugin/pluginmetadata.md | 2 +- API-Reference/Flow.Launcher.Plugin/pluginpair.md | 2 +- API-Reference/Flow.Launcher.Plugin/query.md | 2 +- API-Reference/Flow.Launcher.Plugin/result.md | 10 ++++------ .../resultupdatedeventargs.md | 2 +- .../Flow.Launcher.Plugin/specialkeystate.md | 2 +- API-Reference/README.md | 3 --- 194 files changed, 197 insertions(+), 231 deletions(-) delete mode 100644 API-Reference/Flow.Launcher.Plugin/Result/OriginQuery.md delete mode 100644 API-Reference/Flow.Launcher.Plugin/Result/SubTitleHighlightData.md delete mode 100644 API-Reference/README.md diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md index 1b9ab19..d90ef7d 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/CopyAll.md @@ -16,4 +16,4 @@ public static void CopyAll(this string sourcePath, string targetPath) * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md index 9c43aa3..8c230f1 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/FileExists.md @@ -9,4 +9,4 @@ public static bool FileExists(this string filePath) * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md index f7a129b..e6a9f57 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/GetPreviousExistingDirectory.md @@ -11,4 +11,4 @@ public static string GetPreviousExistingDirectory(Func locationExi * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md index 54cdee6..ebfd586 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/IsLocationPathString.md @@ -11,4 +11,4 @@ public static bool IsLocationPathString(this string querySearchString) * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md index 40595d3..a597414 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/LocationExists.md @@ -9,4 +9,4 @@ public static bool LocationExists(this string path) * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md index 4e24d9d..3e0d8ec 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenContainingFolder.md @@ -9,4 +9,4 @@ public static void OpenContainingFolder(string path) * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md index c9889e9..1f6e25f 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/OpenPath.md @@ -9,4 +9,4 @@ public static void OpenPath(string fileOrFolderPath) * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md index 997bc0f..8ec39c6 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/RemoveFolderIfExists.md @@ -9,4 +9,4 @@ public static void RemoveFolderIfExists(this string path) * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md index 66069bd..38077db 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/ReturnPreviousDirectoryIfIncompleteString.md @@ -11,4 +11,4 @@ public static string ReturnPreviousDirectoryIfIncompleteString(string path) * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md index b1a85b9..85d728d 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders/VerifyBothFolderFilesEqual.md @@ -9,4 +9,4 @@ public static bool VerifyBothFolderFilesEqual(this string fromPath, string toPat * class [FilesFolders](../FilesFolders.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md index 92f19ab..b5ff252 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserTab.md @@ -12,4 +12,4 @@ public static void OpenInBrowserTab(this string url, string browserPath = "", * class [SearchWeb](../SearchWeb.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md index de8d25f..2ebb023 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb/OpenInBrowserWindow.md @@ -12,4 +12,4 @@ public static void OpenInBrowserWindow(this string url, string browserPath = "", * class [SearchWeb](../SearchWeb.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md index 0702b4a..7da1fa7 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.EnumThreadDelegate.md @@ -9,4 +9,4 @@ public delegate bool EnumThreadDelegate(IntPtr hwnd, IntPtr lParam); * class [ShellCommand](./ShellCommand.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md index dcc0138..56608b9 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/Execute.md @@ -44,4 +44,4 @@ public static void Execute(Func startProcess, Process * class [ShellCommand](../ShellCommand.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md index 121115e..f93757e 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/RunAsDifferentUser.md @@ -9,4 +9,4 @@ public static Process RunAsDifferentUser(ProcessStartInfo processStartInfo) * class [ShellCommand](../ShellCommand.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md index 5dab582..58a560c 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand/SetProcessStartInfo.md @@ -11,4 +11,4 @@ public static ProcessStartInfo SetProcessStartInfo(this string fileName, * class [ShellCommand](../ShellCommand.md) * namespace [Flow.Launcher.Plugin.SharedCommands](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md index 149e645..b6feaea 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md @@ -23,4 +23,4 @@ public static class FilesFolders * namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md index ed35c05..b90faa3 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md @@ -15,4 +15,4 @@ public static class SearchWeb * namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md index 8acc214..34c499b 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md @@ -17,4 +17,4 @@ public static class ShellCommand * namespace [Flow.Launcher.Plugin.SharedCommands](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md index 6e8487b..32843e0 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/IsSearchPrecisionScoreMet.md @@ -9,4 +9,4 @@ public bool IsSearchPrecisionScoreMet() * class [MatchResult](../MatchResult.md) * namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md index 7d3c469..7aec31f 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchData.md @@ -11,4 +11,4 @@ public List MatchData { get; set; } * class [MatchResult](../MatchResult.md) * namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md index c20b6a1..02b9fe7 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/MatchResult.md @@ -25,4 +25,4 @@ public MatchResult(bool success, SearchPrecisionScore searchPrecision, List * class [MatchResult](../MatchResult.md) * namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md index 07850e8..4588973 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/RawScore.md @@ -9,4 +9,4 @@ public int RawScore { get; set; } * class [MatchResult](../MatchResult.md) * namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md index 53f893b..3b45753 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Score.md @@ -11,4 +11,4 @@ public int Score { get; } * class [MatchResult](../MatchResult.md) * namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md index e9da3cf..4c3e66b 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/SearchPrecision.md @@ -10,4 +10,4 @@ public SearchPrecisionScore SearchPrecision { get; set; } * class [MatchResult](../MatchResult.md) * namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md index f25ed26..ab9b3d3 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult/Success.md @@ -9,4 +9,4 @@ public bool Success { get; set; } * class [MatchResult](../MatchResult.md) * namespace [Flow.Launcher.Plugin.SharedModels](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md index ede3d9d..43358d4 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md @@ -20,4 +20,4 @@ public class MatchResult * namespace [Flow.Launcher.Plugin.SharedModels](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md index 5d87373..85ebdb7 100644 --- a/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md +++ b/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md @@ -16,4 +16,4 @@ public enum SearchPrecisionScore * namespace [Flow.Launcher.Plugin.SharedModels](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin.md b/API-Reference/Flow.Launcher.Plugin.md index 4c58ccb..d0d7f50 100644 --- a/API-Reference/Flow.Launcher.Plugin.md +++ b/API-Reference/Flow.Launcher.Plugin.md @@ -49,4 +49,4 @@ | class [MatchResult](./Flow.Launcher.Plugin.SharedModels/MatchResult.md) | | | enum [SearchPrecisionScore](./Flow.Launcher.Plugin.SharedModels/SearchPrecisionScore.md) | | - + diff --git a/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md b/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md index 4bfc6ff..0883609 100644 --- a/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md +++ b/API-Reference/Flow.Launcher.Plugin/ActionContext/ActionContext.md @@ -11,4 +11,4 @@ public ActionContext() * class [ActionContext](../ActionContext.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md b/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md index 26a5ef9..abb0e86 100644 --- a/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md +++ b/API-Reference/Flow.Launcher.Plugin/ActionContext/SpecialKeyState.md @@ -10,4 +10,4 @@ public SpecialKeyState SpecialKeyState { get; set; } * class [ActionContext](../ActionContext.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md b/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md index cdf2831..03ea3c1 100644 --- a/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md +++ b/API-Reference/Flow.Launcher.Plugin/AfterFlowLauncherQueryEventHandler.md @@ -9,4 +9,4 @@ public delegate void AfterFlowLauncherQueryEventHandler(FlowLauncherQueryEventAr * class [FlowLauncherQueryEventArgs](./FlowLauncherQueryEventArgs.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md index 15081a8..ad1e22d 100644 --- a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/CSharp.md @@ -9,4 +9,4 @@ public static string CSharp { get; } * class [AllowedLanguage](../AllowedLanguage.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md index 72e87ff..ecabc9b 100644 --- a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Executable.md @@ -9,4 +9,4 @@ public static string Executable { get; } * class [AllowedLanguage](../AllowedLanguage.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md index ec4a9b5..bc824e7 100644 --- a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/FSharp.md @@ -9,4 +9,4 @@ public static string FSharp { get; } * class [AllowedLanguage](../AllowedLanguage.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md index 01093b1..cad347c 100644 --- a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsAllowed.md @@ -9,4 +9,4 @@ public static bool IsAllowed(string language) * class [AllowedLanguage](../AllowedLanguage.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md index 1889d10..e8d9c68 100644 --- a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/IsDotNet.md @@ -9,4 +9,4 @@ public static bool IsDotNet(string language) * class [AllowedLanguage](../AllowedLanguage.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md index 4603c5b..0bcbbff 100644 --- a/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md +++ b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage/Python.md @@ -9,4 +9,4 @@ public static string Python { get; } * class [AllowedLanguage](../AllowedLanguage.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md b/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md index e70a559..5fc05ef 100644 --- a/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel/BaseModel.md @@ -11,4 +11,4 @@ public BaseModel() * class [BaseModel](../BaseModel.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md b/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md index bd78e5d..05c1f30 100644 --- a/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel/OnPropertyChanged.md @@ -9,4 +9,4 @@ protected void OnPropertyChanged([CallerMemberName] string propertyName = null) * class [BaseModel](../BaseModel.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md b/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md index d746c35..abdcb7f 100644 --- a/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md +++ b/API-Reference/Flow.Launcher.Plugin/BaseModel/PropertyChanged.md @@ -9,4 +9,4 @@ public event PropertyChangedEventHandler PropertyChanged; * class [BaseModel](../BaseModel.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md index 230bc05..e78cb95 100644 --- a/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherGlobalKeyboardEventHandler.md @@ -22,4 +22,4 @@ return true to continue handling, return false to intercept system handling * class [SpecialKeyState](./SpecialKeyState.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md index 2ddc34f..5a45404 100644 --- a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/FlowLauncherKeyDownEventArgs.md @@ -11,4 +11,4 @@ public FlowLauncherKeyDownEventArgs() * class [FlowLauncherKeyDownEventArgs](../FlowLauncherKeyDownEventArgs.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md index 815251d..4be61a5 100644 --- a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/Query.md @@ -9,4 +9,4 @@ public string Query { get; set; } * class [FlowLauncherKeyDownEventArgs](../FlowLauncherKeyDownEventArgs.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md index 86feded..4dc13c6 100644 --- a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs/keyEventArgs.md @@ -9,4 +9,4 @@ public KeyEventArgs keyEventArgs { get; set; } * class [FlowLauncherKeyDownEventArgs](../FlowLauncherKeyDownEventArgs.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md index 8c57d4e..e5c9aa6 100644 --- a/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventHandler.md @@ -9,4 +9,4 @@ public delegate void FlowLauncherKeyDownEventHandler(FlowLauncherKeyDownEventArg * class [FlowLauncherKeyDownEventArgs](./FlowLauncherKeyDownEventArgs.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md index 308899a..4146442 100644 --- a/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/FlowLauncherQueryEventArgs.md @@ -11,4 +11,4 @@ public FlowLauncherQueryEventArgs() * class [FlowLauncherQueryEventArgs](../FlowLauncherQueryEventArgs.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md index 7cd6198..3b637d8 100644 --- a/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md +++ b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs/Query.md @@ -10,4 +10,4 @@ public Query Query { get; set; } * class [FlowLauncherQueryEventArgs](../FlowLauncherQueryEventArgs.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md index 1b135ef..820fafc 100644 --- a/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo.md @@ -18,4 +18,4 @@ public record GlyphInfo * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md index 578642d..ab898d0 100644 --- a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/FontFamily.md @@ -9,4 +9,4 @@ public string FontFamily { get; set; } * record [GlyphInfo](../GlyphInfo.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md index 3dd2286..1920755 100644 --- a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/Glyph.md @@ -9,4 +9,4 @@ public string Glyph { get; set; } * record [GlyphInfo](../GlyphInfo.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md index 7508e75..ec689d8 100644 --- a/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md +++ b/API-Reference/Flow.Launcher.Plugin/GlyphInfo/GlyphInfo.md @@ -16,4 +16,4 @@ public GlyphInfo(string FontFamily, string Glyph) * record [GlyphInfo](../GlyphInfo.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md index 2c882f2..a7852b8 100644 --- a/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/InitAsync.md @@ -16,4 +16,4 @@ public Task InitAsync(PluginInitContext context) * interface [IAsyncPlugin](../IAsyncPlugin.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md index a2f9297..d9838eb 100644 --- a/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin/QueryAsync.md @@ -18,4 +18,4 @@ public Task> QueryAsync(Query query, CancellationToken token) * interface [IAsyncPlugin](../IAsyncPlugin.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md b/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md index ef32f2f..fcf48f1 100644 --- a/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md +++ b/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable/ReloadDataAsync.md @@ -9,4 +9,4 @@ public Task ReloadDataAsync() * interface [IAsyncReloadable](../IAsyncReloadable.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md b/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md index 054a5f4..718fcb8 100644 --- a/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md +++ b/API-Reference/Flow.Launcher.Plugin/IContextMenu/LoadContextMenus.md @@ -10,4 +10,4 @@ public List LoadContextMenus(Result selectedResult) * interface [IContextMenu](../IContextMenu.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md b/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md index bb91d9e..79000e0 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md +++ b/API-Reference/Flow.Launcher.Plugin/IPlugin/Init.md @@ -16,4 +16,4 @@ public void Init(PluginInitContext context) * interface [IPlugin](../IPlugin.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md b/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md index 86d15c3..f061488 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md +++ b/API-Reference/Flow.Launcher.Plugin/IPlugin/Query.md @@ -19,4 +19,4 @@ public List Query(Query query) * interface [IPlugin](../IPlugin.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md index 8fce8ed..b42b2dc 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginDescription.md @@ -9,4 +9,4 @@ public string GetTranslatedPluginDescription() * interface [IPluginI18n](../IPluginI18n.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md index 7182341..ed8a50e 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/GetTranslatedPluginTitle.md @@ -9,4 +9,4 @@ public string GetTranslatedPluginTitle() * interface [IPluginI18n](../IPluginI18n.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md index 08d6820..fc587de 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md +++ b/API-Reference/Flow.Launcher.Plugin/IPluginI18n/OnCultureInfoChanged.md @@ -11,4 +11,4 @@ public void OnCultureInfoChanged(CultureInfo newCulture) * interface [IPluginI18n](../IPluginI18n.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md index 45a7c5a..4521675 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/AddActionKeyword.md @@ -16,4 +16,4 @@ public void AddActionKeyword(string pluginId, string newActionKeyword) * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md index 987700f..4b9fb2b 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ChangeQuery.md @@ -16,4 +16,4 @@ public void ChangeQuery(string query, bool requery = false) * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md index 8c3e59a..4e69418 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CheckForNewUpdate.md @@ -11,4 +11,4 @@ public void CheckForNewUpdate() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md index 057d779..34c4bcd 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/CopyToClipboard.md @@ -15,4 +15,4 @@ public void CopyToClipboard(string text) * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md index f4dbab0..7b31b58 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/FuzzySearch.md @@ -21,4 +21,4 @@ Match results * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md index 7a0d4d2..18f91e7 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetAllPlugins.md @@ -12,4 +12,4 @@ public List GetAllPlugins() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md index b47e9ae..ec422b7 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/GetTranslation.md @@ -15,4 +15,4 @@ public string GetTranslation(string key) * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md index 72a3e04..90dfd17 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpDownloadAsync.md @@ -20,4 +20,4 @@ Task showing the progress * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md index 5129aeb..b0a94d6 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStreamAsync.md @@ -20,4 +20,4 @@ Task to get stream result * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md index fc34bb3..bd4ab42 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/HttpGetStringAsync.md @@ -20,4 +20,4 @@ Task to get string result * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md index 8ea141c..48ec321 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LoadSettingJsonStorage.md @@ -16,4 +16,4 @@ public T LoadSettingJsonStorage() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md index 4e5d849..c17bf29 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogDebug.md @@ -11,4 +11,4 @@ public void LogDebug(string className, string message, [CallerMemberName] string * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md index bee4505..1727c56 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogException.md @@ -12,4 +12,4 @@ public void LogException(string className, string message, Exception e, * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md index f0fde65..381ffb1 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogInfo.md @@ -11,4 +11,4 @@ public void LogInfo(string className, string message, [CallerMemberName] string * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md index f0e2edf..3c38b13 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/LogWarn.md @@ -11,4 +11,4 @@ public void LogWarn(string className, string message, [CallerMemberName] string * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md index d33f87d..fdf8ec7 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenDirectory.md @@ -16,4 +16,4 @@ public void OpenDirectory(string DirectoryPath, string FileName = null) * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md index 0fa4daf..4e1aa72 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenSettingDialog.md @@ -11,4 +11,4 @@ public void OpenSettingDialog() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md index 2efd446..735888c 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/OpenUrl.md @@ -11,4 +11,4 @@ public void OpenUrl(string url, bool? inPrivate = null) * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md index 88bff1c..a990812 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RegisterGlobalKeyboardCallback.md @@ -16,4 +16,4 @@ public void RegisterGlobalKeyboardCallback(Func * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md index 8bdd5c2..80c8b08 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ReloadAllPluginData.md @@ -11,4 +11,4 @@ public Task ReloadAllPluginData() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md index 4494f04..dfafcc0 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveActionKeyword.md @@ -16,4 +16,4 @@ public void RemoveActionKeyword(string pluginId, string oldActionKeyword) * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md index a688ee4..9b6eaff 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RemoveGlobalKeyboardCallback.md @@ -16,4 +16,4 @@ public void RemoveGlobalKeyboardCallback(Func c * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md index 9172ffa..082691d 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/RestartApp.md @@ -11,4 +11,4 @@ public void RestartApp() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md index f46db4d..eeccec0 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveAppAllSettings.md @@ -11,4 +11,4 @@ public void SaveAppAllSettings() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md index 8889290..9808308 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SavePluginSettings.md @@ -11,4 +11,4 @@ public void SavePluginSettings() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md index c2c2d9a..e68cc1d 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/SaveSettingJsonStorage.md @@ -16,4 +16,4 @@ public void SaveSettingJsonStorage() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md index ef2b4b9..611a94c 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShellRun.md @@ -23,4 +23,4 @@ public void ShellRun(string cmd, string filename = "cmd.exe") * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md index 1a02160..e75fcc7 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMainWindow.md @@ -11,4 +11,4 @@ public void ShowMainWindow() * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md index fe21722..ffd7adc 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsg.md @@ -40,4 +40,4 @@ public void ShowMsg(string title, string subTitle, string iconPath, * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md index 053fe32..66f0443 100644 --- a/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md +++ b/API-Reference/Flow.Launcher.Plugin/IPublicAPI/ShowMsgError.md @@ -16,4 +16,4 @@ public void ShowMsgError(string title, string subTitle = "") * interface [IPublicAPI](../IPublicAPI.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md b/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md index 1dbee14..90e163a 100644 --- a/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md +++ b/API-Reference/Flow.Launcher.Plugin/IReloadable/ReloadData.md @@ -9,4 +9,4 @@ public void ReloadData() * interface [IReloadable](../IReloadable.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md b/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md index cfc3480..f1857ef 100644 --- a/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md +++ b/API-Reference/Flow.Launcher.Plugin/IResultUpdated/ResultsUpdated.md @@ -10,4 +10,4 @@ public event ResultUpdatedEventHandler ResultsUpdated; * interface [IResultUpdated](../IResultUpdated.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md b/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md index 8b600e3..88bdcf1 100644 --- a/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md +++ b/API-Reference/Flow.Launcher.Plugin/ISavable/Save.md @@ -9,4 +9,4 @@ public void Save() * interface [ISavable](../ISavable.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md b/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md index 26caeb2..28ad7b9 100644 --- a/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md +++ b/API-Reference/Flow.Launcher.Plugin/ISettingProvider.md @@ -14,4 +14,4 @@ public interface ISettingProvider * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md b/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md index cdd95b0..73e53e4 100644 --- a/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md +++ b/API-Reference/Flow.Launcher.Plugin/ISettingProvider/CreateSettingPanel.md @@ -9,4 +9,4 @@ public Control CreateSettingPanel() * interface [ISettingProvider](../ISettingProvider.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md index 6d943e5..444b49e 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/API.md @@ -12,4 +12,4 @@ public IPublicAPI API { get; set; } * class [PluginInitContext](../PluginInitContext.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md index b1967dc..47ba233 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/CurrentPluginMetadata.md @@ -10,4 +10,4 @@ public PluginMetadata CurrentPluginMetadata { get; } * class [PluginInitContext](../PluginInitContext.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md index 9aa32b7..42207e3 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginInitContext/PluginInitContext.md @@ -26,4 +26,4 @@ public PluginInitContext(PluginMetadata currentPluginMetadata, IPublicAPI api) * class [PluginInitContext](../PluginInitContext.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md index e31a974..2b7e3f5 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeyword.md @@ -9,4 +9,4 @@ public string ActionKeyword { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md index 0519681..f037a9d 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ActionKeywords.md @@ -9,4 +9,4 @@ public List ActionKeywords { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md index a62e8d2..e9c25ea 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Author.md @@ -9,4 +9,4 @@ public string Author { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md index 9f3cbbe..c375b5f 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/AvgQueryTime.md @@ -9,4 +9,4 @@ public long AvgQueryTime { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md index edb2a52..29c374b 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Description.md @@ -9,4 +9,4 @@ public string Description { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md index a1d136d..3b46193 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Disabled.md @@ -9,4 +9,4 @@ public bool Disabled { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md index 912a0be..400703d 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFileName.md @@ -9,4 +9,4 @@ public string ExecuteFileName { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md index 9674c17..83f6082 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ExecuteFilePath.md @@ -9,4 +9,4 @@ public string ExecuteFilePath { get; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md index b2a3555..7578d55 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ID.md @@ -9,4 +9,4 @@ public string ID { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md index a83cf18..c55321b 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/IcoPath.md @@ -9,4 +9,4 @@ public string IcoPath { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md index ea1fe20..139ef7e 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/InitTime.md @@ -11,4 +11,4 @@ public long InitTime { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md index 77556fc..fedc7a6 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Language.md @@ -9,4 +9,4 @@ public string Language { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md index 4ee00ee..925cdb1 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Name.md @@ -9,4 +9,4 @@ public string Name { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md index dac7625..87bc6d7 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginDirectory.md @@ -9,4 +9,4 @@ public string PluginDirectory { get; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md index a3c7658..2788d2e 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/PluginMetadata.md @@ -11,4 +11,4 @@ public PluginMetadata() * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md index fc6d370..f28cf84 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Priority.md @@ -9,4 +9,4 @@ public int Priority { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md index d7115bd..1320f3a 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/QueryCount.md @@ -9,4 +9,4 @@ public int QueryCount { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md index 72b2028..dc7fd45 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/ToString.md @@ -9,4 +9,4 @@ public override string ToString() * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md index 1f0ba5f..5899800 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Version.md @@ -9,4 +9,4 @@ public string Version { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md index 5e9e1f3..2293a48 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginMetadata/Website.md @@ -9,4 +9,4 @@ public string Website { get; set; } * class [PluginMetadata](../PluginMetadata.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md index 0550893..ae70a35 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/Equals.md @@ -9,4 +9,4 @@ public override bool Equals(object obj) * class [PluginPair](../PluginPair.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md index 9043d85..d3b5797 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/GetHashCode.md @@ -9,4 +9,4 @@ public override int GetHashCode() * class [PluginPair](../PluginPair.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md index d589f5a..56a64fb 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/Metadata.md @@ -10,4 +10,4 @@ public PluginMetadata Metadata { get; } * class [PluginPair](../PluginPair.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md index 78a3504..b96767b 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/Plugin.md @@ -10,4 +10,4 @@ public IAsyncPlugin Plugin { get; } * class [PluginPair](../PluginPair.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md index 27089e1..d8706d7 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/PluginPair.md @@ -11,4 +11,4 @@ public PluginPair() * class [PluginPair](../PluginPair.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md b/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md index 4dc90d6..5a1608d 100644 --- a/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md +++ b/API-Reference/Flow.Launcher.Plugin/PluginPair/ToString.md @@ -9,4 +9,4 @@ public override string ToString() * class [PluginPair](../PluginPair.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md index ee1ec44..11d0bec 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeyword.md @@ -9,4 +9,4 @@ public string ActionKeyword { get; set; } * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md index 74a0737..7848a5b 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/ActionKeywordSeparator.md @@ -11,4 +11,4 @@ public const string ActionKeywordSeparator; * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md index faa311b..0a4fd07 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/FirstSearch.md @@ -11,4 +11,4 @@ public string FirstSearch { get; } * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md b/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md index 85afd7f..7c9624b 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/GlobalPluginWildcardSign.md @@ -11,4 +11,4 @@ public const string GlobalPluginWildcardSign; * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/Query.md b/API-Reference/Flow.Launcher.Plugin/Query/Query.md index 5610ee7..5588432 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/Query.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/Query.md @@ -27,4 +27,4 @@ public Query(string rawQuery, string search, string[] terms, string[] searchTerm * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md b/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md index 448732c..b8875b7 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/RawQuery.md @@ -11,4 +11,4 @@ public string RawQuery { get; } * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/Search.md b/API-Reference/Flow.Launcher.Plugin/Query/Search.md index 6989ac0..cd60d03 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/Search.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/Search.md @@ -11,4 +11,4 @@ public string Search { get; } * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md b/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md index fe76627..97aa6fa 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/SearchTerms.md @@ -11,4 +11,4 @@ public string[] SearchTerms { get; set; } * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md index b44af74..65457b0 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/SecondSearch.md @@ -11,4 +11,4 @@ public string SecondSearch { get; } * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md index c77e449..035e35f 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/SecondToEndSearch.md @@ -11,4 +11,4 @@ public string SecondToEndSearch { get; } * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md b/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md index b502fa4..97babd1 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/TermSeparator.md @@ -11,4 +11,4 @@ public const string TermSeparator; * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md b/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md index d3764d8..475457b 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/ThirdSearch.md @@ -11,4 +11,4 @@ public string ThirdSearch { get; } * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Query/ToString.md b/API-Reference/Flow.Launcher.Plugin/Query/ToString.md index 2658416..ae5a95e 100644 --- a/API-Reference/Flow.Launcher.Plugin/Query/ToString.md +++ b/API-Reference/Flow.Launcher.Plugin/Query/ToString.md @@ -9,4 +9,4 @@ public override string ToString() * class [Query](../Query.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md b/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md index 66fef90..23199c7 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md +++ b/API-Reference/Flow.Launcher.Plugin/Result.IconDelegate.md @@ -9,4 +9,4 @@ public delegate ImageSource IconDelegate(); * class [Result](./Result.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Action.md b/API-Reference/Flow.Launcher.Plugin/Result/Action.md index 28c758f..998016e 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Action.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Action.md @@ -1,6 +1,6 @@ # Result.Action property -Delegate activated when result is been selected 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 ```csharp public Func Action { get; set; } @@ -12,4 +12,4 @@ public Func Action { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md b/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md index d813892..c2985cd 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/ActionKeywordAssigned.md @@ -11,4 +11,4 @@ public string ActionKeywordAssigned { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md b/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md index 658a1d6..3f5baa5 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/AutoCompleteText.md @@ -11,4 +11,4 @@ public string AutoCompleteText { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md b/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md index f696366..5212291 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/ContextData.md @@ -1,6 +1,6 @@ # Result.ContextData property -Additional data associate with this result As external information for ContextMenu +Additional data associated with this result As external information for ContextMenu ```csharp public object ContextData { get; set; } @@ -11,4 +11,4 @@ public object ContextData { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Equals.md b/API-Reference/Flow.Launcher.Plugin/Result/Equals.md index 7ac31db..f8a5c3b 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Equals.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Equals.md @@ -9,4 +9,4 @@ public override bool Equals(object obj) * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md b/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md index 2a327ab..af4ad6a 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/GetHashCode.md @@ -9,4 +9,4 @@ public override int GetHashCode() * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md b/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md index 36738e8..c70d43b 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Glyph.md @@ -12,4 +12,4 @@ public GlyphInfo Glyph { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md b/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md index 5b6ad17..55baf4c 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/IcoPath.md @@ -1,6 +1,6 @@ # Result.IcoPath property -Image Displayed on the result +Image Displayed on the result Relative Path to the Image FileGlyphInfo is prioritized if not null ```csharp public string IcoPath { get; set; } @@ -11,4 +11,4 @@ public string IcoPath { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Icon.md b/API-Reference/Flow.Launcher.Plugin/Result/Icon.md index 59a9052..8d08325 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Icon.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Icon.md @@ -12,4 +12,4 @@ public IconDelegate Icon; * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/OriginQuery.md b/API-Reference/Flow.Launcher.Plugin/Result/OriginQuery.md deleted file mode 100644 index 905b96a..0000000 --- a/API-Reference/Flow.Launcher.Plugin/Result/OriginQuery.md +++ /dev/null @@ -1,15 +0,0 @@ -# Result.OriginQuery property - -Query information associated with the result - -```csharp -public Query OriginQuery { get; set; } -``` - -## See Also - -* class [Query](../Query.md) -* class [Result](../Result.md) -* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - - diff --git a/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md b/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md index 1635563..d64eb16 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/PluginDirectory.md @@ -11,4 +11,4 @@ public string PluginDirectory { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md b/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md index 1ee56be..6a6343c 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/PluginID.md @@ -11,4 +11,4 @@ public string PluginID { get; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Result.md b/API-Reference/Flow.Launcher.Plugin/Result/Result.md index d7550cd..ba8845d 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Result.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Result.md @@ -11,4 +11,4 @@ public Result() * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Score.md b/API-Reference/Flow.Launcher.Plugin/Result/Score.md index 71b142f..3a0448a 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Score.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Score.md @@ -11,4 +11,4 @@ public int Score { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md b/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md index 18e8d30..7058122 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/SubTitle.md @@ -11,4 +11,4 @@ public string SubTitle { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/SubTitleHighlightData.md b/API-Reference/Flow.Launcher.Plugin/Result/SubTitleHighlightData.md deleted file mode 100644 index c7e0ef8..0000000 --- a/API-Reference/Flow.Launcher.Plugin/Result/SubTitleHighlightData.md +++ /dev/null @@ -1,14 +0,0 @@ -# Result.SubTitleHighlightData property - -A list of indexes for the characters to be highlighted in SubTitle - -```csharp -public IList SubTitleHighlightData { get; set; } -``` - -## See Also - -* class [Result](../Result.md) -* namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - - diff --git a/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md b/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md index 78f9734..a9f652b 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/SubTitleToolTip.md @@ -11,4 +11,4 @@ public string SubTitleToolTip { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/Title.md b/API-Reference/Flow.Launcher.Plugin/Result/Title.md index 2f338c5..1e714cc 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/Title.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/Title.md @@ -11,4 +11,4 @@ public string Title { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md b/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md index c8a2774..76c82dc 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/TitleHighlightData.md @@ -11,4 +11,4 @@ public IList TitleHighlightData { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md b/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md index 0d9f592..2b54b9b 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/TitleToolTip.md @@ -11,4 +11,4 @@ public string TitleToolTip { get; set; } * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/Result/ToString.md b/API-Reference/Flow.Launcher.Plugin/Result/ToString.md index 9c6da8a..df651ac 100644 --- a/API-Reference/Flow.Launcher.Plugin/Result/ToString.md +++ b/API-Reference/Flow.Launcher.Plugin/Result/ToString.md @@ -9,4 +9,4 @@ public override string ToString() * class [Result](../Result.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md b/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md index 5a6d384..76f8617 100644 --- a/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md +++ b/API-Reference/Flow.Launcher.Plugin/ResultItemDropEventHandler.md @@ -10,4 +10,4 @@ public delegate void ResultItemDropEventHandler(Result result, IDataObject dropO * class [Result](./Result.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md index 4c6b8d8..fd78834 100644 --- a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Query.md @@ -10,4 +10,4 @@ public Query Query; * class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md index fa46b68..5972cc4 100644 --- a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/ResultUpdatedEventArgs.md @@ -11,4 +11,4 @@ public ResultUpdatedEventArgs() * class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md index 9b45ae0..1e30af2 100644 --- a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Results.md @@ -10,4 +10,4 @@ public List Results; * class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md index 50778e1..cb70027 100644 --- a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs/Token.md @@ -9,4 +9,4 @@ public CancellationToken Token { get; set; } * class [ResultUpdatedEventArgs](../ResultUpdatedEventArgs.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md index 53e02e1..63d075f 100644 --- a/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md +++ b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventHandler.md @@ -10,4 +10,4 @@ public delegate void ResultUpdatedEventHandler(IResultUpdated sender, ResultUpda * class [ResultUpdatedEventArgs](./ResultUpdatedEventArgs.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md index 9fe5c3d..535406a 100644 --- a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/AltPressed.md @@ -9,4 +9,4 @@ public bool AltPressed { get; set; } * class [SpecialKeyState](../SpecialKeyState.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md index 3daa1c7..5356387 100644 --- a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/CtrlPressed.md @@ -9,4 +9,4 @@ public bool CtrlPressed { get; set; } * class [SpecialKeyState](../SpecialKeyState.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md index 7ec1b3e..d3ed62c 100644 --- a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/ShiftPressed.md @@ -9,4 +9,4 @@ public bool ShiftPressed { get; set; } * class [SpecialKeyState](../SpecialKeyState.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md index e0105c7..473285b 100644 --- a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/SpecialKeyState.md @@ -11,4 +11,4 @@ public SpecialKeyState() * class [SpecialKeyState](../SpecialKeyState.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md index 255018c..cddfc8f 100644 --- a/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md +++ b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState/WinPressed.md @@ -9,4 +9,4 @@ public bool WinPressed { get; set; } * class [SpecialKeyState](../SpecialKeyState.md) * namespace [Flow.Launcher.Plugin](../../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/actioncontext.md b/API-Reference/Flow.Launcher.Plugin/actioncontext.md index 729ad2b..3bdbee3 100644 --- a/API-Reference/Flow.Launcher.Plugin/actioncontext.md +++ b/API-Reference/Flow.Launcher.Plugin/actioncontext.md @@ -15,4 +15,4 @@ public class ActionContext * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md b/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md index 6436add..09ef0ad 100644 --- a/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md +++ b/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md @@ -19,4 +19,4 @@ public static class AllowedLanguage * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/basemodel.md b/API-Reference/Flow.Launcher.Plugin/basemodel.md index a6fb79f..fc8b9cd 100644 --- a/API-Reference/Flow.Launcher.Plugin/basemodel.md +++ b/API-Reference/Flow.Launcher.Plugin/basemodel.md @@ -21,4 +21,4 @@ public class BaseModel : INotifyPropertyChanged * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md b/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md index f7f5c3e..3ad0121 100644 --- a/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md +++ b/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md @@ -16,4 +16,4 @@ public class FlowLauncherKeyDownEventArgs * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md b/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md index 8b45a50..4af8369 100644 --- a/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md +++ b/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md @@ -15,4 +15,4 @@ public class FlowLauncherQueryEventArgs * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md b/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md index 31a612f..2b91e68 100644 --- a/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md +++ b/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md @@ -17,4 +17,4 @@ public interface IAsyncPlugin * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md b/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md index 65c6320..c666109 100644 --- a/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md +++ b/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md @@ -17,4 +17,4 @@ public interface IAsyncReloadable : IFeatures * interface [IFeatures](./IFeatures.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/icontextmenu.md b/API-Reference/Flow.Launcher.Plugin/icontextmenu.md index d62de37..8d73421 100644 --- a/API-Reference/Flow.Launcher.Plugin/icontextmenu.md +++ b/API-Reference/Flow.Launcher.Plugin/icontextmenu.md @@ -15,4 +15,4 @@ public interface IContextMenu : IFeatures * interface [IFeatures](./IFeatures.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ifeatures.md b/API-Reference/Flow.Launcher.Plugin/ifeatures.md index 448c836..b6f56ce 100644 --- a/API-Reference/Flow.Launcher.Plugin/ifeatures.md +++ b/API-Reference/Flow.Launcher.Plugin/ifeatures.md @@ -10,4 +10,4 @@ public interface IFeatures * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/iplugin.md b/API-Reference/Flow.Launcher.Plugin/iplugin.md index 7779fa1..2309e26 100644 --- a/API-Reference/Flow.Launcher.Plugin/iplugin.md +++ b/API-Reference/Flow.Launcher.Plugin/iplugin.md @@ -20,4 +20,4 @@ public interface IPlugin : IAsyncPlugin * interface [IAsyncPlugin](./IAsyncPlugin.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/iplugini18n.md b/API-Reference/Flow.Launcher.Plugin/iplugini18n.md index fac1b1c..aaee16c 100644 --- a/API-Reference/Flow.Launcher.Plugin/iplugini18n.md +++ b/API-Reference/Flow.Launcher.Plugin/iplugini18n.md @@ -19,4 +19,4 @@ public interface IPluginI18n : IFeatures * interface [IFeatures](./IFeatures.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ipublicapi.md b/API-Reference/Flow.Launcher.Plugin/ipublicapi.md index 67ecf9b..15472e2 100644 --- a/API-Reference/Flow.Launcher.Plugin/ipublicapi.md +++ b/API-Reference/Flow.Launcher.Plugin/ipublicapi.md @@ -45,4 +45,4 @@ public interface IPublicAPI * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/ireloadable.md b/API-Reference/Flow.Launcher.Plugin/ireloadable.md index 3a37da3..85586a8 100644 --- a/API-Reference/Flow.Launcher.Plugin/ireloadable.md +++ b/API-Reference/Flow.Launcher.Plugin/ireloadable.md @@ -19,4 +19,4 @@ public interface IReloadable : IFeatures * interface [IFeatures](./IFeatures.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/iresultupdated.md b/API-Reference/Flow.Launcher.Plugin/iresultupdated.md index a0a4e4b..4ad9e75 100644 --- a/API-Reference/Flow.Launcher.Plugin/iresultupdated.md +++ b/API-Reference/Flow.Launcher.Plugin/iresultupdated.md @@ -15,4 +15,4 @@ public interface IResultUpdated : IFeatures * interface [IFeatures](./IFeatures.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/isavable.md b/API-Reference/Flow.Launcher.Plugin/isavable.md index 6815b2c..71c8e0b 100644 --- a/API-Reference/Flow.Launcher.Plugin/isavable.md +++ b/API-Reference/Flow.Launcher.Plugin/isavable.md @@ -17,4 +17,4 @@ public interface ISavable : IFeatures * interface [IFeatures](./IFeatures.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md b/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md index e7f4d31..85e3023 100644 --- a/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md +++ b/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md @@ -17,4 +17,4 @@ public class PluginInitContext * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md b/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md index 4966136..eac5d0e 100644 --- a/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md +++ b/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md @@ -34,4 +34,4 @@ public class PluginMetadata : BaseModel * class [BaseModel](./BaseModel.md) * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/pluginpair.md b/API-Reference/Flow.Launcher.Plugin/pluginpair.md index ccce457..c9d1ca6 100644 --- a/API-Reference/Flow.Launcher.Plugin/pluginpair.md +++ b/API-Reference/Flow.Launcher.Plugin/pluginpair.md @@ -19,4 +19,4 @@ public class PluginPair * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/query.md b/API-Reference/Flow.Launcher.Plugin/query.md index 29a64d1..5ddba79 100644 --- a/API-Reference/Flow.Launcher.Plugin/query.md +++ b/API-Reference/Flow.Launcher.Plugin/query.md @@ -27,4 +27,4 @@ public class Query * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/result.md b/API-Reference/Flow.Launcher.Plugin/result.md index a951868..cbeca3d 100644 --- a/API-Reference/Flow.Launcher.Plugin/result.md +++ b/API-Reference/Flow.Launcher.Plugin/result.md @@ -9,18 +9,16 @@ public class Result | name | description | | --- | --- | | [Result](Result/Result.md)() | The default constructor. | -| [Action](Result/Action.md) { get; set; } | Delegate activated when result is been selected true to hide flowlauncher after select result | +| [Action](Result/Action.md) { get; set; } | 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 | | [ActionKeywordAssigned](Result/ActionKeywordAssigned.md) { get; set; } | This holds the action keyword that triggered the result. If result is triggered by global keyword: *, this should be empty. | | [AutoCompleteText](Result/AutoCompleteText.md) { get; set; } | This holds the text which can be provided by plugin to help Flow autocomplete text for user on the plugin result. If autocomplete action for example is tab, pressing tab will have the default constructed autocomplete text (result's Title), or the text provided here if not empty. | -| [ContextData](Result/ContextData.md) { get; set; } | Additional data associate with this result As external information for ContextMenu | +| [ContextData](Result/ContextData.md) { get; set; } | Additional data associated with this result As external information for ContextMenu | | [Glyph](Result/Glyph.md) { get; set; } | Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons) | -| [IcoPath](Result/IcoPath.md) { get; set; } | Image Displayed on the result | -| [OriginQuery](Result/OriginQuery.md) { get; set; } | Query information associated with the result | +| [IcoPath](Result/IcoPath.md) { get; set; } | Image Displayed on the result Relative Path to the Image FileGlyphInfo is prioritized if not null | | [PluginDirectory](Result/PluginDirectory.md) { get; set; } | Plugin directory | | [PluginID](Result/PluginID.md) { get; } | Plugin ID that generated this result | | [Score](Result/Score.md) { get; set; } | Priority of the current result default: 0 | | [SubTitle](Result/SubTitle.md) { get; set; } | Provides additional details for the result. This is optional | -| [SubTitleHighlightData](Result/SubTitleHighlightData.md) { get; set; } | A list of indexes for the characters to be highlighted in SubTitle | | [SubTitleToolTip](Result/SubTitleToolTip.md) { get; set; } | Show message as ToolTip on result SubTitle hover over | | [Title](Result/Title.md) { get; set; } | The title of the result. This is always required. | | [TitleHighlightData](Result/TitleHighlightData.md) { get; set; } | A list of indexes for the characters to be highlighted in Title | @@ -35,4 +33,4 @@ public class Result * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md b/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md index 573af73..58810cd 100644 --- a/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md +++ b/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md @@ -17,4 +17,4 @@ public class ResultUpdatedEventArgs : EventArgs * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/Flow.Launcher.Plugin/specialkeystate.md b/API-Reference/Flow.Launcher.Plugin/specialkeystate.md index 9a0577e..d395f62 100644 --- a/API-Reference/Flow.Launcher.Plugin/specialkeystate.md +++ b/API-Reference/Flow.Launcher.Plugin/specialkeystate.md @@ -18,4 +18,4 @@ public class SpecialKeyState * namespace [Flow.Launcher.Plugin](../Flow.Launcher.Plugin.md) - + diff --git a/API-Reference/README.md b/API-Reference/README.md deleted file mode 100644 index c8cbe4b..0000000 --- a/API-Reference/README.md +++ /dev/null @@ -1,3 +0,0 @@ -## API Reference - -- [Flow.Launcher.Plugin](Flow.Launcher.Plugin.md) \ No newline at end of file From 2c53b15a9be1b73d9f1d9f7cf6b4f688f8ef854b Mon Sep 17 00:00:00 2001 From: Hongtao Zhang Date: Sun, 2 Jan 2022 22:08:46 -0600 Subject: [PATCH 7/8] Change CaseInsensitive to CaseSensitive --- .../Flow.Launcher.Plugin/{actioncontext.md => ActionContext.md} | 0 .../{allowedlanguage.md => AllowedLanguage.md} | 0 API-Reference/Flow.Launcher.Plugin/{basemodel.md => BaseModel.md} | 0 ...auncherkeydowneventargs.md => FlowLauncherKeyDownEventArgs.md} | 0 ...lowlauncherqueryeventargs.md => FlowLauncherQueryEventArgs.md} | 0 .../Flow.Launcher.Plugin/{iasyncplugin.md => IAsyncPlugin.md} | 0 .../{iasyncreloadable.md => IAsyncReloadable.md} | 0 .../Flow.Launcher.Plugin/{icontextmenu.md => IContextMenu.md} | 0 API-Reference/Flow.Launcher.Plugin/{ifeatures.md => IFeatures.md} | 0 API-Reference/Flow.Launcher.Plugin/{iplugin.md => IPlugin.md} | 0 .../Flow.Launcher.Plugin/{iplugini18n.md => IPluginI18n.md} | 0 .../Flow.Launcher.Plugin/{ipublicapi.md => IPublicAPI.md} | 0 .../Flow.Launcher.Plugin/{ireloadable.md => IReloadable.md} | 0 .../Flow.Launcher.Plugin/{iresultupdated.md => IResultUpdated.md} | 0 API-Reference/Flow.Launcher.Plugin/{isavable.md => ISavable.md} | 0 .../{plugininitcontext.md => PluginInitContext.md} | 0 .../Flow.Launcher.Plugin/{pluginmetadata.md => PluginMetadata.md} | 0 .../Flow.Launcher.Plugin/{pluginpair.md => PluginPair.md} | 0 API-Reference/Flow.Launcher.Plugin/{query.md => Query.md} | 0 API-Reference/Flow.Launcher.Plugin/{result.md => Result.md} | 0 .../{resultupdatedeventargs.md => ResultUpdatedEventArgs.md} | 0 .../{specialkeystate.md => SpecialKeyState.md} | 0 22 files changed, 0 insertions(+), 0 deletions(-) rename API-Reference/Flow.Launcher.Plugin/{actioncontext.md => ActionContext.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{allowedlanguage.md => AllowedLanguage.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{basemodel.md => BaseModel.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{flowlauncherkeydowneventargs.md => FlowLauncherKeyDownEventArgs.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{flowlauncherqueryeventargs.md => FlowLauncherQueryEventArgs.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{iasyncplugin.md => IAsyncPlugin.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{iasyncreloadable.md => IAsyncReloadable.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{icontextmenu.md => IContextMenu.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{ifeatures.md => IFeatures.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{iplugin.md => IPlugin.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{iplugini18n.md => IPluginI18n.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{ipublicapi.md => IPublicAPI.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{ireloadable.md => IReloadable.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{iresultupdated.md => IResultUpdated.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{isavable.md => ISavable.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{plugininitcontext.md => PluginInitContext.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{pluginmetadata.md => PluginMetadata.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{pluginpair.md => PluginPair.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{query.md => Query.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{result.md => Result.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{resultupdatedeventargs.md => ResultUpdatedEventArgs.md} (100%) rename API-Reference/Flow.Launcher.Plugin/{specialkeystate.md => SpecialKeyState.md} (100%) diff --git a/API-Reference/Flow.Launcher.Plugin/actioncontext.md b/API-Reference/Flow.Launcher.Plugin/ActionContext.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/actioncontext.md rename to API-Reference/Flow.Launcher.Plugin/ActionContext.md diff --git a/API-Reference/Flow.Launcher.Plugin/allowedlanguage.md b/API-Reference/Flow.Launcher.Plugin/AllowedLanguage.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/allowedlanguage.md rename to API-Reference/Flow.Launcher.Plugin/AllowedLanguage.md diff --git a/API-Reference/Flow.Launcher.Plugin/basemodel.md b/API-Reference/Flow.Launcher.Plugin/BaseModel.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/basemodel.md rename to API-Reference/Flow.Launcher.Plugin/BaseModel.md diff --git a/API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/flowlauncherkeydowneventargs.md rename to API-Reference/Flow.Launcher.Plugin/FlowLauncherKeyDownEventArgs.md diff --git a/API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md b/API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/flowlauncherqueryeventargs.md rename to API-Reference/Flow.Launcher.Plugin/FlowLauncherQueryEventArgs.md diff --git a/API-Reference/Flow.Launcher.Plugin/iasyncplugin.md b/API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/iasyncplugin.md rename to API-Reference/Flow.Launcher.Plugin/IAsyncPlugin.md diff --git a/API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md b/API-Reference/Flow.Launcher.Plugin/IAsyncReloadable.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/iasyncreloadable.md rename to API-Reference/Flow.Launcher.Plugin/IAsyncReloadable.md diff --git a/API-Reference/Flow.Launcher.Plugin/icontextmenu.md b/API-Reference/Flow.Launcher.Plugin/IContextMenu.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/icontextmenu.md rename to API-Reference/Flow.Launcher.Plugin/IContextMenu.md diff --git a/API-Reference/Flow.Launcher.Plugin/ifeatures.md b/API-Reference/Flow.Launcher.Plugin/IFeatures.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/ifeatures.md rename to API-Reference/Flow.Launcher.Plugin/IFeatures.md diff --git a/API-Reference/Flow.Launcher.Plugin/iplugin.md b/API-Reference/Flow.Launcher.Plugin/IPlugin.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/iplugin.md rename to API-Reference/Flow.Launcher.Plugin/IPlugin.md diff --git a/API-Reference/Flow.Launcher.Plugin/iplugini18n.md b/API-Reference/Flow.Launcher.Plugin/IPluginI18n.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/iplugini18n.md rename to API-Reference/Flow.Launcher.Plugin/IPluginI18n.md diff --git a/API-Reference/Flow.Launcher.Plugin/ipublicapi.md b/API-Reference/Flow.Launcher.Plugin/IPublicAPI.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/ipublicapi.md rename to API-Reference/Flow.Launcher.Plugin/IPublicAPI.md diff --git a/API-Reference/Flow.Launcher.Plugin/ireloadable.md b/API-Reference/Flow.Launcher.Plugin/IReloadable.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/ireloadable.md rename to API-Reference/Flow.Launcher.Plugin/IReloadable.md diff --git a/API-Reference/Flow.Launcher.Plugin/iresultupdated.md b/API-Reference/Flow.Launcher.Plugin/IResultUpdated.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/iresultupdated.md rename to API-Reference/Flow.Launcher.Plugin/IResultUpdated.md diff --git a/API-Reference/Flow.Launcher.Plugin/isavable.md b/API-Reference/Flow.Launcher.Plugin/ISavable.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/isavable.md rename to API-Reference/Flow.Launcher.Plugin/ISavable.md diff --git a/API-Reference/Flow.Launcher.Plugin/plugininitcontext.md b/API-Reference/Flow.Launcher.Plugin/PluginInitContext.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/plugininitcontext.md rename to API-Reference/Flow.Launcher.Plugin/PluginInitContext.md diff --git a/API-Reference/Flow.Launcher.Plugin/pluginmetadata.md b/API-Reference/Flow.Launcher.Plugin/PluginMetadata.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/pluginmetadata.md rename to API-Reference/Flow.Launcher.Plugin/PluginMetadata.md diff --git a/API-Reference/Flow.Launcher.Plugin/pluginpair.md b/API-Reference/Flow.Launcher.Plugin/PluginPair.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/pluginpair.md rename to API-Reference/Flow.Launcher.Plugin/PluginPair.md diff --git a/API-Reference/Flow.Launcher.Plugin/query.md b/API-Reference/Flow.Launcher.Plugin/Query.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/query.md rename to API-Reference/Flow.Launcher.Plugin/Query.md diff --git a/API-Reference/Flow.Launcher.Plugin/result.md b/API-Reference/Flow.Launcher.Plugin/Result.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/result.md rename to API-Reference/Flow.Launcher.Plugin/Result.md diff --git a/API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md b/API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/resultupdatedeventargs.md rename to API-Reference/Flow.Launcher.Plugin/ResultUpdatedEventArgs.md diff --git a/API-Reference/Flow.Launcher.Plugin/specialkeystate.md b/API-Reference/Flow.Launcher.Plugin/SpecialKeyState.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin/specialkeystate.md rename to API-Reference/Flow.Launcher.Plugin/SpecialKeyState.md From 68dcbd5763812ca9b1990e17ea3e0c98606f7177 Mon Sep 17 00:00:00 2001 From: Hongtao Zhang Date: Sun, 2 Jan 2022 22:48:27 -0600 Subject: [PATCH 8/8] fix case insensitive 2 --- .../{filesfolders.md => FilesFolders.md} | 0 .../{searchweb.md => SearchWeb.md} | 0 .../{shellcommand.md => ShellCommand.md} | 0 .../{matchresult.md => MatchResult.md} | 0 .../{searchprecisionscore.md => SearchPrecisionScore.md} | 0 5 files changed, 0 insertions(+), 0 deletions(-) rename API-Reference/Flow.Launcher.Plugin.SharedCommands/{filesfolders.md => FilesFolders.md} (100%) rename API-Reference/Flow.Launcher.Plugin.SharedCommands/{searchweb.md => SearchWeb.md} (100%) rename API-Reference/Flow.Launcher.Plugin.SharedCommands/{shellcommand.md => ShellCommand.md} (100%) rename API-Reference/Flow.Launcher.Plugin.SharedModels/{matchresult.md => MatchResult.md} (100%) rename API-Reference/Flow.Launcher.Plugin.SharedModels/{searchprecisionscore.md => SearchPrecisionScore.md} (100%) diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin.SharedCommands/filesfolders.md rename to API-Reference/Flow.Launcher.Plugin.SharedCommands/FilesFolders.md diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin.SharedCommands/searchweb.md rename to API-Reference/Flow.Launcher.Plugin.SharedCommands/SearchWeb.md diff --git a/API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md b/API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin.SharedCommands/shellcommand.md rename to API-Reference/Flow.Launcher.Plugin.SharedCommands/ShellCommand.md diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin.SharedModels/matchresult.md rename to API-Reference/Flow.Launcher.Plugin.SharedModels/MatchResult.md diff --git a/API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md b/API-Reference/Flow.Launcher.Plugin.SharedModels/SearchPrecisionScore.md similarity index 100% rename from API-Reference/Flow.Launcher.Plugin.SharedModels/searchprecisionscore.md rename to API-Reference/Flow.Launcher.Plugin.SharedModels/SearchPrecisionScore.md