mirror of
https://github.com/microsoft/PowerToys.git
synced 2024-12-15 20:19:17 +08:00
129 lines
3.9 KiB
C#
129 lines
3.9 KiB
C#
using System.Collections.Generic;
|
|
|
|
namespace Wox.Plugin
|
|
{
|
|
/// <summary>
|
|
/// Public APIs that plugin can use
|
|
/// </summary>
|
|
public interface IPublicAPI
|
|
{
|
|
/// <summary>
|
|
/// Push result to query box
|
|
/// </summary>
|
|
/// <param name="query"></param>
|
|
/// <param name="plugin"></param>
|
|
/// <param name="results"></param>
|
|
void PushResults(Query query, PluginMetadata plugin, List<Result> results);
|
|
|
|
/// <summary>
|
|
/// Show context menu with giving results
|
|
/// </summary>
|
|
/// <param name="results"></param>
|
|
void ShowContextMenu(PluginMetadata plugin, List<Result> results);
|
|
|
|
/// <summary>
|
|
/// Execute command
|
|
/// a replacement to RUN(win+r) function
|
|
/// </summary>
|
|
/// <param name="cmd">command that want to execute</param>
|
|
/// <param name="runAsAdministrator">run as administrator</param>
|
|
/// <returns></returns>
|
|
bool ShellRun(string cmd, bool runAsAdministrator = false);
|
|
|
|
/// <summary>
|
|
/// Change Wox query
|
|
/// </summary>
|
|
/// <param name="query">query text</param>
|
|
/// <param name="requery">
|
|
/// force requery By default, Wox will not fire query if your query is same with existing one.
|
|
/// Set this to true to force Wox requerying
|
|
/// </param>
|
|
void ChangeQuery(string query, bool requery = false);
|
|
|
|
/// <summary>
|
|
/// Just change the query text, this won't raise search
|
|
/// </summary>
|
|
/// <param name="query"></param>
|
|
void ChangeQueryText(string query, bool selectAll = false);
|
|
|
|
/// <summary>
|
|
/// Close Wox
|
|
/// </summary>
|
|
void CloseApp();
|
|
|
|
/// <summary>
|
|
/// Hide Wox
|
|
/// </summary>
|
|
void HideApp();
|
|
|
|
/// <summary>
|
|
/// Show Wox
|
|
/// </summary>
|
|
void ShowApp();
|
|
|
|
/// <summary>
|
|
/// Show message box
|
|
/// </summary>
|
|
/// <param name="title">Message title</param>
|
|
/// <param name="subTitle">Message subtitle</param>
|
|
/// <param name="iconPath">Message icon path (relative path to your plugin folder)</param>
|
|
void ShowMsg(string title, string subTitle = "", string iconPath = "");
|
|
|
|
/// <summary>
|
|
/// Open setting dialog
|
|
/// </summary>
|
|
void OpenSettingDialog(string tabName = "general");
|
|
|
|
/// <summary>
|
|
/// Show loading animation
|
|
/// </summary>
|
|
void StartLoadingBar();
|
|
|
|
/// <summary>
|
|
/// Stop loading animation
|
|
/// </summary>
|
|
void StopLoadingBar();
|
|
|
|
/// <summary>
|
|
/// Install Wox plugin
|
|
/// </summary>
|
|
/// <param name="path">Plugin path (ends with .wox)</param>
|
|
void InstallPlugin(string path);
|
|
|
|
/// <summary>
|
|
/// Reload all plugins
|
|
/// </summary>
|
|
void ReloadPlugins();
|
|
|
|
/// <summary>
|
|
/// Get translation of current language
|
|
/// You need to implement IPluginI18n if you want to support multiple languages for your plugin
|
|
/// </summary>
|
|
/// <param name="key"></param>
|
|
/// <returns></returns>
|
|
string GetTranslation(string key);
|
|
|
|
/// <summary>
|
|
/// Get all loaded plugins
|
|
/// </summary>
|
|
/// <returns></returns>
|
|
List<PluginPair> GetAllPlugins();
|
|
|
|
/// <summary>
|
|
/// Fired after Back key down in the Wox query box
|
|
/// </summary>
|
|
event WoxKeyDownEventHandler BackKeyDownEvent;
|
|
|
|
/// <summary>
|
|
/// Fired after global keyboard events
|
|
/// if you want to hook something like Ctrl+R, you should use this event
|
|
/// </summary>
|
|
event WoxGlobalKeyboardEventHandler GlobalKeyboardEvent;
|
|
|
|
/// <summary>
|
|
/// Fired after drop to result item of current plugin
|
|
/// </summary>
|
|
event ResultItemDropEventHandler ResultItemDropEvent;
|
|
}
|
|
}
|