MocaScript Peggy ビルトイン関数リファレンス

警告メッセージボックスにalertMessageを表示します。

開いている編集ウインドウをすべて閉じます。 変更されているファイルは、保存するかどうか問い合わせます。

カラー選択ダイアログボックスを表示して、RGB値を入力します。 defaultColorにより、デフォルトで選択されている色を指定できます。 色を選択するとRGB値(integer)、キャンセルするとnullを返します。

path1、path2を比較します。 path1、path2がファイルであればファイル比較、 path1、path2がフォルダであればフォルダ比較を行います。 ただし、ファイルとフォルダを混在させて指定することはできません。

appendにtrueを指定すると、 現在ある比較結果の後へ追加出力します。 falseを指定するか省略すると、 古い比較結果をクリアしてから出力します。

比較に成功した場合はtrue、それ以外はfalseを返します。

dialogTemplateにより定義されたカスタムダイアログボックスを表示します。 ダイアログボックスの[OK]ボタンがクリックされた場合は、 各コントロールの値をArrayオブジェクトに取り出したものを返します。 どのような値が返されるかは、コントロールの種類によって異なります。 詳しくは、コントロールの値を参照してください。 それ以外の原因で終了した場合は、nullを返します。

この関数は、以下の処理と同等です。 自動的にダイアログボックステンプレートへ[OK]、[キャンセル]ボタンを追加します。 そのため、ダイアログボックステンプレート中にこれらのボタンを定義する必要はありません。

function customBox(title, template)
{
  var dialog = new Dialog(title, template);
  dialog.addOkCancel = Dialog.ADD_OKCANCELLINE;
  return dialog.open() == IDOK ? dialog.results : null;
}

もっと自由度の高いダイアログボックスが必要な場合は、 Dialogオブジェクトを直接作成/操作することで可能になります。

entryで指定されたレジストリのエントリを削除します。 まず指定された名前のエントリがあれば、エントリを削除します。 エントリがない場合、指定された名前がサブキーであればサブキーを削除します。 ただしサブキーがさらにサブキーを持っている場合には削除できません。

【重要】
レジストリにはシステムの重要なデータも収められているため、 不用意に削除するとシステムが不安定になったり、起動しなくなることもあります。 そのため、十分に注意してこの関数を使うようにしてください。
【注意】
不用意な書き換えや削除を防ぐため、 [オプション設定]ダイアログボックス[編集]ページの[編集オプション]の最後にある [スクリプトからレジストリへの書き込みで警告を出す]をONにしておくことをお勧めします。 このオプションをセットしておくと、 MocaScriptからレジストリを削除する直前に警告ダイアログボックスが表示されるようになり、 正しい書き込みかどうかが確認できます。 このオプションは、デフォルトでONになっています。

利用可能なすべての言語モードの言語識別名の配列を返します。

【注意】
将来のバージョンでは、Languageオブジェクトに配列を返すように変更する予定です。

aViewOrNullを指定すると、同じファイルの編集ウインドウの配列を返します。

aViewOrNullがない、またはnullを指定した場合は、 開いているすべての編集ウインドウを表すViewオブジェクトの配列を返します。 編集ウインドウがまったく開いていない場合は、空の配列を返します。

orderは、取得するViewオブジェクトの順序を指定します。 "z"を指定すると、重なり順の上から配列に収めます。 "tab"を指定すると、ウインドウタブに表示されている順で取得します。 orderを指定しない場合の順序は不定です。

【注意】
同じファイルに複数の編集ウインドウを開いているときは、 配列にも複数のViewオブジェクトが格納されます。 また、縦/横ウインドウを分割表示しているときも、複数のViewオブジェクトが格納されます。 そのときの順序は、左上、右上、左下、右下となります。
【注意】
ウインドウタブ順での取得は、 ウインドウタブが表示されているときだけ可能です。 ウインドウタブが表示されていないとき、 orderに"tab"を指定するとnullを返します。

行とインデックスを指定してPointオブジェクトを作成します。

fileLineを省略すると先頭行(=1)、 indexを省略すると行頭(=0)と見なします。

エラーメッセージをステータスバーに表示しスクリプトの実行を終了します。

スクリプトの実行を終了し、続いてPeggyを終了します。

ファイル選択ダイアログボックスを表示します。

titleによりファイル選択ダイアログボックスのタイトルを変更できます。 ファイルを開く場合は、forOpenにtrue、 保存するためにファイルを選択する場合は、falseを指定します。

