継承図

協調図

解説

■ 仕様と使い方

ダイアログは、 ルート[SFZRoot]内に配置されるように設計されたレスポンダです。

すべてのダイアログは SFZDialog クラスを継承し、 実領域よりも大きく設定された仮想領域のスクロール機能とフォーカスの移動機能に加え、 一定時間経過後に自動的にダイアログを閉じる機能とデフォルトのキー操作機能を提供します。

たとえば、 SFZMessageDialog や SFZQuestionDialog などのダイアログは、 このクラスを継承して実装しています。

ウィンドウと同様にコントロールを配置するためのコンテナとして利用できますが、 ダイアログは一時的な画面を表示しユーザーに結果を選択させる目的で使用します。

具象ダイアログはアプリ開発ですぐに使うことができる部品であり、 抽象ダイアログはカスタマイズされたユーザー定義ダイアログを作成するための起点（基底クラス）となります。

	重要
	すべての具象ダイアログにおいて、 SFYResponder::SetParent 関数、 SFYResponder::SetState 関数、 SFYResponder::SetRealBound 関数の呼び出しは必須です。 その他の関数の呼び出しは省略可能です。 ※ SFYResponder::SetFrame 関数を呼び出してフレームをダイアログに装着する場合、 フレームの SFYResponder::SetRealBound 関数を呼び出すと、 ダイアログの実領域がフレーム余白領域に合わせて自動的に設定されるので、SFYResponder::SetRealBound 関数の呼び出しは省略されます。

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

□ダイアログを表す具象クラスとしての汎用ダイアログ[SFZDialog]

汎用ダイアログ[SFZDialog]は、 各種コントロールやコンテナを配置するための汎用的なダイアログとして機能します。

コントロールやコンテナが配置されている場合、 SFYContainer::SetScrollDownKey / SFYContainer::SetScrollUpKey / SFYContainer::SetPageDownKey / SFYContainer::SetPageUpKey / SFYContainer::SetSnapDownKey / SFYContainer::SetSnapUpKey 関数で設定するスクロールキーでフォーカスの移動機能を利用できます。

仮想領域が実領域よりも大きい場合は、 フォーカス移動機能と連動した、仮想領域の上下方向へのスクロール機能も利用できます。

デフォルトの実装では、 汎用ダイアログ[SFZDialog]は 下記の結果イベント[SFEVT_RESPONDER_RESULT]を受信します。

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

ダイアログ操作キーは、SFZDialog::SetOperateKey 関数を使用して設定します。 デフォルトでは、セレクトキーがダイアログ操作キーとして割り当てられています。

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

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

図 354. SFZDialog クラスの動作例

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

ダイアログ(SFZDialog)のサンプルコードです。

