継承図

協調図

解説

■ 仕様と使い方

タイトル付きプレーンフレームとは、 影領域[SFXMargin(0, 0, 1, 1)]に、 タイトルを表示するためのヘッダー領域を加えた領域を枠領域とするフレームです。

	枠領域の取得方法
	フレームの枠領域は、SFYResponder::GetSuitableMargin 関数を呼び出すことで取得できます。

図 461. タイトル付きプレーンフレーム動作例[SFZTitlePlainFrame]

タイトル付きプレーンフレームの枠領域は、 影領域[SFXMargin(0, 0, 1, 1)]に、 タイトルを表示するためのヘッダー領域を加えたマージン領域です。

図 462. タイトル付きプレーンフレーム拡大図[SFZTitlePlainFrame]

黒色の線が影領域、 中央に文字列 "Title" が描画されている灰色の矩形領域がヘッダー領域です。 この２つの領域の和集合がタイトル付きプレーンフレームの枠領域です。そして、枠領域で囲まれた矩形領域はコンテンツ領域です。

ヘッダー領域の高さ(HeaderHeight)は

HeaderHeight = FontHeight + 2 * FrameMarginSize

FontHeight      : 使用しているフォントの高さ
FrameMarginSize : SetFrameSize 関数で設定するヘッダー領域のマージン（デフォルトは 1 ピクセル）

です。

ヘッダー領域の横幅(HeaderWidth)は

HeaderWidth = SFZTitlePlainFrameWidth - ShadowWidth

SFZTitlePlainFrameWidth  : SFZTitlePlainFrame に設定されたローカル領域の幅
ShadowWidth             : 影領域の幅（１ピクセル）

です。

ヘッダー領域の背景は、 SFZTitlePlainFrame::SetHeaderColor 関数で設定した色(SFXRGBColor)で塗り潰されます。

影領域の幅は 1 ピクセルです。

1. 影領域は SFYPlainFrame::DrawShadow 関数が描画します（影領域の色は SFYPlainFrame::SetShadowColor 関数で設定）。
2. ヘッダー領域は SFZTitlePlainFrame::DrawHeader 関数が描画します（ヘッダー領域の色は SFZTitlePlainFrame::SetHeaderColor 関数で設定）。

	タイトル枠付きのレスポンダ
	タイトル付きプレーンフレームをウィンドウやダイアログに装着することで、枠付きウィンドウや枠付きダイアログを実現することが可能になります。 装着はウィンドウやダイアログの SFYResponder::SetFrame 関数を呼び出すことによって行います。 ウィンドウやダイアログの実領域はタイトル付きプレーンフレームの枠(マージン領域)で囲まれるコンテンツ領域となります。

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

  XANDLER_DECLARE_VOIDRENDER(OnRenderRequestSFZWindow) // ウィンドウの描画ハンドラ
  XANDLER_DECLARE_BOOLEVENT(OnKeySFZWindow)            // ウィンドウのキーハンドラ
};


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

  SFZTitlePlainFrameSmp frame;  // SFZTitlePlainFrame のスマートポインタ
  SFZWindowSmp          window; // SFZWindow のスマートポインタ
  SFCError              error(SFERR_NO_ERROR);

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

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

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

    // ウィンドウを生成する
    if ((window = SFZWindow::NewInstance(&error)) != null) {

      // ウィンドウの描画ハンドラを登録する : 文字列 "Hello World!" を描画する
      error = window->RegisterHandler(
        SFXEventRange(SFEVT_RESPONDER_RENDER, SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST, SFP16_RENDER_REQUEST),
        XANDLER_INTERNAL(OnRenderRequestSFZWindow)
      );
      if (error == SFERR_NO_ERROR) {

        // ウィンドウのキーハンドラを登録する : セレクトキーが押下されるとフレームを閉じる
        error = window->RegisterHandler(
          SFXEventRange(SFEVT_KEY, SFEVT_KEY, SFP16_BEGIN, SFP16_END),
          XANDLER_INTERNAL(OnKeySFZWindow)
        );
        if (error == SFERR_NO_ERROR) {

          // ウィンドウの親をアプリケーションクラス（ルート）に設定する
          error = window->SetParent(GetThis());
          if (error == SFERR_NO_ERROR) {

            // ウィンドウにフレームを装着する
            error = window->SetFrame(frame);
            if (error == SFERR_NO_ERROR) {

              // フレームの実領域をルートのローカル領域から (30, 30) だけ縮小した領域に設定する
              // ※自動的にフレームの実領域をフレーム余白領域だけ縮小した領域がウィンドウの実領域に設定される
              frame->SetRealBound(GetLocalBound().Deflate(30, 30));

              // ウィンドウの状態を「可視+活性+操作可能+フォーカス」にまとめて設定する
              window->SetState(true, true, true, true);

              // ウィンドウを最前面に移動する
              // ※自動的にフレームも最前面に移動する
              window->ToFront();
            }
          }
        }
      }
    }
  }
  static_throw(error);
}