defaultExtを指定すると、 拡張子なしのファイル名を入力した場合にこのデフォルトの拡張子と見なされます。 fileNameにより、初期表示されるファイルを指定できます。 filterにより、フィルタを独自のものに変更できます。

フォルダ選択ダイアログボックスを表示します。

titleによりフォルダ選択ダイアログボックスのタイトルを変更できます。 initialFolderにより、初期フォルダを指定します。

アクティブな編集ウインドウのViewオブジェクトを取得します。 編集ウインドウがないときは、nullを返します。

コピー履歴に保存されているindex番目の文字列を取得します。 indexは、0で先頭の履歴、1が次、...となります。

【注意】
ファイル全体をコピーした場合など、 非常に長いテキストを取得する可能性があるので注意してください。

マウスカーソルのスクリーン座標を取得し、それを収めたArrayオブジェクトを返します。 配列の要素0にはx座標、要素1にはy座標が整数で収められます。

フォーカスのあるウインドウの種類を以下の整数値として返します。

編集ウインドウ	1
アウトプットウインドウ	2
プロジェクト	3
ウインドウリスト	4
アウトライン	5
スクリプト	6
検索ツール	7
上記以外のウインドウ	0

キーボードマクロの情報を内部形式のまま配列として取得します。

配列の1つの要素に1キーストローク分の情報が整数として収められています。 キーボードマクロが記録されていないときは、空の配列を返します。

【注意】
キーボードマクロ記録中に情報を取り出すことはできません。 記録中にこの関数を呼び出すと失敗し、nullを返します。

Peggyアプリケーションウインドウのハンドルを取得します。

【注意】
MocaScriptではハンドル型というデータ型が存在しないため、 ハンドル値を整数として扱います。

最近使ったファイル、最近使ったフォルダ、最近使ったプロジェクトのリストを配列として取得します。 どれを取得するかは、typeで選択します。

省略	最近使ったファイル
0
1	最近使ったフォルダ
2	最近使ったプロジェクト

peggy.exe、peggypro.exeの実行ファイルがインストールされているフォルダのパスを取得します。

buttonで指定したスクリプトボタン(1〜72)にスクリプトコマンドを取得します。 スクリプトコマンドは、"<ファイル名>:コマンド名" 形式の文字列です。 何も設定されていないボタンは、空の文字列が返されます。

buttonで指定したスクリプトボタン(1〜72)の位置をスクリーン座標で取得します。 スクリプトボタンがツールバーにないときは、nullを返します。

Arrayオブジェクトにはインデックス0〜3に4つの整数値が収められていて、 それぞれスクリプトボタンの左端x、上端y、右端x、下端y(ピクセル単位・スクリーン座標)を表しています。

Peggyのキーワードファイル<*.kwd>、各種設定ファイルが収められている<share>フォルダのパスを返します。

入力ボックスを表示してユーザからの入力を受け付けます。

titleには、表示されるダイアログボックスのタイトルを指定します。 messageには、入力を促すメッセージを設定します。 入力ダイアログボックスには、4行分のメッセージを表示するスペースがあります。 field1、field2... には、 入力欄のラベル、または入力欄の諸パラメタを収めた配列を渡します。 入力欄は、最大20まで作成することができます。

入力欄に文字列を指定すると、そのまま入力欄のラベルとして表示されます。 さらに細かく指定したい場合は、ラベル文字列の代わりに以下の配列を渡します。

インデックス	内容	詳細
0	入力欄のラベル	入力欄のラベルとして表示される文字列
1	デフォルト値(省略可)	デフォルト値として最初から入力欄にセットされる文字列
2	横幅(省略可)	適切な横幅をドット単位で指定する

[OK]ボタンにより入力ダイアログボックスを閉じると、 各入力欄の文字列を収めた配列を返します。 また、[キャンセル]ボタンにより入力を中止すると、 nullを返します。

filePathが既に開いているかどうか調べます。

openFile()は、まだファイルが開かれていない場合そのファイルを開きますが、 isFileOpened()関数は、まだ開いていない場合はnullを返し、 ファイルを開くことはしません。

アイテムをリスト表示してユーザに選択してもらいます。

