updated PLUGIN.ja.txt.

git-svn-id: svn://sylpheed.sraoss.jp/sylpheed/trunk@2175 ee746299-78ed-0310-b773-934348b2243d

1 files changed, 49 insertions, 0 deletions

diff --git a/PLUGIN.ja.txt b/PLUGIN.ja.txt
index dd74e3b0..335aa9bc 100644
--- a/PLUGIN.ja.txt
+++ b/PLUGIN.ja.txt
@@ -32,6 +32,7 @@ GObject のシグナル機構を利用して、特定のイベントが発生し
 Sylpheed から利用する関数
 -------------------------
 
+-------------------------------------------------------------------------
 gint syl_plugin_init_lib        (void);
 
 libsylpheed-plugin-0 ライブラリの初期化を行います。
@@ -71,10 +72,44 @@ gint syl_plugin_add_symbol              (const gchar *name, gpointer sym);
 gpointer syl_plugin_lookup_symbol       (const gchar *name);
 
 syl_plugin_add_symbol() で登録したシンボルを検索し、ポインタ値を返します。
+-------------------------------------------------------------------------
+
+
+プラグインが実装しなければならない関数
+--------------------------------------
+
+-------------------------------------------------------------------------
+void plugin_load(void)
+
+プラグインのロード時に Sylpheed から呼び出されます。
+ここでプラグインの初期化処理などを行います。
+
+-------------------------------------------------------------------------
+void plugin_unload(void)
+
+プラグインのアンロード時に Sylpheed から呼び出されます。
+ここでプラグインの後処理などを行います。
+
+-------------------------------------------------------------------------
+SylPluginInfo *plugin_info(void)
+
+プラグインの情報を格納する構造体を Sylpheed に返すための関数です。
+通常は静的な構造体へのポインタを返します。
+
+-------------------------------------------------------------------------
+gint plugin_interface_version(void)
+
+プラグイン API のインタフェースのバージョンを Sylpheed に返すための
+関数です。プラグインでは通常 SYL_PLUGIN_INTERFACE_VERSION を返し、
+Sylpheed ではこれが Sylpheed 本体側の値と一致するかどうかチェックします。
+
+-------------------------------------------------------------------------
+
 
 プラグインから利用する関数
 --------------------------
 
+
 シグナルの一覧
 --------------
 
@@ -83,3 +118,17 @@ syl_plugin_add_symbol() で登録したシンボルを検索し、ポインタ�
 サンプルプラグイン
 ==================
 
+plugin/test にサンプルプラグインがあります。このプラグインは
+make install ではインストールされません。インストールするには
+plugin/test ディレクトリに入って make install-plugin を実行してください。
+
+test プラグインは Sylpheed プラグインの基本的な構造に加え、以下の処理を
+行います。
+
+- ロード時に標準出力に "test plug-in loaded!" という文字列を出力
+- フォルダの一覧を取得し、標準出力に表示
+- Sylpheed のバージョン文字列を取得し、標準出力に表示
+- メインウィンドウを取得し、前面に出す
+- 「ツール」メニューに「Plugin test」メニュー項目を追加
+- 「Plugin test」メニューを選択すると、「Click this to quit」という
+  ボタンのみのウィンドウを表示し、クリックすると Sylpheed を終了する