// SFZWindow の描画ハンドラの実装
#define TROPICALBLUE_COLOR (SFXRGBColor(0xCE, 0xD8, 0xF8, 0x00))
#define COLOR_BLACK        (SFXRGBColor(0x00, 0x00, 0x00, 0x00))
XANDLER_IMPLEMENT_VOIDRENDER(helloworld, OnRenderRequestSFZWindow, invoker, reason, graphics)
{
  unused(invoker);
  unused(reason);

  // ウィンドウのローカル領域をトロピカルブルーで描画する
  graphics->FillRectangle(GetLocalBound(), TROPICALBLUE_COLOR);

  // ウィンドウの中央に文字列 "Hello World!" を黒色で描画する
  graphics->DrawSingleText("Hello World!", invoker->GetLocalBound(), COLOR_BLACK);

  return;
}

// SFZWindow のキーハンドラの実装
XANDLER_IMPLEMENT_BOOLEVENT(helloworld, OnKeySFZWindow, invoker, event)
{
  Bool result(false);
  unused(invoker);

  switch (event.GetP16()) {

    case AVK_SELECT:  // セレクトキーのキーイベントを受信したとき

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

         result = true;  // イベントを処理したので true をセットする

         break;
  }

  return result;
}

図 463. サンプルコードの実行結果 : ウィンドウにフレームを付ける[SFZTitlePlainFrame と SFZWindow]

参照

SFZPlainFrame | SFYPlainFrame | SFYFrame | 実領域 | SFYSingleTextWidget | SFYResponder::GetSuitableMargin | フレーム | SFYResponder::ToFront | SFYResponder::Terminate

メンバ

解説

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

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

内部実装

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

/*protected */SFZTitlePlainFrame::SFZTitlePlainFrame(Void) static_throws
{
    static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0xDD, 0xDD, 0xDD}}}
    };
    static SFXEventRange::AtomRecConst          trange[] = {
        { SFEVT_RESPONDER_STATE,  SFEVT_RESPONDER_STATE,    SFP16_STATE_FOCUS,    SFP16_STATE_FOCUS}
    };
    static SFXEventRange::AtomRecConst          urange[] = {
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,    SFP16_STYLE_ALIGN,    SFP16_STYLE_ALIGN}
    };
    static SFXEventRange::AtomRecConst          crange[] = {
        { SFEVT_RESPONDER_STYLE,  SFEVT_RESPONDER_STYLE,          SFP16_BEGIN,            SFP16_END}
    };
    SFYHandler::RuleRec                         trule[lengthof(trange)];
    SFYHandler::RuleRec                         urule[lengthof(urange)];
    SFYHandler::RuleRec                         crule[lengthof(crange)];
    SFCError                                    error;

    if (static_try()) {
        SetType(CODE_TYPE);
        trule[0].spp = XANDLER_FUNCTION(OnStateFocus);
        trule[0].reference = this;
        static_throw(RegisterHandler(atomic_cast(trange), trule, lengthof(trange)));
        if (static_try()) {
            urule[0].spp = XANDLER_FUNCTION(OnStyleAlign);
            urule[0].reference = this;
            static_throw(RegisterHandler(atomic_cast(urange), urule, lengthof(urange)));
            if (static_try()) {
                if ((_widget = SFYSingleTextWidget::NewInstance(&error)) != null) {
                    crule[0].spp = XANDLER_FUNCTION(OnWidgetStyle);
                    crule[0].reference = this;
                    static_throw(_widget->RegisterHandler(atomic_cast(crange), crule, lengthof(crange)));
                    if (static_try()) {
                        static_throw(_widget->SetParent(GetThis()));
                        if (static_try()) {
                            _widget->SetState(true, true, false, false);
                            _frame = DEFAULT_FRAME;
                            _color.header.Set(rgb[0]);
                            Relocate();
                        }
                    }
                }
                else {
                    static_throw(error);
                }
            }
        }
    }
}// SFZTitlePlainFrame::SFZTitlePlainFrame //

