継承図

協調図

解説

■ 仕様と使い方

通知メッセージを表示するダイアログ[SFZMessageDialog]は、 アイコン画像、 メッセージテキスト、 OK ボタンから構成されます。

それぞれの要素は省略することも可能です（Set 関数で何も設定しなかった場合、省略されたものとみなされます）。

図 385. SFZMessageDialog クラスの動作例

アイコン画像、 メッセージテキスト、 OK ボタンは、それぞれ SFZImageLabelControl、 SFZMultipleTextLabelControl、 SFZTextButtonControl インスタンスとして内部で保持されています。 これらのインスタンスを取得するための API も用意されています。

アイコン画像とメッセージテキストは、操作不能状態に設定されているので、これらにフォーカスを移動できません。 OK ボタンだけが操作可能状態に設定されているので、ダイアログにフォーカスが移動すると、 OK ボタンもフォーカスを持つことになります。

SFZMessageDialog::SetIconImage 関数、 SFZMessageDialog::SetMessageText 関数、 SFZMessageDialog::SetButtonText 関数を使用してアイコン画像やメッセージ、ボタンのテキストを設定しなかった場合、 それらは省略されたことになり、 ダイアログには表示されません。

デフォルトの実装では、 通知メッセージを表示するダイアログ[SFZMessageDialog]は 下記の結果イベント[SFEVT_RESPONDER_RESULT]を受信します。

開発者は、これらのイベントを受信するハンドラを登録できます。 デフォルトのハンドラは、ダイアログを閉じる処理だけを行います。

ダイアログ操作キーは、SFZDialog::SetOperateKey 関数を使用して設定します。 OK ボタンを操作するためのボタン操作キーは、SFYButtonControl::SetOperateKey 関数を使用して設定します。 デフォルトでは、セレクトキーがダイアログ操作キーとボタン操作キーとして割り当てられています。 ボタンが表示されている場合、セレクトキーはボタン操作キーとして処理されます。

ESCAPE キーは、SFZDialog::SetEscapeKey 関数を使用して設定します。 デフォルトでは、クリアキーが ESCAPE キーとして割り当てられています。

	タイマーのキャンセル
	SFZDialog::ScheduleTimer 関数で設定したタイマー処理は、 ダイアログ操作キー、ESCAPE キー、またはOK ボタンを押したときに自動的にキャンセルされます。 サスペンド時もタイマーはキャンセルされますが、 レジューム時に SFZDialog::ScheduleTimer 関数の引数に指定した時間でタイマー処理は再開されます。 ダイアログの有効状態が無効になったときもタイマーはキャンセルされます。

	ダイアログ操作キーによるダイアログの処理
	OK ボタンを省略したり、操作不能状態に設定した場合、 ダイアログはダイアログ操作キーで操作します。デフォルトの実装では、OK ボタンを押したときの動作と同じになります。 つまり、ダイアログ操作キーを押すと (SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK) イベントが送信されてダイアログは閉じることになります。 この機能は、警告文だけのボタンを持たないダイアログを表示し、ダイアログ操作キーの押下でダイアログを閉じる場面などで利用できます。

	デフォルトの背景色
	SFZMessageDialog クラスでは、 SFYWidget::SetBackgroundColor 関数で設定する背景色がデフォルトで灰色[SFXRGBColor(0xEE, 0xEE, 0xEE,0x00)]に設定されています。

	重要
	SFYResponder::SetParent 関数、 SFYResponder::SetState 関数、 SFYResponder::SetRealBound 関数の呼び出しは必須です。 その他の関数の呼び出しは省略可能です。

□ダイアログのサンプルコード

通知メッセージを表示するダイアログ(SFZMessageDialog)のサンプルコードです。

// クラスの定義
SFMTYPEDEFCLASS(USRApplication)
class USRApplication : public SFYApplication {
  SFMSEALCOPY(USRApplication)
public:
  static SFCInvokerPtr Factory(Void);
private:
  explicit USRApplication(Void) static_throws;
  virtual ~USRApplication(Void);

  XANDLER_DECLARE_VOIDRESULT(OnResult)        // ダイアログ選択結果イベントを受信するハンドラ
};


