前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.0
SFZImageButtonControl
イメージボタンを表すコントロールです。
#include <SFZImageButtonControl.h.hpp>
class SFZImageButtonControl : public SFYButtonControl;
SFMTYPEDEFRESPONDER(SFZImageButtonControl)

継承図

SFZImageButtonControl クラスの継承図

協調図

SFZImageButtonControl クラスの協調図

解説

SFZImageButtonControl は、ボタン操作時にイベントを受信することができるクラスです。

図 224. 動作例

動作例

参照

イメージを表示するボタンコントロール [SFZImageButtonControl]

メンバ

コンストラクタ/デストラクタ
SFZImageButtonControl( Void )
SFZImageButtonControl クラスのコンストラクタです。
~SFZImageButtonControl( Void )
SFZImageButtonControl クラスのデストラクタです。
パブリック関数
HorizontalEnum GetHorizontalAlign( Void )
水平アラインメントの値を取得します。
SFBImageSmpConstRef GetImage( Void )
イメージを取得します。
VerticalEnum GetVerticalAlign( Void )
垂直アラインメントの値を取得します。
static
SFZImageButtonControlSmp
NewInstance( SFCErrorPtr exception = null )
新しいインスタンスを作成します。
Void SetHorizontalAlign( HorizontalEnum param )
水平アラインメントを設定します。
SFCError SetImage( SFXPathConstRef path )
SetImage( SFBImageSmpConstRef param )
SetImage( SFXPathConstRef path , UInt16 id )
イメージを設定します。
Void SetVerticalAlign( VerticalEnum param )
垂直アラインメントを設定します。
Void ClearHandler( Void ) (SFYResponder から継承)
ハンドラの登録をすべて解除します。
Void ClearTracer( Void ) (SFYResponder から継承)
トレーサの登録をすべて解除します。
SFCError Distribute( SFXEventConstRef event , BoolPtr result = null ) (SFYResponder から継承)
配信エンジンを起動してイベントを配信します。
SFXRGBColorConstRef GetBackgroundColor( Void ) (SFYWidget から継承)
背景の色を取得します。
SFXBevelColorConstRef GetButtonColor( Void ) (SFYButtonControl から継承)
フォーカス以外の状態にあるときのボタンコントロールを描画するベベルカラーを取得します。
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 から継承)
最前面に位置する子レスポンダを取得します。
SInt32 GetCurrentValue( Void ) (SFYControl から継承)
コントロールの現在値を取得します。
SFYDistributerPtr GetDistributer( Void ) (SFYResponder から継承)
配信エンジンを取得します。
SFXBevelColorConstRef GetFocusColor( Void ) (SFYButtonControl から継承)
フォーカス状態にあるときのボタンコントロールを描画するベベルカラーを取得します。
SFXRectangle GetGlobalBound( Void ) (SFYResponder から継承)
グローバル領域を取得します。
UInt32 GetID( Void ) (SFYResponder から継承)
ID を取得します。
SFXRectangle GetLocalBound( Void ) (SFYResponder から継承)
ローカル領域を取得します。
SInt32 GetMaximumValue( Void ) (SFYControl から継承)
コントロールの最大値を取得します。
SInt32 GetMinimumValue( Void ) (SFYControl から継承)
コントロールの最小値を取得します。
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 から継承)
自レスポンダが前面から数えて何番目に位置するかを取得します。
AVKType GetOperateKey( Void ) (SFYButtonControl から継承)
ボタンの操作キーを取得します。
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 ) (SFYButtonControl から継承)
影の色を取得します。
Bool GetStateActive( Bool inherit = false ) (SFYResponder から継承)
活性状態を取得します。
Bool GetStateEnable( Bool inherit = false ) (SFYResponder から継承)
操作可能状態を取得します。
Bool GetStateFocus( Bool inherit = false ) (SFYResponder から継承)
フォーカス状態を取得します。
Bool GetStatePress( Void ) (SFYButtonControl から継承)
ボタンの押下状態を取得します。
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 SetButtonColor( SFXBevelColorConstRef param ) (SFYButtonControl から継承)
フォーカス以外の状態にあるときのボタンコントロールを描画するベベルカラーを設定します。
Void SetCurrentValue( SInt32 param ) (SFYControl から継承)
コントロールの現在値を設定します。
Void SetDistributer( SFYDistributerPtr param ) (SFYResponder から継承)
配信エンジンを設定します。
Void SetFocusColor( SFXBevelColorConstRef param ) (SFYButtonControl から継承)
フォーカス状態にあるときのボタンコントロールを描画するベベルカラーを設定します。
Void SetID( UInt32 param ) (SFYResponder から継承)
ID を設定します。
Void SetMaximumValue( SInt32 param ) (SFYControl から継承)
コントロールの最大値を設定します。
Void SetMinimumValue( SInt32 param ) (SFYControl から継承)
コントロールの最小値を設定します。
Void SetOperateKey( AVKType param ) (SFYButtonControl から継承)
ボタンの操作キーを設定します。
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 ) (SFYButtonControl から継承)
影の色を設定します。
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 SetStatePress( Bool param ) (SFYButtonControl から継承)
ボタンの押下状態を設定します。
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 から継承)
現在保持している例外を取得します。
プロテクト関数
SFYImageWidgetSmpConstRef GetWidget( Void )
ウィジェットを取得します。
Void HandleBoundOptimize( SFXRectanglePtr rectangle )
指定した矩形に収まる範囲内で最適なサイズを計算します。
Void HandleBoundRequest( SFXRectanglePtr rectangle )
最適な矩形を計算します。
Void HandleBoundVirtual( Void )
仮想領域の変更処理を行います。
Void HandleRenderRequest( SFXGraphicsPtr graphics )
レスポンダを描画します。
Void DrawButton( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (SFYButtonControl から継承)
ボタンを描画します。
SFXRectangle DrawShadow( SFXGraphicsPtr graphics , SFXRectangleConstRef rectangle ) (SFYButtonControl から継承)
影を描画します。
static
SFYResponderSmp
Factory( SFYResponderPtr responder , SFCErrorPtr exception = null ) (SFYResponder から継承)
NewInstance 関数の実装を補助します。
static
SFXMarginConstRef
GetButtonMargin( Void ) (SFYButtonControl から継承)
ボタンコントロールのマージンを取得します。
static
SFXGridConstRef
GetPressOffset( Void ) (SFYButtonControl から継承)
プレス オフセットを取得します。
static
SFXMarginConstRef
GetShadowMargin( Void ) (SFYButtonControl から継承)
ボタンコントロールの影部分のマージンを取得します。
SFYResponderSmp GetThis( Void ) (SFYResponder から継承)
スマートポインタで保持された this を取得します。
Void HandleBoundGlobal( SFXRectangleConstRef rectangle ) (SFYWidget から継承)
グローバル領域の変更処理を行います。
Void HandleBoundReal( Void ) (SFYControl から継承)
実領域の変更処理を行います。
Void HandleOperateKey( Void ) (SFYButtonControl から継承)
キーイベントを処理します。
Void HandleOperateKeyPress( Void ) (SFYButtonControl から継承)
キー押下イベントを処理します。
Void HandleOperateKeyRelease( Void ) (SFYButtonControl から継承)
キー解放イベントを処理します。
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
SFZImageButtonControl クラスを表す定数です。
HorizontalEnum
水平方向のアラインメントを表す定数です。
VerticalEnum
垂直方向のアラインメントを表す定数です。

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

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

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

戻り値

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

参照

SFZImageButtonControl::SetHorizontalAlign | SFZImageButtonControl::HorizontalEnum


SFZImageButtonControl::GetImage
イメージを取得します。
[ public, const ]
SFBImageSmpConstRef GetImage(Void);

参照

SFZImageButtonControl::SetImage | SFBImage


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

戻り値

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

参照

SFZImageButtonControl::SetVerticalAlign | SFZImageButtonControl::VerticalEnum


SFZImageButtonControl::GetWidget
ウィジェットを取得します。
[ protected, const ]
SFYImageWidgetSmpConstRef GetWidget(Void);

戻り値

イメージ ボタンコントロールのウィジェット。

解説

[Note] ウィジェットとは

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

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

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

参照

SFYImageWidget


SFZImageButtonControl::HandleBoundOptimize
指定した矩形に収まる範囲内で最適なサイズを計算します。
[ protected, virtual, const ]
Void HandleBoundOptimize(
    SFXRectanglePtr rectangle   // 矩形
);

解説

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

指定した矩形に収まる範囲内で最適なサイズを計算します。


SFZImageButtonControl::HandleBoundRequest
最適な矩形を計算します。
[ protected, virtual, const ]
Void HandleBoundRequest(
    SFXRectanglePtr rectangle   // 計算された座標
);

解説

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

レスポンダに最適な大きさの矩形を計算して返したい場合は、この関数をオーバーライドします。

デフォルトの実装は、イメージの大きさをもとにボタンに最適な矩形を計算します。


SFZImageButtonControl::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]


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