/*private */XANDLER_IMPLEMENT_VOIDSTATE(SFZTitlePlainFrame, OnStateFocus, invoker, reason, state)
{
    unused(invoker);
    unused(reason);
    (state) ? (_widget->StartScroll()) : (_widget->StopScroll());
    return;
}// XANDLER_IMPLEMENT_VOIDSTATE(SFZTitlePlainFrame, OnStateFocus) //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZTitlePlainFrame, OnStyleAlign, invoker, reason)
{
    unused(invoker);
    unused(reason);
    Relocate();
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZTitlePlainFrame, OnStyleAlign) //

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZTitlePlainFrame, OnWidgetStyle, invoker, reason)
{
    unused(invoker);
    switch (reason) {
        case SFP16_STYLE_FONT:
            Relocate();
            break;
        default:
            break;
    }
    InvokeBackward(SFXEvent(SFEVT_RESPONDER_STYLE, reason, 0), true);
    return;
}// XANDLER_IMPLEMENT_VOIDSTYLE(SFZTitlePlainFrame, OnWidgetStyle) //

/*private */Void SFZTitlePlainFrame::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    lx.Deflate(GetShadowMargin());
    lx.Deflate(_frame, _frame);
    lx.SetHeight(_widget->GetFontSize().GetHeight());
    _bound.Set(lx);
    _bound.Inflate(_frame, _frame);
    _widget->SetRealBound(lx);
    return;
}// SFZTitlePlainFrame::Relocate //

参照

SFYResponder::SetType | SFZTitlePlainFrame::CodeEnum | SFZTitlePlainFrame::SetFrameSize | SFZTitlePlainFrame::SetHeaderColor | SFZTitlePlainFrame::GetWidget | SFYResponder::SetState | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::SetTextColor | SFZTitlePlainFrame::SetFont | SFZTitlePlainFrame::SetHorizontalAlign | SFZTitlePlainFrame::SetScrollDirection | SFZTitlePlainFrame::SetScrollInterval | SFZTitlePlainFrame::SetScrollStep | SFZTitlePlainFrame::SetTextColor | SFZTitlePlainFrame::SetVerticalAlign | SFZTitlePlainFrame::SetWaitInterval | SFYSingleTextWidget::NewInstance | SFYSingleTextWidget::DirectionEnum | SFYSingleTextWidget::DefaultEnum | SFYSingleTextWidget | SFXRGBColor | タイプ | 状態 | イベント | 状態イベント[SFEVT_RESPONDER_STATE]

解説

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

内部実装

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

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

解説

この関数は、タイトル付きプレーンフレームのヘッダーを設定された色で塗り潰します。

独自の処理を行う場合は、この関数をオーバーライドします。

内部実装

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

/*protected */Void SFZTitlePlainFrame::DrawHeader(SFXGraphicsPtr graphics, SFXRectangleConstRef rectangle) const
{
    graphics->FillRectangle(rectangle, _color.header);
    return;
}// SFZTitlePlainFrame::DrawHeader //

参照

SFZTitlePlainFrame::SetHeaderColor | SFXRGBColor

参照

SFZTitlePlainFrame::SetFont | BREW API AEEFont

戻り値

ヘッダー領域の枠とタイトル文字表示領域間の余白。[単位：ピクセル]

解説

この関数は、ヘッダー領域の枠とタイトル文字表示領域間の余白を取得します。[単位：ピクセル]

参照

SFZTitlePlainFrame::SetFrameSize

戻り値

タイトル付きプレーンフレームのヘッダー領域。

解説

この関数は、 タイトル付きプレーンフレームのタイトルを表示するためのヘッダー領域を取得します。

