前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFZTitleFlatFrame
タイトル付きフラットフレームです。
#include <SFZTitleFlatFrame.h.hpp>
class SFZTitleFlatFrame : public SFYFlatFrame;
SFMTYPEDEFCLASS(SFZTitleFlatFrame)

継承図

SFZTitleFlatFrame クラスの継承図

協調図

SFZTitleFlatFrame クラスの協調図

解説

■ 仕様と使い方

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

[Note] 枠領域の取得方法

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

図 453. タイトル付きフラットフレーム動作例[SFZTitleFlatFrame]


タイトル付きフラットフレーム動作例[SFZTitleFlatFrame]

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

図 454. タイトル付きフラットフレーム拡大図[SFZTitleFlatFrame]


タイトル付きフラットフレーム拡大図[SFZTitleFlatFrame]

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

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

HeaderHeight = FontHeight + 2 * FrameMarginSize

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

です。

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

HeaderWidth = SFZTitleFlatFrameWidth - FlatFrameWidth - ShadowWidth

SFZTitleFlatFrameWidth  : SFZTitleFlatFrame に設定されたローカル領域の幅
FlatFrameWidth          : フラットフレーム領域の幅(1ピクセル)
ShadowWidth             : 影領域の幅(1ピクセル)

です。

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

影領域、フラットフレーム領域の幅は、それぞれ1ピクセルです。

  1. 影領域は SFYPlainFrame::DrawShadow 関数が描画します(影領域の色は SFYPlainFrame::SetShadowColor 関数で設定)。
  2. フラットフレーム領域は SFYFlatFrame::DrawFrame 関数が描画します(フラットフレーム領域の色は SFYFlatFrame::SetFrameColor / SFYFlatFrame::SetFocusColor 関数で設定)。
  3. ヘッダー領域は SFZTitleFlatFrame::DrawHeader 関数が描画します(ヘッダー領域の色は SFZTitleFlatFrame::SetHeaderColor 関数で設定)。
[Note] タイトル枠付きのレスポンダ

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