// クラスの定義
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
{
  // ...（省略）...

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

  // ダイアログを生成する
  if ((dialog = SFZDialog::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) {

        // 携帯画面領域を (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:

      // 操作キー押下時

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

    case SFP16_RESULT_ESCAPE:

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

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

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

  return;
}

図 355. サンプルコードの実行結果 : ダイアログ[SFZDialog]

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

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

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

// クラスの定義
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;  // フレームのスマートポインタ
  SFZDialogSmp          dialog; // ダイアログのスマートポインタ
  SFCError              error(SFERR_NO_ERROR);
 
  // フレームを生成する
  if ((frame = SFZTitleBevelFrame::NewInstance(&error)) != null) {

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

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

    // ダイアログを生成する
    if ((dialog = SFZDialog::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) {

            // 携帯画面領域を (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:

      // 操作キー押下時

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

    case SFP16_RESULT_ESCAPE:

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

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

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

  return;
}

図 356. サンプルコードの実行結果 : タイトル付きベベルフレームを持つダイアログ[SFZDialog と SFZTitleBevelFrame]

□ダイアログを表す抽象クラスとしての汎用ダイアログ[SFZDialog]

SFZDialog クラスは各種ダイアログを実装するための起点（基底クラス）となります。

たとえば、 SFZMessageDialog や SFZQuestionDialog などのダイアログは、 SFZDialog クラスを継承して実装しています。

コントロールやコンテナが配置されている場合、 SFYContainer::SetScrollUpKey や SFYContainer::SetScrollDownKey 関数で設定するスクロールキーを使用してフォーカス移動できます。 仮想領域が実領域よりも大きい場合は、 フォーカス移動機能と連動した、仮想領域の上下方向へのスクロール機能も利用できます。

デフォルトの実装では、 抽象ダイアログ [SFZDialog]は 下記の結果イベント[SFEVT_RESPONDER_RESULT]を受信します。

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

ダイアログ操作キーは、SFZDialog::SetOperateKey 関数を使用して設定します。 デフォルトでは、セレクトキーがダイアログ操作キーとして割り当てられています。

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

	注意
	SFZDialog::ScheduleTimer 関数で設定したタイマー処理は、 ダイアログ操作キーまたは ESCAPE キーを押したときに自動的にキャンセルされます。

■ イベントとハンドラ

SFZDialog を継承するレスポンダでは、 SFZDialog::SFZDialog / SFYContainer::SFYContainer / SFYWidget::SFYWidget コンストラクタで登録されたハンドラの処理により、 下記のイベントを受信すると、対応する下記の仮想関数（ハンドラ）が最初に呼び出されます。 その後、開発者がレスポンダに登録したハンドラが呼び出されることになります。

	注意
	ハンドラの詳細については、 SFZDialog::SFZDialog / SFYContainer::SFYContainer / SFYWidget::SFYWidget コンストラクタの解説を参照してください。

	Tip
	ハンドラを登録する手間を省略できるので、 通常、これらのイベント処理は仮想関数をオーバーライドして記述します。

※デフォルトの動作にある "−" は何も実装していないことを表す。

注釈

※1. SFYResponder::InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, 0), false) を実行します。 SFZDialog::HandleOperateKey 関数を呼び出す直前に、 SFZDialog::ScheduleTimer 関数で設定したタイマー処理をキャンセルする操作が内部的に行われます。 ※2. SFYResponder::InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0), false) を実行します。 SFZDialog::HandleEscapeKey 関数を呼び出す直前に、 SFZDialog::ScheduleTimer 関数で設定したタイマー処理をキャンセルする操作が内部的に行われます。 ※3. SFYContainer::ScrollUp 関数を実行します。 ※4. SFYContainer::ScrollDown 関数を実行します。 ※5. SFYContainer::PageUp 関数を実行します。 ※6. SFYContainer::PageDown 関数を実行します。 ※7. SFYContainer::SnapUp 関数を実行します。 ※8. SFYContainer::SnapDown 関数を実行します。

以下にユーザー定義ダイアログを作成するときに最低限必要なコードを示します。

SFMTYPEDEFRESPONDER(USRDialog)
class USRDialog : public SFZDialog {
    SFMSEALRESPONDER(USRDialog)
    SFMRESPONDERINSTANTIATEFIVE(USRDialog, SFZDialog, SFZWindow, SFYContainer, SFYWidget, SFYResponder)
public:

    // レスポンダのタイプを定義する
    // 小文字と記号のみからなるタイプは予約されているので使えない
    enum CodeEnum {
        CODE_TYPE = four_char_code('U', 'D', 'L', 'G')
    };
    SFMTYPEDEFTYPE(CodeEnum)

public:
    static USRDialogSmp NewInstance(SFCErrorPtr exception = null);
protected:
    explicit USRDialog(Void) static_throws;
    virtual ~USRDialog(Void);

    // 親クラスで定義されている仮想関数のうち、実装が推奨される仮想関数
    virtual Void HandleBoundRequest(SFXRectanglePtr rectangle) const;
    virtual Void HandleBoundOptimize(SFXRectanglePtr rectangle) const;
    virtual Void HandleBoundReal(Void);
    virtual Void HandleBoundVirtual(Void);
    virtual Void HandleRenderRequest(SFXGraphicsPtr graphics) const;
};

USRDialog::USRDialog(Void) static_throws
{
    if (static_try()) {

        // レスポンダのタイプを設定する
        SetType(CODE_TYPE);

        // 初期化処理を記述する
    }
}

USRDialog::~USRDialog(Void)
{
    // 終了処理を記述する
}

USRDialogSmp USRDialog::NewInstance(SFCErrorPtr exception)
{
    return static_pointer_cast<USRDialog>(Factory(::new USRDialog, exception));
}