// コンストラクタ
USRApplication::USRApplication(Void) static_throws
{
  // ...（省略）...

  SFZMessageDialogSmp dialog;  // SFZMessageDialog のスマートポインタ
  SFCError error(SFERR_NO_ERROR);

  // ダイアログを生成する
  if ((dialog = SFZMessageDialog::NewInstance(&error)) != null) {

    // 親レスポンダをアプリケーションクラス（ルート）に設定する
    error = dialog->SetParent(GetThis());
    if (error == SFERR_NO_ERROR) {

      // ダイアログ選択結果イベントを受信するハンドラを登録する
      error = dialog->RegisterHandler(
                  SFXEventRange(SFEVT_RESPONDER_RESULT, SFEVT_RESPONDER_RESULT, SFP16_BEGIN, SFP16_END),
                  XANDLER_INTERNAL(OnResult)
      );
      if (error == SFERR_NO_ERROR) {

        // アイコン画像を設定する
        error = dialog->SetIconImage(SFXPath(USRApplication_RES_FILE), ICON);
        if (error == SFERR_NO_ERROR) {

          // メッセージを "SFZMessageDialog:\n\nThis is a message dialog" に設定する
          error = dialog->SetMessageText("SFZMessageDialog:\n\nThis is a message dialog");
          if (error == SFERR_NO_ERROR) {

            // ボタンのテキストを "OK" に設定する
            error = dialog->SetButtonText("OK");
            if (error == SFERR_NO_ERROR) {

              // 携帯画面領域を (20, 20) だけ縮小した領域をヒント領域にして
              // ダイアログに最適な領域を取得しヒント領域内の中央に配置し、
              // ダイアログの実領域に設定する
              dialog->SetRealBound(dialog->GetSuitableBound(GetLocalBound().Deflate(20, 20), SFYResponder::HORIZONTAL_CENTER, SFYResponder::VERTICAL_MIDDLE));

              // 状態を「可視＋活性＋操作可能＋フォーカス」にまとめて設定する
              dialog->SetState(true, true, true, true);

              // 最前面に移動する
              dialog->ToFront();
            }
          }
        }
      }
    }
  }
  static_throw(error);
}


// ダイアログ選択結果イベントを受信するハンドラ
XANDLER_IMPLEMENT_VOIDRESULT(USRApplication, OnResult, invoker, reason, result)
{
  // invoker にはダイアログが渡される
  // reason には結果イベントの P16 値が渡される
  // result には 0 が渡される

  switch (reason) {

    case SFP16_RESULT_OK:

      // OK ボタン押下時、または操作キー押下時

      // ...（省略）...
      break;

    case SFP16_RESULT_ESCAPE:

      // ESCAPE キー押下時、または ScheduleTimer 関数で設定した時間が経過した時

      // ...（省略）...
      break;
  }

  // ダイアログを閉じる
  invoker->Terminate();

  return;
}

図 386. サンプルコードの実行結果 : 通知メッセージを表示するダイアログ[SFZMessageDialog]

□タイトルと枠を持つダイアログのサンプルコード

フレームの機能を利用して、 ダイアログにタイトルや枠を付けることが可能です。

タイトル付きベベルフレーム(SFZTitleBevelFrame)を持つ通知メッセージを表示するダイアログ(SFZMessageDialog)のコードです。

// クラスの定義
SFMTYPEDEFCLASS(USRApplication)
class USRApplication : public SFYApplication {
  SFMSEALCOPY(USRApplication)
public:
  static SFCInvokerPtr Factory(Void);
private:
  explicit USRApplication(Void) static_throws;
  virtual ~USRApplication(Void);

  XANDLER_DECLARE_VOIDRESULT(OnResult)        // ダイアログ選択結果イベントを受信するハンドラ
};


// コンストラクタ
USRApplication::USRApplication(Void) static_throws
{
  // ..... ( 省略 ) .....

  SFZTitleBevelFrameSmp frame;  // フレームのスマートポインタ
  SFZMessageDialogSmp   dialog; // ダイアログのスマートポインタ
  SFCError              error(SFERR_NO_ERROR);

  // フレームを生成する
  if ((frame = SFZTitleBevelFrame::NewInstance(&error)) != null) {

    // フレームのタイトルを "SFZMessageDialog" に設定する
    frame->SetText("SFZMessageDialog");

    // 通常、フレームの状態は「可視+活性+操作可能+フォーカス」に設定する
    frame->SetState(true, true, true, true);

    // ダイアログを生成する
    if ((dialog = SFZMessageDialog::NewInstance(&error)) != null) {

      // ダイアログの親レスポンダをアプリケーションクラス（ルート）に設定する
      error = dialog->SetParent(GetThis());
      if (error == SFERR_NO_ERROR) {

        // ダイアログにフレームを装着する
      　error = dialog->SetFrame(frame);
        if (error == SFERR_NO_ERROR) {

          // ダイアログ選択結果イベントを受信するハンドラを登録する
          error = dialog->RegisterHandler(
                      SFXEventRange(SFEVT_RESPONDER_RESULT, SFEVT_RESPONDER_RESULT, SFP16_BEGIN, SFP16_END),
                      XANDLER_INTERNAL(OnResult)
          );
          if (error == SFERR_NO_ERROR) {

            // アイコン画像を設定する
            error = dialog->SetIconImage(SFXPath(USRApplication_RES_FILE), ICON);
            if (error == SFERR_NO_ERROR) {

              // メッセージを "This is a message dialog with a title bevel frame." に設定する
              error = dialog->SetMessageText("This is a message dialog with a title bevel frame.");
              if (error == SFERR_NO_ERROR) {

                // ボタンのテキストを "OK" に設定する
                error = dialog->SetButtonText("OK");
                if (error == SFERR_NO_ERROR) {

                  // 携帯画面領域を (20, 20) だけ縮小した領域をヒント領域にして
                  // ダイアログに最適な領域を取得しヒント領域内の中央に配置し、
                  // ダイアログの実領域に設定する
                  // ※自動的にダイアログの実領域をフレーム余白領域だけ拡大した領域がフレームの実領域に設定される
                  dialog->SetRealBound(dialog->GetSuitableBound(GetLocalBound().Deflate(20, 20), SFYResponder::HORIZONTAL_CENTER, SFYResponder::VERTICAL_MIDDLE));

                  // ダイアログの状態を「可視＋活性＋操作可能＋フォーカス」にまとめて設定する
                  dialog->SetState(true, true, true, true);

                  // ダイアログを最前面に移動する
                  // ※自動的にフレームも最前面に移動する
                  dialog->ToFront();
                }
              }
            }
          }
        }
      }
    }
  }
  static_throw(error);
}


