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

継承図

SFZTitleFlatFrame クラスの継承図

協調図

SFZTitleFlatFrame クラスの協調図

解説

タイトル付きフラットフレームです。

フラットフレームとは影部分を持つ枠の有る平面的な矩形領域のことです。

参照

SFZFlatFrame | SFYFlatFrame | SFYFrame

メンバ

コンストラクタ/デストラクタ
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 )
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 から継承)
配信エンジンを起動してイベントを配信します。
SFXRGBColorConstRef GetBackgroundColor( Void ) (SFYWidget から継承)
背景の色を取得します。
SFYResponderSmp GetChildBack( Void ) (SFYResponder から継承)
GetChildBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
GetChildBack( UInt32 id ) (SFYResponder から継承)
GetChildBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最背面に位置する子レスポンダを取得します。
SFYResponderSmp GetChildBackward( SInt32 index ) (SFYResponder から継承)
GetChildBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
GetChildBackward( SInt32 index , UInt32 id ) (SFYResponder から継承)
GetChildBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
背面から数えて指定された順番に位置する子レスポンダを取得します。
SInt32 GetChildCount( Void ) (SFYResponder から継承)
GetChildCount( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
GetChildCount( UInt32 id ) (SFYResponder から継承)
GetChildCount( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
子レスポンダの数を取得します。
SFYResponderSmp GetChildForward( SInt32 index ) (SFYResponder から継承)
GetChildForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
GetChildForward( SInt32 index , UInt32 id ) (SFYResponder から継承)
GetChildForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
前面から数えて指定された順番に位置する子レスポンダを取得します。
SFYResponderSmp GetChildFront( Void ) (SFYResponder から継承)
GetChildFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
GetChildFront( UInt32 id ) (SFYResponder から継承)
GetChildFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
最前面に位置する子レスポンダを取得します。
SFYDistributerPtr GetDistributer( Void ) (SFYResponder から継承)
配信エンジンを取得します。
SFXRGBColorConstRef GetFocusColor( Void ) (SFYFlatFrame から継承)
フォーカス状態にあるときの枠線の色を取得します。
SFXRGBColorConstRef GetFrameColor( Void ) (SFYFlatFrame から継承)
フレームの枠線の色を取得します。
SFXRectangle GetGlobalBound( Void ) (SFYResponder から継承)
グローバル領域を取得します。
UInt32 GetID( Void ) (SFYResponder から継承)
ID を取得します。
SFXRectangle GetLocalBound( Void ) (SFYResponder から継承)
ローカル領域を取得します。
SInt32 GetNthBackward( Void ) (SFYResponder から継承)
GetNthBackward( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
GetNthBackward( UInt32 id ) (SFYResponder から継承)
GetNthBackward( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
自レスポンダが背面から数えて何番目に位置するかを取得します。
SInt32 GetNthForward( Void ) (SFYResponder から継承)
GetNthForward( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
GetNthForward( UInt32 id ) (SFYResponder から継承)
GetNthForward( 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 GetStateActive( Bool inherit = false ) (SFYResponder から継承)
活性状態を取得します。
Bool GetStateEnable( Bool inherit = false ) (SFYResponder から継承)
操作可能状態を取得します。
Bool GetStateFocus( Bool inherit = false ) (SFYResponder から継承)
フォーカス状態を取得します。
Bool GetStateVisible( Bool inherit = false ) (SFYResponder から継承)
可視状態を取得します。
SFXRectangle GetSuitableBound( Void ) (SFYResponder から継承)
GetSuitableBound( SFXRectangleConstRef param ) (SFYResponder から継承)
最適な大きさを取得します。
SFXMargin GetSuitableMargin( Void ) (SFYResponder から継承)
最適な余白を取得します。
SFCType GetType( Void ) (SFYResponder から継承)
タイプを取得します。
SFXRectangleConstRef GetVirtualBound( Void ) (SFYResponder から継承)
仮想領域を取得します。
Void Initialize( Void ) (SFYResponder から継承)
レスポンダを初期化します。
Void Invalidate( Void ) (SFYResponder から継承)
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 から継承)
IsBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
IsBack( UInt32 id ) (SFYResponder から継承)
IsBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
自レスポンダが最背面に位置するかどうかを判定します。
Bool IsFront( Void ) (SFYResponder から継承)
IsFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
IsFront( UInt32 id ) (SFYResponder から継承)
IsFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
自レスポンダが最前面に位置するかどうかを判定します。
Bool IsNthBackward( SInt32 index ) (SFYResponder から継承)
IsNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
IsNthBackward( SInt32 index , UInt32 id ) (SFYResponder から継承)
IsNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
自レスポンダが背面から数えて指定された順番に位置するかどうかを判定します。
Bool IsNthForward( SInt32 index ) (SFYResponder から継承)
IsNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
IsNthForward( SInt32 index , UInt32 id ) (SFYResponder から継承)
IsNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
自レスポンダが前面から数えて指定された順番に位置するかどうかを判定します。
Bool IsRoot( Void ) (SFYResponder から継承)
自レスポンダがルートレスポンダかどうかを判定します。
SFCError RegisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (SFYResponder から継承)
RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (SFYResponder から継承)
RegisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承)
RegisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (SFYResponder から継承)
ハンドラを登録します。
SFCError RegisterTracer( SFXEventRangeConstRef range , SFYTracer::RuleRecConstRef rule ) (SFYResponder から継承)
RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::OrderEnumConstPtr order , SFYTracer::StateEnumConstPtr state , BoolConstPtr overload , SInt32 length ) (SFYResponder から継承)
RegisterTracer( SFXEventRangeConstPtr range , SFYTracer::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承)
RegisterTracer( SFXEventRangeConstRef range , SFYTracer::OrderEnum order , SFYTracer::StateEnum state , Bool overload ) (SFYResponder から継承)
トレーサを登録します。
SFCError Render( Bool force = false ) (SFYResponder から継承)
描画エンジンを起動して再描画します。
Void SetBackgroundColor( SFXRGBColorConstRef param ) (SFYWidget から継承)
背景の色を設定します。
Void SetDistributer( SFYDistributerPtr param ) (SFYResponder から継承)
配信エンジンを設定します。
Void SetFocusColor( SFXRGBColorConstRef param ) (SFYFlatFrame から継承)
フォーカス状態にあるときの枠線の色を設定します。
Void SetFrameColor( SFXRGBColorConstRef 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 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 から継承)
仮想領域を設定します。
Void Terminate( Void ) (SFYResponder から継承)
レスポンダの終了処理をします。
Void ToBack( Void ) (SFYResponder から継承)
ToBack( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
ToBack( UInt32 id ) (SFYResponder から継承)
ToBack( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
自レスポンダを姉妹レスポンダのなかで最背面に移動します。
Void ToFront( Void ) (SFYResponder から継承)
ToFront( UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
ToFront( UInt32 id ) (SFYResponder から継承)
ToFront( Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
自レスポンダを姉妹レスポンダのなかで最前面に移動します。
Void ToNthBackward( SInt32 index ) (SFYResponder から継承)
ToNthBackward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
ToNthBackward( SInt32 index , UInt32 id ) (SFYResponder から継承)
ToNthBackward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
自レスポンダを背面から数えて指定された順番に移動します。
Void ToNthForward( SInt32 index ) (SFYResponder から継承)
ToNthForward( SInt32 index , UInt32 id , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
ToNthForward( SInt32 index , UInt32 id ) (SFYResponder から継承)
ToNthForward( SInt32 index , Bool visible , Bool active , Bool enable , Bool focus ) (SFYResponder から継承)
自レスポンダを前面から数えて指定された順番に移動します。
Void UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::RuleRecConstRef rule ) (SFYResponder から継承)
UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::HandlerSPPConstPtr spp , VoidPtrConstPtr reference , SInt32 length ) (SFYResponder から継承)
UnregisterHandler( SFXEventRangeConstPtr range , SFYHandler::RuleRecConstPtr rule , SInt32 length ) (SFYResponder から継承)
UnregisterHandler( SFXEventRangeConstRef range , SFYHandler::HandlerSPP spp , VoidPtr reference ) (SFYResponder から継承)
ハンドラの登録を解除します。
Void UnregisterTracer( SFXEventRangeConstRef range ) (SFYResponder から継承)
UnregisterTracer( SFXEventRangeConstPtr range , SInt32 length ) (SFYResponder から継承)
トレーサの登録を解除します。
T const & static_catch( Void ) (static_exception から継承)
現在保持している例外を取得します。
プロテクト関数
Void DrawHeader( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle )
ヘッダーを描画します。
SFXRectangleConstRef GetHeaderBound( Void )
ヘッダーの高さを取得します。
SFYSingleTextWidgetSmpConstRef GetWidget( Void )
ウィジェットを取得します。
Void HandleBoundVirtual( Void )
仮想領域の変更処理を行います。
Void HandleMarginRequest( SFXMarginPtr margin )
余白を計算します。
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 関数の実装を補助します。
static
SFXMarginConstRef
GetFrameMargin( Void ) (SFYFlatFrame から継承)
余白を取得します。
static
SFXMarginConstRef
GetShadowMargin( Void ) (SFYPlainFrame から継承)
影の余白を取得します。
SFYResponderSmp GetThis( Void ) (SFYResponder から継承)
スマートポインタで保持された this を取得します。
Void HandleBoundGlobal( SFXRectangleConstRef rectangle ) (SFYWidget から継承)
グローバル領域の変更処理を行います。
Void HandleBoundOptimize( SFXRectanglePtr rectangle ) (SFYWidget から継承)
指定した矩形に収まる範囲内で最適なサイズを計算します。
Void HandleBoundReal( Void ) (SFYFrame から継承)
実領域の変更処理を行います。
Void HandleBoundRequest( SFXRectanglePtr rectangle ) (SFYWidget から継承)
最適な矩形を計算します。
Void SetType( SFCType param ) (SFYResponder から継承)
タイプを設定します。
Void static_throw( static_exception< T > const & param ) (static_exception から継承)
static_throw( T const & param ) (static_exception から継承)
例外を設定します。
Bool static_try( Void ) (static_exception から継承)
例外が保持されているかどうかを確かめます。
CodeEnum
SFZTitleFlatFrame クラスを表す定数です。
DefaultEnum
各種パラメータのデフォルト値を表します。
DirectionEnum
タイトルのスクロール移動方向を表します。
HorizontalEnum
タイトルの水平方向のアラインメントを表す定数です。
VerticalEnum
タイトルの垂直方向のアラインメントを表す定数です。

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

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

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

解説

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

参照

SFZTitleFlatFrame::SetHeaderColor | SFXRGBColor


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

参照

SFZTitleFlatFrame::SetFont


SFZTitleFlatFrame::GetFrameSize
内枠の上辺とタイトル文字の間の余白を取得します。
[ public, const ]
SInt16 GetFrameSize(Void);

戻り値

タイトル付きフラットフレームの内枠の上辺とタイトル文字の間のピクセル数(余白)。

参照

SFZTitleFlatFrame::SetFrameSize


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

戻り値

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

参照

SFZTitleFlatFrame::HandleMarginRequest


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

戻り値

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

参照

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);

戻り値

テキストラベルコントロールのウィジェット。

解説

[Note] ウィジェットとは

ウィジェットはコントロールなどが内部的に利用するレスポンダです。イベントに直接反応せず、描画機能だけが実装されています。 ただし、イベントへの応答や各種パラメータの設定のための API が用意されており、 ウィジェットを利用するコントロールなどがイベントに応答してこれらの API を呼び出します。

ウィジェットは同じ機能のコンポーネント化を目指して作成されています。 たとえば、ボタンコントロールとラベルコントロールでスクロールするテキストを実際に描画しているのは、 これらのコントロールが保持している SFYSingleTextWidget です。

このように、スクロールするテキストなど基本的な機能を提供するのがウィジェットであり、 新しいコントロールを作成する場合などに適宜ウィジェットを子レスポンダとして 用いれば複雑な処理を記述せずに簡単に実装することができます。

参照

SFYSingleTextWidget


SFZTitleFlatFrame::HandleBoundVirtual
仮想領域の変更処理を行います。
[ protected, virtual ]
Void HandleBoundVirtual(Void);

解説

(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントを受信したときに呼び出される関数です。

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

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

[Note] (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントの送信

(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベントは SFYResponder::SetRealBound または SFYResponder::SetVirtualBound 関数を呼び出したときなどに発生します。

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

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

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

領域イベント専用ハンドラを宣言し登録する手間が省けるので、通常はこの仮想関数をオーバーライドだけして仮想領域の変更処理を行います。

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 領域イベント(SFEVT_RESPONDER_BOUND) | 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]


SFZTitleFlatFrame::HandleMarginRequest
余白を計算します。
[ protected, virtual, const ]
Void HandleMarginRequest(
    SFXMarginPtr margin   // 計算された余白
);

解説

影部分と枠とヘッダーを加えた余白を返します。

参照

SFZTitleFlatFrame::GetHeaderBound SFYPlainFrame::GetShadowMargin | SFYFlatFrame::GetFrameMargin


SFZTitleFlatFrame::HandleRenderRequest
レスポンダを描画します。
[ protected, virtual, const ]
Void HandleRenderRequest(
    SFXGraphicsPtr graphics   // グラフィックスオブジェクト
);

解説

(SFEVT_RESPONDER_RENDER, SFP16_RENDER_REQUEST) イベントを受信したときに呼び出される関数です。

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

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

[Note] 描画処理の方法

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

描画処理は、最初に仮想関数を実行し、次に描画イベント専用ハンドラを登録した順に実行して行われます。

描画イベント専用ハンドラを宣言し登録する手間が省けるので、通常はこの仮想関数をオーバーライドだけして描画を行います。

[Note] 描画処理の手順

描画ハンドラは描画イベント(SFEVT_RESPONDER_RENDER)の発生によって起動されます。 そして実際の描画は描画ハンドラによって行われます。

描画イベント(SFEVT_RESPONDER_RENDER)自体は、 SFYResponder::Render 関数によって描画エンジンが起動してから 描画エンジンが登録された再描画領域のなかから再描画が必要な領域を含むレスポンダだけに SFYResponder::InvokeBackward 関数を使って送信します。

なお、SFYResponder::Render 関数は イベントループの最後で自動的に呼び出されるか、 コールバックなどの処理なかから明示的に呼び出されるかのどちらかです。

また、SFYResponder::Render 関数の引数を true にして呼び出すと、 再描画領域の登録に関係無くレスポンダツリーの自レスポンダ以下の枝部分で実際に携帯電話の画面に描画されるすべてのレスポンダに描画イベントが送信されます。

参照

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 以外のポインタを返し、exception 引数は常に SFERR_NO_ERROR になります。 メモリ不足などで作成に失敗した場合は null ポインタを返し、exception 引数にエラー値が返ります。

使用例

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

SFZTitleFlatFrameSmp titleflatframe;
SFCError error;

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

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

解説

デフォルト値: AEE_FONT_NORMAL

参照

SFZTitleFlatFrame::GetFont


SFZTitleFlatFrame::SetFrameSize
内枠の上辺とタイトル文字の間の余白を設定します。
[ public ]
Void SetFrameSize(
    SInt16 param   // 内枠の上辺とタイトル文字の間のピクセル数(余白)
);

解説

タイトル付きフラットフレームの内枠の上辺とタイトル文字の間のピクセル数(余白)を設定します。

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

参照

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   // 設定する値
);

解説

タイトルの水平アラインメントを設定します。

デフォルト値: SFYSingleTextWidget::DEFAULT_HORIZONTAL(中央揃え)

参照

SFZTitleFlatFrame::GetHorizontalAlign | SFZTitleFlatFrame::HorizontalEnum


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

解説

デフォルト値: DIRECTION_LEFT(左方向)

参照

SFZTitleFlatFrame::GetScrollDirection | SFZTitleFlatFrame::DirectionEnum


SFZTitleFlatFrame::SetScrollInterval
タイトルのスクロール移動時間を設定します。
[ public ]
Void SetScrollInterval(
    UInt32 param   // 設定する値
);

解説

デフォルト値: 100 ミリ秒

参照

SFZTitleFlatFrame::GetScrollInterval | SFZTitleFlatFrame::DefaultEnum


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

解説

デフォルト値: -1

参照

SFZTitleFlatFrame::GetScrollStep | SFZTitleFlatFrame::DefaultEnum


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

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • メモリ不足のとき : SFERR_NO_MEMORY
  • その他のエラーのとき : SFERR_FAILED

解説

表示するタイトルを設定します。

文字列を直接設定したり、ファイルから読み込むように設定することもできます。

参照

SFZTitleFlatFrame::GetText


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

解説

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

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

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

参照

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


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

解説

タイトルの垂直アラインメントを設定します。

デフォルト値: SFYSingleTextWidget::DEFAULT_VERTICAL(中央揃え)

参照

SFZTitleFlatFrame::GetVerticalAlign | SFZTitleFlatFrame::VerticalEnum


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

解説

デフォルト値: 1000 ミリ秒

参照

SFZTitleFlatFrame::GetWaitInterval | SFZTitleFlatFrame::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