前のページ次のページ上に戻るホーム BREW C++ ライブラリ & GUI フレームワーク & XML ミドルウェア : SophiaFramework UNIVERSE 5.0

24.3. SFY レスポンダシステム用マクロ（新レスポンダシステム）

レスポンダにてイベントを受信するには、ハンドラマクロを利用してハンドラを作成します。

ハンドラには汎用ハンドラと特定のイベントに特化された専用ハンドラがあり、それぞれ汎用ハンドラマクロと専用ハンドラマクロが用意されています。

いくつかのハンドラマクロには戻り値を省略する VOID タイプと戻り値を明記する BOOL タイプがあります。

戻り値を省略する場合、戻り値は true であると判断されます。

関連情報 : ハンドラ | SFXEvent | SFXEventRange | SFCEventEnum

24.3.1. 引数のない汎用ハンドラ[XANDLER_DECLARE_VOIDVOID または XANDLER_DECLARE_BOOLVOID]

例 24.1. ハンドラ宣言

XANDLER_DECLARE_VOIDVOID(FUNCTION)

// または

XANDLER_DECLARE_BOOLVOID(FUNCTION)

表 24.7. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.2. ハンドラ実装

XANDLER_IMPLEMENT_VOIDVOID(CLASS, FUNCTION, invoker)
{
    return;
}

// または

XANDLER_IMPLEMENT_BOOLVOID(CLASS, FUNCTION, invoker)
{
    return false;
}

表 24.8. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。

24.3.2. 引数のある汎用ハンドラ[XANDLER_DECLARE_VOIDEVENT または XANDLER_DECLARE_BOOLEVENT]

例 24.3. ハンドラ宣言

XANDLER_DECLARE_VOIDEVENT(FUNCTION)

// または

XANDLER_DECLARE_BOOLEVENT(FUNCTION)

表 24.9. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.4. ハンドラ実装

XANDLER_IMPLEMENT_VOIDEVENT(CLASS, FUNCTION, invoker, event)
{
    return;
}

// または

XANDLER_IMPLEMENT_BOOLEVENT(CLASS, FUNCTION, invoker, event)
{
    return false;
}

表 24.10. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 SFXEventConstRef 型変数名 イベントを表します。

関連情報 : キーイベント[SFEVT_KEY から SFEVT_KEY_HOOK_RELEASE] | コントロールイベント[SFEVT_COMMAND から SFEVT_CTL_TEXT_MODECHANGED] | ダイアログイベント[SFEVT_DIALOG_INIT から SFEVT_COPYRIGHT_END] | シェルイベント[SFEVT_ALARM から SFEVT_NOTIFY_FAILURE] | デバイスイベント[SFEVT_FLIP から SFEVT_SCR_ROTATE] | クリップボードイベント[SFEVT_CB_CUT から SFEVT_CB_PASTE] | その他のアプレットイベント[SFEVT_APP_CONFIG から SFEVT_APP_START_WINDOW] | ソフトキーイベント[SFEVT_RESPONDER_SOFTKEY]

24.3.3. アプレット開始イベント専用ハンドラ[XANDLER_DECLARE_VOIDSTART または XANDLER_DECLARE_BOOLSTART]

例 24.5. ハンドラ宣言

XANDLER_DECLARE_VOIDSTART(FUNCTION)

// または

XANDLER_DECLARE_BOOLSTART(FUNCTION)

表 24.11. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.6. ハンドラ実装

XANDLER_IMPLEMENT_VOIDSTART(CLASS, FUNCTION, invoker, environment)
{
    return;
}

// または

XANDLER_IMPLEMENT_BOOLSTART(CLASS, FUNCTION, invoker, environment)
{
    return false;
}

表 24.12. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 AEEAppStart* 型変数名 開始情報を表します。

関連情報 : アプレット開始イベント[SFEVT_APP_START]

24.3.4. アプレット終了イベント専用ハンドラ[XANDLER_DECLARE_VOIDSTOP または XANDLER_DECLARE_BOOLSTOP]

例 24.7. ハンドラ宣言