// ダイアログ選択結果イベントを受信するハンドラ
XANDLER_IMPLEMENT_VOIDRESULT(USRApplication, OnResult, invoker, reason, result)
{
  // invoker にはダイアログが渡される
  // reason には結果イベントの P16 値が渡される
  // result には 0 が渡される

  switch (reason) {

    case SFP16_RESULT_OK:

      // OK ボタン押下時、または操作キー押下時

      // ...（省略）...
      break;

    case SFP16_RESULT_ESCAPE:

      // ESCAPE キー押下時、または ScheduleTimer 関数で設定した時間が経過した時

      // ...（省略）...
      break;
  }

  // ダイアログだけを閉じる
  // ※自動的にフレームはダイアログから切り離されて見えなくなる
  invoker->Terminate();

  return;
}

図 387. サンプルコードの実行結果 : タイトル付きベベルフレームを持つ通知メッセージを表示するダイアログ[SFZMessageDialog と SFZTitleBevelFrame]

	引数（矩形領域）を指定しないで GetSuitableBound 関数を呼び出すときの注意
	このレスポンダの SFYResponder::GetSuitableBound 関数を呼び出すときに引数（矩形領域）を指定しない場合は、 予め SFYResponder::SetRealBound 関数を使用して実領域（＝ローカル領域※）を設定する必要があります。 設定された実領域の横幅は領域計算に必要なヒント値として利用されます。 通常、実領域の横幅には [ 使用しているフォントの横幅 ＋ フレームマージンの幅 × 2 ] 以上の値を設定します。 ※仮想領域を設定しない限り、 実領域はローカル領域と同じです。 また、ヒント値として使われる実領域を設定する際は、 SFZMessageDialog::SetFrameSize 関数で設定するフレームマージンの幅も考慮する必要があります。 参照: 複数行のテキストを表示するレスポンダに最適な大きさを取得する

参照

通知メッセージを表示するダイアログ [SFZMessageDialog] | SFZDialog | SFZQuestionDialog | SFZImageLabelControl | SFZMultipleTextLabelControl | SFZTextButtonControl | SFYWidget | SFXRGBColor | SFYWidget::SetBackgroundColor | SFZMessageDialog::SetIconImage | SFZMessageDialog::SetMessageText | SFZMessageDialog::SetButtonText | SFZDialog::SetOperateKey | SFZDialog::SetEscapeKey | SFYButtonControl::SetOperateKey | SFYContainer::SetScrollUpKey | SFYContainer::SetScrollDownKey | SFZDialog::ScheduleTimer | SFYResponder::ToFront | SFYResponder::Terminate | フレーム | SFZTitleBevelFrame | 実領域 | ローカル領域 | 仮想領域 | 複数行のテキストを表示するレスポンダに最適な大きさを取得する | SFZMessageDialog::SetFrameSize

メンバ

解説

このコンストラクタは、以下の初期化処理を行います。

内部実装

このコンストラクタの内部実装は以下の通りです。

