公開中ソフトウェア/さっとメモ/プラグインについて - LineSoftware

プラグインについて(TTSneoユーザー向け)

　プラグインというよりかは、スクリプトという感じですが、さっとメモではプラグインと呼んでいます。

事前知識

注意点

• さっとメモのプラグインは、すべて目に見えるインターフェイスを提供するものです。したがって、ライブラリのように単体では動作しないものは作成できません。
• インターフェイスは「パネル」と呼ばれる領域で設計します。このパネルは、プラグインごとで独立しています。
• パネルはピクチャーオブジェクトで作成します。
• ただ「参照」命令でプラグインを読み込んでいるだけなので、変数、手順、パネルのオブジェクト名が重複してしまう可能性があります。

プラグインに使うファイル

• さっとメモ\プラグイン
  • Plugin.ini
    • プラグインの名前、パネルの名前などを記録しています。削除するとさっとメモが使えないようになります。
  • PluginRegistar.exe
    • プラグインの情報をPlugin.iniに書き込み、プラグインを登録します。

Plugin.iniの構造

Plugin.iniの例：

[PluginList]・・・①
List=メモ検索,…
[メモ検索]・・・②
PluginFileName=標準_さっとメモ検索.tts・・・③
PluginName=メモ検索・・・④
CreatePanelProc=さっとメモ検索パネル生成・・・⑤
PanelName=さっとメモ検索・・・⑥
PluginVersion=1.0.0・・・⑦

・・・

• [PluginList] 項目の List：登録されているプラグインの一覧を配列形式で表します。この一覧に含まれるものだけパネルとして追加されます。
• [（プラグイン名）]：個々のプラグインの情報を記録しています。この項目名は１．のプラグインの一覧と対応しています。
• PluginFileName：プラグインのファイル名。フルパスではありません。（必須）
• PluginName：プラグインの名前。（必須）
• CreatePanelProc：パネルを生成する手順の名前。（必須）
• PanelName：パネルの名前。オブジェクト名。（必須）
• PluginVersion：プラグインのバージョン。現在は特に機能は持ちません。（任意）

PluginRegistar.exeの使い方

　PluginRegistar.exeはプラグインの登録のために使われます。
プラグインの情報を起動時の引数（コマンドライン）に指定しないと機能しません。

書き方：（改行は消してください）

「プラグイン\PluginRegistar.exe 
PluginName=プラグイン名,
PluginFileName=ファイル名,
CreatePanelProc=パネル生成手順,
PanelName=パネル名,
PluginVersion=バージョン」を起動

プラグイン機構の仕組み

※カッコ内はPlugin.iniでの位置を表します。

1. さっとメモがPlugin.iniからプラグインの一覧（PluginListのList項目）を取得し、プラグインの情報を読み込みます。
2. プラグインの情報を元に、指定されたttsファイル（PluginFileName項目）を参照します。
3. 指定されたパネルを生成する手順（CreatePanelProc項目）を実行します。
4. 指定されたパネル名（PanelName）でサイズを「相対位置」設定項目で調整します。
5. さっとメモの設定にしたがって、プラグインの枠と、グラデーションを描画します。
6. 完了

プラグインの作成方法

プログラミング方法

• 必ず１番最初にPluginRegistar.exeでプラグインを登録させる命令を記述してください。これにより、ttsファイルをダブルクリックするだけで登録できます。(PluginRegistar.exeの使い方を参照)
• 指定したパネル生成手順に、指定したパネル名のピクチャーオブジェクトを作成させる命令を記述します。
• 後は、目的に応じてプログラミングしてください。
• さっとメモの操作には、さっとメモAPIを使ってください。

プログラミングでの注意点

• 変数はできる限り、ファイル内のローカル変数か、手順内のローカル変数にしてください。
• 手順はプラグイン名をプレフィックス（接頭辞）としてつけるなど、できる限りかぶらないように命名してください。パネルも同様です。
• プラグインでの「今の位置」関数は、さっとメモのトップのフォルダになります。

さっとメモAPI（標準命令・関数）

メモ機能

メモの操作をするＡＰＩ群です。

［命令］　＜内容＞をメモ保存

＜内容＞をメモとして保存します。

［命令］　＜メモ番号＞にメモページ移動

現在のメモ番号を保持している変数を＜メモ番号＞に変えます。ですので、実際に移動するには「読むだけ」命令を使います。

［関数］　読むだけ

メモを読み、内容を返します。

［関数］　次読む

１つ次のメモ番号のメモを読み、内容を返します。

［関数］　前読む

１つ前のメモ番号のメモを読み、内容を返します。

［関数］　選択メモ番号取得

現在、開いているメモの番号を取得します。

［関数］　メモファイル一覧取得

「メモ」フォルダにあるファイルの一覧を取得します。拡張子がtxtのものだけを取得します。

［関数］　メモ検索（＜キーワード＞）

＜キーワード＞を指定して、一致するメモの番号と内容を返します。

プラグイン機能

［関数］　プラグインファイル一覧取得

Plugin.iniの各プラグインに設定されているファイル名を配列で返します。

［関数］　プラグイン名一覧取得

Plugin.iniの各プラグインの名前を配列で返します。

［関数］　パネル名取得（＜プラグイン名＞）

＜プラグイン名＞を指定して、それに設定されているパネル名を取得します。

［関数］　パネル生成手順名取得（＜プラグイン名＞）

＜プラグイン名＞を指定して、それに設定されているパネル生成手順名を取得します。

［関数］　プラグインファイル名取得（＜プラグイン名＞）

＜プラグイン名＞を指定して、それに設定されているファイル名を返します。

［命令］　パネル切り替え（＜パネル名＞）

指定した＜パネル名＞を最前面に移動させます。

プラグインの登録

　プラグインのプログラムの頭に、「PluginRegistar.exeの使い方」で紹介した、プログラムをつけて実行します。
これにより、他のユーザーはファイルをダブルクリックすれば登録できるようになります。
手動で、Plugin.iniに直接書き加える方法もありますが、面倒で初心者ユーザーにとって難しいのでおすすめできません。

プラグインの公開

　プラグインを公開するには、 さっとメモプラグインセンター で、公開できます。