独自の処理を行いたい場合は、この関数をオーバーライドします。

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

ヘッダー領域の幅は、タイトル付きプレーンフレームから影領域を取り除いた矩形領域の幅になります。

ヘッダー領域の高さは、SFZTitlePlainFrame::SetFrameSize 関数で設定する値の２倍に、 使用するフォントの高さを加えた値になります。

この関数は、SFZTitlePlainFrame::HandleMarginRequest 関数の中でヘッダー領域を計算するときに呼び出されます。

図 464. タイトル付きプレーンフレーム拡大図[SFZTitlePlainFrame]

参照

SFZTitlePlainFrame::HandleMarginRequest | SFZTitlePlainFrame::SetFrameSize

戻り値

タイトル付きプレーンフレームのヘッダーに設定された色。

解説

この関数は、タイトル付きプレーンフレームに設定された色を取得します。

参照

SFZTitlePlainFrame::SetHeaderColor | SFXRGBColor

戻り値

タイトルの水平アライメントの値。

解説

この関数は、タイトルの水平アライメントの値を取得します。

参照

SFZTitlePlainFrame::SetHorizontalAlign | SFZTitlePlainFrame::HorizontalEnum

戻り値

タイトルのスクロール移動方向

解説

この関数は、タイトルのスクロール移動方向を取得します。

参照

SFZTitlePlainFrame::SetScrollDirection

戻り値

スクロールインターバル。[単位:ミリ秒]

解説

この関数は、タイトルのスクロールインターバルを取得します。[単位:ミリ秒]

参照

SFZTitlePlainFrame::SetScrollInterval

戻り値

スクロール移動量。[単位:ピクセル]

解説

この関数は、タイトルのスクロール移動量を取得します。[単位:ピクセル]

参照

SFZTitlePlainFrame::SetScrollStep

戻り値

タイトル。

解説

この関数は、タイトルを取得します。

参照

SFZTitlePlainFrame::SetText

戻り値

タイトルの色。

解説

この関数は、タイトルの色を取得します。

参照

SFZTitlePlainFrame::SetTextColor | SFXRGBColor

戻り値

タイトルの垂直アライメントの値。

解説

この関数は、タイトルの垂直アライメントの値を取得します。

参照

SFZTitlePlainFrame::SetVerticalAlign | SFZTitlePlainFrame::VerticalEnum

戻り値

スクロール開始までの待ち時間。[単位:ミリ秒]

解説

この関数は、タイトルのスクロール開始までの待ち時間を取得します。[単位:ミリ秒]

参照

SFZTitlePlainFrame::SetWaitInterval

戻り値

タイトル描画用に子レスポンダとして内部で保持する SFYSingleTextWidget インスタンス。

解説

この関数は、 タイトル描画用に子レスポンダとして内部で保持する SFYSingleTextWidget インスタンスを取得します。

タイトルの描画は、SFYSingleTextWidget インスタンスに委譲して処理します。

参照

SFYSingleTextWidget

解説

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

仮想領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は、タイトル付きプレーンフレームを仮想領域の中央に再配置します。

デフォルトの実装は、 タイトル表示領域を内部で保持するテキストウィジェット(SFYSingleTextWidget)の実領域として設定します。

SFZTitlePlainFrame::SetText 関数によって設定されたタイトルは、 内部でテキストウィジェット(SFYSingleTextWidget)として保持されます。