/*protected */SFZMessageDialog::SFZMessageDialog(Void) static_throws
{
    static SFXEventRange::AtomRecConst          crange[] = {
        {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END},
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,          SFP16_BEGIN,            SFP16_END}
    };
    static SFXEventRange::AtomRecConst          brange[] = {
        {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END},
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,          SFP16_BEGIN,            SFP16_END},
        {SFEVT_RESPONDER_RESULT, SFEVT_RESPONDER_RESULT,          SFP16_BEGIN,            SFP16_END}
    };
    SFYHandler::RuleRec                         crule[lengthof(crange)];
    SFYHandler::RuleRec                         brule[lengthof(brange)];
    SFCError                                    error;

    if (static_try()) {
        SetType(CODE_TYPE);
        if ((_icon = SFZImageLabelControl::NewInstance(&error)) != null) {
            static_throw(_icon->SetParent(GetThis()));
            if (static_try()) {
                crule[0].spp = XANDLER_FUNCTION(OnRewind);
                crule[0].reference = this;
                crule[1].spp = XANDLER_FUNCTION(OnIconStyle);
                crule[1].reference = this;
                static_throw(_icon->RegisterHandler(atomic_cast(crange), crule, lengthof(crange)));
                if (static_try()) {
                    if ((_message = SFZMultipleTextLabelControl::NewInstance(&error)) != null) {
                        static_throw(_message->SetParent(GetThis()));
                        if (static_try()) {
                            crule[0].spp = XANDLER_FUNCTION(OnRewind);
                            crule[0].reference = this;
                            crule[1].spp = XANDLER_FUNCTION(OnMessageStyle);
                            crule[1].reference = this;
                            static_throw(_message->RegisterHandler(atomic_cast(crange), crule, lengthof(crange)));
                            if (static_try()) {
                                if ((_button = SFZTextButtonControl::NewInstance(&error)) != null) {
                                    static_throw(_button->SetParent(GetThis()));
                                    if (static_try()) {
                                        brule[0].spp = XANDLER_FUNCTION(OnRewind);
                                        brule[0].reference = this;
                                        brule[1].spp = XANDLER_FUNCTION(OnButtonStyle);
                                        brule[1].reference = this;
                                        brule[2].spp = XANDLER_FUNCTION(OnButtonResult);
                                        brule[2].reference = this;
                                        static_throw(_button->RegisterHandler(atomic_cast(brange), brule, lengthof(brange)));
                                        if (static_try()) {
                                            _message->SetHorizontalAlign(SFZMultipleTextLabelControl::HORIZONTAL_LEFT);
                                            _message->SetVerticalAlign(SFZMultipleTextLabelControl::VERTICAL_TOP);
                                            _frame = DEFAULT_FRAME;
                                            _space = DEFAULT_SPACE;
                                            Relocate();
                                        }
                                    }
                                }
                                else {
                                    static_throw(error);
                                }
                            }
                        }
                    }
                    else {
                        static_throw(error);
                    }
                }
            }
        }
        else {
            static_throw(error);
        }
    }
}// SFZMessageDialog::SFZMessageDialog //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZMessageDialog, OnRewind, invoker, event)
{
    unused(invoker);
    unused(event);
    RewindTimer();
    return false;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFZMessageDialog, OnRewind) //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZMessageDialog, OnIconStyle, invoker, reason)
{
    switch (reason) {
        case SFP16_STYLE_IMAGE:
            invoker->SetState(static_cast<SFZImageLabelControlPtr>(invoker)->GetImage() != null, true, false, false);
            Relocate();
            break;
        default:
            break;
    }
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, reason, 0), true);
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZMessageDialog, OnIconStyle) //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZMessageDialog, OnMessageStyle, invoker, reason)
{
    switch (reason) {
        case SFP16_STYLE_TEXT:
            invoker->SetState(!static_cast<SFZMultipleTextLabelControlPtr>(invoker)->GetText().IsEmpty(), true, false, false);
        case SFP16_STYLE_FONT:
            Relocate();
            break;
        default:
            break;
    }
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, reason, 0), true);
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZMessageDialog, OnMessageStyle) //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZMessageDialog, OnButtonStyle, invoker, reason)
{
    switch (reason) {
        case SFP16_STYLE_TEXT:
            invoker->SetState(!static_cast<SFZTextButtonControlPtr>(invoker)->GetText().IsEmpty(), true, true, true);
        case SFP16_STYLE_FONT:
            Relocate();
            break;
        default:
            break;
    }
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, reason, 0), true);
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZMessageDialog, OnButtonStyle) //

/*private */XANDLER_IMPLEMENT_VOIDRESULT(SFZMessageDialog, OnButtonResult, invoker, reason, result)
{
    unused(invoker);
    unused(reason);
    unused(result);
    CancelTimer();
    InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, 0), false);
    return;
}// XANDLER_IMPLEMENT_VOIDRESULT(SFZMessageDialog, OnButtonResult) //

/*private */Void SFZMessageDialog::Relocate(Void)
{
    SFXRectangle                                lx;
    SFXRectangle                                icon;
    SFXRectangle                                message;
    SFXRectangle                                button;

    lx.Set(GetLocalBound());
    lx.Deflate(_frame, _frame);
    icon.Set(SFXRectangle::ZeroInstance());
    message.Set(SFXRectangle::ZeroInstance());
    button.Set(SFXRectangle::ZeroInstance());
    if (_button->GetStateVisible()) {
        button.Set(_button->GetSuitableBound(lx));
        button.SnapLeftBottom(lx.GetLeftBottom());
        if (!button.IsEmpty()) {
            button.SetRight(lx.GetRight());
            lx.SubBottom(button.GetHeight() + _space);
        }
    }
    if (_icon->GetStateVisible()) {
        icon.Set(_icon->GetSuitableBound(lx));
        icon.SnapLeftTop(lx.GetLeftTop());
        if (!icon.IsEmpty()) {
            lx.AddLeft(icon.GetWidth() + _space);
        }
    }
    if (_message->GetStateVisible()) {
        message.Set(_message->GetSuitableBound(lx));
        message.SnapRightTop(lx.GetRightTop());
        if (!message.IsEmpty()) {
            message.SetLeftBottom(lx.GetLeftBottom());
        }
    }
    _icon->SetRealBound(icon);
    _message->SetRealBound(message);
    _button->SetRealBound(button);
    return;
}// SFZMessageDialog::Relocate //

