前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFRFrame
フレームの機能を提供するクラスです。
#include <SFRFrame.hpp>
class SFRFrame;
SFMTYPEDEFCLASS(SFRFrame)

継承図

SFRFrame クラスの継承図

参照

SFRPlainFrame | SFRFrameFrame | SFRTitleFrame

メンバ

コンストラクタ/デストラクタ
SFRFrame( SFRResponderPtr parent )
SFRFrame クラスのコンストラクタです。
~SFRFrame( Void )
SFRFrame クラスのデストラクタです。
パブリック関数
SFXRGBColorConstRef GetColor( ColorType index )
色を取得します。
Void SetColor( ColorType index , SFXRGBColorConstRef color )
色を設定します。
プロテクト関数
static
SFXRectangle
AdjustBound( SFXRectangleConstRef rect )
座標を調節します。
Void ContentHandler( SFXGraphicsPtr graphics )
[ハンドラ] コンテント領域を再描画します。
SFRResponderPtr GetResponder( Void )
レスポンダを取得します。
SFCError MakeHandler( Void )
コンテント領域を再描画します。
ColorEnum
特定の箇所を表す定数です。

SFRFrame::SFRFrame
SFRFrame クラスのコンストラクタです。
[ protected ]
SFRFrame(
    SFRResponderPtr parent   // 親となるレスポンダのポインタ
);

参照

SFRFrame::~SFRFrame


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

参照

SFRFrame::SFRFrame


SFRFrame::AdjustBound
座標を調節します。
[ protected, static ]
SFXRectangle AdjustBound(
    SFXRectangleConstRef rect   // 調節する座標
);

解説

座標の幅もしくは高さが 0 以下の場合は、座標の幅もしくは高さを 1 に設定します。


SFRFrame::ContentHandler
[ハンドラ] コンテント領域を再描画します。
[ protected ]
Void ContentHandler(
    SFXGraphicsPtr graphics   // SFXGraphics インスタンス
);

解説

レスポンダのコンテント領域を、白く塗り潰します。( 白色 : SFXRGBColor(0xFF, 0xFF, 0xFF, 0x00) で定義される色 )

使用例

SFRTitleWindow クラスのコンテント領域を白く塗り潰します。

SFRTitleWindow::ContentHandler(graphics);

参照

SFXGraphics


SFRFrame::GetColor
色を取得します。
[ public, const ]
SFXRGBColorConstRef GetColor(
    ColorType index   // パレットインデックス
);

引数

index

SFRFrame::ColorEnum 型のパレットインデックスを指定します。

解説

無効なパレットインデックスを設定したときの動作は不定です。

参照

SFRFrame::SetColor | SFRFrame::ColorEnum


SFRFrame::GetResponder
レスポンダを取得します。
[ protected, const ]
SFRResponderPtr GetResponder(Void);

SFRFrame::MakeHandler
コンテント領域を再描画します。
[ protected ]
SFCError MakeHandler(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY

解説

SFRFrame::MakeHandler 関数は、内部的に SFRFrame::ContentHandler ハンドラ関数を SREVT_RESPONDER_RENDER と SRP16_RENDER_CONTENT のイベント ペアと関連付けて登録します。

参照

SFRFrame::ContentHandler


SFRFrame::SetColor
色を設定します。
[ public ]
Void SetColor(
    ColorType index             // パレットインデックス
    SFXRGBColorConstRef color   // 色
);

引数

index

SFRFrame::ColorEnum 型のパレットインデックスを指定します。

color

色を指定します。

解説

無効なパレットインデックスを設定したときの動作は不定です。

参照

SFRFrame::GetColor | SFRFrame::ColorEnum


SFRFrame::ColorEnum
特定の箇所を表す定数です。
enum ColorEnum {
  COLOR_CONTENT_BASE = 0,  // コンテント領域の内部を表す定数
};

解説

色を設定 / 取得するときに使います。

参照

SFRFrame::SetColor | SFRFrame::GetColor