titleには、ダイアログボックスのタイトルを指定します。 messageには、リストからの選択を促すメッセージを最大2行まで表示できます。 arrayは、選択肢を要素として持った配列です。 1つ1つがリストアイテムとして表示されますが、未定義(undefined)の要素は表示されません。 initialSelectに配列のインデックス(0 〜 array.length - 1)を指定すると、 デフォルトとしてそのアイテムを選択した状態でリストダイアログボックスが表示されます。

リストからアイテムが選択されると、配列中のこのアイテムが返されます。 また[キャンセル]ボタンがクリックされると、nullが返されます。

【注意】
配列中の選択肢としてnullがあると、 [OK]が押されたのか、キャンセルされたのかが区別しにくくなります。

メッセージボックスにメッセージmessageを表示します。

flagsにより、ボタン、アイコンを指定できます。 flagsの値は、グローバルスコープに登録されている以下のシンボルが使えます。 OR演算子(|)を使って複数指定することもできます。

シンボル	機能
MB_OK	[OK]ボタンを表示する
MB_OKCANCEL	[OK]、[キャンセル]ボタンを表示する
MB_ABORTRETRYIGNORE	[中止]、[再試行]、[無視]ボタンを表示する
MB_YESNOCANCEL	[はい]、[いいえ]、[キャンセル]ボタンを表示する
MB_YESNO	[はい]、[いいえ]ボタンを表示する
MB_RETRYCANCEL	[再試行]、[キャンセル]ボタンを表示する
MB_ICONHAND	手のアイコン
MB_ICONQUESTION	？アイコン
MB_ICONEXCLAMATION	！アイコン
MB_ICONASTERISK	＊アイコン
MB_DEFBUTTON1	ボタン1をデフォルトにする
MB_DEFBUTTON2	ボタン2をデフォルトにする
MB_DEFBUTTON3	ボタン3をデフォルトにする

【注意】
実際のアイコンはシステムや設定によって異なります。

また、messageBox()は、クリックされたボタンのIDを返します。 ボタンのIDを下表に示します。

シンボル	ボタン
IDOK	[OK]
IDCANCEL	[キャンセル]
IDABORT	[中止]
IDRETRY	[再試行]
IDIGNORE	[無視]
IDYES	[はい]
IDNO	[いいえ]

新しい編集ウインドウを作成し、その編集ウインドウを表すViewオブジェクトを返します。 テンプレートの名前を指定すると、そのテンプレートを元に新規ファイルを作成します。 テンプレートを省略すると、ブランクの新規ファイルを作成します。

テンプレートファイルをフルパスで指定すると、任意のファイルをテンプレートとすることができます。 ファイル名と拡張子だけ指定すると、 <share\template>フォルダから名前に一致するテンプレートファイルを探します。 テンプレートファイルが見つからない場合は、 新規ファイルの作成に失敗し、nullを返します。

新しいプロジェクトを作成し、Projectオブジェクトを返します。 途中で中止したなどの理由により失敗した場合は、nullを返します。

【注意】
一度に開くことが出来るプロジェクトは、1つだけです。 現在開いているプロジェクトは、新しいプロジェクトを作成する前に閉じられます。

filePathで指定されたファイルを開き、Viewオブジェクトを返します。 filePathを省略したときは、[開く]ダイアログボックスでファイルを選択できます。

encodingを指定すると、ファイルを指定した漢字コードと見なして開きます。 encodingの値は、 File.guessEncoding() メソッドを参照してください。

途中でキャンセルしたりファイルが見つからなかった場合は、nullを返します。

helpFilePathのヘルプファイルを開きます。 Windowsヘルプファイル(.HLP)、HTMLヘルプファイル(.CHM と .COL)をヘルプファイルとして認識します。 それ以外の拡張子はヘルプファイルではないと見なし、失敗します。

topicKeywordが指定されていれば、 ヘルプファイルからキーワードを含んだトピックを検索します。

projectPathで指定されたプロジェクトファイルを開き、Projectオブジェクトを返します。 途中でキャンセルしたりプロジェクトファイルが見つからなかった場合は、nullを返します。

【注意】
一度に開くことが出来るプロジェクトは、1つだけです。 現在開いているプロジェクトは、新しいプロジェクトを開く前に閉じられます。

配列itemArrayに収められた項目をポップアップメニューとして表示します。 itemArrayの個々の要素を文字列に変換したものがメニュー項目として表示されます。 要素がundefinedまたはnullのときは、セパレータ(区切り線)となります。

itemArrayの要素が配列であった場合、 メニュー項目の内容を細かく制御することができます。 これを「メニュー項目配列」と呼ぶことにします。