参照

SFYResponder::SetType | SFZMessageDialog::CodeEnum | SFZMessageDialog::DefaultEnum | SFZMultipleTextLabelControl::HorizontalEnum | SFZMultipleTextLabelControl::VerticalEnum | SFZMultipleTextLabelControl | SFXEvent | SFXRGBColor | タイプ | イベント | 結果イベント[SFEVT_RESPONDER_RESULT]

解説

このデストラクタは、何も行いません。

内部実装

このデストラクタの内部実装は以下の通りです。

/*protected virtual */SFZMessageDialog::~SFZMessageDialog(Void)
{
}// SFZMessageDialog::~SFZMessageDialog //

戻り値

ボタンコントロール（SFZTextButtonControl）。

解説

この関数は、 ボタンコントロール（このダイアログが内部で保持するボタンコントロール）を取得します。

SFZTextButtonControl クラスの API を使用してボタンのテキストの色や配置の変更などが行えます。

参照

SFZMessageDialog::SetButtonText | SFZTextButtonControl

戻り値

ボタンコントロールのテキスト。

解説

この関数は、 ボタンコントロールのテキストを取得します。

参照

SFZMessageDialog::SetButtonText | SFXWideString

戻り値

フレームマージンのサイズ。[単位 : ピクセル]

解説

この関数は、フレームマージンのサイズを取得します。

	フレームマージン
	ダイアログの枠と、ダイアログが内包しているコントロールまでのマージン。 このマージンはダイアログの枠から上下左右同じ値だけ効きます。 アイコンとメッセージは上から、ボタンは下からフレームマージンの間隔を空けてダイアログ内に配置されます。

参照

SFZMessageDialog::SetFrameSize

戻り値

アイコン画像として内部で保持するイメージラベル（SFZImageLabelControl）。

解説

この関数は、 このダイアログのアイコン画像として内部で保持する SFZImageLabelControl インスタンスを取得します。

SFZImageLabelControl クラスの API を使用して画像や配置の変更などが行えます。

参照

SFZMessageDialog::SetIconImage | SFZImageLabelControl

戻り値

ダイアログのアイコン画像。

解説

この関数は、このダイアログのアイコン画像を取得します。

参照

SFZMessageDialog::SetIconImage | SFBImage | BREW API IImage

戻り値

内部で保持する複数行テキストラベルコントロール（SFZMultipleTextLabelControl）。

解説

この関数は、 このダイアログがメッセージとして内部で保持する複数行テキストラベルコントロール SFZMultipleTextLabelControl インスタンスを取得します。

SFZMultipleTextLabelControl クラスの API を使用してメッセージの色や配置の変更などが行えます。

参照

SFZMultipleTextLabelControl

戻り値

ダイアログのメッセージテキスト。

解説

この関数は、メッセージテキストを取得します。

参照

SFZMessageDialog::SetMessageText | SFXWideString

戻り値

ダイアログのスペースマージンのサイズ。[単位 : ピクセル]

解説

この関数は、 ダイアログのスペースマージンのサイズを取得します。

ダイアログに最適なサイズを自動計算する場合、 スペースマージンのサイズの間隔でコントロールは配置されます。

	スペースマージン
	コントロール同士のマージン。 アイコンイメージとメッセージテキスト、ボタンとメッセージテキストの間のスペースです。 ダイアログの縦幅が大きい場合、ボタンとメッセージテキストの間隔はスペースマージンより大きくなります。

参照

SFZMessageDialog::SetSpaceSize

解説

この関数は、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] を受信したときに呼び出されます。

引数 rectangle で指定した矩形領域に収まる範囲内で、レスポンダの最適な領域を計算します。

計算結果のレスポンダに最適なサイズは、rectangle 引数の size 要素（サイズ）に格納されます。 なお、領域イベントの P32 パラメータとして渡された rectangle 引数の origin 要素（始点）はこの関数内で変更しないことを推奨します。

デフォルトの実装は以下の通りです。