Void USRDialog::HandleBoundRequest(SFXRectanglePtr rectangle) const
{
    // ダイアログに最適な大きさを計算して rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)

    return;
}

Void USRDialog::HandleBoundOptimize(SFXRectanglePtr rectangle) const
{
    // ダイアログに最適な大きさを rectangle パラメータ内の大きさに
    // 収まるように計算し、rectangle パラメータに設定する
    // この関数内では、rectangle の原点は変更せず、rectangle のサイズだけを設定する(推奨)

    return;
}

Void USRDialog::HandleBoundReal(Void)
{
    // 実領域が変更された場合に再計算が必要なものがあれば、ここに記述する
    return;
}

Void USRDialog::HandleBoundVirtual(Void)
{
    // 仮想領域が変更された場合に再計算が必要なものがあれば、ここに記述する
    return;
}

Void USRDialog::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    // ダイアログを描画する
    return;
}

参照

SFZDialog::SFZDialog | SFYContainer::SFYContainer | SFYWidget::SFYWidget | SFZMessageDialog | SFZQuestionDialog | SFZWindow | SFYContainer | SFYWidget | SFXRGBColor | SFYWidget::SetBackgroundColor | SFYResponder::ToFront | SFYResponder::Terminate | 仮想領域 | 実領域 | ローカル領域 | SFZDialog::SetOperateKey | SFZDialog::SetEscapeKey | SFYContainer::SetScrollDownKey | SFYContainer::SetScrollUpKey | SFYContainer::SetPageDownKey | SFYContainer::SetPageUpKey | SFYContainer::SetSnapDownKey | SFYContainer::SetSnapUpKey | キーイベント[SFEVT_KEY] | 領域イベント[SFEVT_RESPONDER_BOUND] | 描画イベント[SFEVT_RESPONDER_RENDER] | フレーム | ダイアログ（基礎編）

メンバ

解説

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

	注意
	SFZDialog クラスを継承するレスポンダでは、 上記イベントが発生すると、それに対応するハンドラが呼び出されます。

内部実装

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

/*protected */SFZDialog::SFZDialog(Void) static_throws : _state(STATE_IDLE)
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0xEE, 0xEE, 0xEE}}}
    };
    static SFXEventRange::AtomRecConst          trange[] = {
        {     SFEVT_APP_RESUME,       SFEVT_APP_RESUME,           SFP16_BEGIN,            SFP16_END},
        {     SFEVT_APP_SUSPEND,      SFEVT_APP_SUSPEND,          SFP16_BEGIN,            SFP16_END},
        #if TARGET_VERSION_GE(3, 0, 0)
        {       SFEVT_KEY_PRESS,      SFEVT_KEY_RELEASE,          SFP16_BEGIN,            SFP16_END},
        #else
        {       SFEVT_KEY_PRESS,         SFEVT_KEY_HELD,          SFP16_BEGIN,            SFP16_END},
        #endif
        {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END},
        {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END},
        { SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,    SFP16_STATE_VALID,    SFP16_STATE_VALID},
        {SFEVT_RESPONDER_RESULT, SFEVT_RESPONDER_RESULT,          SFP16_BEGIN,            SFP16_END}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnAppResume);
        trule[0].reference = this;
        trule[1].spp = XANDLER_FUNCTION(OnAppSuspend);
        trule[1].reference = this;
        trule[2].spp = XANDLER_FUNCTION(OnShield);
        trule[2].reference = this;
        trule[3].spp = XANDLER_FUNCTION(OnKey);
        trule[3].reference = this;
        trule[4].spp = XANDLER_FUNCTION(OnRewind);
        trule[4].reference = this;
        trule[5].spp = XANDLER_FUNCTION(OnStateValid);
        trule[5].reference = this;
        trule[6].spp = XANDLER_FUNCTION(OnDialogResult);
        trule[6].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            SetBackgroundColor(rgb[0]);
            _timer.Set(XALLBACK_INTERNAL(OnTimer));
            _msec = 0;
            _key.operate = AVK_SELECT;
            _key.escape = AVK_CLR;
        }
    }
}// SFZDialog::SFZDialog //

/*private */XANDLER_IMPLEMENT_VOIDRESUME(SFZDialog, OnAppResume, invoker, environment)
{
    unused(invoker);
    unused(environment);
    if (_state == STATE_FIRE) {
        _timer.Schedule(_msec);
    }
    return;
}// XANDLER_IMPLEMENT_VOIDRESUME(SFZDialog, OnAppResume) //