メニュー項目配列の最初の要素(インデックス0)は、メニューに表示される文字列となります。 次の要素(インデックス1)は、その項目が選択されたときにpopupMenu()関数から返される値を指定できます。 これはオプションで、省略するとインデックス0の要素が戻り値となります。 3番目の要素(インデックス2)には、true、または下表のフラグを1つ以上OR演算して組み合わせたものを指定できます。 4番目の要素(インデックス3)には、ステータスバーに表示するメッセージを指定できます。

インデックス	内容
0	文字列へ変換してメニューに表示される
1	項目が選択されたときの戻り値。省略した場合は、インデックス0の値となる。
2	フラグ(trueとMF_XXXを混ぜて指定することはできません) true ........ メニュー項目にチェックを表示する MF_CHECKED ......... メニュー項目にチェックを表示する MF_GRAYED .......... メニュー項目を灰色で表示し無効にする MF_MENUBREAK ....... メニューを水平に分割する MF_MENUBARBREAK .... メニューを水平に分割して縦線を入れる
3	ポップアップメニューを表示してこの項目がハイライトされているとき、 ステータスバーに表示されるメッセージです。 省略すると、インデックス0の値がステータスバーに表示されます。

aViewOrPositionは、ポップアップメニューを表示する場所を指定します。 aViewOrPositionにViewオブジェクトを指定すると、 そのViewオブジェクトのカーソル位置にポップアップメニューを表示します。 aViewOrPositionに2つの数値を要素として持った配列を指定すると、 スクリーン上の[x, y]位置に表示します。 省略すると、マウスカーソルのある位置にポップアップメニューを表示します。

entryで指定されたレジストリの値を取得します。 REG_DWORD型は整数、 REG_SZ、REG_EXPAND_SZ、REG_BINARYは文字列を返します。

値が取得できなかった場合は、undefinedを返します。

必要に応じてlibraryで指定されたライブラリを読み込みます。

ここで言う「ライブラリを読み込む」とは、 「ライブラリファイルをコンパイルして一度実行する」ということと同義です。 ライブラリが読み込まれると、 グローバルスコープのModuleオブジェクトにファイルのタイムスタンプ情報がNumber型として保存されます。

libraryは、絶対パスまたは相対パスで指定できます。 相対パスで指定した場合は、<share\script>からの相対と見なします。 また拡張子を省略した場合は、<.msl>と見なします。

同じライブラリの同じタイムスタンプのものは、一度しか読み込みません。 同じファイルでも更新されタイムスタンプが変化していれば、再度読み込みます。 また、forceLoadにtrueが指定されていると、 何度でも強制的に読み込ませることができます。

【メモ】
#includeによりライブラリをファイルの一部としてインクルードする方法とは、 以下のような違いがあります。

#inlucde
#inlucdeは、コンパイル時に指定されたファイルを、 あたかもそこに記述しているかのように取り込みます。 そのため、あちこちのファイルから同じものをインクルードすると、 メモリ上にも重複して記憶されます。

require()関数
一方require()関数によるライブラリの読み込みは、 (コンパイル時ではなく)最初にrequire()関数が実行されたときに行われます。 また2回目以降は、ライブラリファイルのタイムスタンプが変化している場合だけ読み込みます。 これにより、同じコードが幾つもメモリ上へ確保されるのを防ぐことができます。
【注意】
require()を呼び出している側と、 require()によってコンパイル＆実行されているライブラリ側のスコープは、 グローバルスコープを除いて分離されています。 従ってライブラリファイル中で定義されている関数・変数を、 require()を呼び出しているコンテキストから参照することはできません。

またその逆で、require()を実行しているスクリプトで定義している関数・変数を、 読み込んでいるライブラリ内部から参照することもできません。 つまり、あたかもライブラリが単独であるかのような状態で実行されるのです。 require()関数で読み込むライブラリは、 グローバルスコープなど実行終了後も残る場所へ関数や定数を登録するようにします。

赤、緑、青からRGB値を作成します。

runCommand() 関数は、Peggy組み込み版(書式(1))とコマンドライン版(書式(2))で少し異なります。 Peggy 組み込み版では、commandを隠れたDOS窓で実行し、コマンドからの出力をアウトプットウインドウへ表示します。 コマンドライン版では、commandを子プロセスとして実行します。 commandには、コマンド名とパラメタを含んだものを指定します。