以下で、アイコン、メッセージ、ボタンが省略されている場合は、それらの領域は計算されません。 また、その分だけスペースマージンも計算対象に含まれません。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント]
	SFYResponder::GetSuitableBound 関数は、 引数にヒント領域を指定した場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundOptimize 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle にはヒント領域が初期設定されています。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベント受信時の最適な領域計算
	SFYWidget::HandleBoundOptimize 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 最適な領域の計算は、最初に SFYWidget::HandleBoundOptimize 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundOptimize 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZMessageDialog::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    SFXRectangle                                rx;
    SFXSize                                     icon;
    SFXSize                                     message;
    SFXSize                                     button;
    SInt16                                      horizontal;
    SInt16                                      vertical;

    rectangle->Deflate(_frame, _frame);
    rx.Set(*rectangle);
    icon.Set(SFXSize::ZeroInstance());
    message.Set(SFXSize::ZeroInstance());
    button.Set(SFXSize::ZeroInstance());
    horizontal = 0;
    vertical = 0;
    if (_button->GetStateVisible()) {
        button.Set(_button->GetSuitableBound(rx).GetSize());
        if (!button.IsEmpty()) {
            rx.SubBottom(button.GetHeight() + _space);
            ++vertical;
        }
    }
    if (_icon->GetStateVisible()) {
        icon.Set(_icon->GetSuitableBound(rx).GetSize());
        if (!icon.IsEmpty()) {
            rx.AddLeft(icon.GetWidth() + _space);
            ++horizontal;
            if (message.IsEmpty()) {
                ++vertical;
            }
        }
    }
    if (_message->GetStateVisible()) {
        message.Set(_message->GetSuitableBound(rx).GetSize());
        if (!message.IsEmpty()) {
            ++horizontal;
            if (icon.IsEmpty()) {
                ++vertical;
            }
        }
    }
    rx.SetSize(icon.GetWidth() + message.GetWidth(), (icon.GetHeight() > message.GetHeight()) ? (icon.GetHeight()) : (message.GetHeight()));
    if (--horizontal > 0) {
        rx.AddWidth(_space * horizontal);
    }
    if (--vertical > 0) {
        rx.AddHeight(_space * vertical);
    }
    rx.SetSize((rx.GetWidth() > button.GetWidth()) ? (rx.GetWidth()) : (button.GetWidth()), rx.GetHeight() + button.GetHeight());
    rectangle->SetSize(rx.GetSize());
    rectangle->Inflate(_frame, _frame);
    return;
}// SFZMessageDialog::HandleBoundOptimize //

参照

SFYResponder::GetSuitableBound | SFZTextButtonControl::HandleBoundOptimize | SFZMultipleTextLabelControl::HandleBoundOptimize | SFZImageLabelControl::HandleBoundOptimize | SFZMessageDialog::SetFrameSize | SFZMessageDialog::SetSpaceSize | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL, rectangle)] を受信したときに呼び出されます。

実領域が変化したときに実行される処理です。

デフォルトの実装では、仮想領域を実領域に一致させます。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベント]
	SFYResponder::SetRealBound 関数は、この関数内の処理により実領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundReal 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の実領域が設定されています。

	実領域が変化した時の処理
	SFYWidget::HandleBoundReal 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 実領域の変更処理は、最初に SFYWidget::HandleBoundReal 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundReal 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZMessageDialog::HandleBoundReal(Void)
{
    SetVirtualBound(SFXRectangle(SFXGrid::ZeroInstance(), GetRealBound().GetSize()));
    return;
}// SFZMessageDialog::HandleBoundReal //

参照

SFYResponder::SetRealBound | 実領域 | 仮想領域 | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] を受信したときに呼び出されます。

レスポンダの最適な領域を計算します。

計算結果のレスポンダに最適なサイズは、rectangle 引数の size 要素（サイズ）に格納されます。 なお、領域イベントの P32 パラメータとして渡された rectangle 引数の origin 要素（始点）はこの関数内で変更しないことを推奨します。

デフォルトの実装は以下の通りです。

以下で、アイコン、メッセージ、ボタンが省略されている場合は、それらの領域は計算されません。 また、その分だけスペースマージンも計算対象に含まれません。

	前提条件
	予め SFYResponder::SetRealBound 関数を使用して実領域（＝ローカル領域※）を設定する必要があります。 設定された実領域の横幅は領域計算に必要なヒント値として利用されます。 通常、実領域の横幅には [ 使用しているフォントの横幅 ＋ フレームマージンの幅 × ２ ] 以上の値を設定します。 ※仮想領域を設定しない限り、 実領域はローカル領域と同じです。また、ヒント値として使われる実領域を設定する際は、 SFZMessageDialog::SetFrameSize 関数で設定するフレームマージンの幅も考慮する必要があります。 参照: 複数行のテキストを表示するレスポンダに最適な大きさを取得する

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント]
	SFYResponder::GetSuitableBound 関数は、 引数に何も指定しない場合は 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundRequest 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には実領域が初期設定されています。 Tip 実領域のデフォルト値は SFXRectangle(0, 0, 0, 0) です。

	(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベント受信時の最適な領域計算
	SFYWidget::HandleBoundRequest 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 最適な領域の計算は、最初に SFYWidget::HandleBoundRequest 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundRequest 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZMessageDialog::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    SFXRectangle                                rx;
    SFXRectangle                                lx;
    SFXSize                                     icon;
    SFXSize                                     message;
    SFXSize                                     button;
    SInt16                                      horizontal;
    SInt16                                      vertical;

    rectangle->Deflate(_frame, _frame);
    rx.Set(*rectangle);
    icon.Set(SFXSize::ZeroInstance());
    message.Set(SFXSize::ZeroInstance());
    button.Set(SFXSize::ZeroInstance());
    horizontal = 0;
    vertical = 0;
    if (_button->GetStateVisible()) {
        button.Set(_button->GetSuitableBound().GetSize());
        if (!button.IsEmpty()) {
            rx.SetWidth((rx.GetWidth() > button.GetWidth()) ? (rx.GetWidth()) : (button.GetWidth()));
            rx.SubBottom(button.GetHeight() + _space);
            ++vertical;
        }
    }
    if (_icon->GetStateVisible()) {
        icon.Set(_icon->GetSuitableBound().GetSize());
        if (!icon.IsEmpty()) {
            rx.AddLeft(icon.GetWidth() + _space);
            rx.SetHeight((rx.GetHeight() > icon.GetHeight()) ? (rx.GetHeight()) : (icon.GetHeight()));
            ++horizontal;
            if (message.IsEmpty()) {
                ++vertical;
            }
        }
    }
    if (_message->GetStateVisible()) {
        lx.Set(_message->GetRealBound());
        _message->SetRealBound(rx);
        message.Set(_message->GetSuitableBound().GetSize());
        _message->SetRealBound(lx);
        if (!message.IsEmpty()) {
            ++horizontal;
            if (icon.IsEmpty()) {
                ++vertical;
            }
        }
    }
    rx.SetSize(icon.GetWidth() + message.GetWidth(), (icon.GetHeight() > message.GetHeight()) ? (icon.GetHeight()) : (message.GetHeight()));
    if (--horizontal > 0) {
        rx.AddWidth(_space * horizontal);
    }
    if (--vertical > 0) {
        rx.AddHeight(_space * vertical);
    }
    rx.SetSize((rx.GetWidth() > button.GetWidth()) ? (rx.GetWidth()) : (button.GetWidth()), rx.GetHeight() + button.GetHeight());
    rectangle->SetSize(rx.GetSize());
    rectangle->Inflate(_frame, _frame);
    return;
}// SFZMessageDialog::HandleBoundRequest //