XANDLER_DECLARE_VOIDSTOP(FUNCTION)

// または

XANDLER_DECLARE_BOOLSTOP(FUNCTION)

表 24.13. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.8. ハンドラ実装

XANDLER_IMPLEMENT_VOIDSTOP(CLASS, FUNCTION, invoker, quitable)
{
    return;
}

// または

XANDLER_IMPLEMENT_BOOLSTOP(CLASS, FUNCTION, invoker, quitable)
{
    return false;
}

表 24.14. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 BoolPtr 型変数名 終了確認を表します。

関連情報 : アプレット終了イベント[SFEVT_APP_STOP]

24.3.5. アプレット再開イベント専用ハンドラ[XANDLER_DECLARE_VOIDRESUME または XANDLER_DECLARE_BOOLRESUME]

例 24.9. ハンドラ宣言

XANDLER_DECLARE_VOIDRESUME(FUNCTION)

// または

XANDLER_DECLARE_BOOLRESUME(FUNCTION)

表 24.15. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.10. ハンドラ実装

XANDLER_IMPLEMENT_VOIDRESUME(CLASS, FUNCTION, invoker, environment)
{
    return;
}

// または

XANDLER_IMPLEMENT_BOOLRESUME(CLASS, FUNCTION, invoker, environment)
{
    return false;
}

表 24.16. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 AEEAppStart* 型変数名 再開情報を表します。

関連情報 : アプレット再開イベント[SFEVT_APP_RESUME]

24.3.6. アプレット中断イベント専用ハンドラ[XANDLER_DECLARE_VOIDSUSPEND または XANDLER_DECLARE_BOOLSUSPEND]

例 24.11. ハンドラ宣言

XANDLER_DECLARE_VOIDSUSPEND(FUNCTION)

// または

XANDLER_DECLARE_BOOLSUSPEND(FUNCTION)

表 24.17. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.12. ハンドラ実装

XANDLER_IMPLEMENT_VOIDSUSPEND(CLASS, FUNCTION, invoker, reason, info)
{
    return;
}

// または

XANDLER_IMPLEMENT_BOOLSUSPEND(CLASS, FUNCTION, invoker, reason, info)
{
    return false;
}

表 24.18. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 AEESuspendReason 型変数名 中断原因を表します。
5 AEESuspendInfo* 型変数名 中断情報を表します。

関連情報 : アプレット中断イベント[SFEVT_APP_SUSPEND]

24.3.7. 親子イベント専用ハンドラ[XANDLER_DECLARE_VOIDOWNER]

例 24.13. ハンドラ宣言

XANDLER_DECLARE_VOIDOWNER(FUNCTION)

表 24.19. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.14. ハンドラ実装

XANDLER_IMPLEMENT_VOIDOWNER(CLASS, FUNCTION, invoker, reason, responder)
{
    return;
}

表 24.20. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 UInt16 型変数名 イベントの P16 パラメータを表します。
5 SFYResponderPtr 型変数名 通知するレスポンダを表します。

関連情報 : 親子イベント[SFEVT_RESPONDER_OWNER]

24.3.8. 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]

例 24.15. ハンドラ宣言

XANDLER_DECLARE_VOIDBOUND(FUNCTION)

表 24.21. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.16. ハンドラ実装

XANDLER_IMPLEMENT_VOIDBOUND(CLASS, FUNCTION, invoker, reason, rectangle)
{
    return;
}

表 24.22. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 UInt16 型変数名 イベントの P16 パラメータを表します。
5 SFXRectanglePtr 型変数名 通知する矩形を表します。

関連情報 : 領域イベント[SFEVT_RESPONDER_BOUND]

24.3.9. 余白イベント専用ハンドラ[XANDLER_DECLARE_VOIDMARGIN]

例 24.17. ハンドラ宣言

XANDLER_DECLARE_VOIDMARGIN(FUNCTION)

表 24.23. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.18. ハンドラ実装

XANDLER_IMPLEMENT_VOIDMARGIN(CLASS, FUNCTION, invoker, reason, margin)
{
    return;
}

