SFXEvent

イベントを表すクラスです。

#include <SFXEvent.h.hpp>

class SFXEvent;

SFMTYPEDEFCLASS(SFXEvent)

解説

SFXEvent クラスは、イベントタイプ（BREW API AEEEvent 型）、 P16 パラメータ値（UInt16 型）、 P32 パラメータ値（UInt32 型）の 3 つから構成されるイベント情報をカプセル化して管理するためのクラスです。

イベントタイプは、 BREW API AEEEvent イベントに対応します。 P16 パラメータと P32 パラメータは、 BREW のイベントハンドラに渡す、wParam パラメータと dwParam パラメータに対応し、イベントタイプに付随する情報を格納しているパラメータであり、その意味はイベントタイプ毎に異なります。

	イベントタイプのリスト
	イベントタイプのリストについては、`SFCEventEnum` を参照してください。

例 822. SFXEvent クラスの使い方 1

// イベントハンドラ
Bool helloworld::HandleEvent(SFXEventConstRef event)
{
    // ここに BREW 環境から配信される各種イベントの分岐処理を記述する

    Bool result(false);

    // イベントタイプを判定する
    switch (event.GetType()) {

        case SFEVT_KEY: // キーイベントのとき

            // キーハンドラ OnKey 関数を呼び出す
            result = OnKey(event.GetP16()); // OnKey 関数はキーイベントを処理した場合は true、しなかった場合は false を返す
    }

    return result; // イベントを処理したときは true を返し, そうでないときは false を返す
}

例 823. SFXEvent クラスの使い方 2

SFXEvent event;

// ユーザーイベントを設定する場合
event.Set(SFEVT_USER + 0x01, 0, 0);

SFBShellSmp shell = SFBShell::GetInstance();

// 自分自身にユーザーイベントを送信する
shell->PostEvent(GetClassID(), event);

参照

SFXEventRange | SFCEventEnum | BREW API AEEEvent

メンバ

コンストラクタ/デストラクタ
SFXEvent( `Void` ) SFXEvent クラスのコンストラクタです。
SFXEvent( `SFXEventConstRef` param ) SFXEvent クラスのコンストラクタです。
SFXEvent( `AEEEvent` type , `UInt16` p16 , `UInt32` p32 ) SFXEvent クラスのコンストラクタです。

パブリック関数
`Bool`	Equals( `SFXEventConstRef` param ) このイベントが指定されたイベントと等しいか判定します。
`Bool`	Equals( `AEEEvent` type , `UInt16` p16 , `UInt32` p32 ) このイベントが指定されたイベントと等しいか判定します。
`Bool`	EqualsTypeP16( `SFXEventConstRef` param ) このイベントのイベントタイプと P16 パラメータが指定した値と等しいか判定します。
`Bool`	EqualsTypeP16( `AEEEvent` type , `UInt16` p16 ) このイベントのイベントタイプと P16 パラメータが指定した値と等しいか判定します。
`UInt16`	GetP16( `Void` ) このイベントの P16 パラメータを取得します。
`UInt32`	GetP32( `Void` ) このイベントの P32 パラメータを取得します。
`AEEEvent`	GetType( `Void` ) このイベントのイベントタイプを取得します。
static `SFXEventConstRef`	NoneInstance( `Void` ) SFEVT_NONE イベントを取得します。
`Void`	Set( `SFXEventConstRef` param ) このイベントを設定します。
`Void`	Set( `AEEEvent` type , `UInt16` p16 , `UInt32` p32 ) このイベントを設定します。
`Void`	SetP16( `UInt16` param ) このイベントの P16 パラメータを設定します。
`Void`	SetP32( `UInt32` param ) このイベントの P32 パラメータを設定します。
`Void`	SetType( `AEEEvent` param ) このイベントのイベントタイプを設定します。
`Void`	SetTypeP16( `AEEEvent` type , `UInt16` p16 ) このイベントのイベントタイプと P16 パラメータを設定します。
`SFXEventRef`	operator=( `SFXEventConstRef` param ) 左側のイベントに右側のイベントを代入します。
`SFXEvent::AtomRec *`	atomic_cast( `SFXEvent *` param ) SFXEvent クラスを SFXEvent::AtomRec 構造体に型変換します。
`SFXEvent::AtomRec const *`	atomic_cast( `SFXEvent const *` param ) SFXEvent クラスを SFXEvent::AtomRec 構造体に型変換します。
`Bool`	operator==( `SFXEventConstRef` left , `SFXEventConstRef` right ) 左側のイベントが右側のイベントと等しいか判定します。
`Bool`	operator!=( `SFXEventConstRef` left , `SFXEventConstRef` right ) 左側のイベントが右側のイベントと異なるか判定します。