参照

SFYResponder::GetSuitableBound | SFZTextButtonControl::HandleBoundRequest | SFZMultipleTextLabelControl::HandleBoundRequest | SFZImageLabelControl::HandleBoundRequest | 実領域 | ローカル領域 | 仮想領域 | 複数行のテキストを表示するレスポンダに最適な大きさを取得する | SFZMessageDialog::SetFrameSize | SFZMessageDialog::SetSpaceSize | SFXEvent | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] を受信したときに呼び出されます。

仮想領域が変化したときに実行される処理です。

デフォルトの実装は、以下のようにしてダイアログ内のアイコン、メッセージ、ボタンの再配置を行います。

	注意
	以下で、アイコン、メッセージ、ボタンが省略されている場合は、それらは再配置されません。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベント]
	SFYResponder::SetRealBound / SFYResponder::SetVirtualBound 関数は、 この関数内の処理により仮想領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundVirtual 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の仮想領域が設定されています。

	仮想領域の変更処理
	SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 仮想領域の変更処理は、最初に SFYWidget::HandleBoundVirtual 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZMessageDialog::HandleBoundVirtual(Void)
{
    Relocate();
    return;
}// SFZMessageDialog::HandleBoundVirtual //

/*private */Void SFZMessageDialog::Relocate(Void)
{
    SFXRectangle                                lx;
    SFXRectangle                                icon;
    SFXRectangle                                message;
    SFXRectangle                                button;

    lx.Set(GetLocalBound());
    lx.Deflate(_frame, _frame);
    icon.Set(SFXRectangle::ZeroInstance());
    message.Set(SFXRectangle::ZeroInstance());
    button.Set(SFXRectangle::ZeroInstance());
    if (_button->GetStateVisible()) {
        button.Set(_button->GetSuitableBound(lx));
        button.SnapLeftBottom(lx.GetLeftBottom());
        if (!button.IsEmpty()) {
            button.SetRight(lx.GetRight());
            lx.SubBottom(button.GetHeight() + _space);
        }
    }
    if (_icon->GetStateVisible()) {
        icon.Set(_icon->GetSuitableBound(lx));
        icon.SnapLeftTop(lx.GetLeftTop());
        if (!icon.IsEmpty()) {
            lx.AddLeft(icon.GetWidth() + _space);
        }
    }
    if (_message->GetStateVisible()) {
        message.Set(_message->GetSuitableBound(lx));
        message.SnapRightTop(lx.GetRightTop());
        if (!message.IsEmpty()) {
            message.SetLeftBottom(lx.GetLeftBottom());
        }
    }
    _icon->SetRealBound(icon);
    _message->SetRealBound(message);
    _button->SetRealBound(button);
    return;
}// SFZMessageDialog::Relocate //

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 仮想領域 | 領域イベント[SFEVT_RESPONDER_BOUND] | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND] SFZTextButtonControl::HandleBoundRequest | SFZMultipleTextLabelControl::HandleBoundRequest | SFZImageLabelControl::HandleBoundRequest | SFZMessageDialog::SetFrameSize | SFZMessageDialog::SetSpaceSize

引数

戻り値

解説

この関数は、SFZMessageDialog クラスの新しいインスタンスを作成します。

インスタンスの作成に成功した場合は null 以外のポインタを返します。 失敗した場合は、null ポインタを返します。

exception 引数を指定した場合、 この引数にはエラー値が返ります。

使用例

以下は、メッセージダイアログのインスタンスを生成するためのコードです。