表 24.24. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 UInt16 型変数名 イベントの P16 パラメータを表します。
5 SFXMarginPtr 型変数名 通知する余白を表します。

関連情報 : 余白イベント[SFEVT_RESPONDER_MARGIN]

24.3.10. 状態イベント専用ハンドラ[XANDLER_DECLARE_VOIDSTATE]

例 24.19. ハンドラ宣言

XANDLER_DECLARE_VOIDSTATE(FUNCTION)

表 24.25. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.20. ハンドラ実装

XANDLER_IMPLEMENT_VOIDSTATE(CLASS, FUNCTION, invoker, reason, state)
{
    return;
}

表 24.26. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 UInt16 型変数名 イベントの P16 パラメータを表します。
5 Bool 型変数名 通知する状態を表します。

関連情報 : 状態イベント[SFEVT_RESPONDER_STATE]

24.3.11. フォーカスイベント専用ハンドラ[XANDLER_DECLARE_VOIDFOCUS]

例 24.21. ハンドラ宣言

XANDLER_DECLARE_VOIDFOCUS(FUNCTION)

表 24.27. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.22. ハンドラ実装

XANDLER_IMPLEMENT_VOIDFOCUS(CLASS, FUNCTION, invoker, reason, focus)
{
    return;
}

表 24.28. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 UInt16 型変数名 イベントの P16 パラメータを表します。
5 Bool 型変数名 フォーカスの状態を表します。

関連情報 : フォーカスイベント[SFEVT_RESPONDER_FOCUS]

24.3.12. 描画イベント専用ハンドラ[XANDLER_DECLARE_VOIDRENDER]

例 24.23. ハンドラ宣言

XANDLER_DECLARE_VOIDRENDER(FUNCTION)

表 24.29. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.24. ハンドラ実装

XANDLER_IMPLEMENT_VOIDRENDER(CLASS, FUNCTION, invoker, reason, graphics)
{
    return;
}

表 24.30. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 UInt16 型変数名 イベントの P16 パラメータを表します。
5 SFXGraphicsPtr 型変数名 グラフィックスオブジェクトを表します。

関連情報 : 描画イベント[SFEVT_RESPONDER_RENDER]

24.3.13. スタイルイベント専用ハンドラ[XANDLER_DECLARE_VOIDSTYLE]

例 24.25. ハンドラ宣言

XANDLER_DECLARE_VOIDSTYLE(FUNCTION)

表 24.31. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.26. ハンドラ実装

XANDLER_IMPLEMENT_VOIDSTYLE(CLASS, FUNCTION, invoker, reason)
{
    return;
}

表 24.32. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 UInt16 型変数名 イベントの P16 パラメータを表します。

関連情報 : スタイルイベント[SFEVT_RESPONDER_STYLE]

24.3.14. 値イベント専用ハンドラ[XANDLER_DECLARE_VOIDVALUE]

例 24.27. ハンドラ宣言

XANDLER_DECLARE_VOIDVALUE(FUNCTION)

表 24.33. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.28. ハンドラ実装

XANDLER_IMPLEMENT_VOIDVALUE(CLASS, FUNCTION, invoker, reason, value)
{
    return;
}

表 24.34. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 UInt16 型変数名 イベントの P16 パラメータを表します。
5 SInt32 型変数名 通知する値を表します。

関連情報 : 値イベント[SFEVT_RESPONDER_VALUE]

24.3.15. 結果イベント専用ハンドラ[XANDLER_DECLARE_VOIDRESULT]

例 24.29. ハンドラ宣言

XANDLER_DECLARE_VOIDRESULT(FUNCTION)

表 24.35. 宣言マクロ引数

番号 内容 解説
1 関数名 ハンドラに用いるクラス関数名を表します。

例 24.30. ハンドラ実装

XANDLER_IMPLEMENT_VOIDRESULT(CLASS, FUNCTION, invoker, reason, result)
{
    return;
}

表 24.36. 実装マクロ引数