folderを指定すると、コマンドをそのフォルダ中で実行します。 folderを省略、またはnullを指定した場合には、 カレントフォルダで実行します。

inpfile、outfileを指定すると、 それぞれコマンドの標準入力、標準出力をリダイレクトします。 inpfileを省略またはnullを指定すると、 空のデバイスNULが標準入力として割り当てられます。 Peggy 組み込み版でoutfileを省略またはnullとすると、 アウトプットウインドウのページにリダイレクトされます。 標準エラー出力は、常にアウトプットウインドウへ表示されます。

outputPage(書式(1) コマンドライン版のみ)を指定すると、そのページに出力が送られます。 outputPageを省略すると、[スクリプト]ページに出力されます。 そのときencoding(書式(1) コマンドライン版のみ)を指定しておくと、コマンドの出力が指定漢字コードであるとみなし、 Shift JISに変換してからアウトプットウインドウへリダイレクトします。 指定できる漢字コードは、以下の7種類です。

Shift JIS	File.ENCODING_SJIS (=3)
EUC	File.ENCODING_EUC (=4)
JIS	File.ENCODING_JIS (=5)
UTF-7	File.ENCODING_UTF7 (=8)
UTF-8	File.ENCODING_UTF8 (=6)
UTF-8N	File.ENCODING_UTF8N (=9)
Unicode	File.ENCODING_UNICODE (=7)

コマンドライン版では、outputPageの代わりにerrfile (書式(2))を指定することで、 標準エラー出力をファイルにリダイレクトできます。

コマンドが起動できたときは、そのコマンドの終了コードを返します。 コマンドが起動できなかったとき、 または起動できても途中でユーザにより停止された場合は、以下のエラーコードを返します。

エラーコード	エラー原因
-1	コマンドが見つからない
-2	ユーザによりコマンド実行を中止した (Peggy 組み込み版のみ)
-3	既に子プロセス実行中である(Peggy 組み込み版のみ・同時には1つしか実行できない)

【注意】
すでに何らかの子プロセス実行中にスクリプトを起動し、 その中からrunCommand()関数を使ってさらに別の子プロセスを実行することはできません。
【注意】
スクリプトから子プロセス実行中に、他のスクリプトコマンドを実行することはできません。

現在実行しているスクリプトを終了し、commandで指定されたスクリプトを実行します。

同じスクリプトファイルでも別のスクリプトファイルでもかまいません。 コマンド名commandは、 "Sample.ms:Face.Smile"のようにファイル名を含む完全なコマンド名でなければなりません。

【注意】
指定コマンドが存在しない場合でも、このコマンドからはリターンしません。

編集中のファイルで変更されているものをすべて保存します。

quietにtrueを指定すると、 保存するかどうかの問い合わせを省略し、すべてを保存します。 quietを省略するかfalseを指定すると、 ファイル毎に保存するかどうかを選択できます。

ignoreUntitledにtrueを指定すると、 まだ一度も保存されていないファイルを保存の対象から外します。

MAPI(Mail Application Program Interface)を使って送信メールを作成します。

どのようなメールを作成するかは、messageオブジェクトのプロパティで指定します。 messageオブジェクトの不要なプロパティは省略できます。 messageオブジェクト自体を省略すると、プロパティを何も指定しなかったのと同じです。

以下のプロパティをmessageオブジェクトに設定できます。

プロパティ	型	内容
to	string array	宛先を指定します。 宛先が1つだけのときは、そのまま文字列として設定できます。 宛先が複数ある場合は、文字列の配列としてセットします。 個々のメールアドレスは、以下の3通りの形式を指定できます。 "株式会社エスコア" <anchor@anchorsystems.jp> <anchor@anchorsystems.jp> anchor@anchorsystems.jp これらの指定方法は、以下のccやbccプロパティでも同じです。
cc	string array	コピー配布先を指定します。 指定方法はtoと同じです。
bcc	string array	表示しないコピー配布先 指定方法はtoと同じです。
subject	string	表題とする文字列を指定します。
text	string	本文を指定します。
attach	string array	添付ファイルを指定します。 複数添付したいときは、配列に入れてセットします。

【注意】
デフォルトで指定されているメーラーによって、正しく動作しない場合があります。

マウスカーソルをスクリーン座標x、y、またはArrayオブジェクト[x, y]で指定された場所へ移動します。 戻り値は、移動前のマウスカーソル座標を収めたArrayオブジェクトです。