例 911. サンプルコード : ウィンドウにフレームを付ける[SFZTitleFlatFrame と SFZWindow]

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

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

  // フレームを生成する
  if ((frame = SFZTitleFlatFrame::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;
}

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


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

参照

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

メンバ

コンストラクタ/デストラクタ
SFZTitleFlatFrame( Void )
SFZTitleFlatFrame クラスのコンストラクタです。
~SFZTitleFlatFrame( Void )
SFZTitleFlatFrame クラスのデストラクタです。
パブリック関数
AEEFont GetFont( Void )
タイトルのフォントを取得します。
SInt16 GetFrameSize( Void )
ヘッダー領域の枠とタイトル文字表示領域間の余白を取得します。[単位:ピクセル]
SFXRGBColorConstRef GetHeaderColor( Void )
ヘッダーの色を取得します。
HorizontalEnum GetHorizontalAlign( Void )
タイトルの水平アライメントの値を取得します。
DirectionEnum GetScrollDirection( Void )
タイトルのスクロール移動方向を取得します。
UInt32 GetScrollInterval( Void )
タイトルのスクロールインターバルを取得します。[単位:ミリ秒]
SInt16 GetScrollStep( Void )
タイトルのスクロール移動量を取得します。[単位:ピクセル]
SFXWideStringConstRef GetText( Void )
タイトルを取得します。
SFXRGBColorConstRef GetTextColor( Void )
タイトルの色を取得します。
VerticalEnum GetVerticalAlign( Void )
タイトルの垂直アライメントの値を取得します。
UInt32 GetWaitInterval( Void )
タイトルのスクロール開始までの待ち時間を取得します。[単位:ミリ秒]
static
SFZTitleFlatFrameSmp
NewInstance( SFCErrorPtr exception = null )
新しいインスタンスを作成します。
Void SetFont( AEEFont param )
タイトルのフォントを設定します。
Void SetFrameSize( SInt16 param )
ヘッダー領域の枠とタイトル文字表示領域間の余白を設定します。[単位:ピクセル]
Void SetHeaderColor( SFXRGBColorConstRef param )
ヘッダーの色を設定します。
Void SetHorizontalAlign( HorizontalEnum param )
タイトルの水平アライメントを設定します。
Void SetScrollDirection( DirectionEnum param )
タイトルのスクロール移動方向を設定します。
Void SetScrollInterval( UInt32 param )
タイトルのスクロールインターバルを設定します。[単位:ミリ秒]
Void SetScrollStep( SInt16 param )
タイトルのスクロール移動量を設定します。[単位:ピクセル]
SFCError SetText( SFXPathConstRef path , UInt16 id )
タイトルを設定します。
SFCError SetText( SFXWideStringConstRef param )
タイトルを設定します。
Void SetTextColor( SFXRGBColorConstRef param )
タイトルの色を設定します。
Void SetVerticalAlign( VerticalEnum param )
タイトルの垂直アライメントを設定します。
Void SetWaitInterval( UInt32 param )
タイトルのスクロール開始までの待ち時間を設定します。[単位:ミリ秒]
Void StartScroll( Void )
タイトルのスクロールを開始します.
Void StopScroll( Void )
タイトルのスクロールを停止します.
Void ClearHandler( Void ) (SFYResponder から継承)
このレスポンダのハンドラの登録をすべて解除します。
Void ClearTracer( Void ) (SFYResponder から継承)
このレスポンダのトレーサの配信規則の登録をすべて解除します。
SFCError Distribute( SFXEventConstRef event , BoolPtr result = null ) (SFYResponder から継承)
指定された配信型イベントを SFYDistributer インスタンスと、このレスポンダ以下のレスポンダツリーに配信します。
SFXRGBColorConstRef GetBackgroundColor( Void ) (SFYWidget から継承)
背景の色を取得します。
SFYResponderSmp GetChildBack( Void ) (SFYResponder から継承)
最背面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最背面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBack( UInt32 id ) (SFYResponder から継承)
最背面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最背面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBackward( SInt32 index ) (SFYResponder から継承)
背面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
背面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBackward( SInt32 index , UInt32 id ) (SFYResponder から継承)
背面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
背面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SInt32 GetChildCount( Void ) (SFYResponder から継承)
このレスポンダの子レスポンダの数を取得します。
SInt32 GetChildCount( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダの子レスポンダの数を取得します。
SInt32 GetChildCount( UInt32 id ) (SFYResponder から継承)
このレスポンダの子レスポンダの数を取得します。
SInt32 GetChildCount( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダの子レスポンダの数を取得します。
SFYResponderSmp GetChildForward( SInt32 index ) (SFYResponder から継承)
前面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
前面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildForward( SInt32 index , UInt32 id ) (SFYResponder から継承)
前面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
前面から数えて指定された順番に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildFront( Void ) (SFYResponder から継承)
最前面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最前面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildFront( UInt32 id ) (SFYResponder から継承)
最前面に位置するこのレスポンダの子レスポンダを取得します。
SFYResponderSmp GetChildFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最前面に位置するこのレスポンダの子レスポンダを取得します。
SFYDistributerPtr GetDistributer( Void ) (SFYResponder から継承)
このレスポンダに設定されている配信エンジンを取得します。
SFXRGBColorConstRef GetFocusColor( Void ) (SFYFlatFrame から継承)
フォーカス状態にあるときのフラットフレーム領域の色を取得します。
SFYResponderSmp GetFrame( Void ) (SFYResponder から継承)
このレスポンダに装着されたフレームを取得します。
SFXRGBColorConstRef GetFrameColor( Void ) (SFYFlatFrame から継承)
フラットフレーム領域の色を取得します。
Bool GetFrameEnable( Void ) (SFYFlatFrame から継承)
フレームの有無を取得します。
SFXRectangle GetGlobalBound( Void ) (SFYResponder から継承)
このレスポンダのグローバル領域を取得します。
UInt32 GetID( Void ) (SFYResponder から継承)
このレスポンダの ID を取得します。
SFXRectangle GetLocalBound( Void ) (SFYResponder から継承)
このレスポンダのローカル領域を取得します。
SInt32 GetNthBackward( Void ) (SFYResponder から継承)
このレスポンダが背面から数えて何番目に位置するかを取得します。
SInt32 GetNthBackward( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが背面から数えて何番目に位置するかを取得します。
SInt32 GetNthBackward( UInt32 id ) (SFYResponder から継承)
このレスポンダが背面から数えて何番目に位置するかを取得します。
SInt32 GetNthBackward( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが背面から数えて何番目に位置するかを取得します。
SInt32 GetNthForward( Void ) (SFYResponder から継承)
このレスポンダが前面から数えて何番目に位置するかを取得します。
SInt32 GetNthForward( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが前面から数えて何番目に位置するかを取得します。
SInt32 GetNthForward( UInt32 id ) (SFYResponder から継承)
このレスポンダが前面から数えて何番目に位置するかを取得します。
SInt32 GetNthForward( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが前面から数えて何番目に位置するかを取得します。
SFYResponderSmp GetParent( Void ) (SFYResponder から継承)
このレスポンダの親レスポンダを取得します。
Bool GetPropertyTransparent( Void ) (SFYResponder から継承)
このレスポンダの透過属性を取得します。
SFXRectangleConstRef GetRealBound( Void ) (SFYResponder から継承)
このレスポンダの実領域を取得します。
VoidPtr GetReference( Void ) (SFYResponder から継承)
このレスポンダのリファレンス値を取得します。
SFYRendererPtr GetRenderer( Void ) (SFYResponder から継承)
このレスポンダに設定されている描画エンジンを取得します。
SFYResponderSmp GetRoot( Void ) (SFYResponder から継承)
このレスポンダが所属するレスポンダツリーのルートレスポンダを取得します。
SFXRGBColorConstRef GetShadowColor( Void ) (SFYPlainFrame から継承)
影領域の色を取得します。
Bool GetShadowEnable( Void ) (SFYPlainFrame から継承)
影の有無を取得します。
Bool GetStateActive( Bool inherit = false ) (SFYResponder から継承)
このレスポンダの活性状態を取得します。
Bool GetStateEnable( Bool inherit = false ) (SFYResponder から継承)
このレスポンダの操作可能状態を取得します。
Bool GetStateFocus( Bool inherit = false ) (SFYResponder から継承)
このレスポンダのフォーカス状態を取得します。
Bool GetStateValid( Bool inherit = false ) (SFYResponder から継承)
このレスポンダの有効状態を取得します。
Bool GetStateVisible( Bool inherit = false ) (SFYResponder から継承)
このレスポンダの可視状態を取得します。
SFXRectangle GetSuitableBound( Void ) (SFYResponder から継承)
このレスポンダの最適な領域(サイズ)を取得します。
SFXRectangle GetSuitableBound( SFXRectangleConstRef rectangle ) (SFYResponder から継承)
このレスポンダの最適な領域(サイズ)を取得します。
SFXRectangle GetSuitableBound( SFXRectangleConstRef param , HorizontalEnum horizontal , VerticalEnum vertical ) (SFYResponder から継承)
このレスポンダの最適な領域(サイズ)を取得します。
SFXMargin GetSuitableMargin( Void ) (SFYResponder から継承)
このレスポンダのフレーム余白領域を取得します。
SFCType GetType( Void ) (SFYResponder から継承)
このレスポンダのタイプを取得します。
SFXRectangleConstRef GetVirtualBound( Void ) (SFYResponder から継承)
このレスポンダの仮想領域を取得します。
Bool HasFrame( Void ) (SFYResponder から継承)
このレスポンダがコンテントレスポンダであるかどうかを判定します。
Void Initialize( Void ) (SFYResponder から継承)
このレスポンダを初期化します。
Void Invalidate( Void ) (SFYResponder から継承)
指定された領域を再描画領域に登録します。
Void Invalidate( SFXRectangleConstRef param ) (SFYResponder から継承)
指定された領域を再描画領域に登録します。
Void InvokeBackward( SFXEventConstRef event , Bool overload , BoolPtr result = null ) (SFYResponder から継承)
指定されたコールバック型イベントをこのレスポンダに送信します (ハンドラは登録順に起動されます)。
Void InvokeForward( SFXEventConstRef event , Bool overload , BoolPtr result = null ) (SFYResponder から継承)
指定されたコールバック型イベントをこのレスポンダに送信します (ハンドラは登録の逆順に起動されます)。
Bool IsBack( Void ) (SFYResponder から継承)
このレスポンダが最背面に位置するかどうかを判定します。
Bool IsBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが最背面に位置するかどうかを判定します。
Bool IsBack( UInt32 id ) (SFYResponder から継承)
このレスポンダが最背面に位置するかどうかを判定します。
Bool IsBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが最背面に位置するかどうかを判定します。
Bool IsFrame( Void ) (SFYResponder から継承)
このレスポンダがアタッチメントフレームであるかどうかを判定します。
Bool IsFront( Void ) (SFYResponder から継承)
このレスポンダが最前面に位置するかどうかを判定します。
Bool IsFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが最前面に位置するかどうかを判定します。
Bool IsFront( UInt32 id ) (SFYResponder から継承)
このレスポンダが最前面に位置するかどうかを判定します。
Bool IsFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが最前面に位置するかどうかを判定します。
Bool IsNthBackward( SInt32 index ) (SFYResponder から継承)
このレスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthBackward( SInt32 index , UInt32 id ) (SFYResponder から継承)
このレスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthForward( SInt32 index ) (SFYResponder から継承)
このレスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthForward( SInt32 index , UInt32 id ) (SFYResponder から継承)
このレスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool IsRoot( Void ) (SFYResponder から継承)
このレスポンダがルートレスポンダであるかどうかを判定します。
SFCError Recover( Void ) (SFYResponder から継承)
デバイス画面保存用ビットマップを使用してこのレスポンダとレスポンダ空間との交差領域を復元します。
SFCError RegisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (SFYResponder から継承)
指定されたハンドラをこのレスポンダに登録します。
SFCError RegisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (SFYResponder から継承)
指定されたハンドラをこのレスポンダに登録します。
SFCError RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承)
指定されたハンドラをこのレスポンダに登録します。
SFCError RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (SFYResponder から継承)
指定されたハンドラをこのレスポンダに登録します。
SFCError RegisterTracer( SFXEventRangeConstRef range , SFYTracer::RuleRecConstRef rule ) (SFYResponder から継承)
指定された配信規則をこのレスポンダのトレーサに登録します。
SFCError RegisterTracer( SFXEventRangeConstRef range , SFYTracer::OrderEnum order , SFYTracer::StateEnum state , Bool overload ) (SFYResponder から継承)
指定された配信規則をこのレスポンダのトレーサに登録します。
SFCError RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承)
指定された配信規則をこのレスポンダのトレーサに登録します。
SFCError RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::OrderEnumConstPtr order , SFYTracer::StateEnumConstPtr state , BoolConstPtr overload , SInt32 length ) (SFYResponder から継承)
指定された配信規則をこのレスポンダのトレーサに登録します。
SFCError Render( Bool force = false ) (SFYResponder から継承)
このレスポンダ以下のレスポンダツリーをレスポンダ空間に再描画します。
Void SetBackgroundColor( SFXRGBColorConstRef param ) (SFYWidget から継承)
背景の色を設定します。
Void SetDistributer( SFYDistributerPtr param ) (SFYResponder から継承)
指定された配信エンジンをこのレスポンダに設定します。
Void SetFocusColor( SFXRGBColorConstRef param ) (SFYFlatFrame から継承)
フォーカス状態にあるときのフラットフレーム領域の色を設定します。
SFCError SetFrame( SFYResponderSmpConstRef param ) (SFYResponder から継承)
このレスポンダにフレームを装着します。
Void SetFrameColor( SFXRGBColorConstRef param ) (SFYFlatFrame から継承)
フラットフレーム領域の色を設定します。
Void SetFrameEnable( Bool param ) (SFYFlatFrame から継承)
フレームの有無を設定します。
Void SetID( UInt32 param ) (SFYResponder から継承)
指定された ID をこのレスポンダに設定します。
SFCError SetParent( SFYResponderSmpConstRef param ) (SFYResponder から継承)
指定されたレスポンダをこのレスポンダの親レスポンダに設定します。
Void SetProperty( Bool transparent ) (SFYResponder から継承)
指定された属性をこのレスポンダに設定します。
Void SetPropertyTransparent( Bool param ) (SFYResponder から継承)
指定された透過属性をこのレスポンダに設定します。
Void SetRealBound( SFXRectangleConstRef param ) (SFYResponder から継承)
指定された領域をこのレスポンダの実領域に設定します。
Void SetReference( VoidPtr param ) (SFYResponder から継承)
指定された値をこのレスポンダのリファレンスに設定します。
Void SetRenderer( SFYRendererPtr param ) (SFYResponder から継承)
指定された描画エンジンをこのレスポンダに設定します。
Void SetShadowColor( SFXRGBColorConstRef param ) (SFYPlainFrame から継承)
影領域の色を設定します。
Void SetShadowEnable( Bool param ) (SFYPlainFrame から継承)
影の有無を設定します。
Void SetState( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
指定された値をこのレスポンダの可視、活性、操作可能、フォーカスの各状態フラグに設定します。
Void SetStateActive( Bool param ) (SFYResponder から継承)
指定された値をこのレスポンダの活性状態フラグに設定します。
Void SetStateEnable( Bool param ) (SFYResponder から継承)
指定された値をこのレスポンダの操作可能状態フラグに設定します。
Void SetStateFocus( Bool param ) (SFYResponder から継承)
指定された値をこのレスポンダのフォーカス状態フラグに設定します。
Void SetStateVisible( Bool param ) (SFYResponder から継承)
指定された値をこのレスポンダの可視状態フラグに設定します。
Void SetVirtualBound( SFXRectangleConstRef param ) (SFYResponder から継承)
指定された領域をこのレスポンダの仮想領域に設定します。
SFCError Snapshot( SFBBitmapSmpConstRef bitmap ) (SFYResponder から継承)
デバイス画面保存用ビットマップからこのレスポンダとレスポンダ空間との交差領域のスナップショットを取得します。
Void Terminate( Void ) (SFYResponder から継承)
このレスポンダの終了処理を行います。
Void ToBack( Void ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最背面に移動します。
Void ToBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最背面に移動します。
Void ToBack( UInt32 id ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最背面に移動します。
Void ToBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最背面に移動します。
Void ToFront( Void ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最前面に移動します。
Void ToFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最前面に移動します。
Void ToFront( UInt32 id ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最前面に移動します。
Void ToFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで最前面に移動します。
Void ToNthBackward( SInt32 index ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで背面から数えて指定された位置に移動します。
Void ToNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで背面から数えて指定された位置に移動します。
Void ToNthBackward( SInt32 index , UInt32 id ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで背面から数えて指定された位置に移動します。
Void ToNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで背面から数えて指定された位置に移動します。
Void ToNthForward( SInt32 index ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで前面から数えて指定された位置に移動します。
Void ToNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで前面から数えて指定された位置に移動します。
Void ToNthForward( SInt32 index , UInt32 id ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで前面から数えて指定された位置に移動します。
Void ToNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
このレスポンダを指定された条件の姉妹レスポンダのなかで前面から数えて指定された位置に移動します。
Void UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (SFYResponder から継承)
このレスポンダから指定されたハンドラの登録を解除します。
Void UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (SFYResponder から継承)
このレスポンダから指定されたハンドラの登録を解除します。
Void UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承)
このレスポンダから指定されたハンドラの登録を解除します。
Void UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (SFYResponder から継承)
このレスポンダから指定されたハンドラの登録を解除します。
Void UnregisterTracer( SFXEventRangeConstRef range ) (SFYResponder から継承)
このレスポンダのトレーサから指定された配信規則の登録を解除します。
Void UnregisterTracer( SFXEventRangeConstPtr range , SInt32 length ) (SFYResponder から継承)
このレスポンダのトレーサから指定された配信規則の登録を解除します。
プロテクト関数
Void DrawHeader( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle )
ヘッダーを描画します。
SFXRectangleConstRef GetHeaderBound( Void )
ヘッダー領域を取得します。
SFYSingleTextWidgetSmpConstRef GetWidget( Void )
タイトル描画用に内部で保持しているテキストウィジェットを取得します。
Void HandleBoundVirtual( Void )
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントを受信したときに呼び出される関数です (仮想領域が変化したときの処理を行います)。
Void HandleMarginRequest( SFXMarginPtr margin )
(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST) イベントを受信したときに呼び出される関数です (フレーム余白領域を計算します)。
Void HandleRenderRequest( SFXGraphicsPtr graphics )
描画イベントを受信したときに呼び出される関数です(レスポンダを描画します)。
SFXRectangle DrawFrame( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (SFYFlatFrame から継承)
フラットフレーム領域を描画します。
SFXRectangle DrawShadow( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (SFYPlainFrame から継承)
影領域を描画します。
static
SFYResponderSmp
Factory( SFYResponderPtr responder , SFCErrorPtr exception = null ) (SFYResponder から継承)
NewInstance 関数の実装を補助します。
SFXMarginConstRef GetFrameMargin( Void ) (SFYFlatFrame から継承)
フラットフレーム領域のマージンを取得します。
SFXMarginConstRef GetShadowMargin( Void ) (SFYPlainFrame から継承)
影領域のマージンを取得します。
SFYResponderSmp GetThis( Void ) (SFYResponder から継承)
このレスポンダのスマートポインタを取得します。
Void HandleBoundGlobal( SFXRectangleConstRef rectangle ) (SFYWidget から継承)
[非推奨(廃止予定 API)] グローバル領域が変化したときに呼び出される関数です。
Void HandleBoundOptimize( SFXRectanglePtr rectangle ) (SFYWidget から継承)
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_OPTIMIZE) イベントを受信したときに呼び出される関数です(指定した矩形に収まる範囲内で最適な領域を計算します)。
Void HandleBoundReal( Void ) (SFYFrame から継承)
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REAL) イベントを受信したときに呼び出される関数です (実領域が変化したときの処理を行います)。
Void HandleBoundRequest( SFXRectanglePtr rectangle ) (SFYWidget から継承)
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_REQUEST) イベントを受信したときに呼び出される関数です(最適な領域を計算します)。
Void SetType( SFCType param ) (SFYResponder から継承)
指定された値をこのレスポンダのタイプに設定します。
CodeEnum
SFZTitleFlatFrame クラスを表す定数です。
DefaultEnum
各種パラメータのデフォルト値を表します。
DirectionEnum
タイトルのスクロール移動方向を表します。
HorizontalEnum
タイトルの水平方向のアライメントを表す定数です。
VerticalEnum
タイトルの垂直方向のアライメントを表す定数です。

SFZTitleFlatFrame::SFZTitleFlatFrame
SFZTitleFlatFrame クラスのコンストラクタです。
[ protected, explicit ]
SFZTitleFlatFrame(Void);

解説

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

  1. タイプを "tbvl" に設定します。
  2. ヘッダー領域の枠とタイトル文字表示領域間の余白を SFZTitleFlatFrame::DEFAULT_FRAME に設定します。
  3. ヘッダー領域のカラーを SFXRGBColor(0xDD, 0xDD, 0xDD0, 0x00)[灰色] に設定します。
  4. タイトル描画用に内部で子レスポンダとして保持する SFYSingleTextWidget インスタンスを生成します。
  5. SFYSingleTextWidget インスタンスの状態を「可視+活性+操作不能+非フォーカス」に設定します。
  6. タイトルの文字列を ""[空文字列] に設定します。
  7. タイトルの色を SFXRGBColor(0x00, 0x00, 0x00, 0x00)[黒色] に設定します。
  8. タイトルのフォントを AEE_FONT_NORMAL に設定します。
  9. タイトルの水平アライメントを SFYSingleTextWidget::DEFAULT_HORIZONTAL に設定します。
  10. タイトルの垂直アライメントを SFYSingleTextWidget::DEFAULT_VERTICAL に設定します。
  11. タイトルのスクロール開始までの待ち時間を SFYSingleTextWidget::DEFAULT_WAIT に設定します。
  12. タイトルのスクロール移動方向を SFYSingleTextWidget::DEFAULT_DIRECTION に設定します。
  13. タイトルのスクロールインターバルを SFYSingleTextWidget::DEFAULT_SCROLL に設定します。
  14. タイトルのスクロール移動量を SFYSingleTextWidget::DEFAULT_STEP に設定します。
  15. 下表にあるハンドラをレスポンダに登録します。

表 277. イベントハンドラ

イベント ハンドラの内容
フォーカス状態になったときの状態イベント[SFEVT_RESPONDER_STATE] タイトルのスクロールを開始します。
非フォーカス状態になったときの状態イベント[SFEVT_RESPONDER_STATE] タイトルのスクロールを停止します。
[Note] 注意
SFZTitleFlatFrame クラスを継承するレスポンダでは、 上記イベントが発生すると、それに対応するハンドラが呼び出されます。

内部実装

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

/*protected */SFZTitleFlatFrame::SFZTitleFlatFrame(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);
                }
            }
        }
    }
}// SFZTitleFlatFrame::SFZTitleFlatFrame //

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

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

/*private */XANDLER_IMPLEMENT_VOIDSTYLE(SFZTitleFlatFrame, 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(SFZTitleFlatFrame, OnWidgetStyle) //

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

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

参照

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


SFZTitleFlatFrame::~SFZTitleFlatFrame
SFZTitleFlatFrame クラスのデストラクタです。
[ protected, virtual ]
virtual ~SFZTitleFlatFrame(Void);

解説

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

内部実装

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

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

SFZTitleFlatFrame::DrawHeader
ヘッダーを描画します。
[ protected, const ]
Void DrawHeader(
    SFXGraphicsPtr graphics          // グラフィックスオブジェクト
    SFXRectangleConstRef rectangle   // ヘッダー領域
);

解説

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

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

内部実装

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

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

参照

SFZTitleFlatFrame::SetHeaderColor | SFXRGBColor


SFZTitleFlatFrame::GetFont
タイトルのフォントを取得します。
[ public, const ]
AEEFont GetFont(Void);

参照

SFZTitleFlatFrame::SetFont | BREW API AEEFont


SFZTitleFlatFrame::GetFrameSize
ヘッダー領域の枠とタイトル文字表示領域間の余白を取得します。[単位:ピクセル]
[ public, const ]
SInt16 GetFrameSize(Void);

戻り値

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

解説

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

参照

SFZTitleFlatFrame::SetFrameSize


SFZTitleFlatFrame::GetHeaderBound
ヘッダー領域を取得します。
[ protected, const ]
SFXRectangleConstRef GetHeaderBound(Void);

戻り値

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

解説

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

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

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

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

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

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

図 456. タイトル付きフラットフレーム拡大図[SFZTitleFlatFrame]


タイトル付きフラットフレーム拡大図[SFZTitleFlatFrame]

参照

SFZTitleFlatFrame::HandleMarginRequest | SFZTitleFlatFrame::SetFrameSize


SFZTitleFlatFrame::GetHeaderColor
ヘッダーの色を取得します。
[ public, const ]
SFXRGBColorConstRef GetHeaderColor(Void);

戻り値

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

解説

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

参照

SFZTitleFlatFrame::SetHeaderColor | SFXRGBColor


SFZTitleFlatFrame::GetHorizontalAlign
タイトルの水平アライメントの値を取得します。
[ public, const ]
HorizontalEnum GetHorizontalAlign(Void);

戻り値

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

解説

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

参照

SFZTitleFlatFrame::SetHorizontalAlign | SFZTitleFlatFrame::HorizontalEnum


SFZTitleFlatFrame::GetScrollDirection
タイトルのスクロール移動方向を取得します。
[ public, const ]
DirectionEnum GetScrollDirection(Void);

戻り値

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

解説

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

参照

SFZTitleFlatFrame::SetScrollDirection


SFZTitleFlatFrame::GetScrollInterval
タイトルのスクロールインターバルを取得します。[単位:ミリ秒]
[ public, const ]
UInt32 GetScrollInterval(Void);

戻り値

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

解説

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

参照

SFZTitleFlatFrame::SetScrollInterval


SFZTitleFlatFrame::GetScrollStep
タイトルのスクロール移動量を取得します。[単位:ピクセル]
[ public, const ]
SInt16 GetScrollStep(Void);

戻り値

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

解説

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

参照

SFZTitleFlatFrame::SetScrollStep


SFZTitleFlatFrame::GetText
タイトルを取得します。
[ public, const ]
SFXWideStringConstRef GetText(Void);

戻り値

タイトル。

解説

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

参照

SFZTitleFlatFrame::SetText


SFZTitleFlatFrame::GetTextColor
タイトルの色を取得します。
[ public, const ]
SFXRGBColorConstRef GetTextColor(Void);

戻り値

タイトルの色。

解説

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

参照

SFZTitleFlatFrame::SetTextColor | SFXRGBColor


SFZTitleFlatFrame::GetVerticalAlign
タイトルの垂直アライメントの値を取得します。
[ public, const ]
VerticalEnum GetVerticalAlign(Void);

戻り値

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

解説

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

参照

SFZTitleFlatFrame::SetVerticalAlign | SFZTitleFlatFrame::VerticalEnum


SFZTitleFlatFrame::GetWaitInterval
タイトルのスクロール開始までの待ち時間を取得します。[単位:ミリ秒]
[ public, const ]
UInt32 GetWaitInterval(Void);

戻り値

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

解説

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

参照

SFZTitleFlatFrame::SetWaitInterval


SFZTitleFlatFrame::GetWidget
タイトル描画用に内部で保持しているテキストウィジェットを取得します。
[ protected, const ]
SFYSingleTextWidgetSmpConstRef GetWidget(Void);

戻り値

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

解説

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

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

参照

SFYSingleTextWidget


SFZTitleFlatFrame::HandleBoundVirtual
(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントを受信したときに呼び出される関数です (仮想領域が変化したときの処理を行います)。
[ protected, virtual ]
Void HandleBoundVirtual(Void);

解説

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

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

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

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

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

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

[Note] 領域イベント[(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 には変更後の仮想領域が設定されています。

[Note] 仮想領域の変更処理

SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。

仮想領域の変更処理は、最初に SFYWidget::HandleBoundVirtual 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。

領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドして処理を記述します。

内部実装

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

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

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

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

参照

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


SFZTitleFlatFrame::HandleMarginRequest
(SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST) イベントを受信したときに呼び出される関数です (フレーム余白領域を計算します)。
[ protected, virtual, const ]
Void HandleMarginRequest(
    SFXMarginPtr margin   // 計算されたフレーム余白領域
);

解説

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

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

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

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

影領域、フラットフレーム領域、ヘッダー領域は、それぞれ SFYPlainFrame::GetShadowMargin 関数、 SFYFlatFrame::GetFrameMargin 関数、 SFZTitleFlatFrame::GetHeaderBound 関数を呼び出すことで取得できます。

図 457. タイトル付きフラットフレーム[SFZTitleFlatFrame]


タイトル付きフラットフレーム[SFZTitleFlatFrame]

図 458. タイトル付きフラットフレーム拡大図[SFZTitleFlatFrame]


タイトル付きフラットフレーム拡大図[SFZTitleFlatFrame]

ヘッダー領域の高さ HeaderHeight は

HeaderHeight = FontHeight + 2 * FrameMarginSize

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

です。

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

HeaderWidth = SFZTitleFlatFrameWidth - FlatFrameWidth - ShadowWidth

SFZTitleFlatFrameWidth  : SFZTitleFlatFrame に設定されたローカル領域の幅
FlatFrameWidth          : フラットフレーム領域の幅(1ピクセル)
ShadowWidth             : 影領域の幅(1ピクセル)

です。

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

影領域、フラットフレーム領域の幅は、それぞれ1ピクセルです。

[Note] 余白イベント[(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() が初期設定されています。

[Note] (SFEVT_RESPONDER_MARGIN, SFP16_MARGIN_REQUEST) イベント受信時の余白領域計算

SFYFrame::HandleMarginRequest 仮想関数をオーバーライドする以外に、 余白イベント専用ハンドラを定義・実装し レスポンダに登録して行うことも可能です。

フレーム余白領域の計算は、最初に SFYFrame::HandleMarginRequest 仮想関数を実行し、 次に余白イベント専用ハンドラを登録した順に実行して行われます。

余白イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYFrame::HandleMarginRequest 仮想関数をオーバーライドして処理を記述します。

内部実装

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

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

参照

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


SFZTitleFlatFrame::HandleRenderRequest
描画イベントを受信したときに呼び出される関数です(レスポンダを描画します)。
[ protected, virtual, const ]
Void HandleRenderRequest(
    SFXGraphicsPtr graphics   // グラフィックスオブジェクト
);

解説

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

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

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

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

  1. SFYPlainFrame::DrawShadow 関数、 SFYFlatFrame::DrawFrame 関数、 SFZTitleFlatFrame::DrawHeader 関数 を呼び出してヘッダー付きフラットフレームを描画します。
  2. ヘッダー領域は SFZTitleFlatFrame::SetHeaderColor 関数で設定する色(SFXRGBColor) で描画します。
  3. ヘッダー領域のマージンで囲まれるタイトル表示用領域にタイトルを描画します。
  4. タイトルは、 SFZTitleFlatFrame::SetText 関数で設定します。
  5. ヘッダー領域内でのタイトルの配置は、 SFZTitleFlatFrame::SetHorizontalAlign 関数、 SFZTitleFlatFrame::SetVerticalAlign 関数で設定します。
  6. テキストのフォントと色は、 SFZTitleFlatFrame::SetFont 関数、 SFZTitleFlatFrame::SetTextColor 関数で設定します。
  7. 非活性状態のとき、テキストの色は SFZTitleFlatFrame::SetTextColor 関数の説明にある方法で計算された色になります。
  8. 実際のテキストの描画は、 このクラスが内部で保持する SFYSingleTextWidget クラスに委譲して行われます。

図 459. タイトル付きフラットフレーム[SFZTitleFlatFrame]


タイトル付きフラットフレーム[SFZTitleFlatFrame]

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

図 460. タイトル付きフラットフレーム拡大図[SFZTitleFlatFrame]


タイトル付きフラットフレーム拡大図[SFZTitleFlatFrame]

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

影領域、フラットフレーム領域の幅は、それぞれ1ピクセルです。

  1. 影領域は SFYPlainFrame::DrawShadow 関数が描画します(影領域の色は SFYPlainFrame::SetShadowColor 関数で設定)。
  2. フラットフレーム領域は SFYFlatFrame::DrawFrame 関数が描画します(フラットフレーム領域の色は SFYFlatFrame::SetFrameColor / SFYFlatFrame::SetFocusColor 関数で設定)。
  3. ヘッダー領域は SFZTitleFlatFrame::DrawHeader 関数が描画します(ヘッダー領域の色は SFZTitleFlatFrame::SetHeaderColor 関数で設定)。
[Note] レスポンダの描画手順

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

[Tip] Tip
描画ハンドラの宣言と登録の手間を省けるので、 通常は SFYWidget::HandleRenderRequest 仮想関数だけを利用してレスポンダを描画します。

内部実装

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

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

参照

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


SFZTitleFlatFrame::NewInstance
新しいインスタンスを作成します。
[ public, static ]
SFZTitleFlatFrameSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

引数

exception

関数内部で発生したエラー値を返します。

戻り値

  • 成功したとき: null 以外のポインタ
  • 失敗したとき: null ポインタ

解説

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

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

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

使用例

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

// タイトルフラットフレームのインスタンスを生成する
SFZTitleFlatFrameSmp _titleflatframe;
SFCError error;

if ((_titleflatflame = SFZTitleFlatFrame::NewInstance(&error)) != null) {
    // ...
}

SFZTitleFlatFrame::SetFont
タイトルのフォントを設定します。
[ public ]
Void SetFont(
    AEEFont param   // 設定する値
);

解説

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

デフォルト値: AEE_FONT_NORMAL

参照

SFZTitleFlatFrame::GetFont | BREW API AEEFont


SFZTitleFlatFrame::SetFrameSize
ヘッダー領域の枠とタイトル文字表示領域間の余白を設定します。[単位:ピクセル]
[ public ]
Void SetFrameSize(
    SInt16 param   // ヘッダー領域の枠とタイトル文字表示領域間の余白[単位:ピクセル]
);

解説

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

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

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

参照

SFZTitleFlatFrame::GetFrameSize


SFZTitleFlatFrame::SetHeaderColor
ヘッダーの色を設定します。
[ public ]
Void SetHeaderColor(
    SFXRGBColorConstRef param   // 設定する色
);

解説

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

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

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

参照

SFZTitleFlatFrame::GetHeaderColor | SFXRGBColor


SFZTitleFlatFrame::SetHorizontalAlign
タイトルの水平アライメントを設定します。
[ public ]
Void SetHorizontalAlign(
    HorizontalEnum param   // 設定する値
);

解説

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

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

デフォルト値: SFYSingleTextWidget::DEFAULT_HORIZONTAL

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

参照

SFYSingleTextWidget | SFZTitleFlatFrame::SetText | SFZTitleFlatFrame::GetHorizontalAlign | SFZTitleFlatFrame::HorizontalEnum | SFYSingleTextWidget::HorizontalEnum


SFZTitleFlatFrame::SetScrollDirection
タイトルのスクロール移動方向を設定します。
[ public ]
Void SetScrollDirection(
    DirectionEnum param   // 設定する値
);

解説

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

デフォルト値: SFYSingleTextWidget::DEFAULT_DIRECTION

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

参照

SFZTitleFlatFrame::GetScrollDirection | SFZTitleFlatFrame::DirectionEnum | SFYSingleTextWidget::DirectionEnum


SFZTitleFlatFrame::SetScrollInterval
タイトルのスクロールインターバルを設定します。[単位:ミリ秒]
[ public ]
Void SetScrollInterval(
    UInt32 param   // 設定する値
);

解説

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

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

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

参照

SFZTitleFlatFrame::GetScrollInterval | SFZTitleFlatFrame::DefaultEnum | SFYSingleTextWidget::DefaultEnum


SFZTitleFlatFrame::SetScrollStep
タイトルのスクロール移動量を設定します。[単位:ピクセル]
[ public ]
Void SetScrollStep(
    SInt16 param   // 設定する値
);

解説

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

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

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

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

参照

SFZTitleFlatFrame::GetScrollStep | SFZTitleFlatFrame::DefaultEnum | SFYSingleTextWidget::DefaultEnum


SFZTitleFlatFrame::SetText
タイトルを設定します。
[ public ]
SFCError SetText(
    SFXPathConstRef path   // リソースファイルパス
    UInt16 id              // リソース ID
);
[ public ]
SFCError SetText(
    SFXWideStringConstRef param   // 文字列
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • BREW API IShell インターフェースのインスタンスが取得できないとき: SFERR_FAILED

解説

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

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

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

参照

SFZTitleFlatFrame::GetText | SFZTitleFlatFrame::SetHorizontalAlign | SFZTitleFlatFrame::SetVerticalAlign SFZTitleFlatFrame::SetTextColor | SFZTitleFlatFrame::SetFont


SFZTitleFlatFrame::SetTextColor
タイトルの色を設定します。
[ public ]
Void SetTextColor(
    SFXRGBColorConstRef param   // 設定する値
);

解説

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

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

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

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

参照

SFZTitleFlatFrame::GetTextColor | SFXRGBColor::GetBrightness | SFXRGBColor | 状態


SFZTitleFlatFrame::SetVerticalAlign
タイトルの垂直アライメントを設定します。
[ public ]
Void SetVerticalAlign(
    VerticalEnum param   // 
);

解説

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

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

デフォルト値: SFYSingleTextWidget::DEFAULT_VERTICAL

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

参照

SFYSingleTextWidget | SFZTitleFlatFrame::SetText | SFZTitleFlatFrame::GetVerticalAlign | SFZTitleFlatFrame::VerticalEnum | SFYSingleTextWidget::VerticalEnum


SFZTitleFlatFrame::SetWaitInterval
タイトルのスクロール開始までの待ち時間を設定します。[単位:ミリ秒]
[ public ]
Void SetWaitInterval(
    UInt32 param   // 
);

解説

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

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

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

参照

SFZTitleFlatFrame::GetWaitInterval | SFZTitleFlatFrame::DefaultEnum | SFYSingleTextWidget::DefaultEnum


SFZTitleFlatFrame::StartScroll
タイトルのスクロールを開始します.
[ public ]
Void StartScroll(Void);

解説

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

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

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

参照

SFZTitleFlatFrame::StopScroll


SFZTitleFlatFrame::StopScroll
タイトルのスクロールを停止します.
[ public ]
Void StopScroll(Void);

解説

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

参照

SFZTitleFlatFrame::StartScroll


SFZTitleFlatFrame::CodeEnum
SFZTitleFlatFrame クラスを表す定数です。
enum CodeEnum {
    CODE_TYPE = four_char_code('f', 't', 'f', 't')
};
SFMTYPEDEFTYPE(CodeEnum)

参照

SFYResponder::GetType | SFYResponder::SetType


SFZTitleFlatFrame::DefaultEnum
各種パラメータのデフォルト値を表します。
enum DefaultEnum {
    DEFAULT_WAIT   = SFYSingleTextWidget::DEFAULT_WAIT,    // スクロール開始までの待ち時間(単位:ミリ秒)
    DEFAULT_SCROLL = SFYSingleTextWidget::DEFAULT_SCROLL,  // スクロールインターバル(単位:ミリ秒)
    DEFAULT_STEP   = SFYSingleTextWidget::DEFAULT_STEP     // スクロール移動量(単位:ピクセル)
};
SFMTYPEDEFTYPE(DefaultEnum)

参照

SFYSingleTextWidget::DefaultEnum


SFZTitleFlatFrame::DirectionEnum
タイトルのスクロール移動方向を表します。
enum DirectionEnum {
    DIRECTION_LEFT    = SFYSingleTextWidget::DIRECTION_LEFT,    // 左へスクロール
    DIRECTION_RIGHT   = SFYSingleTextWidget::DIRECTION_RIGHT,   // 右へスクロール
    DEFAULT_DIRECTION = SFYSingleTextWidget::DEFAULT_DIRECTION  // デフォルト値: 左へスクロール
};
SFMTYPEDEFTYPE(DirectionEnum)

参照

SFYSingleTextWidget::DirectionEnum


SFZTitleFlatFrame::HorizontalEnum
タイトルの水平方向のアライメントを表す定数です。
enum HorizontalEnum {
    HORIZONTAL_LEFT    = SFYSingleTextWidget::HORIZONTAL_LEFT,   // 左詰め
    HORIZONTAL_CENTER  = SFYSingleTextWidget::HORIZONTAL_CENTER, // 中央揃え
    HORIZONTAL_RIGHT   = SFYSingleTextWidget::HORIZONTAL_RIGHT,  // 右詰め
    DEFAULT_HORIZONTAL = SFYSingleTextWidget::DEFAULT_HORIZONTAL // デフォルト設定: 中央揃え
};
SFMTYPEDEFTYPE(HorizontalEnum)

参照

SFYSingleTextWidget::HorizontalEnum


SFZTitleFlatFrame::VerticalEnum
タイトルの垂直方向のアライメントを表す定数です。
enum VerticalEnum {
    VERTICAL_TOP     = SFYSingleTextWidget::VERTICAL_TOP,     // 上詰め
    VERTICAL_MIDDLE  = SFYSingleTextWidget::VERTICAL_MIDDLE,  // 中央揃え
    VERTICAL_BOTTOM  = SFYSingleTextWidget::VERTICAL_BOTTOM,  // 下詰め
    DEFAULT_VERTICAL = SFYSingleTextWidget::DEFAULT_VERTICAL  // デフォルト値: 中央揃え
};
SFMTYPEDEFTYPE(VerticalEnum)

参照

SFYSingleTextWidget::VerticalEnum