番号 内容 解説
1 クラス名 ハンドラが所属するクラス名を表します。
2 関数名 ハンドラに用いるクラス関数名を表します。
3 SFYResponderPtr 型変数名 ハンドラの呼び出し元レスポンダを表します。
4 UInt16 型変数名 イベントの P16 パラメータを表します。
5 SInt32 型変数名 通知する結果を表します。

関連情報 : 結果イベント[SFEVT_RESPONDER_RESULT]

24.3.16. その他のマクロ

例 24.31. ハンドラのエントリ名を取得するマクロ

#define    XANDLER_FUNCTION(FUNCTION)    FUNCTION##SHP

表 24.37. マクロ引数

番号 内容 解説
1 関数名 エントリ名の取得に用いるクラス関数名を表します。
[Tip] XANDLER_FUNCTION マクロの利用シーン
複数のハンドラをまとめて登録するときに使います。 
static SFXEventRange::AtomRecConst range[] = {
    {             SFEVT_KEY,              SFEVT_KEY,          SFP16_BEGIN,            SFP16_END},
    {       SFEVT_KEY_PRESS,        SFEVT_KEY_PRESS,          SFP16_BEGIN,            SFP16_END},
    {     SFEVT_KEY_RELEASE,      SFEVT_KEY_RELEASE,          SFP16_BEGIN,            SFP16_END}
};
SFYHandler::RuleRec rule[lengthof(range)];
SFCError error;

rule[0].spp = XANDLER_FUNCTION(OnKey);
rule[0].reference = this;
rule[1].spp = XANDLER_FUNCTION(OnKeyPress);
rule[1].reference = this;
rule[2].spp = XANDLER_FUNCTION(OnKeyRelease);
rule[2].reference = this;

error = RegisterHandler(atomic_cast(range), rule, lengthof(range));

例 24.32. ヌル ハンドラを取得するマクロ

#define    XANDLER_NULL    (null), (null)

例 24.33. 内部のインスタンスを参照するハンドラを取得するマクロ

#define    XANDLER_INTERNAL(FUNCTION)    (XANDLER_FUNCTION(FUNCTION)), (this)

表 24.38. マクロ引数

番号 内容 解説
1 関数名 ハンドラの取得に用いるクラス関数名を表します。
[Tip] XANDLER_INTERNAL マクロの利用シーン
同じクラスのインスタンスを参照するハンドラを個別に登録するときに使います。 
SFCError error;

error = RegisterHandler(SFXEventRange(SFEVT_KEY, SFEVT_KEY, SFP16_BEGIN, SFP16_END), XANDLER_INTERNAL(OnKey));

例 24.34. 外部のインスタンスを参照するハンドラを取得するマクロ

#define    XANDLER_EXTERNAL(FUNCTION, REFERENCE)    (XANDLER_FUNCTION(FUNCTION)), ((REFERENCE))

表 24.39. マクロ引数

番号 内容 解説
1 関数名 ハンドラの取得に用いるクラス関数名を表します。
2 インスタンス変数名 外部のインスタンスを保持する変数名を表します。
[Note] XANDLER_INTERNALマクロと XANDLER_EXTERNALマクロ

ハンドラが同じクラスのインスタンスを参照する場合は、XANDLER_INTERNALマクロを使ってハンドラを取得します。 このとき、ハンドラは自動的に this 変数を含む構文に展開されます。

ハンドラが外部のクラスのインスタンスを参照する場合は、XANDLER_EXTERNALマクロを使ってハンドラを取得します。 このとき、ハンドラは自動的に引数で指定した外部クラスのインスタンスを含む構文に展開されます。

同じクラスのインスタンスを参照するハンドラが大半なので大抵の場合は XANDLER_INTERNALマクロを利用します。

static 関数の中など this が使えない場所や、 this が使える場合でも渡したいインスタンスが自分自身ではなく外部のレスポンダの場合、 XANDLER_EXTERNAL マクロを利用することになります。

Copyright (C) 2002 - 2008 Sophia Cradle Incorporated
All Rights Reserved.		 前のページ次のページ上に戻るホーム