from〜to番目のDBツールボタンに、 ビットマップファイルbitmapのイメージを設定します。 bitmapを相対パスで指定すると、<share>フォルダからの相対パスであると見なします。 ビットマップファイルbitmapを省略すると、 ボタンのイメージを元の状態へ戻します。

offsetには、ビットマップファイル中のボタンイメージの何番目から使うかを指定します。 最初のイメージが0です。省略したときは、0と見なします。

この関数によりセットしたボタンイメージは保存されるので、 Peggy を再起動しても失われることはありません。

【注意】
1つのボタンの大きさは、横16ドット×縦15ドットです。 1つのビットマップファイルには、複数のボタンイメージを収めることができます。 そのためビットマップファイル全体の大きさは、縦15ドット、横は16ドットの倍数としてください。 縦横ドット数が多少多くても読み込むことは可能ですが、それらのドットは使用されません。

色は16色(4-bit)、256色(8-bit)、65535/32768色(16-bit)、フルカラー(24-bit)のどれでもかまいません。 ただし、明るい灰色(ライトグレー: RGB=192,192,192)は背景色として扱われるので、 実際に描画されるときはシステムで選択されているボタン表面の色に変換されます。
【注意】
Peggyは、 ボタンを表示するのに必要なビットマップファイルを1回だけ読み込みます。 その後、そのファイルが更新されても再読み込みしません。 編集したビットマップファイルを再読み込みさせるには、Peggyを再起動してください。

ステータスバーにエラーメッセージを表示します。 背景が赤色になりエラーであることを強調します。

buttonで指定したスクリプトボタン(1〜72)にスクリプトコマンドcommandを設定します。

スクリプトコマンドcommandは、"<ファイル名>:コマンド名" 形式の文字列です。 スクリプトコマンドの長さは、255バイトまでに制限されています。 また、空の文字列を設定すると、スクリプトボタンが「未設定」になります。

from〜to番目のスクリプトボタンに、 ビットマップファイルbitmapのイメージを設定します。 bitmapを相対パスで指定すると、<share>フォルダからの相対パスであると見なします。 ビットマップファイルbitmapを省略すると、 ボタンのイメージを元の状態へ戻します。

offsetには、ビットマップファイル中のボタンイメージの何番目から使うかを指定します。 最初のイメージが0です。省略したときは、0と見なします。

この関数によりセットしたボタンイメージは保存されるので、 Peggy を再起動しても失われることはありません。

【注意】
1つのボタンの大きさは、横16ドット×縦15ドットです。 1つのビットマップファイルには、複数のボタンイメージを収めることができます。 そのためビットマップファイル全体の大きさは、縦15ドット、横は16ドットの倍数としてください。 縦横ドット数が多少多くても読み込むことは可能ですが、それらのドットは使用されません。

色は16色(4-bit)、256色(8-bit)、65535/32768色(16-bit)、フルカラー(24-bit)のどれでもかまいません。 ただし、明るい灰色(ライトグレー: RGB=192,192,192)は背景色として扱われるので、 実際に描画されるときはシステムで選択されているボタン表面の色に変換されます。
【注意】
Peggyは、ボタンを表示するのに必要なビットマップファイルを1回だけ読み込みます。 その後、そのファイルが更新されても再読み込みしません。 編集したビットマップファイルを再読み込みさせるには、Peggyを再起動してください。

ステータスバーにメッセージを表示します。

intervalで指定した秒間隔でタイマーを起動します。 Event.onTimer()イベントハンドラがセットされていると、 ここで指定した時間間隔で呼び出されるようになります。

intervalに0を指定すると、タイマーを停止します。

from〜to番目のユーザ定義ツールボタンに、 ビットマップファイルbitmapのイメージを設定します。 bitmapを相対パスで指定すると、<share>フォルダからの相対パスであると見なします。 ビットマップファイルbitmapを省略すると、 ボタンのイメージを元の状態へ戻します。

offsetには、ビットマップファイル中のボタンイメージの何番目から使うかを指定します。 最初のイメージが0です。省略したときは、0と見なします。

【注意】
この関数によりセットしたボタンイメージは保存されません。 スクリプトやDBツールボタンと違い、Peggy を再起動すると失われますので注意してください。
【注意】
1つのボタンの大きさは、横16ドット×縦15ドットです。 1つのビットマップファイルには、複数のボタンイメージを収めることができます。 そのためビットマップファイル全体の大きさは、縦15ドット、横は16ドットの倍数としてください。 縦横ドット数が多少多くても読み込むことは可能ですが、それらのドットは使用されません。

