Plugin API
日本語
日本語
  • 入門
    • 概要
    • あなたの最初のプラグイン
    • ファイル構造概要
    • プラグインタイプ
      • ウィンドウ
      • バックグラウンドサービス
      • フォーマット拡張
      • インスペクター
    • プラグインのデバッグ
  • 配布
    • プラグインの準備
    • プラグインパッケージ
    • プラグインを公開する
    • プラグインを更新する
    • 開発者ポリシー
    • Plugin Icon Teamplate
  • 開発ガイド
    • manifest.json 設定
    • データ取得
    • データ変更
    • ローカルファイルへのアクセス
    • ネットワークリクエストの送信
    • Node.js ネイティブ API の使用
    • サードパーティモジュールの使用
    • 多言語対応(i18n)
    • フレームレスウィンドウ
  • API 参照
    • event(イベント)
    • item(項目)
    • folder(フォルダー)
    • tag(タグ)
    • tagGroup(タグ グループ)
    • library(ライブラリ)
    • window(ウィンドウ)
    • app(アプリケーション)
    • os(オペレーティングシステム)
    • screen(スクリーン)
    • notification(通知)
    • contextMenu(コンテキストメニュー)
    • dialog(ダイアログ)
    • clipboard(クリップボード)
    • drag(ドラッグファイル)
    • shell(シェル)
    • log(ログ)
  • 追加モジュール
    • FFmpeg
GitBook提供
このページ内
  • onPluginCreate(callback)
  • onPluginRun(callback)
  • onPluginBeforeExit(callback)
  • onPluginShow(callback)
  • onPluginHide(callback)
  • onLibraryChanged(callback)
  • onThemeChanged(callback)
  1. API 参照

event(イベント)

必要に応じて、事前にいくつかのコールバック関数を定義しておくことができます。Eagleはイベントが発生した際にそれらを自動的に呼び出します。

onPluginCreate(callback)

プラグインウィンドウが作成されたとき、Eagleはこのメソッドを自動的に呼び出します。このメソッドを使用して、プラグインが必要なモジュールを初期化できます。

  • callback Function

    • plugin Object - プラグイン属性

      • manifest Object - プラグイン manifest.json の完全な設定。

      • path String - プラグインのパス

eagle.onPluginCreate((plugin) => {
    console.log(plugin.manifest.name);
    console.log(plugin.manifest.version);
    console.log(plugin.manifest.logo);
    console.log(plugin.path);
});

ヒント:プラグインが manifest 情報なしで実行できる場合、window.onload を使用して開発を進めることもできます。

onPluginRun(callback)

ユーザーがプラグインパネルのプラグインをクリックすると、Eagleはこのメソッドを自動的に呼び出します。

  • callback Function

eagle.onPluginRun(() => {
    console.log('eagle.onPluginRun');
});

onPluginBeforeExit(callback)

プラグインウィンドウが閉じる前に、Eagleはこのメソッドを自動的に呼び出します。

  • callback Function

eagle.onPluginBeforeExit(() => {
    console.log("プラグインが終了します");
});

// ウィンドウのクローズを阻止
window.onbeforeunload = (event) => {
    return event.returnValue = false;
};

ヒント:ウィンドウのクローズを防ぎたい場合は、window.onbeforeunload メソッドを登録してウィンドウが閉じられないようにできます。

onPluginShow(callback)

プラグインウィンドウが表示されるとき、Eagleはこのメソッドを自動的に呼び出します。

  • callback Function

eagle.onPluginShow(() => {
    console.log("プラグインウィンドウが表示されました");
});

onPluginHide(callback)

プラグインウィンドウが隠れるとき、Eagleはこのメソッドを自動的に呼び出します。

  • callback Function

eagle.onPluginHide(() => {
    console.log("プラグインウィンドウが隠れました");
});

onLibraryChanged(callback)

ユーザーがリソースライブラリを切り替えると、Eagleはこのメソッドを自動的に呼び出します。

  • callback Function

    • libraryPath String - 現在のリソースライブラリのパス。

eagle.onLibraryChanged((libraryPath) => {
    console.log(`リソースライブラリの切り替えが検出されました。新しいリソースライブラリのパス: ${libraryPath}`);
});

ヒント:より完全なリソースライブラリ情報が必要な場合は、eagle.library.info() メソッドを使用できます。

注意: プラグインの実行過程で相対的なリソースライブラリパスに依存する場合、この方法を登録してリソースライブラリが切り替えられたときに対応する調整を行い、プログラムの実行過程でエラーが発生しないようにする必要があります。

onThemeChanged(callback)

Eagle メインプログラムのテーマカラーが変更されると、Eagle はこのメソッドを自動的に呼び出します。プラグインが複数のカラーテーマに対応している場合、このメソッドを使用して対応する UI の調整を行うことができます。

  • callback 関数

    • theme String - 現在のテーマカラーの名前。Auto、LIGHT、LIGHTGRAY、GRAY、DARK、BLUE、PURPLE など。

eagle.onThemeChanged((theme) => {
    console.log(`配色テーマが次のように変更されました: ${theme}`);
});

前へフレームレスウィンドウ次へitem(項目)

最終更新 1 年前