/*private */XANDLER_IMPLEMENT_VOIDSUSPEND(SFZDialog, OnAppSuspend, invoker, reason, info)
{
    unused(invoker);
    unused(reason);
    unused(info);
    if (_state != STATE_IDLE) {
        _timer.Cancel();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDSUSPEND(SFZDialog, OnAppSuspend) //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZDialog, OnShield, invoker, event)
{
    unused(invoker);
    return (event.GetP16() == _key.operate || event.GetP16() == _key.escape);
}// XANDLER_IMPLEMENT_BOOLEVENT(SFZDialog, OnShield) //

/*private */XANDLER_IMPLEMENT_BOOLEVENT(SFZDialog, OnKey, invoker, event)
{
    Bool                                        result(false);

    unused(invoker);
    if (event.GetP16() == _key.operate) {
        CancelTimer();
        HandleOperateKey();
        result = true;
    }
    else if (event.GetP16() == _key.escape) {
        CancelTimer();
        HandleEscapeKey();
        result = true;
    }
    return result;
}// XANDLER_IMPLEMENT_BOOLEVENT(SFZDialog, OnKey) //

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

/*private */XANDLER_IMPLEMENT_VOIDSTATE(SFZDialog, OnStateValid, invoker, reason, state)
{
    unused(invoker);
    unused(reason);
    if (!state) {
        CancelTimer();
    }
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFZDialog, OnStateValid) //

/*private */XANDLER_IMPLEMENT_VOIDRESULT(SFZDialog, OnDialogResult, invoker, reason, result)
{
    unused(invoker);
    unused(reason);
    unused(result);
    Terminate();
    return;
}// XANDLER_IMPLEMENT_VOIDRESULT(SFZDialog, OnDialogResult) //

/*private */XALLBACK_IMPLEMENT_SFXTIMER(SFZDialog, OnTimer)
{
    SFYResponderSmp                             root;
    SFCError                                    error;

    error = SFERR_NO_ERROR;
    if ((root = GetRoot()) != null) {
        if (_state == STATE_FIRE) {
            _state = STATE_IDLE;
            _msec = 0;
            Invalidate();
            HandleEscapeKey();
            error = root->Render();
        }
    }
    else {
        error = SFERR_FAILED;
    }
    if (error != SFERR_NO_ERROR) {
        // internal fault!
    }
    return;
}// XALLBACK_IMPLEMENT_SFXTIMER(SFZDialog, OnTimer) //

参照

SFYResponder::SetType | SFZDialog::CodeEnum | SFYWidget::SetBackgroundColor | SFZDialog::SetOperateKey | SFZDialog::SetEscapeKey | SFZDialog::HandleOperateKey | SFZDialog::HandleEscapeKey | SFZDialog::ScheduleTimer | SFXEvent | SFXRGBColor | タイプ | イベント | キーイベント[SFEVT_KEY] | 結果イベント[SFEVT_RESPONDER_RESULT] | アプリ中断イベント[SFEVT_APP_SUSPEND] | アプリ再開イベント[SFEVT_APP_RESUME]

解説

タイマーをキャンセルします。

内部実装

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

/*protected virtual */SFZDialog::~SFZDialog(Void)
{
    CancelTimer();
}// SFZDialog::~SFZDialog //

参照

SFZDialog::CancelTimer

解説

この関数は、SFZDialog::ScheduleTimer 関数によるタイマーの設定をキャンセルします。

参照

SFZDialog::ScheduleTimer | SFZDialog::RewindTimer

戻り値

ダイアログの ESCAPE キー。

解説

この関数は、 SFZDialog::SetEscapeKey 関数で設定されたダイアログの ESCAPE キーを取得します。

参照

SFZDialog::SetEscapeKey | SFZDialog::HandleEscapeKey | AVKType

戻り値

ダイアログの操作キー。

解説

この関数は、 SFZDialog::SetOperateKey 関数で設定したダイアログの操作キーを取得します。

参照

SFZDialog::SetOperateKey | SFZDialog::HandleOperateKey | AVKType

解説

この関数は、 SFZDialog::SetEscapeKey 関数で設定した ESCAPE キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したとき、 または SFZDialog::ScheduleTimer 関数で指定した時間が経過しても操作キーや ESCAPE キーが押下されなかったときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、 結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0)] を送信します。 そして、結果ハンドラが起動されます。

	注意
	デフォルトの結果ハンドラの実装は、ダイアログを閉じます。