型
AtomRec イベントを表す構造体です。

グローバル関数
`SFXEvent::AtomRec *`	atomic_cast( `SFXEvent *` param ) SFXEvent クラスを SFXEvent::AtomRec 構造体に型変換します。
`SFXEvent::AtomRec const *`	atomic_cast( `SFXEvent const *` param ) SFXEvent クラスを SFXEvent::AtomRec 構造体に型変換します。
`Bool`	operator==( `SFXEventConstRef` left , `SFXEventConstRef` right ) 左側のイベントが右側のイベントと等しいか判定します。
`Bool`	operator!=( `SFXEventConstRef` left , `SFXEventConstRef` right ) 左側のイベントが右側のイベントと異なるか判定します。

SFXEvent::SFXEvent

SFXEvent クラスのコンストラクタです。

[ public, explicit ]
SFXEvent(Void);

[ public ]
SFXEvent(
    SFXEventConstRef param   // コピーする SFXEvent
);

[ public, explicit ]
SFXEvent(
    AEEEvent type   // イベントタイプ
    UInt16 p16      // P16 パラメータ
    UInt32 p32      // P32 パラメータ
);

解説

このコンストラクタは、引数を指定した場合、内部で SFXEvent::Set 関数を呼び出して引数に指定した値でこのイベントを設定します。

参照

SFXEvent::Set | BREW API AEEEvent

SFXEvent::Equals

このイベントが指定されたイベントと等しいか判定します。

[ public, const ]
Bool Equals(
    SFXEventConstRef param   // 比較対象となる SFXEvent
);

[ public, const ]
Bool Equals(
    AEEEvent type   // イベントタイプ
    UInt16 p16      // P16 パラメータ
    UInt32 p32      // P32 パラメータ
);

戻り値

等しいとき: true
異なるとき: false

解説

この関数は、このイベントが指定されたイベントと等しいか判定します。

参照

operator== | SFXEvent::EqualsTypeP16 | SFXEvent::Set | SFXEvent::SFXEvent | BREW API AEEEvent

SFXEvent::EqualsTypeP16

このイベントのイベントタイプと P16 パラメータが指定した値と等しいか判定します。

[ public, const ]
Bool EqualsTypeP16(
    SFXEventConstRef param   // 比較対象となるイベント
);

[ public, const ]
Bool EqualsTypeP16(
    AEEEvent type   // 比較対象となるイベントタイプ
    UInt16 p16      // 比較対象となる P16 パラメータ
);

戻り値

等しいとき: true
異なるとき: false

解説

この関数は、このイベントのイベントタイプと P16 パラメータが指定した値と等しいか判定します。

参照

SFXEvent::Equals | SFXEvent::SetP16 | SFXEvent::SetType | SFXEvent::Set | SFXEvent::SFXEvent

SFXEvent::GetP16

このイベントの P16 パラメータを取得します。

[ public, const ]
UInt16 GetP16(Void);

戻り値

このイベントの P16 パラメータ

解説

この関数は、このイベントの P16 パラメータを取得します。

参照

SFXEvent::SetP16 SFXEvent::Set | SFXEvent::SFXEvent

SFXEvent::GetP32

このイベントの P32 パラメータを取得します。

[ public, const ]
UInt32 GetP32(Void);

戻り値

このイベントの P32 パラメータ

解説

この関数は、このイベントの P32 パラメータを取得します。

参照

SFXEvent::SetP32 SFXEvent::Set | SFXEvent::SFXEvent

SFXEvent::GetType

このイベントのイベントタイプを取得します。

[ public, const ]
AEEEvent GetType(Void);

戻り値

このイベントのイベントタイプ

解説

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

参照

SFXEvent::SetType | SFXEvent::Set | SFXEvent::SFXEvent | BREW API AEEEvent

SFXEvent::NoneInstance

