MQExportPluginクラス

(new in Rev2.40)

MQExportPlugin クラスは MQBasePlugin クラスを継承し、ファイル出力用プラグインの実装に必要な関数を提供します。

この MQExportPlugin クラスを継承して、必要な仮想関数の実装を行うことにより、本体との複雑なメッセージ処理を隠ぺい化して簡便な実装でファイル出力用プラグインを作成することができます。

MQExportPlugin クラス内には各プラグイン・メッセージ処理関数が仮想関数として宣言されており、継承クラスで各仮想関数を実装する必要があります。

クラス
MQExportPlugin コンストラクタ
~MQExportPlugin デストラクタ
上位クラスの宣言
GetPlugInID プラグインIDの取得
GetPlugInName プラグイン名の取得
プラグイン
GetPlugInType プラグインの種類の取得
EnumFileType ファイルの形式名を返す
EnumFileExt ファイルの拡張子を返す
ExportFile ファイルを保存する
上位クラスの補助関数
OpenSetting 設定ファイルを開く
CloseSetting 設定ファイルを閉じる
GetResourceString リソース文字列を取得する
GetSettingValue 設定値を取得する
GetSystemColor システム色を取得する
GetResourceCursor 標準マウスカーソルを取得
GetScreenMouseCursor スクリーン用マウスカーソルを取得
SetScreenMouseCursor スクリーン用マウスカーソルを設定
SendUserMessage 他のプラグインにプラグイン独自のメッセージを送る
SetDrawProxyObject 描画代替オブジェクトを設定
GetSceneOption シーンの表示オプションを取得
GetEditOption 編集オプションを取得

MQExportPlugin::MQExportPlugin();

 コンストラクタです。


virtual MQExportPlugin::~MQExportPlugin();

 デストラクタです。仮想関数として定義されます。


virtual int MQExportPlugin::GetPlugInType();

戻り値
プラグインタイプ
[MQPLUGIN_TYPE_EXPORT] ファイル出力用

MQBasePlugin::GetPlugInType() で宣言された仮想関数を実装しています。継承クラス内で新たに実装を行う必要はありません。


virtual const char *MQExportPlugin::EnumFileType(int index);

index
ファイルの種類のインデックス
戻り値
ファイルの形式名

ファイルの形式名を返します。返した形式名はファイルダイアログ上のコンボボックスに表示されます。

この関数は起動時に呼び出されます。indexは0から順に呼び出されるごとに増えていき、戻り値としてNULLを返したときに呼び出しが終了します。

純粋仮想関数として宣言されており、継承クラスで実装することにより MQEnumFileType() を隠ぺい化します。


virtual const char *MQExportPlugin::EnumFileExt(int index);

index
ファイルの種類のインデックス
戻り値
拡張子

ファイルの拡張子を返します。返した拡張子はファイルダイアログ上で扱われます。

この関数は起動時に呼び出されます。indexは0から順に呼び出されるごとに増えていき、戻り値としてNULLを返したときに呼び出しが終了します。

純粋仮想関数として宣言されており、継承クラスで実装することにより MQEnumFileExt() を隠ぺい化します。


virtual BOOL MQExportPlugin::ExportFile(int index, const wchar_t *filename, MQDocument doc);

index
ファイルの種類のインデックス
filename
ファイル名(フルパス)
doc
ドキュメントクラス
戻り値
ファイル出力の成功の可否
[TRUE] 出力に成功
[FALSE] 出力に失敗

ファイルにデータを書き込みます。

純粋仮想関数として宣言されており、継承クラスで実装することにより MQExportFileW() を隠ぺい化します。

(in Rev4.70)

filename の型が char から wchar_t に変更されました。