内部実装

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

/*protected virtual */Void SFZDialog::HandleEscapeKey(Void)
{
    InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_ESCAPE, 0), false);
    return;
}// SFZDialog::HandleEscapeKey //

参照

SFZDialog::SetEscapeKey | SFZDialog::ScheduleTimer | SFZDialog::SetOperateKey | SFXEvent | 結果イベント[SFEVT_RESPONDER_RESULT] | キーイベント[SFEVT_KEY]

解説

この関数は、SFZDialog::SetOperateKey 関数で設定した操作キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

開発者は、独自の処理のためにこの関数をオーバーライドできます。

デフォルトの実装では、 結果イベント [SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, 0)] を送信します。 そして、結果ハンドラが起動されます。

	注意
	デフォルトの結果ハンドラの実装は、ダイアログを閉じます。

内部実装

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

/*protected virtual */Void SFZDialog::HandleOperateKey(Void)
{
    InvokeForward(SFXEvent(SFEVT_RESPONDER_RESULT, SFP16_RESULT_OK, 0), false);
    return;
}// SFZDialog::HandleOperateKey //

参照

SFZDialog::SetOperateKey | SFXEvent | 結果イベント[SFEVT_RESPONDER_RESULT] | キーイベント[SFEVT_KEY]

引数

戻り値

解説

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

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

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

使用例

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

// ダイアログのインスタンスを生成する
SFZDialogSmp _dialog;
SFCError error;

if ((_dialog = SFZDialog::NewInstance(&error)) != null) {
    ...
}

解説

この関数は、 ダイアログが自動的に閉じるまでの時間を、 前回 SFZDialog::ScheduleTimer 関数によって設定された時間に再設定します。

参照

SFZDialog::ScheduleTimer | SFZDialog::CancelTimer

解説

この関数は、 指定された時間が経過しても操作キーまたは ESCAPE キーが押下されなかった場合、 ESCAPE キーを押下したときと同等の処理が行われるようにタイマーをスケジュールします。[単位：ミリ秒]

	注意
	SFZMessageDialog や SFZQuestionDialog クラスの場合、 指定された時間が経過しても操作キー、ESCAPE キー、またはボタンが押下されなかったとき、 ESCAPE キーを押下したときと同等の処理が行われるようにタイマー処理をスケジュールします。

	タイマー処理コールバックの登録と解除
	指定された時間が経過すると、 SFZDialog::HandleEscapeKey 関数を呼び出し、 画面を再描画するタイマー処理コールバックを登録します。 指定された時間の経過するまでに、 SFZDialog::SetOperateKey 関数で設定する操作キー、または SFZDialog::SetEscapeKey 関数で設定する ESCAPE キーが押下されると、 このタイマー処理コールバックをキャンセルします。 サスペンド時にこのタイマー処理コールバックが登録されていると、 自動的に解除し、レジューム時に再び登録します。 その他、ダイアログの有効状態が無効になったときにこのタイマー処理コールバックが登録されていると、 自動的に解除します。

参照

SFZDialog::HandleEscapeKey | SFZDialog::CancelTimer | SFZDialog::RewindTimer | SFZDialog::SetOperateKey | SFZDialog::SetEscapeKey | 状態

解説

この関数は、ダイアログの ESCAPE キーを設定します。

この関数で設定されたキーの SFEVT_KEY イベントを受信すると、 SFZDialog::HandleEscapeKey 関数が呼び出されます。

デフォルト値: AVK_CLR

参照

SFZDialog::GetEscapeKey | SFZDialog::HandleEscapeKey | AVKType

解説

この関数は、ダイアログの操作キーを設定します。

この関数で設定されたキーの SFEVT_KEY イベントを受信すると、 SFZDialog::HandleOperateKey 関数が呼び出されます。

デフォルト値: AVK_SELECT

参照

SFZDialog::GetOperateKey | SFZDialog::HandleOperateKey | AVKType

参照

SFYResponder::GetType | SFYResponder::SetType