タイトル表示領域は、 SFZTitlePlainFrame::GetHeaderBound 関数で取得できるヘッダー領域から SFZTitlePlainFrame::SetFrameSize 関数で設定するヘッダー領域のマージンを取り除いた領域です。

	領域イベント[(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 SFZTitlePlainFrame::HandleBoundVirtual(Void)
{
    Relocate();
    return;
}// SFZTitlePlainFrame::HandleBoundVirtual //

/*private */Void SFZTitlePlainFrame::Relocate(Void)
{
    SFXRectangle                                lx;

    lx.Set(GetLocalBound());
    lx.Deflate(GetShadowMargin());
    lx.Deflate(_frame, _frame);
    lx.SetHeight(_widget->GetFontSize().GetHeight());
    _bound.Set(lx);
    _bound.Inflate(_frame, _frame);
    _widget->SetRealBound(lx);
    return;
}// SFZTitlePlainFrame::Relocate //

参照

SFYSingleTextWidget | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::GetHeaderBound | SFZTitlePlainFrame::SetFrameSize | SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

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

フレーム余白領域を計算する場合は、この関数をオーバーライドします。

なお、この枠領域は、 SFZTitlePlainFrame::HandleRenderRequest 関数によって描画されます。

デフォルトの実装は、影領域とヘッダー領域から構成されるマージン領域を計算します。

影領域、ヘッダー領域は、それぞれ SFYPlainFrame::GetShadowMargin 関数、 SFZTitlePlainFrame::GetHeaderBound 関数を呼び出すことで取得できます。

図 465. タイトル付きプレーンフレーム[SFZTitlePlainFrame]

図 466. タイトル付きプレーンフレーム拡大図[SFZTitlePlainFrame]

ヘッダー領域の高さ HeaderHeight は

HeaderHeight = FontHeight + 2 * FrameMarginSize

FontHeight      : 使用しているフォントの高さ
FrameMarginSize : SetFrameSize 関数で設定するヘッダー領域のマージン（デフォルトは 1 ピクセル）

です。

ヘッダー領域の横幅は HeaderWidth は

HeaderWidth = SFZTitleFlatFrameWidth - ShadowWidth

SFZTitlePlainFrameWidth  : SFZTitlePlainFrame に設定されたローカル領域の幅
ShadowWidth             : 影領域の幅（１ピクセル）

です。

ヘッダー領域の背景は、 SFZTitlePlainFrame::SetHeaderColor 関数で設定した色(SFXRGBColor)で塗り潰されます。

影領域の幅は 1 ピクセルです。

	余白イベント[(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST) イベント]
	SFYResponder::GetSuitableMargin 関数は、 余白イベント [SFXEvent(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST, margin)] をレスポンダに送信します。 SFYFrame クラスを継承するレスポンダが余白イベントを受信すると、 SFYFrame::SFYFrame コンストラクタで最初に登録した余白イベント専用ハンドラの処理により、 SFYFrame::HandleMarginRequest 仮想関数が呼び出されます。 ※ 余白イベントの P32 パラメータ margin には SFXMargin::ZeroInstance() が初期設定されています。

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

内部実装

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

/*protected virtual */Void SFZTitlePlainFrame::HandleMarginRequest(SFXMarginPtr margin) const
{
    margin->Add(GetShadowMargin());
    margin->AddTop(_bound.GetHeight());
    return;
}// SFZTitlePlainFrame::HandleMarginRequest //

参照

SFYResponder::GetSuitableMargin | SFYPlainFrame::GetShadowMargin | SFZTitlePlainFrame::GetHeaderBound | SFZTitlePlainFrame::HandleRenderRequest | SFXMargin | 余白イベント[SFEVT_RESPONDER_MARGIN]

解説

この関数は、 描画イベント [SFXEvent(SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST, graphics)] を受信したときに呼び出されます。

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

デフォルトの実装は、タイトル付きプレーンフレームを描画します。

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

図 467. タイトル付きプレーンフレーム[SFZTitlePlainFrame]

タイトル付きプレーンフレームの枠領域は、 影領域[SFXMargin(0, 0, 1, 1)]に、 タイトルを表示するためのヘッダー領域を加えたマージン領域です。

図 468. タイトル付きプレーンフレーム拡大図[SFZTitlePlainFrame]

黒色の線が影領域、 中央に文字列 "Title" が描画されているベベルカラーの矩形領域がヘッダー領域です。 この２つの領域の和集合がタイトル付きフラットフレームの枠領域です。そして、枠領域で囲まれた矩形領域はコンテンツ領域です。

影領域の幅は 1 ピクセルです。

1. 影領域は SFYPlainFrame::DrawShadow 関数が描画します（影領域の色は SFYPlainFrame::SetShadowColor 関数で設定）。
2. ヘッダー領域は SFZTitlePlainFrame::DrawHeader 関数が描画します（ヘッダー領域の色は SFZTitlePlainFrame::SetHeaderColor 関数で設定）。

レスポンダの描画手順

SFYResponder::Invalidate 関数を使用して再描画領域を登録します。 イベントループの最後、 アプリ開始/レジュームまたは優先的イベントハンドラ終了のタイミング、 あるいは、コールバックなどのイベントループの外で、 自動的に、あるいは、明示的に SFYResponder::Render 関数を呼び出します。 描画エンジンが起動されます。 再描画が必要なレスポンダだけが描画イベントを受信します。 SFYWidget クラスを継承するレスポンダが描画イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した描画ハンドラの処理により、 SFYWidget::HandleRenderRequest 仮想関数が呼び出されます。 その後、描画ハンドラが登録した順に呼び出されます。 実際にレスポンダが描画されます。 Tip 描画ハンドラの宣言と登録の手間を省けるので、 通常は SFYWidget::HandleRenderRequest 仮想関数だけを利用してレスポンダを描画します。

内部実装

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

/*protected virtual */Void SFZTitlePlainFrame::HandleRenderRequest(SFXGraphicsPtr graphics) const
{
    DrawShadow(graphics, GetLocalBound());
    DrawHeader(graphics, _bound);
    return;
}// SFZTitlePlainFrame::HandleRenderRequest //

参照

SFYPlainFrame::DrawShadow | SFZTitlePlainFrame::DrawHeader | SFZTitlePlainFrame::SetHeaderColor | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::SetHorizontalAlign | SFZTitlePlainFrame::SetVerticalAlign | SFZTitlePlainFrame::SetFont | SFZTitlePlainFrame::SetTextColor | SFXRGBColor | SFYSingleTextWidget | SFYSingleTextWidget::HandleRenderRequest | SFYResponder::Invalidate | SFYResponder::Render | SFYResponder::InvokeBackward | 描画イベント[SFEVT_RESPONDER_RENDER] | 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER] | 描画処理

引数

戻り値

解説

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

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

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

使用例

以下は、タイトルプレーンフレームのインスタンスを生成するためのコードです。

// タイトルプレーンフレームのインスタンスを生成する
SFZTitlePlainFrameSmp _titleplainframe;
SFCError error;

if ((_titleplainflame = SFZTitlePlainFrame::NewInstance(&error)) != null) {
    // ...
}

解説

この関数は、タイトルのフォントを設定します。

デフォルト値: AEE_FONT_NORMAL

参照

SFZTitlePlainFrame::GetFont | BREW API AEEFont

解説

この関数は、タイトル付きプレーンフレームのヘッダー領域の枠と、 タイトル文字を表示するための領域間の余白を設定します。[単位：ピクセル]

デフォルト値: 1 ピクセル。

	ヘッダー領域の高さ
	この関数で指定する値を２倍した数値に、 使用しているフォントの高さを加えた値がヘッダー領域の高さになります。

参照

SFZTitlePlainFrame::GetFrameSize

解説

この関数は、タイトル付きプレーンフレームのヘッダーの色を設定します。

デフォルトでは、下記の設定になっています。

static SFXRGBColor::AtomRecConst            rgb[] = {
        {{{0x00, 0xDD, 0xDD, 0xDD}}}
};

参照

SFZTitlePlainFrame::GetHeaderColor | SFXRGBColor

解説

この関数は、タイトルの水平アライメントを設定します。

SFZTitlePlainFrame::SetText 関数によって設定されたタイトルは、 内部でテキストウィジェット(SFYSingleTextWidget)として保持されます。

デフォルト値: SFYSingleTextWidget::DEFAULT_HORIZONTAL

SFYSingleTextWidget::DEFAULT_HORIZONTAL の値は SFYSingleTextWidget::HorizontalEnum を参照してください。

参照

SFYSingleTextWidget | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::GetHorizontalAlign | SFZTitlePlainFrame::HorizontalEnum | SFYSingleTextWidget::HorizontalEnum

解説

この関数は、タイトルのスクロール移動方向を設定します。

デフォルト値: SFYSingleTextWidget::DEFAULT_DIRECTION

SFYSingleTextWidget::DEFAULT_DIRECTION の値は SFYSingleTextWidget::DirectionEnum を参照してください。

参照

SFZTitlePlainFrame::GetScrollDirection | SFZTitlePlainFrame::DirectionEnum | SFYSingleTextWidget::DirectionEnum

解説

この関数は、タイトルのスクロールインターバルを設定します。[単位:ミリ秒]

デフォルト値: SFYSingleTextWidget::DEFAULT_SCROLL ミリ秒

SFYSingleTextWidget::DEFAULT_SCROLL の値は SFYSingleTextWidget::DefaultEnum を参照してください。

参照

SFZTitlePlainFrame::GetScrollInterval | SFZTitlePlainFrame::DefaultEnum | SFYSingleTextWidget::DefaultEnum

解説

この関数は、タイトルのスクロール移動量を設定します。[単位:ピクセル]

−1（デフォルト値）を設定すると、使用しているフォントの半角空白文字 1 文字分（" "）の幅がスクロール移動量となります。

デフォルト値: SFYSingleTextWidget::DEFAULT_STEP [単位:ピクセル]

SFYSingleTextWidget::DEFAULT_STEP の値は SFYSingleTextWidget::DefaultEnum を参照してください。

参照

SFZTitlePlainFrame::GetScrollStep | SFZTitlePlainFrame::DefaultEnum | SFYSingleTextWidget::DefaultEnum

戻り値

解説

この関数は、タイトルを設定します。

文字列を直接、あるいは、リソースファイルから読み込むように指定します。

デフォルト値: ""[空文字列]

参照

SFZTitlePlainFrame::GetText | SFZTitlePlainFrame::SetHorizontalAlign | SFZTitlePlainFrame::SetVerticalAlign SFZTitlePlainFrame::SetTextColor | SFZTitlePlainFrame::SetFont

解説

この関数は、タイトルの色を設定します。

デフォルト値: SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色]

