MQButtonクラス

(new in Rev4.00)

MQButton クラスはボタンを表示するウィジェットを管理します。MQWidgetBaseクラスを継承しています。

継承元クラスで定義されるメンバ関数はそのクラスの記述を参照してください。

クラス
MQButton コンストラクタ
~MQButton デストラクタ
メンバ関数
GetText 表示文字列の取得
SetText 表示文字列の設定
GetToggle 自動切り替えのOn/Offの取得
SetToggle 自動切り替えのOn/Offの設定
GetDown 押下状態の取得
SetDown 押下状態の設定
GetRepeat リピートOn/Offの取得
SetRepeat リピートOn/Offの設定
GetChain チェイン状態の取得
SetChain チェイン状態の設定
SetDefault デフォルトボタンとして設定
SetCancel キャンセルボタンとして設定
SetModalResult ダイアログの結果値の設定
イベント
AddClickEvent ボタンが押された時のイベントを追加
AddRepeatEvent ボタンが押し続けられた時のイベントを追加

MQButton::MQButton();

MQButton::MQButton(int id);

id
プラグイン外で生成されたウィジェットのID

コンストラクタです。


virtual MQButton::~MQButton();

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


std::wstring MQButton::GetText();

戻り値
表示文字列

ボタン上に表示される文字列を取得します。


void MQButton::SetText(const std::wstring& text);

text
表示文字列

ボタン上に表示される文字列を設定します。


bool MQButton::GetToggle();

戻り値
自動切り替えのOn/Off

ボタンが押されたときに自動的にボタンのOn/Offを切り替えるどうかを取得します。


void MQButton::SetToggle(bool value);

value
自動切り替えのOn/Off

ボタンが押されたときに自動的にボタンのOn/Offを切り替えるどうかを設定します。


bool MQButton::GetDown();

戻り値
押下状態

ボタンが押されているかどうかを取得します。


void MQButton::SetDown(bool value);

value
押下状態

ボタンが押されているかどうかを設定します。


bool MQButton::GetRepeat();

戻り値
リピートのOn/Off

ボタンが押し続けられた時にイベントを連続的に発生させるかどうかを取得します。


void MQButton::SetRepeat(bool value);

value
リピートのOn/Off

ボタンが押し続けられた時にイベントを連続的に発生させるかどうかを設定します。

trueが指定された場合、AddRepeatEventで指定した関数が呼び出されます。


bool MQButton::GetChain();

戻り値
チェイン状態

隣り合うボタンがあるときにボタンがつながったような表示を行うかどうかを取得します。


void MQButton::SetChain(bool value);

value
チェイン状態

隣り合うボタンがあるときにボタンがつながったような表示を行うかどうかを設定します。


void MQButton::SetDefault(bool value);

value
デフォルトボタンとして指定

ダイアログ上でEnterキーが押されたときにボタンを動作させるかどうかを設定します。


void MQButton::SetCancel(bool value);

value
キャンセルボタンとして指定

ダイアログ上でEscキーが押されたときにボタンを動作させるかどうかを設定します。


void MQButton::SetModalResult(MQDialog::DIALOG_RESULT value);

value
ダイアログの結果値
[DIALOG_NONE] なし
[DIALOG_OK] OKボタンとして動作
[DIALOG_CANCEL] キャンセルボタンとして動作
[DIALOG_YES] はいボタンとして動作
[DIALOG_NO] いいえボタンとして動作
[DIALOG_ALL] すべてボタンとして動作

ボタンが押されたときにダイアログを閉じてMQDialog::executeの戻り値として返す値を指定します。

DIALOG_NONE以外が指定されていれば、ボタンが押されたときに自動的にダイアログが閉じられます。


template<typename T> void MQButton::AddClickEvent(T *p, BOOL (T::*f)(MQWidgetBase*, MQDocument), bool prior = false);

p
イベント通知先のウィジェット
f
イベント通知先のメンバ関数
prior
イベントの通知順序
[true] 最初に通知されるよう指定
[false] 最後に通知されるよう指定

ボタンが押されたときに発生されるイベントを追加します。


template<typename T> void MQButton::AddRepeatEvent(T *p, BOOL (T::*f)(MQWidgetBase*, MQDocument), bool prior = false);

p
イベント通知先のウィジェット
f
イベント通知先のメンバ関数
prior
イベントの通知順序
[true] 最初に通知されるよう指定
[false] 最後に通知されるよう指定

ボタンが押し続けられたときに発生されるイベントを追加します。

このイベントを発生させるには SetRepeat() で true が指定されている必要があります。