色は16色(4-bit)、256色(8-bit)、65535/32768色(16-bit)、フルカラー(24-bit)のどれでもかまいません。 ただし、明るい灰色(ライトグレー: RGB=192,192,192)は背景色として扱われるので、 実際に描画されるときはシステムで選択されているボタン表面の色に変換されます。
【注意】
Peggyは、ボタンを表示するのに必要なビットマップファイルを1回だけ読み込みます。 その後、そのファイルが更新されても再読み込みしません。 編集したビットマップファイルを再読み込みさせるには、Peggyを再起動してください。

ステータスバーに警告メッセージを表示します。 ステータスバーの背景色が警告色(黄色)になります。

Win32 APIのShellExecute関数を実行します。 詳細は、Win32 APIのマニュアルを参照してください。 親ウインドウのハンドルは、Peggyのフレームウインドウとなります。

ウインドウタブの表示/非表示を切り替えます。 showにtrueを指定すると、ウインドウタブを表示します。 showにfalseを指定すると、ウインドウタブを消します。 showを省略すると、表示/非表示を反転させます。

表示行とカラムを指定してPointオブジェクトを作成します。

viewLineを省略すると先頭行(=1)、 columnを省略すると表示行頭(=1)と見なします。 thresholdを指定すると、 指定カラムが文字の途中を指していた場合に文字の前と判定するか後と判定するかのしきい値を設定できます。 詳しくは、Pointオブジェクトを参照してください。

entryで指定されたレジストリのエントリに値valueを書き込みます。 typeに以下の値を指定すると、そのデータ型で書き込みます。 typeを省略した場合は、 valueのデータ型がintegerかbooleanならばREG_DWORD、 それ以外は文字列に変換してREG_SZとして書き込みます。

1 ...... 文字列 (REG_SZ)
2 ...... 文字列 (REG_EXPAND_SZ)
3 ...... バイナリデータ (REG_BINARY)
4 ...... 整数 (REG_DWORD)

【重要】
レジストリにはシステムの重要なデータも収められているため、 不用意に書き換えるとシステムが不安定になったり、起動しなくなることもあります。 そのため、十分に注意してこの関数を使うようにしてください。
【注意】
不用意な書き換えを防ぐため、 [オプション設定]ダイアログボックス[編集]ページの[編集オプション]の最後にある [スクリプトからレジストリへの書き込みで警告を出す]をONにしておくことをお勧めします。 このオプションをセットしておくと、 MocaScriptからレジストリを書き換える直前に警告ダイアログボックスが表示されるようになり、 正しい書き込みかどうかが確認できます。 このオプションは、デフォルトでONになっています。

Pointオブジェクトを生成して初期化します。

書式(1)は、ファイル行番号fileLineとその行中の文字インデックスindexから、 Pointオブジェクトを作成します。 indexを省略すると、0と見なして作成します。

書式(2)は、編集ウインドウaViewのカーソル位置を取得して、それを表すPointオブジェクトを作成します。 書式(3)は、PointオブジェクトaPointのコピーを作成します。 書式(4)は、ファイル行1、文字インデックス0、つまりファイルの先頭を表すPointオブジェクトを作成します。

カーソル位置情報を得るための以下のプロパティを持っています。

line	...... fileLine の別名
fileLine	...... ファイル行番号 (1 〜 )
index	...... ファイル行中の文字インデックス (0 〜 )
viewLine	...... 表示行番号 (1 〜 )
column	...... カラム (1 〜 )

line、fileLine、indexは、 ファイル行を基準としたカーソル位置を示しています。 それに対して、viewLine、columnは、 表示行を基準としたカーソル位置を表します。

矩形選択モードでカーソル位置がテキストのない所にある場合、 fileLine(line)、indexには、 テキストのある最も近い行とその行中の文字インデックスが設定されます。

CPオブジェクトのこれらのプロパティは、常に自動的に更新されていて、 いつアクセスしても現在のカーソル位置を知ることができます。 しかし、これらのプロパティは読み出し専用なので、 値を代入してもカーソル位置を変えることはできません。

このオブジェクトも常に更新されています。 このオブジェクトのプロパティに値を代入しても、 アンカーポイントを変えることはできません。

編集ウインドウをアクティブにします。