非活性状態にあるときは、この関数で設定された色の明度が 0x7F より大きい場合はこの色の RGB 値からそれぞれ 0x44 を減算した色、 0x7F 以下の場合はこの色の RGB 値にそれぞれ 0x44 を加算した色でテキストは描画されます。

色の明度とは、SFXRGBColor::GetBrightness 関数によって得られる値です。

参照

SFZTitlePlainFrame::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態

解説

この関数は、タイトルの垂直アライメントを設定します。

SFZTitlePlainFrame::SetText 関数によって設定されたタイトルは、 内部でテキストウィジェット(SFYSingleTextWidget)として保持されます。

デフォルト値: SFYSingleTextWidget::DEFAULT_VERTICAL

SFYSingleTextWidget::DEFAULT_VERTICAL の値は SFYSingleTextWidget::VerticalEnum を参照してください。

参照

SFYSingleTextWidget | SFZTitlePlainFrame::SetText | SFZTitlePlainFrame::GetVerticalAlign | SFZTitlePlainFrame::VerticalEnum | SFYSingleTextWidget::VerticalEnum

解説

この関数は、タイトルのスクロール開始までの待ち時間を設定します。[単位:ミリ秒]

デフォルト値: SFYSingleTextWidget::DEFAULT_WAIT ミリ秒

SFYSingleTextWidget::DEFAULT_WAIT の値は SFYSingleTextWidget::DefaultEnum を参照してください。

参照

SFZTitlePlainFrame::GetWaitInterval | SFZTitlePlainFrame::DefaultEnum | SFYSingleTextWidget::DefaultEnum

解説

この関数は、タイトルのスクロールを開始します。

仮想領域の幅がタイトルの幅よりも大きいときは何もしません。

SFEVT_APP_SUSPEND イベントと SFEVT_APP_RESUME イベントに自動的に応答しますが、 SFEVT_APP_SUSPEND イベントの受信後から SFEVT_APP_RESUME イベントの受信までの間にこの関数を呼び出したときの動作は未定です。

参照

SFZTitlePlainFrame::StopScroll

解説

この関数は、タイトルのスクロールを停止します。

参照

SFZTitlePlainFrame::StartScroll

参照

SFYResponder::GetType | SFYResponder::SetType

参照

SFYSingleTextWidget::DefaultEnum

参照

SFYSingleTextWidget::DirectionEnum

参照

SFYSingleTextWidget::HorizontalEnum

参照

SFYSingleTextWidget::VerticalEnum