SFEVT_NONE イベントを取得します。

[ public, static ]
SFXEventConstRef NoneInstance(Void);

解説

この関数は、SFEVT_NONE イベントを取得します。

	注意
	`SFXEvent::SFXEvent`(SFEVT_NONE, 0, 0) と同じ結果を返しますが、この関数の方が高速に動作します。

参照

SFXEvent::SFXEvent

SFXEvent::Set

このイベントを設定します。

[ public ]
Void Set(
    SFXEventConstRef param   // コピーする SFXEvent
);

[ public ]
Void Set(
    AEEEvent type   // イベントタイプ
    UInt16 p16      // P16 パラメータ
    UInt32 p32      // P32 パラメータ
);

解説

この関数は、このイベントを設定します。

参照

SFXEvent::SFXEvent | SFXEvent::SetP16 | SFXEvent::SetP32 | SFXEvent::SetType | BREW API AEEEvent

SFXEvent::SetP16

このイベントの P16 パラメータを設定します。

[ public ]
Void SetP16(
    UInt16 param   // 設定する P16 パラメータ
);

解説

この関数は、このイベントの P16 パラメータを設定します。

参照

SFXEvent::GetP16 | SFXEvent::Set | SFXEvent::SFXEvent

SFXEvent::SetP32

このイベントの P32 パラメータを設定します。

[ public ]
Void SetP32(
    UInt32 param   // 設定する P32 パラメータ
);

解説

この関数は、このイベントの P32 パラメータを設定します。

参照

SFXEvent::GetP32 | SFXEvent::Set | SFXEvent::SFXEvent

SFXEvent::SetType

このイベントのイベントタイプを設定します。

[ public ]
Void SetType(
    AEEEvent param   // 設定するイベントタイプ
);

解説

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

参照

SFXEvent::GetType | SFXEvent::Set | SFXEvent::SFXEvent | BREW API AEEEvent

SFXEvent::SetTypeP16

このイベントのイベントタイプと P16 パラメータを設定します。

[ public ]
Void SetTypeP16(
    AEEEvent type   // 設定するイベントタイプ
    UInt16 p16      // 設定する P16 パラメータ
);

解説

この関数は、このイベントのイベントタイプと P16 パラメータを設定します。

参照

atomic_cast

SFXEvent クラスを SFXEvent::AtomRec 構造体に型変換します。

[ public, friend ]
SFXEvent::AtomRec * atomic_cast(
    SFXEvent * param   // キャストするイベント
);

[ public, friend ]
SFXEvent::AtomRec const * atomic_cast(
    SFXEvent const * param   // キャストするイベント
);

解説

この関数は、SFXEvent クラスを SFXEvent::AtomRec 構造体に型変換します。

参照

SFXEvent::AtomRec

SFXEvent::operator=

左側のイベントに右側のイベントを代入します。

[ public ]
SFXEventRef operator=(
    SFXEventConstRef param   // 右側のイベント
);

戻り値

代入後の左側のイベント

解説

このオペレーターは、左側のイベントに右側のイベントを代入します。

	注意
	このオペレーターは左側のイベントに影響を及ぼします。

参照

SFXEvent::Set

operator==

左側のイベントが右側のイベントと等しいか判定します。

[ public, friend ]
Bool operator==(
    SFXEventConstRef left    // 左側のイベント
    SFXEventConstRef right   // 右側のイベント
);

戻り値

等しいとき: true
そうでないとき: false

解説

このオペレーターは、左側のイベントが右側のイベントと等しいか判定します。

参照

SFXEvent::Equals | operator!=

operator!=

左側のイベントが右側のイベントと異なるか判定します。

[ public, friend ]
Bool operator!=(
    SFXEventConstRef left    // 左側のイベント
    SFXEventConstRef right   // 右側のイベント
);

戻り値

異なるとき: true
そうでないとき: false

解説

このオペレーターは、左側のイベントが右側のイベントと異なるか判定します。

参照

SFXEvent::Equals | operator==

SFXEvent::AtomRec

イベントを表す構造体です。

[ public ]
struct AtomRec {
    AEEEvent     type;  // イベントタイプ
    UInt16       p16;   // P16 パラメータ
    UInt32       p32;   // P32 パラメータ
};

参照

BREW API AEEEvent