Scripting API

CopyQは、クリップボードの変更を自動的に処理し、アイテムを整理、設定を変更するなどのスクリプト機能を提供します。
Qtスクリプトが提供する機能に加えて、以下の関数、タイプ、オブジェクト、MIMEタイプがあります。

実行スクリプト

スクリプトは次の場所から実行できます。

アクションまたはコマンドダイアログ（F5、F6ショートカット）、1行目が copyq:
コマンドラインとして copyq eval '<SCRIPT>'
コマンドラインとして cat script.js | copyq eval -
コマンドラインとして copyq <SCRIPT_FUNCTION> <FUNCTION_ARGUMENT_1> <FUNCTION_ARGUMENT_2> ...

コマンドラインから実行すると、最後の式の結果がstdoutに出力されます。
コマンドの終了値は次のとおりです。

0-スクリプトはエラーなしで終了しました
1- fail()がcallされた
2- 文法間違い
3- 例外が発生

コマンドライン

関数に渡す引数の数が限られている場合は、以下のように使用できます：

copyq <FUNCTION1> <FUNCTION1_ARGUMENT_1> <FUNCTION1_ARGUMENT_2> \
          <FUNCTION2> <FUNCTION2_ARGUMENT> \
              <FUNCTION3> <FUNCTION3_ARGUMENTS> ...

ここで<FUNCTION1>および<FUNCTION2>は、最後の式の結果がそれぞれ2つおよび1つの引数を取る関数であるスクリプトです。
例えば

copyq tab clipboard separator "," read 0 1 2

evalの後ろは、それがすべての引数にアクセスすることができますので、引数なしの関数として扱われます。
引数は、エスケープシーケンス\n（改行）、\t （タブ文字）、および\\（バックスラッシュ）を認識します。
引数-eは、evalと同じです。
引数-は、標準入力から読み取られたデータに置き換えられます。
引数--は、スキップされ、残りの全ての引数はそのまま解釈されます（エスケープシーケンスが無視され、-e、-、 --は変更されません）。