// メッセージダイアログのインスタンスを生成する
SFZMessageDialogSmp _messagedialog;
SFCError error;

if ((_messagedialog = SFZMessageDialog::NewInstance(&error)) != null) {
    // ...
}

戻り値

解説

この関数は、 ダイアログのボタンのテキストを設定します。

この関数を使用してボタンのテキストを設定しない場合は、 ダイアログにボタンは表示されません。

なお、この関数で設定したボタンのテキストは、 内部で SFZTextButtonControl インスタンスとして保持されます。 このインスタンスは、SFZMessageDialog::GetButton 関数を呼び出して取得できます。

参照

SFZMessageDialog::GetButtonText | SFZMessageDialog::GetButton | SFZTextButtonControl | SFXWideString

解説

この関数は、 ダイアログのフレームマージンのサイズを設定します。[単位 : ピクセル]

デフォルト値: SFZMessageDialog::DEFAULT_FRAME ピクセル （5 ピクセル）

	フレームマージン
	ダイアログの枠と、ダイアログが内包しているコントロールまでのマージン。 このマージンはダイアログの枠から上下左右同じ値だけ効きます。 アイコンは左上、メッセージは右上から、ボタンは下からフレームマージンの間隔を空けてダイアログ内に配置されます。

図 388. フレームマージン[SFZMessageDialog(拡大図)]

ダイアログのアイコン、メッセージ、ボタンは、フレームマージンの枠で囲まれる領域に配置されます。

参照

SFZMessageDialog::GetFrameSize | SFZMessageDialog::DefaultEnum

戻り値

解説

この関数は、 ダイアログのアイコン画像を設定します。

画像オブジェクトを直接、あるいは、リソースファイルから読み込むように指定します。

画像サイズの X または Y 成分が 0 以下のときや画像にアニメーションが含まれるときは、SFERR_INVALID_PARAM が返ります。

この関数を使用してダイアログのアイコン画像を設定しない場合は、 ダイアログにアイコンは表示されません。

なお、この関数で設定したアイコン画像は、 内部で SFZImageLabelControl インスタンスとして保持されます。 このインスタンスは、SFZMessageDialog::GetIcon 関数を呼び出して取得できます。

参照

SFZMessageDialog::GetIconImage | SFZMessageDialog::GetIcon | SFZImageLabelControl | SFBImage | BREW API IImage

戻り値

解説

この関数は、 ダイアログのメッセージテキストを設定します。

この関数を使用してメッセージテキストを設定しない場合は、 ダイアログにメッセージは表示されません。

なお、この関数で設定したメッセージは、 内部で SFZMultipleTextLabelControl インスタンスとして保持されます。 このインスタンスは、SFZMessageDialog::GetMessage 関数を呼び出して取得できます。

参照

SFZMessageDialog::GetMessageText | SFZMessageDialog::GetMessage | SFZMultipleTextLabelControl | SFXWideString

解説

この関数は、 ダイアログのスペースマージンのサイズを設定します。[単位 : ピクセル]

ダイアログに最適なサイズを自動計算する場合、 スペースマージンのサイズの間隔でコントロールは配置されます。

デフォルト値: SFZMessageDialog::DEFAULT_SPACE [５ピクセル]

	スペースマージン
	コントロール同士のマージン。 アイコンとメッセージ、ボタンとメッセージの間のスペースです。 ダイアログの領域の縦幅が大きく設定されている場合は、ボタンとメッセージの間隔はスペースマージンより広くなります。

図 389. スペースマージン[SFZMessageDialog(拡大図)]

アイコンとメッセージ、メッセージとボタンの間には、スペースマージンの余白が設定されます。

ダイアログの領域の縦幅が大きく設定されている場合は、ボタンとメッセージの間隔はスペースマージンより広くなります。

参照

SFZMessageDialog::GetSpaceSize | SFZMessageDialog::DefaultEnum

参照

SFYResponder::GetType | SFYResponder::SetType

解説

	フレームマージン
	ダイアログの枠と、ダイアログが内包しているコントロールまでのマージン。 このマージンはダイアログの枠から上下左右同じ値だけ効きます。 アイコンは左上、メッセージは右上から、ボタンは下からフレームマージンの間隔を空けてダイアログ内に配置されます。

図 390. フレームマージン[SFZMessageDialog(拡大図)]

ダイアログのアイコン、メッセージ、ボタンは、フレームマージンの枠で囲まれる領域に配置されます。

	スペースマージン
	コントロール同士のマージン。 アイコンとメッセージ、メッセージとボタンの間には、スペースマージンの余白が設定されます。 ダイアログの領域の縦幅が大きく設定されている場合は、ボタンとメッセージの間隔はスペースマージンより広くなります。

図 391. スペースマージン[SFZMessageDialog(拡大図)]

アイコンとメッセージ、メッセージとボタンの間には、スペースマージンの余白が設定されます。

ダイアログの領域の縦幅が大きく設定されている場合は、ボタンとメッセージの間隔はスペースマージンより広くなります。

参照

SFZMessageDialog::SetFrameSize | SFZMessageDialog::SetSpaceSize