選択範囲のテキストを左、右、中央揃えします。 alignmentには、 View.ALIGN_LEFT、 View.ALIGN_RIGHT、 View.ALIGN_CENTERが指定できます。

アウトライン解析を行います。結果はプロジェクトウインドウの[アウトライン]ページに表示されます。

modeOrArrayに整数の0〜3を指定すると、 予めPeggyに組み込まれている方法でアウトライン解析を行います。 modeOrArrayを省略すると、0と見なし、 ファイルの種類により適当な解析を試みます。

0 ........ ファイルの種類により1〜3の適当な解析を行います。
1 ........ プログラムとして解析を試みます。
2 ........ 文章として見出し解析を試みます。
3 ........ HTMLファイルとしてタグ解析を試みます。

modeOrArrayに正規表現の配列を指定することで、 任意のパターンによる見出し解析が可能です。 結果は配列の最初の正規表現が大見出し、次が中見出し、次が小見出し、...のようにツリー表示されます。

ensureVisibleにtrueを指定すると、 解析後にプロジェクトウインドウの[アウトライン]ページを見えるようにします。

submatch に整数値 0〜 を指定すると、 正規表現のサブパターン ( ) に一致した部分を抜き出し、アウトラインウインドウの表示ラベルとして使用します。 0 を指定すると、マッチした部分全体をラベルとします。 負の値を指定するか省略すると、行全体をラベルとして使用します。 modeOrArray が正規表現の配列ではないときは、無視されます。

カーソル直前の文字を削除します。

矩形選択モードに切り替えます。

選択範囲をキャンセルします。

選択範囲のASCII英単語の頭文字を大文字に変換します。

単語の頭文字だけ大文字にします。

カーソルを一文字左に移動します。 repeatCountにより指定回数だけカーソルを左へ移動できます。 省略すると、1回移動します。

extendSelectionにtrueを指定すると、 選択範囲を拡大/縮小しながらカーソルを左へ移動します。Shift+←キーと同じです。 falseを指定するとカーソルを左へ移動し選択範囲はなくなります。 extendSelectionを省略すると、 選択範囲の拡張がロックされているかどうかにより選択範囲を拡大縮小するか、 カーソルだけが移動するかが決まります。←キーと同じです。

カーソルを一文字右へ移動します。 repeatCountにより指定回数だけカーソルを右へ移動できます。 省略すると、1回移動します。

extendSelectionにtrueを指定すると、 選択範囲を拡大/縮小しながらカーソルを右へ移動します。Shift+→キーと同じです。

falseを指定するとカーソルを右へ移動し選択範囲はなくなります。 extendSelectionを省略すると、 選択範囲の拡張がロックされているかどうかにより選択範囲を拡大縮小するか、 カーソルだけが移動するかが決まります。→キーと同じです。

文字選択モードに切り替えます。

ファイルのすべてのブックマークをクリアします。

すべての言語のすべてのガイドライン設定をクリアします。

【注意】
View.clearAllGuidelines()はクラスメソッドです。

変更行情報をクリアします。

編集ウインドウaViewの検索強調表示をクリアします。

すべてのファイルの検索強調表示をクリアするには、 Search.clearHighlight()メソッドを使ってください。

ファイルの比較やsetLineBackground()メソッドで付けたすべての行の背景色をクリアします。

【注意】
行の背景色はサブ言語の背景色とは異なります。 このメソッドでサブ言語の背景色を消すことはありません。

ファイルを閉じます。 forceCloseが省略されているかfalseが指定されていて、 かつファイルが変更されている場合は、保存するかどうかを問い合わせます。 forceCloseにtrueを指定すると、 変更の有無に関わらず強制的に閉じます。

【注意】
強制的に閉じると、変更内容は失われてしまいます。

ウインドウを閉じます。 編集しているファイルの最後のウインドウであれば、ファイルも閉じます。

最後のウインドウを閉じるとき、 forceCloseが省略されているかfalseが指定してあると、 ファイルを保存するかどうか問い合わせてきます。 forceCloseにtrueが指定されていると、 変更内容を保存することなく強制的にウインドウを閉じます。

選択している行をコメント化します。

カーソル位置の単語をコメント化します。

カーソル位置にあるタイプしかけの部分をヒントとして、 キーワードの残りの部分を補完入力します。 候補となるキーワードが複数ある場合は、 カーソル位置にポップアップメニューが表示されます。