解説

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

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

デフォルトの実装は、ボタンを描画します。


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

引数

exception

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

戻り値

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

解説

SFZImageButtonControl クラスの新しいインスタンスを作成します。

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

使用例

イメージボタンを作成する方法

SFZImageButtonControlSmp button;
SFCError error;

if ((button = SFZImageButtonControl::NewInstance(&error)) != null) {
    ...
}

SFZImageButtonControl::SetHorizontalAlign
水平アラインメントを設定します。
[ public ]
Void SetHorizontalAlign(
    HorizontalEnum param   // 
);

解説

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

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

参照

SFZImageButtonControl::GetHorizontalAlign | SFZImageButtonControl::HorizontalEnum


SFZImageButtonControl::SetImage
イメージを設定します。
[ public ]
SFCError SetImage(
    SFXPathConstRef path   // ファイルパス
);
[ public ]
SFCError SetImage(
    SFXPathConstRef path   // リソースファイルパス
    UInt16 id              // リソース ID
);
[ public ]
SFCError SetImage(
    SFBImageSmpConstRef param   // イメージオブジェクト
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 利用できないイメージのとき : SFERR_INVALID_PARAM
  • その他のエラーのとき : SFERR_FAILED

解説

表示するイメージを設定します。

イメージオブジェクトを直接設定したり、ファイルから読み込むように設定することもできます。

イメージのサイズが不正なものやアニメーションビットマップなどは利用できません。

参照

SFZImageButtonControl::GetImage | SFBImage


SFZImageButtonControl::SetVerticalAlign
垂直アラインメントを設定します。
[ public ]
Void SetVerticalAlign(
    VerticalEnum param   // 設定する値
);

解説

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

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

参照

SFZImageButtonControl::GetVerticalAlign | SFZImageButtonControl::VerticalEnum


SFZImageButtonControl::CodeEnum
SFZImageButtonControl クラスを表す定数です。
enum CodeEnum {
    CODE_TYPE = four_char_code('c', 'i', 'b', 'n')
};
SFMTYPEDEFTYPE(CodeEnum)

参照

SFYResponder::GetType | SFYResponder::SetType


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

参照

SFYImageWidget::HorizontalEnum


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

参照

SFYImageWidget::VerticalEnum